Commit | Line | Data |
---|---|---|
6b61353c KH |
1 | \input texinfo.tex @c -*-texinfo-*- |
2 | @c We must \input texinfo.tex instead of texinfo, otherwise make | |
3 | @c distcheck in the Texinfo distribution fails, because the texinfo Info | |
4 | @c file is made first, and texi2dvi must include . first in the path. | |
b457dbd9 EZ |
5 | @comment %**start of header |
6 | @setfilename info.info | |
7 | @settitle Info | |
8 | @syncodeindex fn cp | |
9 | @syncodeindex vr cp | |
10 | @syncodeindex ky cp | |
11 | @comment %**end of header | |
b457dbd9 | 12 | |
18f952d5 | 13 | @copying |
b457dbd9 EZ |
14 | This file describes how to use Info, the on-line, menu-driven GNU |
15 | documentation system. | |
26901792 | 16 | |
6b61353c | 17 | Copyright (C) 1989, 1992, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 |
b457dbd9 | 18 | Free Software Foundation, Inc. |
26901792 | 19 | |
18f952d5 | 20 | @quotation |
308374ca DL |
21 | Permission is granted to copy, distribute and/or modify this document |
22 | under the terms of the GNU Free Documentation License, Version 1.1 or | |
23 | any later version published by the Free Software Foundation; with no | |
24 | Invariant Sections, with the Front-Cover texts being ``A GNU | |
25 | Manual'', and with the Back-Cover Texts as in (a) below. A copy of the | |
26 | license is included in the section entitled ``GNU Free Documentation | |
27 | License'' in the Emacs manual. | |
28 | ||
29 | (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify | |
30 | this GNU Manual, like GNU software. Copies published by the Free | |
31 | Software Foundation raise funds for GNU development.'' | |
32 | ||
33 | This document is part of a collection distributed under the GNU Free | |
34 | Documentation License. If you want to distribute this document | |
35 | separately from the collection, you can do so by adding a copy of the | |
36 | license to the document, as described in section 6 of the license. | |
18f952d5 KB |
37 | @end quotation |
38 | @end copying | |
39 | ||
40 | @dircategory Texinfo documentation system | |
41 | @direntry | |
42 | * Info: (info). How to use the documentation browsing system. | |
43 | @end direntry | |
26901792 | 44 | |
26901792 | 45 | @titlepage |
b457dbd9 EZ |
46 | @title Info |
47 | @subtitle The online, hyper-text GNU documentation system | |
48 | @author Brian Fox | |
49 | @author and the GNU Texinfo community | |
26901792 DL |
50 | @page |
51 | @vskip 0pt plus 1filll | |
18f952d5 | 52 | @insertcopying |
26901792 DL |
53 | @end titlepage |
54 | ||
0270117b KB |
55 | @contents |
56 | ||
b457dbd9 | 57 | @ifnottex |
919f29b6 | 58 | @node Top |
26901792 DL |
59 | @top Info: An Introduction |
60 | ||
b1d75c43 RS |
61 | The GNU Project distributes most of its on-line manuals in the |
62 | @dfn{Info format}, which you read using an @dfn{Info reader}. You are | |
63 | probably using an Info reader to read this now. | |
26901792 | 64 | |
b457dbd9 | 65 | @ifinfo |
b1d75c43 RS |
66 | If you are new to the Info reader and want to learn how to use it, |
67 | type the command @kbd{h} now. It brings you to a programmed | |
68 | instruction sequence. | |
26901792 | 69 | |
b1d75c43 RS |
70 | To read about expert-level Info commands, type @kbd{n} twice. This |
71 | brings you to @cite{Info for Experts}, skipping over the `Getting | |
72 | Started' chapter. | |
26901792 | 73 | @end ifinfo |
b457dbd9 | 74 | @end ifnottex |
26901792 DL |
75 | |
76 | @menu | |
77 | * Getting Started:: Getting started using an Info reader. | |
9170767d | 78 | * Expert Info:: Info commands for experts. |
b457dbd9 | 79 | * Creating an Info File:: How to make your own Info file. |
768e4b74 | 80 | * Index:: An index of topics, commands, and variables. |
26901792 DL |
81 | @end menu |
82 | ||
9170767d | 83 | @node Getting Started, Expert Info, Top, Top |
26901792 DL |
84 | @comment node-name, next, previous, up |
85 | @chapter Getting Started | |
86 | ||
87 | This first part of the Info manual describes how to get around inside | |
88 | of Info. The second part of the manual describes various advanced | |
89 | Info commands, and how to write an Info as distinct from a Texinfo | |
b457dbd9 | 90 | file. The third part briefly explains how to generate Info files from |
26901792 DL |
91 | Texinfo files. |
92 | ||
b457dbd9 EZ |
93 | @ifnotinfo |
94 | This manual is primarily designed for browsing with an Info reader | |
95 | program on a computer, so that you can try Info commands while reading | |
96 | about them. Reading it on paper or with an HTML browser is less | |
26901792 | 97 | effective, since you must take it on faith that the commands described |
b457dbd9 EZ |
98 | really do what the manual says. By all means go through this manual |
99 | now that you have it; but please try going through the on-line version | |
100 | as well. | |
26901792 | 101 | |
b457dbd9 EZ |
102 | @cindex Info reader, how to invoke |
103 | @cindex entering Info | |
26901792 DL |
104 | There are two ways of looking at the online version of this manual: |
105 | ||
106 | @enumerate | |
107 | @item | |
108 | Type @code{info} at your shell's command line. This approach uses a | |
3c7625c9 | 109 | stand-alone program designed just to read Info files. |
26901792 DL |
110 | |
111 | @item | |
3c7625c9 EZ |
112 | Type @code{emacs} at the command line; then type @kbd{C-h i} |
113 | (@kbd{Control-h}, followed by @kbd{i}). This approach uses the Info | |
114 | mode of the Emacs program, an editor with many other capabilities. | |
26901792 DL |
115 | @end enumerate |
116 | ||
117 | In either case, then type @kbd{mInfo} (just the letters), followed by | |
118 | @key{RET}---the ``Return'' or ``Enter'' key. At this point, you should | |
119 | be ready to follow the instructions in this manual as you read them on | |
120 | the screen. | |
121 | @c FIXME! (pesch@cygnus.com, 14 dec 1992) | |
122 | @c Is it worth worrying about what-if the beginner goes to somebody | |
123 | @c else's Emacs session, which already has an Info running in the middle | |
124 | @c of something---in which case these simple instructions won't work? | |
b457dbd9 | 125 | @end ifnotinfo |
26901792 DL |
126 | |
127 | @menu | |
128 | * Help-Small-Screen:: Starting Info on a Small Screen | |
129 | * Help:: How to use Info | |
130 | * Help-P:: Returning to the Previous node | |
e4a9d9e3 | 131 | * Help-^L:: The Space, DEL, B and ^L commands. |
bac598bb | 132 | * Help-Inv:: Invisible text in Emacs Info. |
26901792 | 133 | * Help-M:: Menus |
e4a9d9e3 | 134 | * Help-Xref:: Following cross-references |
2fc7d480 | 135 | * Help-Int:: Some intermediate Info commands |
26901792 | 136 | * Help-Q:: Quitting Info |
26901792 DL |
137 | @end menu |
138 | ||
919f29b6 | 139 | @node Help-Small-Screen |
26901792 DL |
140 | @section Starting Info on a Small Screen |
141 | ||
b457dbd9 | 142 | @ifnotinfo |
26901792 DL |
143 | (In Info, you only see this section if your terminal has a small |
144 | number of lines; most readers pass by it without seeing it.) | |
b457dbd9 | 145 | @end ifnotinfo |
26901792 | 146 | |
b457dbd9 EZ |
147 | @cindex small screen, moving around |
148 | Since your terminal has a relatively small number of lines on its | |
26901792 DL |
149 | screen, it is necessary to give you special advice at the beginning. |
150 | ||
b457dbd9 | 151 | If you see the text @samp{--All----} near the bottom right corner |
26901792 DL |
152 | of the screen, it means the entire text you are looking at fits on the |
153 | screen. If you see @samp{--Top----} instead, it means that there is | |
154 | more text below that does not fit. To move forward through the text | |
b457dbd9 EZ |
155 | and see another screen full, press @key{SPC}, the Space bar. To move |
156 | back up, press the key labeled @samp{Backspace} or @samp{DEL} (on some | |
157 | keyboards, this key might be labeled @samp{Delete}). | |
26901792 DL |
158 | |
159 | @ifinfo | |
3c7625c9 | 160 | Here are 40 lines of junk, so you can try @key{SPC} and @key{DEL} and |
26901792 DL |
161 | see what they do. At the end are instructions of what you should do |
162 | next. | |
b457dbd9 | 163 | |
26901792 | 164 | @format |
26901792 DL |
165 | This is line 20 |
166 | This is line 21 | |
167 | This is line 22 | |
168 | This is line 23 | |
169 | This is line 24 | |
170 | This is line 25 | |
171 | This is line 26 | |
172 | This is line 27 | |
173 | This is line 28 | |
174 | This is line 29 | |
175 | This is line 30 | |
176 | This is line 31 | |
177 | This is line 32 | |
178 | This is line 33 | |
179 | This is line 34 | |
180 | This is line 35 | |
181 | This is line 36 | |
182 | This is line 37 | |
183 | This is line 38 | |
184 | This is line 39 | |
185 | This is line 40 | |
186 | This is line 41 | |
187 | This is line 42 | |
188 | This is line 43 | |
189 | This is line 44 | |
190 | This is line 45 | |
191 | This is line 46 | |
192 | This is line 47 | |
193 | This is line 48 | |
194 | This is line 49 | |
195 | This is line 50 | |
196 | This is line 51 | |
197 | This is line 52 | |
198 | This is line 53 | |
199 | This is line 54 | |
200 | This is line 55 | |
201 | This is line 56 | |
b457dbd9 EZ |
202 | This is line 57 |
203 | This is line 58 | |
204 | This is line 59 | |
26901792 | 205 | @end format |
b457dbd9 | 206 | |
26901792 | 207 | If you have managed to get here, go back to the beginning with |
3c7625c9 EZ |
208 | @kbd{DEL} (or @key{BACKSPACE}), and come back here again, then you |
209 | understand the about the @samp{Space} and @samp{Backspace} keys. So | |
210 | now type an @kbd{n} ---just one character; don't type the quotes and | |
211 | don't type the Return key afterward--- to get to the normal start of | |
212 | the course. | |
26901792 DL |
213 | @end ifinfo |
214 | ||
215 | @node Help, Help-P, Help-Small-Screen, Getting Started | |
216 | @comment node-name, next, previous, up | |
217 | @section How to use Info | |
218 | ||
219 | You are talking to the program Info, for reading documentation. | |
220 | ||
bac598bb LT |
221 | There are two ways to use Info: from within Emacs or as a |
222 | stand-alone reader that you can invoke from a shell using the command | |
223 | @command{info}. | |
224 | ||
b457dbd9 | 225 | @cindex node, in Info documents |
26901792 DL |
226 | Right now you are looking at one @dfn{Node} of Information. |
227 | A node contains text describing a specific topic at a specific | |
b457dbd9 EZ |
228 | level of detail. This node's topic is ``how to use Info''. The mode |
229 | line says that this is node @samp{Help} in the file @file{info}. | |
26901792 | 230 | |
b457dbd9 | 231 | @cindex header of Info node |
b1d75c43 RS |
232 | The top line of a node is its @dfn{header}. This node's header |
233 | (look at it now) says that the @samp{Next} node after this one is the | |
234 | node called @samp{Help-P}. An advanced Info command lets you go to | |
235 | any node whose name you know. In the stand-alone Info reader program, | |
236 | the header line shows the names of this node and the info file as | |
237 | well. In Emacs, the header line is duplicated in a special typeface, | |
238 | and the duplicate remains at the top of the window all the time even | |
239 | if you scroll through the node. | |
26901792 DL |
240 | |
241 | Besides a @samp{Next}, a node can have a @samp{Previous} or an | |
b457dbd9 EZ |
242 | @samp{Up} links, or both. As you can see, this node has all of these |
243 | links. | |
26901792 | 244 | |
b457dbd9 | 245 | @kindex n @r{(Info mode)} |
26901792 DL |
246 | Now it is time to move on to the @samp{Next} node, named @samp{Help-P}. |
247 | ||
248 | @format | |
b457dbd9 | 249 | >> Type @kbd{n} to move there. Type just one character; |
26901792 DL |
250 | do not type the quotes and do not type a @key{RET} afterward. |
251 | @end format | |
252 | ||
b457dbd9 | 253 | @noindent |
26901792 DL |
254 | @samp{>>} in the margin means it is really time to try a command. |
255 | ||
b457dbd9 | 256 | @format |
1649f3e5 KB |
257 | >> If you are in Emacs and have a mouse, and if you already practiced |
258 | typing @kbd{n} to get to the next node, click now with the middle | |
259 | mouse button on the @samp{Next} link to do the same ``the mouse way''. | |
b457dbd9 EZ |
260 | @end format |
261 | ||
26901792 DL |
262 | @node Help-P, Help-^L, Help, Getting Started |
263 | @comment node-name, next, previous, up | |
264 | @section Returning to the Previous node | |
265 | ||
b457dbd9 | 266 | @kindex p @r{(Info mode)} |
26901792 DL |
267 | This node is called @samp{Help-P}. The @samp{Previous} node, as you see, |
268 | is @samp{Help}, which is the one you just came from using the @kbd{n} | |
269 | command. Another @kbd{n} command now would take you to the next | |
b1d75c43 | 270 | node, @samp{Help-^L}. |
26901792 DL |
271 | |
272 | @format | |
3c7625c9 | 273 | >> But do not type @kbd{n} yet. First, try the @kbd{p} command, |
b1d75c43 RS |
274 | or click the middle mouse button on the @samp{Prev} link. That |
275 | takes you to the @samp{Previous} node. Then use @kbd{n} to return here. | |
26901792 DL |
276 | @end format |
277 | ||
3c7625c9 | 278 | If you read this in Emacs, you will see an @samp{Info} item in the |
b1d75c43 | 279 | menu bar, close to its right edge. Clicking the mouse on the |
3c7625c9 EZ |
280 | @samp{Info} menu-bar item opens a menu of commands which include |
281 | @samp{Next} and @samp{Prev} (and also some others which you didn't yet | |
282 | learn about). | |
283 | ||
b1d75c43 RS |
284 | This all probably seems insultingly simple so far, but @emph{please |
285 | don't} start skimming. Things will get complicated soon enough! | |
286 | Also, please do not try a new command until you are told it is time | |
287 | to. You could make Info skip past an important warning that was | |
288 | coming up. | |
26901792 DL |
289 | |
290 | @format | |
b1d75c43 RS |
291 | >> Now do an @kbd{n}, or click the middle mouse button on the @samp{Next} |
292 | link, to get to the node @samp{Help-^L} and learn more. | |
26901792 DL |
293 | @end format |
294 | ||
bac598bb | 295 | @node Help-^L, Help-Inv, Help-P, Getting Started |
26901792 | 296 | @comment node-name, next, previous, up |
bac598bb | 297 | @section The Space, DEL, B and ^L commands |
26901792 | 298 | |
9170767d RS |
299 | This node's mode line tells you that you are now at node |
300 | @samp{Help-^L}, and the header line tells you that @kbd{p} would get | |
301 | you back to @samp{Help-P}. The node's title is highlighted and may be | |
302 | underlined as well; it says what the node is about. | |
26901792 DL |
303 | |
304 | This is a big node and it does not all fit on your display screen. | |
305 | You can tell that there is more that is not visible because you | |
306 | can see the string @samp{--Top-----} rather than @samp{--All----} near | |
307 | the bottom right corner of the screen. | |
308 | ||
b457dbd9 EZ |
309 | @kindex SPC @r{(Info mode)} |
310 | @kindex DEL @r{(Info mode)} | |
311 | @kindex BACKSPACE @r{(Info mode)} | |
312 | @findex Info-scroll-up | |
313 | @findex Info-scroll-down | |
3c7625c9 EZ |
314 | The @key{SPC}, @key{BACKSPACE} (or @key{DEL})@footnote{The key which |
315 | we call ``Backspace or DEL'' in this manual is labeled differently on | |
f7118ec3 EZ |
316 | different keyboards. Look for a key which is a little ways above the |
317 | @key{ENTER} or @key{RET} key and which you normally use outside Emacs | |
318 | to erase the character before the cursor, i.e.@: the character you | |
319 | typed last. It might be labeled @samp{Backspace} or @samp{<-} or | |
320 | @samp{DEL}, or sometimes @samp{Delete}.} and @kbd{b} commands exist to | |
321 | allow you to ``move around'' in a node that does not all fit on the | |
3c7625c9 EZ |
322 | screen at once. @key{SPC} moves forward, to show what was below the |
323 | bottom of the screen. @key{DEL} or @key{BACKSPACE} moves backward, to | |
324 | show what was above the top of the screen (there is not anything above | |
b1d75c43 | 325 | the top until you have typed some spaces). |
26901792 DL |
326 | |
327 | @format | |
3c7625c9 EZ |
328 | >> Now try typing a @key{SPC} (afterward, type a @key{BACKSPACE} to |
329 | return here). | |
26901792 DL |
330 | @end format |
331 | ||
3c7625c9 EZ |
332 | When you type the @key{SPC}, the two lines that were at the bottom of |
333 | the screen appear at the top, followed by more lines. @key{DEL} or | |
334 | @key{BACKSPACE} takes the two lines from the top and moves them to the | |
b457dbd9 EZ |
335 | bottom, @emph{usually}, but if there are not a full screen's worth of |
336 | lines above them they may not make it all the way to the bottom. | |
337 | ||
338 | If you are reading this in Emacs, note that the header line is | |
339 | always visible, never scrolling off the display. That way, you can | |
340 | always see the @samp{Next}, @samp{Prev}, and @samp{Up} links, and you | |
b1d75c43 RS |
341 | can conveniently go to one of these links at any time by |
342 | clicking the middle mouse button on the link. | |
b457dbd9 EZ |
343 | |
344 | @cindex reading Info documents top to bottom | |
345 | @cindex Info documents as tutorials | |
3c7625c9 | 346 | @key{SPC} and @key{DEL} not only move forward and backward through |
b1d75c43 RS |
347 | the current node. They also move between nodes. @key{SPC} at the end |
348 | of a node moves to the next node; @key{DEL} (or @key{BACKSPACE}) at | |
349 | the beginning of a node moves to the previous node. In effect, these | |
350 | commands scroll through all the nodes in an Info file as a single | |
351 | logical sequence. You can read an entire manual top to bottom by just | |
352 | typing @key{SPC}, and move backward through the entire manual from | |
353 | bottom to top by typing @key{DEL} (or @key{BACKSPACE}). | |
354 | ||
355 | In this sequence, a node's subnodes appear following their parent. | |
356 | If a node has a menu, @key{SPC} takes you into the subnodes listed in | |
357 | the menu, one by one. Once you reach the end of a node, and have seen | |
358 | all of its subnodes, @key{SPC} takes you to the next node or to the | |
359 | parent's next node. | |
b457dbd9 EZ |
360 | |
361 | @kindex PAGEUP @r{(Info mode)} | |
362 | @kindex PAGEDOWN @r{(Info mode)} | |
363 | Many keyboards nowadays have two scroll keys labeled @samp{PageUp} | |
364 | and @samp{PageDown} (or maybe @samp{Prior} and @samp{Next}). If your | |
365 | keyboard has these keys, you can use them to move forward and backward | |
b1d75c43 RS |
366 | through the text of one node, like @key{SPC} and @key{BACKSPACE} (or |
367 | @key{DEL}). However, @key{PAGEUP} and @key{PAGEDOWN} keys never | |
368 | scroll beyond the beginning or the end of the current node. | |
b457dbd9 EZ |
369 | |
370 | @kindex C-l @r{(Info mode)} | |
1fdd9f43 | 371 | If your screen is ever garbaged, you can tell Info to display it |
b457dbd9 | 372 | again by typing @kbd{C-l} (@kbd{Control-L}, that is---hold down |
3c7625c9 | 373 | @key{CTRL} and type @kbd{L} or @kbd{l}). |
26901792 DL |
374 | |
375 | @format | |
376 | >> Type @kbd{C-l} now. | |
377 | @end format | |
378 | ||
b457dbd9 | 379 | @kindex b @r{(Info mode)} |
26901792 | 380 | To move back to the beginning of the node you are on, you can type |
b1d75c43 RS |
381 | the @key{BACKSPACE} key (or @key{DEL}) many times. You can also type |
382 | @kbd{b} just once. @kbd{b} stands for ``beginning.'' | |
b457dbd9 | 383 | |
26901792 DL |
384 | @format |
385 | >> Try that now. (We have put in enough verbiage to push this past | |
b457dbd9 EZ |
386 | the first screenful, but screens are so big nowadays that perhaps it |
387 | isn't enough. You may need to shrink your Emacs or Info window.) | |
9170767d | 388 | Then come back, by typing @key{SPC} one or more times. |
26901792 DL |
389 | @end format |
390 | ||
b1d75c43 RS |
391 | If your screen is very tall, all of this node might fit at once. In |
392 | that case, @kbd{b} won't do anything. But you could observe the | |
393 | effect of the @kbd{b} key if you use a smaller window. | |
26901792 | 394 | |
b457dbd9 EZ |
395 | @kindex ? @r{(Info mode)} |
396 | @findex Info-summary | |
26901792 DL |
397 | You have just learned a considerable number of commands. If you |
398 | want to use one but have trouble remembering which, you should type | |
79c43dcd | 399 | a @kbd{?} (in Emacs it runs the @code{Info-summary} command) which |
1fdd9f43 | 400 | displays a brief list of commands. When you are finished looking at |
3c7625c9 | 401 | the list, make it go away by typing a @key{SPC} repeatedly. |
26901792 DL |
402 | |
403 | @format | |
b457dbd9 | 404 | >> Type a @key{?} now. Press @key{SPC} to see consecutive screenfuls of |
1649f3e5 KB |
405 | the list until finished. Then type @key{SPC} several times. If |
406 | you are using Emacs, the help will then go away automatically. | |
26901792 DL |
407 | @end format |
408 | ||
b457dbd9 | 409 | (If you are using the stand-alone Info reader, type @kbd{C-x 0} to |
3c7625c9 EZ |
410 | return here, that is---press and hold @key{CTRL}, type an @kbd{x}, |
411 | then release @key{CTRL} and @kbd{x}, and press @kbd{0}---a zero, not | |
b457dbd9 | 412 | the letter ``o''.) |
26901792 DL |
413 | |
414 | From now on, you will encounter large nodes without warning, and | |
3c7625c9 EZ |
415 | will be expected to know how to use @key{SPC} and @key{BACKSPACE} to |
416 | move around in them without being told. Since not all terminals have | |
26901792 DL |
417 | the same size screen, it would be impossible to warn you anyway. |
418 | ||
419 | @format | |
b1d75c43 | 420 | >> Now type @kbd{n}, or click the middle mouse button on the @samp{Next} link, |
bac598bb | 421 | to visit the next node. |
26901792 DL |
422 | @end format |
423 | ||
a57743b9 | 424 | @node Help-Inv, Help-M, Help-^L, Getting Started |
bac598bb LT |
425 | @comment node-name, next, previous, up |
426 | @section Invisible text in Emacs Info | |
427 | ||
428 | Before discussing menus, we need to make some remarks that are only | |
429 | relevant to users reading Info using Emacs. Users of the stand-alone | |
430 | version can skip this node by typing @kbd{]} now. | |
431 | ||
432 | @cindex invisible text in Emacs | |
433 | In Emacs, certain text that appears in the stand-alone version is | |
434 | normally hidden, technically because it has the @samp{invisibility} | |
435 | property. Invisible text is really a part of the text. It becomes | |
436 | visible (by default) after killing and yanking, it appears in printed | |
437 | output, it gets saved to file just like any other text, and so on. | |
438 | Thus it is useful to know it is there. | |
439 | ||
a57743b9 | 440 | @findex visible-mode |
bac598bb | 441 | You can make invisible text visible by using the command @kbd{M-x |
51983fce LT |
442 | visible-mode}. Visible mode is a minor mode, so using the command a |
443 | second time will make the text invisible again. Watch the effects of | |
444 | the command on the ``menu'' below and the top line of this node. | |
bac598bb LT |
445 | |
446 | If you prefer to @emph{always} see the invisible text, you can set | |
22065ab9 LT |
447 | @code{Info-hide-note-references} to @code{nil}. Enabling Visible mode |
448 | permanently is not a real alternative, because Emacs Info also uses | |
449 | (although less extensively) another text property that can change the | |
450 | text being displayed, the @samp{display} property. Only the | |
451 | invisibility property is affected by Visible mode. When, in this | |
452 | tutorial, we refer to the @samp{Emacs} behavior, we mean the | |
453 | @emph{default} Emacs behavior. | |
bac598bb LT |
454 | |
455 | Now type @kbd{]}, to learn about the @kbd{]} and @kbd{[} commands. | |
456 | ||
457 | @menu | |
458 | * ]: Help-]. Node telling about ]. | |
459 | * stuff: Help-]. Same node. | |
460 | * Help-]:: Yet again, same node. | |
461 | @end menu | |
462 | ||
463 | @node Help-], , , Help-Inv | |
6b61353c | 464 | @subsection The @kbd{]} and @kbd{[} commands |
bac598bb LT |
465 | |
466 | If you type @kbd{n} now, you get an error message saying that this | |
467 | node has no next node. Similarly, if you type @kbd{p}, the error | |
468 | message tells you that there is no previous node. (The exact message | |
469 | depends on the Info reader you use.) This is because @kbd{n} and | |
470 | @kbd{p} carry you to the next and previous node @emph{at the same | |
471 | level}. The present node is contained in a menu (see next) of the | |
472 | node you came from, and hence is considered to be at a lower level. | |
473 | It is the only node in the previous node's menu (even though it was | |
474 | listed three times). Hence it has no next or previous node that | |
475 | @kbd{n} or @kbd{p} could move to. | |
476 | ||
477 | If you systematically move through a manual by typing @kbd{n}, you run | |
478 | the risk of skipping many nodes. You do not run this risk if you | |
479 | systematically use @kbd{@key{SPC}}, because, when you scroll to the | |
480 | bottom of a node and type another @kbd{@key{SPC}}, then this carries | |
481 | you to the following node in the manual @emph{regardless of level}. | |
482 | If you immediately want to go to that node, without having to scroll | |
483 | to the bottom of the screen first, you can type @kbd{]}. | |
484 | ||
485 | Similarly, @kbd{@key{BACKSPACE}} carries you to the preceding node | |
486 | regardless of level, after you scrolled to the beginning of the | |
487 | present node. If you want to go to the preceding node immediately, | |
488 | you can type @kbd{[}. | |
489 | ||
490 | For instance, typing this sequence will come back here in three steps: | |
491 | @kbd{[ n [}. To do the same backward, type @kbd{] p ]}. | |
492 | ||
493 | Now type @kbd{]} to go to the next node and learn about menus. | |
494 | ||
495 | @node Help-M, Help-Xref, Help-Inv, Getting Started | |
26901792 | 496 | @comment node-name, next, previous, up |
b457dbd9 EZ |
497 | @section Menus and the @kbd{m} command |
498 | ||
499 | @cindex menus in an Info document | |
500 | @cindex Info menus | |
bac598bb LT |
501 | With only the @kbd{n} (next), @kbd{p} (previous), @kbd{@key{SPC}}, |
502 | @kbd{@key{BACKSPACE}}, @kbd{]} and @kbd{[} commands for moving between | |
503 | nodes, nodes are restricted to a linear sequence. Menus allow a | |
504 | branching structure. A menu is a list of other nodes you can move to. | |
505 | It is actually just part of the text of the node formatted specially | |
506 | so that Info can interpret it. The beginning of a menu is always | |
507 | identified by a line which starts with @w{@samp{* Menu:}}. A node | |
508 | contains a menu if and only if it has a line in it which starts that | |
509 | way. The only menu you can use at any moment is the one in the node | |
510 | you are in. To use a menu in any other node, you must move to that | |
511 | node first. | |
26901792 DL |
512 | |
513 | After the start of the menu, each line that starts with a @samp{*} | |
bac598bb LT |
514 | identifies one subtopic. The line usually contains a brief name for |
515 | the subtopic (followed by a @samp{:}, normally hidden in Emacs), the | |
516 | name of the node that talks about that subtopic (again, normally | |
517 | hidden in Emacs), and optionally some further description of the | |
26901792 DL |
518 | subtopic. Lines in the menu that do not start with a @samp{*} have no |
519 | special meaning---they are only for the human reader's benefit and do | |
520 | not define additional subtopics. Here is an example: | |
521 | ||
522 | @example | |
9170767d | 523 | * Foo: Node about FOO. This tells about FOO. |
26901792 DL |
524 | @end example |
525 | ||
b457dbd9 EZ |
526 | The subtopic name is Foo, and the node describing it is @samp{Node |
527 | about FOO}. The rest of the line is just for the reader's | |
528 | Information. [[ But this line is not a real menu item, simply because | |
bac598bb LT |
529 | there is no line above it which starts with @w{@samp{* Menu:}}. Also, |
530 | in a real menu item, the @samp{*} would appear at the very start of | |
531 | the line. This is why the ``normally hidden'' text in Emacs, namely | |
532 | @samp{: Node about FOO.}, is actually visible in this example, even | |
22065ab9 | 533 | when Visible mode is off.]] |
26901792 DL |
534 | |
535 | When you use a menu to go to another node (in a way that will be | |
536 | described soon), what you specify is the subtopic name, the first | |
537 | thing in the menu line. Info uses it to find the menu line, extracts | |
538 | the node name from it, and goes to that node. The reason that there | |
539 | is both a subtopic name and a node name is that the node name must be | |
540 | meaningful to the computer and may therefore have to be ugly looking. | |
541 | The subtopic name can be chosen just to be convenient for the user to | |
542 | specify. Often the node name is convenient for the user to specify | |
543 | and so both it and the subtopic name are the same. There is an | |
544 | abbreviation for this: | |
545 | ||
546 | @example | |
9170767d | 547 | * Foo:: This tells about FOO. |
26901792 DL |
548 | @end example |
549 | ||
550 | @noindent | |
551 | This means that the subtopic name and node name are the same; they are | |
bac598bb | 552 | both @samp{Foo}. (The @samp{::} is normally hidden in Emacs.) |
26901792 DL |
553 | |
554 | @format | |
3c7625c9 EZ |
555 | >> Now use @key{SPC} to find the menu in this node, then come back to |
556 | the front with a @kbd{b} and some @key{SPC}s. As you see, a menu is | |
26901792 DL |
557 | actually visible in its node. If you cannot find a menu in a node |
558 | by looking at it, then the node does not have a menu and the | |
559 | @kbd{m} command is not available. | |
560 | @end format | |
561 | ||
b1d75c43 RS |
562 | If you keep typing @key{SPC} once the menu appears on the screen, it |
563 | will move to another node (the first one in the menu). If that | |
564 | happens, type @key{BACKSPACE} to come back. | |
565 | ||
b457dbd9 | 566 | @kindex m @r{(Info mode)} |
b1d75c43 RS |
567 | The command to go to one of the subnodes is @kbd{m}. This is very |
568 | different from the commands you have used: it is a command that | |
569 | prompts you for more input. | |
570 | ||
571 | The Info commands you know do not need additional input; when you | |
572 | type one of them, Info processes it instantly and then is ready for | |
573 | another command. The @kbd{m} command is different: it needs to know | |
574 | the @dfn{name of the subtopic}. Once you have typed @kbd{m}, Info | |
575 | tries to read the subtopic name. | |
26901792 | 576 | |
bac598bb LT |
577 | Now, in the stand-alone Info, look for the line containing many |
578 | dashes near the bottom of the screen. (This is the stand-alone | |
579 | equivalent for the mode line in Emacs.) There is one more line | |
580 | beneath that one, but usually it is blank. (In Emacs, this is the | |
581 | echo area.) When it is blank, Info is ready for a command, such as | |
582 | @kbd{n} or @kbd{b} or @key{SPC} or @kbd{m}. If that line contains | |
583 | text ending in a colon, it means Info is reading more input for the | |
584 | last command. You can't type an Info command then, because Info is | |
585 | trying to read input, not commands. You must either give the input | |
586 | and finish the command you started, or type @kbd{Control-g} to cancel | |
587 | the command. When you have done one of those things, the input entry | |
588 | line becomes blank again. Then you can type Info commands again. | |
26901792 | 589 | |
b457dbd9 | 590 | @findex Info-menu |
26901792 DL |
591 | The command to go to a subnode via a menu is @kbd{m}. After you type |
592 | the @kbd{m}, the line at the bottom of the screen says @samp{Menu item: }. | |
593 | You must then type the name of the subtopic you want, and end it with | |
b457dbd9 | 594 | a @key{RET}. In Emacs, @kbd{m} runs the command @code{Info-menu}. |
26901792 | 595 | |
b457dbd9 | 596 | @cindex abbreviating Info subnodes |
26901792 | 597 | You can abbreviate the subtopic name. If the abbreviation is not |
b457dbd9 EZ |
598 | unique, the first matching subtopic is chosen. Some menus put |
599 | the shortest possible abbreviation for each subtopic name in capital | |
600 | letters, so you can see how much you need to type. It does not | |
601 | matter whether you use upper case or lower case when you type the | |
602 | subtopic. You should not put any spaces at the end, or inside of the | |
603 | item name, except for one space where a space appears in the item in | |
604 | the menu. | |
605 | ||
606 | @cindex completion of Info node names | |
b1d75c43 RS |
607 | You can also use the @dfn{completion} feature to help enter the |
608 | subtopic name. If you type the @key{TAB} key after entering part of a | |
609 | name, it will fill in more of the name---as much as Info can deduce | |
610 | from the part you have entered. | |
26901792 DL |
611 | |
612 | If you move the cursor to one of the menu subtopic lines, then you do | |
b457dbd9 | 613 | not need to type the argument: you just type a @key{RET}, and it |
b1d75c43 RS |
614 | stands for the subtopic of the line you are on. You can also click |
615 | the middle mouse button directly on the subtopic line to go there. | |
26901792 | 616 | |
b457dbd9 EZ |
617 | Here is a menu to give you a chance to practice. This menu gives you |
618 | three ways of going to one place, Help-FOO: | |
26901792 DL |
619 | |
620 | @menu | |
26901792 | 621 | * Foo: Help-FOO. A node you can visit for fun. |
b1d75c43 | 622 | * Bar: Help-FOO. We have made two ways to get to the same place. |
26901792 DL |
623 | * Help-FOO:: And yet another! |
624 | @end menu | |
625 | ||
22065ab9 | 626 | (Turn Visible mode on if you are using Emacs.) |
bac598bb | 627 | |
26901792 DL |
628 | @format |
629 | >> Now type just an @kbd{m} and see what happens: | |
630 | @end format | |
631 | ||
632 | Now you are ``inside'' an @kbd{m} command. Commands cannot be used | |
633 | now; the next thing you will type must be the name of a subtopic. | |
634 | ||
b457dbd9 EZ |
635 | You can change your mind about doing the @kbd{m} by typing |
636 | @kbd{Control-g}. | |
26901792 DL |
637 | |
638 | @format | |
639 | >> Try that now; notice the bottom line clear. | |
b457dbd9 | 640 | @end format |
26901792 | 641 | |
b457dbd9 | 642 | @format |
26901792 | 643 | >> Then type another @kbd{m}. |
b457dbd9 | 644 | @end format |
26901792 | 645 | |
b457dbd9 EZ |
646 | @format |
647 | >> Now type @kbd{BAR}, the item name. Do not type @key{RET} yet. | |
26901792 DL |
648 | @end format |
649 | ||
b457dbd9 | 650 | While you are typing the item name, you can use the @key{DEL} (or |
3c7625c9 | 651 | @key{BACKSPACE}) key to cancel one character at a time if you make a |
b457dbd9 | 652 | mistake. |
26901792 DL |
653 | |
654 | @format | |
b457dbd9 EZ |
655 | >> Press @key{DEL} to cancel the @samp{R}. You could type another @kbd{R} |
656 | to replace it. But you do not have to, since @samp{BA} is a valid | |
657 | abbreviation. | |
658 | @end format | |
26901792 | 659 | |
b457dbd9 | 660 | @format |
26901792 DL |
661 | >> Now you are ready to go. Type a @key{RET}. |
662 | @end format | |
663 | ||
b457dbd9 EZ |
664 | After visiting @samp{Help-FOO}, you should return here. |
665 | ||
666 | Another way to move to the menu subtopic lines and between them is | |
667 | to type @key{TAB}. Each time you type a @key{TAB}, you move to the | |
668 | next subtopic line. To move to a previous subtopic line, type | |
3c7625c9 EZ |
669 | @kbd{M-@key{TAB}}---that is, press and hold the @key{META} key and then |
670 | press @key{TAB}. (On some keyboards, the @key{META} key might be labeled | |
671 | @samp{Alt}.) | |
b457dbd9 EZ |
672 | |
673 | Once you move cursor to a subtopic line, press @key{RET} to go to | |
674 | that subtopic's node. | |
675 | ||
676 | @cindex mouse support in Info mode | |
677 | @kindex Mouse-2 @r{(Info mode)} | |
678 | If your terminal supports a mouse, you have yet another way of going | |
679 | to a subtopic. Move your mouse pointer to the subtopic line, | |
680 | somewhere between the beginning @samp{*} and the colon @samp{:} which | |
681 | ends the subtopic's brief name. You will see the subtopic's name | |
682 | change its appearance (usually, its background color will change), and | |
683 | the shape of the mouse pointer will change if your platform supports | |
b1d75c43 RS |
684 | that. After a while, if you leave the mouse on that spot, a small |
685 | window will pop up, saying ``Mouse-2: go to that node'', or the same | |
686 | message may appear at the bottom of the screen. | |
687 | ||
688 | @kbd{Mouse-2} is the second button of your mouse counting from the | |
689 | left---the middle button on a 3-button mouse. (On a 2-button mouse, | |
690 | you may have to press both buttons together to ``press the middle | |
691 | button''.) The message tells you pressing @kbd{Mouse-2} with the | |
692 | current position of the mouse pointer (on subtopic in the menu) will | |
693 | go to that subtopic. | |
b457dbd9 EZ |
694 | |
695 | @findex Info-mouse-follow-nearest-node | |
b1d75c43 | 696 | More generally, @kbd{Mouse-2} in an Info buffer finds the nearest |
b457dbd9 EZ |
697 | link to another node and goes there. For example, near a cross |
698 | reference it acts like @kbd{f}, in a menu it acts like @kbd{m}, on the | |
699 | node's header line it acts like @kbd{n}, @kbd{p}, or @kbd{u}, etc. At | |
700 | end of the node's text @kbd{Mouse-2} moves to the next node, or up if | |
701 | there's no next node. | |
702 | ||
26901792 DL |
703 | @format |
704 | >> Type @kbd{n} to see more commands. | |
705 | @end format | |
706 | ||
26901792 | 707 | @node Help-FOO, , , Help-M |
26901792 DL |
708 | @subsection The @kbd{u} command |
709 | ||
b457dbd9 EZ |
710 | Congratulations! This is the node @samp{Help-FOO}. It has an @samp{Up} |
711 | pointer @samp{Help-M}, the node you just came from via the @kbd{m} | |
712 | command. This is the usual convention---the nodes you reach from a menu | |
713 | have @samp{Up} nodes that lead back to the menu. Menus move Down in the | |
714 | tree, and @samp{Up} moves Up. @samp{Previous}, on the other hand, is | |
715 | usually used to ``stay on the same level but go backwards''. | |
26901792 | 716 | |
b457dbd9 EZ |
717 | @kindex u @r{(Info mode)} |
718 | @findex Info-up | |
26901792 | 719 | You can go back to the node @samp{Help-M} by typing the command |
3c7625c9 | 720 | @kbd{u} for ``Up'' (the Emacs command run by @kbd{u} is |
b457dbd9 EZ |
721 | @code{Info-up}). That puts you at the @emph{front} of the node---to |
722 | get back to where you were reading you have to type some @key{SPC}s. | |
723 | (Some Info readers, such as the one built into Emacs, put you at the | |
724 | same place where you were reading in @samp{Help-M}.) | |
725 | ||
b1d75c43 RS |
726 | Another way to go Up is to click @kbd{Mouse-2} on the @samp{Up} |
727 | pointer shown in the header line (provided that you have a mouse). | |
26901792 DL |
728 | |
729 | @format | |
730 | >> Now type @kbd{u} to move back up to @samp{Help-M}. | |
731 | @end format | |
732 | ||
e4a9d9e3 RS |
733 | @node Help-Xref, Help-Int, Help-M, Getting Started |
734 | @comment node-name, next, previous, up | |
735 | @section Following Cross-References | |
736 | ||
1fdd9f43 RS |
737 | @cindex cross references in Info documents |
738 | In Info documentation, you will see many @dfn{cross references}. | |
739 | Cross references look like this: @xref{Help-Cross, Cross}. That text | |
740 | is a real, live cross reference, whose name is @samp{Cross} and which | |
bac598bb | 741 | points to the node named @samp{Help-Cross}. (The node name is hidden |
a57743b9 | 742 | in Emacs. Do @kbd{M-x visible-mode} to show or hide it.) |
e4a9d9e3 RS |
743 | |
744 | @kindex f @r{(Info mode)} | |
745 | @findex Info-follow-reference | |
1fdd9f43 RS |
746 | There are two ways to follow a cross reference. You can move the |
747 | cursor to it and press @key{RET}, just as in a menu. @key{RET} | |
748 | follows the cross reference that the cursor is on. Or you can type | |
749 | @kbd{f} and then specify the name of the cross reference (in this | |
750 | case, @samp{Cross}) as an argument. In Emacs Info, @kbd{f} runs | |
751 | @code{Info-follow-reference}, | |
752 | ||
753 | In the @kbd{f} command, you select the cross reference with its | |
754 | name, so it does not matter where the cursor was. If the cursor is on | |
755 | or near a cross reference, @kbd{f} suggests that reference name in | |
756 | parentheses as the default; typing @key{RET} will follow that | |
757 | reference. However, if you type a different reference name, @kbd{f} | |
758 | will follow the other reference which has that name. | |
e4a9d9e3 RS |
759 | |
760 | @format | |
1fdd9f43 | 761 | >> Type @kbd{f}, followed by @kbd{Cross}, and then @key{RET}. |
e4a9d9e3 RS |
762 | @end format |
763 | ||
1fdd9f43 RS |
764 | As you enter the reference name, you can use the @key{DEL} (or |
765 | @key{BACKSPACE}) key to edit your input. If you change your mind | |
766 | about following any reference, you can use @kbd{Control-g} to cancel | |
767 | the command. Completion is available in the @kbd{f} command; you can | |
768 | complete among all the cross reference names in the current node by | |
769 | typing a @key{TAB}. | |
770 | ||
771 | To get a list of all the cross references in the current node, you | |
772 | can type @kbd{?} after an @kbd{f}. The @kbd{f} continues to await a | |
773 | cross reference name even after displaying the list, so if you don't | |
e4a9d9e3 RS |
774 | actually want to follow a reference, you should type a @kbd{Control-g} |
775 | to cancel the @kbd{f}. | |
776 | ||
777 | @format | |
778 | >> Type @kbd{f?} to get a list of the cross references in this node. Then | |
779 | type a @kbd{Control-g} and see how the @samp{f} gives up. | |
780 | @end format | |
781 | ||
1fdd9f43 RS |
782 | The @key{TAB} and @kbd{M-@key{TAB}} key, which move between menu |
783 | items in a menu, also move between cross references outside of menus. | |
e4a9d9e3 | 784 | |
bac598bb LT |
785 | Sometimes a cross reference (or a node) can lead to another file (in |
786 | other words another ``manual''), or, on occasion, even a file on a | |
787 | remote machine (although Info files distributed with Emacs or the | |
788 | stand-alone Info avoid using remote links). Such a cross reference | |
d023326a KB |
789 | looks like this: @xref{Top,, Overview of Texinfo, texinfo, Texinfo: |
790 | The GNU Documentation Format}. (After following this link, type | |
791 | @kbd{l} to get back to this node.) Here the name @samp{texinfo} | |
792 | between parentheses (shown in the stand-alone version) refers to the | |
793 | file name. This file name appears in cross references and node names | |
794 | if it differs from the current file. In Emacs, the file name is | |
795 | hidden (along with other text). (Use @kbd{M-x visible-mode} to show | |
796 | or hide it.) | |
bac598bb LT |
797 | |
798 | The remainder of this node applies only to the Emacs version. If | |
a57743b9 | 799 | you use the stand-alone version, you can type @kbd{n} immediately. |
bac598bb LT |
800 | |
801 | To some users, switching manuals is a much bigger switch than | |
802 | switching sections. These users like to know that they are going to | |
803 | be switching to another manual (and which one) before actually doing | |
804 | so, especially given that, if one does not notice, Info commands like | |
805 | @kbd{t} (see the next node) can have confusing results. | |
806 | ||
807 | If you put your mouse over the cross reference and if the cross | |
808 | reference leads to a different manual, then the information appearing | |
809 | in a separate box (tool tip) or in the echo area, will mention the | |
810 | file the cross reference will carry you to (between parentheses). | |
811 | This is also true for menu subtopic names. If you have a mouse, just | |
812 | leave it over the @samp{Overview} cross reference above and watch what | |
813 | happens. | |
814 | ||
815 | If you always like to have that information available without having | |
816 | to move your mouse over the cross reference, set | |
817 | @code{Info-hide-note-references} to a value other than t (@pxref{Emacs | |
818 | Info Variables}). You might also want to do that if you have a lot of | |
819 | cross references to files on remote machines and have non-permanent or | |
820 | slow access, since otherwise you might not be able to distinguish | |
821 | between local and remote links. | |
822 | ||
823 | @format | |
824 | >> Now type @kbd{n} to learn more commands. | |
825 | @end format | |
826 | ||
e4a9d9e3 | 827 | @node Help-Int, Help-Q, Help-Xref, Getting Started |
26901792 | 828 | @comment node-name, next, previous, up |
2fc7d480 | 829 | @section Some intermediate Info commands |
26901792 | 830 | |
2fc7d480 RS |
831 | The introductory course is almost over; please continue |
832 | a little longer to learn some intermediate-level commands. | |
26901792 | 833 | |
6b61353c KH |
834 | Most Info files have an index, which is actually a large node |
835 | containing little but a menu. The menu has one menu item for each | |
836 | topic listed in the index. (As a special feature, menus for indices | |
837 | may also include the line number within the node of the index entry. | |
838 | This allows Info readers to go to the exact line of an entry, not just | |
839 | the start of the containing node.) | |
840 | ||
841 | You can get to the index from the main menu of the file with the | |
842 | @kbd{m} command; then you can use the @kbd{m} command again in the | |
843 | index node to go to the node that describes the topic you want. | |
e4a9d9e3 RS |
844 | |
845 | There is also a short-cut Info command, @kbd{i}, which does all of | |
846 | that for you. It searches the index for a given topic (a string) and | |
847 | goes to the node which is listed in the index for that topic. | |
848 | @xref{Info Search}, for a full explanation. | |
849 | ||
b457dbd9 EZ |
850 | @kindex l @r{(Info mode)} |
851 | @findex Info-last | |
852 | @cindex going back in Info mode | |
26901792 DL |
853 | If you have been moving around to different nodes and wish to |
854 | retrace your steps, the @kbd{l} command (@kbd{l} for @dfn{last}) will | |
855 | do that, one node-step at a time. As you move from node to node, Info | |
856 | records the nodes where you have been in a special history list. The | |
857 | @kbd{l} command revisits nodes in the history list; each successive | |
858 | @kbd{l} command moves one step back through the history. | |
859 | ||
b457dbd9 EZ |
860 | In Emacs, @kbd{l} runs the command @code{Info-last}. |
861 | ||
26901792 | 862 | @format |
bac598bb LT |
863 | >> Try typing @kbd{p p n} and then three @kbd{l}'s, pausing in between |
864 | to see what each @kbd{l} does. You should wind up right back here. | |
26901792 DL |
865 | @end format |
866 | ||
26901792 DL |
867 | Note the difference between @kbd{l} and @kbd{p}: @kbd{l} moves to |
868 | where @emph{you} last were, whereas @kbd{p} always moves to the node | |
b457dbd9 | 869 | which the header says is the @samp{Previous} node (from this node, the |
bac598bb | 870 | @samp{Prev} link leads to @samp{Help-Xref}). |
b457dbd9 EZ |
871 | |
872 | @kindex d @r{(Info mode)} | |
873 | @findex Info-directory | |
874 | @cindex go to Directory node | |
875 | The @kbd{d} command (@code{Info-directory} in Emacs) gets you | |
876 | instantly to the Directory node. This node, which is the first one | |
3c7625c9 EZ |
877 | you saw when you entered Info, has a menu which leads (directly or |
878 | indirectly, through other menus), to all the nodes that exist. The | |
b457dbd9 EZ |
879 | Directory node lists all the manuals and other Info documents that |
880 | are, or could be, installed on your system. | |
26901792 DL |
881 | |
882 | @format | |
b457dbd9 | 883 | >> Try doing a @kbd{d}, then do an @kbd{l} to return here (yes, |
26901792 DL |
884 | @emph{do} return). |
885 | @end format | |
886 | ||
b457dbd9 EZ |
887 | @kindex t @r{(Info mode)} |
888 | @findex Info-top-node | |
889 | @cindex go to Top node | |
890 | The @kbd{t} command moves to the @samp{Top} node of the manual. | |
891 | This is useful if you want to browse the manual's main menu, or select | |
892 | some specific top-level menu item. The Emacs command run by @kbd{t} | |
893 | is @code{Info-top-node}. | |
894 | ||
b457dbd9 EZ |
895 | Clicking @kbd{Mouse-2} on or near a cross reference also follows the |
896 | reference. You can see that the cross reference is mouse-sensitive by | |
897 | moving the mouse pointer to the reference and watching how the | |
898 | underlying text and the mouse pointer change in response. | |
899 | ||
900 | @format | |
26901792 DL |
901 | >> Now type @kbd{n} to see the last node of the course. |
902 | @end format | |
903 | ||
9170767d | 904 | @xref{Expert Info}, for more advanced Info features. |
2fc7d480 | 905 | |
26901792 DL |
906 | @c If a menu appears at the end of this node, remove it. |
907 | @c It is an accident of the menu updating command. | |
908 | ||
9170767d | 909 | @node Expert Info |
26901792 DL |
910 | @chapter Info for Experts |
911 | ||
9170767d RS |
912 | This chapter describes various Info commands for experts. (If you |
913 | are using a stand-alone Info reader, there are additional commands | |
b457dbd9 EZ |
914 | specific to it, which are documented in several chapters of @ref{Top,, |
915 | GNU Info, info-stnd, GNU Info}.) | |
916 | ||
917 | This chapter also explains how to write an Info as distinct from a | |
918 | Texinfo file. (However, in most cases, writing a Texinfo file is | |
3ae62f22 EZ |
919 | better, since you can use it to make a printed manual or produce other |
920 | formats, such as HTML and DocBook, as well as for generating Info | |
921 | files.) @xref{Top,, Overview of Texinfo, texinfo, Texinfo: The GNU | |
bac598bb | 922 | Documentation Format}. |
26901792 DL |
923 | |
924 | @menu | |
bac598bb | 925 | * Advanced:: Advanced Info commands: g, e, and 1 - 9. |
b457dbd9 | 926 | * Info Search:: How to search Info documents for specific subjects. |
26901792 DL |
927 | * Add:: Describes how to add new nodes to the hierarchy. |
928 | Also tells what nodes look like. | |
929 | * Menus:: How to add to or create menus in Info nodes. | |
930 | * Cross-refs:: How to add cross-references to Info nodes. | |
931 | * Tags:: How to make tags tables for Info files. | |
932 | * Checking:: Checking an Info File | |
933 | * Emacs Info Variables:: Variables modifying the behavior of Emacs Info. | |
934 | @end menu | |
935 | ||
9170767d | 936 | @node Advanced, Info Search, , Expert Info |
26901792 DL |
937 | @comment node-name, next, previous, up |
938 | @section Advanced Info Commands | |
939 | ||
b457dbd9 EZ |
940 | Here are some more Info commands that make it easier to move around. |
941 | ||
6b61353c | 942 | @subheading @kbd{g} goes to a node by name |
26901792 | 943 | |
b457dbd9 EZ |
944 | @kindex g @r{(Info mode)} |
945 | @findex Info-goto-node | |
946 | @cindex go to a node by name | |
947 | If you know a node's name, you can go there by typing @kbd{g}, the | |
26901792 | 948 | name, and @key{RET}. Thus, @kbd{gTop@key{RET}} would go to the node |
b457dbd9 | 949 | called @samp{Top} in this file. (This is equivalent to @kbd{t}, see |
603c85d3 | 950 | @ref{Help-Int}.) @kbd{gAdvanced@key{RET}} would come back here. |
b457dbd9 | 951 | @kbd{g} in Emacs runs the command @code{Info-goto-node}. |
26901792 | 952 | |
b457dbd9 EZ |
953 | Unlike @kbd{m}, @kbd{g} does not allow the use of abbreviations. |
954 | But it does allow completion, so you can type @key{TAB} to complete a | |
955 | partial node name. | |
26901792 | 956 | |
b457dbd9 EZ |
957 | @cindex go to another Info file |
958 | To go to a node in another file, you can include the file name in the | |
26901792 DL |
959 | node name by putting it at the front, in parentheses. Thus, |
960 | @kbd{g(dir)Top@key{RET}} would go to the Info Directory node, which is | |
b457dbd9 EZ |
961 | the node @samp{Top} in the Info file @file{dir}. Likewise, |
962 | @kbd{g(emacs)Top@key{RET}} goes to the top node of the Emacs manual. | |
26901792 | 963 | |
b457dbd9 | 964 | The node name @samp{*} specifies the whole file. So you can look at |
26901792 | 965 | all of the current file by typing @kbd{g*@key{RET}} or all of any |
b457dbd9 EZ |
966 | other file with @kbd{g(@var{filename})@key{RET}}. |
967 | ||
6b61353c | 968 | @subheading @kbd{1} -- @kbd{9} choose a menu subtopic by its number |
b457dbd9 EZ |
969 | |
970 | @kindex 1 @r{through} 9 @r{(Info mode)} | |
971 | @findex Info-nth-menu-item | |
972 | @cindex select @var{n}'th menu item | |
973 | If you begrudge each character of type-in which your system requires, | |
974 | you might like to use the commands @kbd{1}, @kbd{2}, @kbd{3}, @kbd{4}, | |
975 | @dots{}, @kbd{9}. They are short for the @kbd{m} command together | |
976 | with a name of a menu subtopic. @kbd{1} goes through the first item | |
977 | in the current node's menu; @kbd{2} goes through the second item, etc. | |
978 | In the stand-alone reader, @kbd{0} goes through the last menu item; | |
979 | this is so you need not count how many entries are there. In Emacs, | |
980 | the digit keys run the command @code{Info-nth-menu-item}. | |
981 | ||
6b61353c KH |
982 | If your display supports multiple fonts, colors or underlining, and |
983 | you are using Emacs' Info mode to read Info files, the third, sixth | |
984 | and ninth menu items have a @samp{*} that stands out, either in color | |
985 | or in some other attribute, such as underline; this makes it easy to | |
986 | see at a glance which number to use for an item. | |
b457dbd9 | 987 | |
6b61353c KH |
988 | Some terminals don't support either multiple fonts, colors or |
989 | underlining. If you need to actually count items, it is better to use | |
990 | @kbd{m} instead, and specify the name, or use @key{TAB} to quickly | |
991 | move between menu items. | |
26901792 | 992 | |
6b61353c | 993 | @subheading @kbd{e} makes Info document editable |
b457dbd9 EZ |
994 | |
995 | @kindex e @r{(Info mode)} | |
996 | @findex Info-edit | |
997 | @cindex edit Info document | |
998 | The Info command @kbd{e} changes from Info mode to an ordinary | |
26901792 DL |
999 | Emacs editing mode, so that you can edit the text of the current node. |
1000 | Type @kbd{C-c C-c} to switch back to Info. The @kbd{e} command is allowed | |
1001 | only if the variable @code{Info-enable-edit} is non-@code{nil}. | |
1002 | ||
b457dbd9 EZ |
1003 | The @kbd{e} command only works in Emacs, where it runs the command |
1004 | @code{Info-edit}. The stand-alone Info reader doesn't allow you to | |
1005 | edit the Info file, so typing @kbd{e} there goes to the end of the | |
1006 | current node. | |
1007 | ||
6b61353c KH |
1008 | @subheading @kbd{M-n} creates a new independent Info buffer in Emacs |
1009 | ||
1010 | @kindex M-n @r{(Info mode)} | |
1011 | @findex clone-buffer | |
1012 | @cindex multiple Info buffers | |
1013 | If you are reading Info in Emacs, you can select a new independent | |
1014 | Info buffer in another window by typing @kbd{M-n}. The new buffer | |
1015 | starts out as an exact copy of the old one, but you will be able to | |
1016 | move independently between nodes in the two buffers. (In Info mode, | |
1017 | @kbd{M-n} runs the Emacs command @code{clone-buffer}.) | |
1018 | ||
1019 | In Emacs Info, you can also produce new Info buffers by giving a | |
1020 | numeric prefix argument to the @kbd{m} and @kbd{g} commands. @kbd{C-u | |
1021 | m} and @kbd{C-u g} go to a new node in exactly the same way that | |
1022 | @kbd{m} and @kbd{g} do, but they do so in a new Info buffer which they | |
1023 | select in another window. | |
1024 | ||
9170767d | 1025 | @node Info Search, Add, Advanced, Expert Info |
b457dbd9 EZ |
1026 | @comment node-name, next, previous, up |
1027 | @section How to search Info documents for specific subjects | |
1028 | ||
1029 | @cindex searching Info documents | |
1030 | @cindex Info document as a reference | |
1031 | The commands which move between and inside nodes allow you to read | |
1032 | the entire manual or its large portions. But what if you need to find | |
1033 | some information in the manual as fast as you can, and you don't know | |
1034 | or don't remember in what node to look for it? This need arises when | |
1035 | you use a manual as a @dfn{reference}, or when it is impractical to | |
1036 | read the entire manual before you start using the programs it | |
1037 | describes. | |
1038 | ||
1039 | Info has powerful searching facilities that let you find things | |
1040 | quickly. You can search either the manual indices or its text. | |
1041 | ||
1042 | @kindex i @r{(Info mode)} | |
1043 | @findex Info-index | |
1044 | Since most subjects related to what the manual describes should be | |
1045 | indexed, you should try the index search first. The @kbd{i} command | |
1046 | prompts you for a subject and then looks up that subject in the | |
1047 | indices. If it finds an index entry with the subject you typed, it | |
1048 | goes to the node to which that index entry points. You should browse | |
1049 | through that node to see whether the issue you are looking for is | |
1050 | described there. If it isn't, type @kbd{,} one or more times to go | |
1051 | through additional index entries which match your subject. | |
1052 | ||
1053 | The @kbd{i} command finds all index entries which include the string | |
1054 | you typed @emph{as a substring}. For each match, Info shows in the | |
1055 | echo area the full index entry it found. Often, the text of the full | |
1056 | index entry already gives you enough information to decide whether it | |
1057 | is relevant to what you are looking for, so we recommend that you read | |
6b61353c | 1058 | what Emacs shows in the echo area before looking at the node it |
b457dbd9 EZ |
1059 | displays. |
1060 | ||
1061 | Since @kbd{i} looks for a substring, you can search for subjects even | |
1062 | if you are not sure how they are spelled in the index. For example, | |
1063 | suppose you want to find something that is pertinent to commands which | |
1064 | complete partial input (e.g., when you type @key{TAB}). If you want | |
1065 | to catch index entries that refer to ``complete'', ``completion'', and | |
1066 | ``completing'', you could type @kbd{icomplet@key{RET}}. | |
1067 | ||
1068 | Info documents which describe programs should index the commands, | |
1069 | options, and key sequences that the program provides. If you are | |
1070 | looking for a description of a command, an option, or a key, just type | |
1071 | their names when @kbd{i} prompts you for a topic. For example, if you | |
1072 | want to read the description of what the @kbd{C-f} key does, type | |
6b61353c | 1073 | @kbd{i C - f @key{RET}}. Here @kbd{C-f} are 3 literal characters |
b457dbd9 EZ |
1074 | @samp{C}, @samp{-}, and @samp{f}, not the ``Control-f'' command key |
1075 | you type inside Emacs to run the command bound to @kbd{C-f}. | |
1076 | ||
1077 | In Emacs, @kbd{i} runs the command @code{Info-index}. | |
1078 | ||
6b61353c KH |
1079 | @findex info-apropos |
1080 | If you don't know what manual documents something, try the @kbd{M-x | |
1081 | info-apropos} command. It prompts for a string and then looks up that | |
1082 | string in all the indices of all the Info documents installed on your | |
1083 | system. | |
1084 | ||
b457dbd9 EZ |
1085 | @kindex s @r{(Info mode)} |
1086 | @findex Info-search | |
1087 | The @kbd{s} command allows you to search a whole file for a string. | |
1088 | It switches to the next node if and when that is necessary. You | |
1089 | type @kbd{s} followed by the string to search for, terminated by | |
1090 | @key{RET}. To search for the same string again, just @kbd{s} followed | |
1091 | by @key{RET} will do. The file's nodes are scanned in the order | |
1092 | they are in in the file, which has no necessary relationship to the | |
1093 | order that they may be in the tree structure of menus and @samp{next} | |
1094 | pointers. But normally the two orders are not very different. In any | |
1095 | case, you can always do a @kbd{b} to find out what node you have | |
1096 | reached, if the header is not visible (this can happen, because @kbd{s} | |
1097 | puts your cursor at the occurrence of the string, not at the beginning | |
1098 | of the node). | |
1099 | ||
1100 | @kindex M-s @r{(Info mode)} | |
1101 | In Emacs, @kbd{Meta-s} is equivalent to @kbd{s}. That is for | |
1102 | compatibility with other GNU packages that use @kbd{M-s} for a similar | |
1103 | kind of search command. Both @kbd{s} and @kbd{M-s} run in Emacs the | |
1104 | command @code{Info-search}. | |
1105 | ||
1106 | ||
9170767d | 1107 | @node Add, Menus, Info Search, Expert Info |
26901792 DL |
1108 | @comment node-name, next, previous, up |
1109 | @section Adding a new node to Info | |
1110 | ||
1111 | To add a new topic to the list in the Info directory, you must: | |
b457dbd9 | 1112 | |
26901792 DL |
1113 | @enumerate |
1114 | @item | |
1115 | Create some nodes, in some file, to document that topic. | |
1116 | @item | |
1117 | Put that topic in the menu in the directory. @xref{Menus, Menu}. | |
1118 | @end enumerate | |
1119 | ||
b457dbd9 EZ |
1120 | Usually, the way to create the nodes is with Texinfo (@pxref{Top,, |
1121 | Overview of Texinfo, texinfo, Texinfo: The GNU Documentation Format}); | |
9170767d RS |
1122 | this has the advantage that you can also make a printed manual or HTML |
1123 | from them. You would use the @samp{@@dircategory} and | |
1124 | @samp{@@direntry} commands to put the manual into the Info directory. | |
1125 | However, if you want to edit an Info file manually and install it | |
1126 | manually, here is how. | |
26901792 | 1127 | |
b457dbd9 | 1128 | @cindex node delimiters |
26901792 | 1129 | The new node can live in an existing documentation file, or in a new |
79c43dcd | 1130 | one. It must have a @samp{^_} character before it (invisible to the |
26901792 | 1131 | user; this node has one but you cannot see it), and it ends with either |
79c43dcd EZ |
1132 | a @samp{^_}, a @samp{^L} (``formfeed''), or the end of file.@footnote{If |
1133 | you put in a @samp{^L} to end a new node, be sure that there is a | |
1134 | @samp{^_} after it to start the next one, since @samp{^L} cannot | |
1135 | @emph{start} a node. Also, a nicer way to make a node boundary be a | |
1136 | page boundary as well is to put a @samp{^L} @emph{right after} the | |
1137 | @samp{^_}.} | |
1138 | ||
1139 | The @samp{^_} starting a node must be followed by a newline or a | |
9170767d RS |
1140 | @samp{^L} newline, after which comes the node's header line. The |
1141 | header line must give the node's name (by which Info finds it), and | |
1142 | state the names of the @samp{Next}, @samp{Previous}, and @samp{Up} | |
1143 | nodes (if there are any). As you can see, this node's @samp{Up} node | |
1144 | is the node @samp{Expert Info}. The @samp{Next} node is @samp{Menus}. | |
b457dbd9 EZ |
1145 | |
1146 | @cindex node header line format | |
1147 | @cindex format of node headers | |
1148 | The keywords @dfn{Node}, @dfn{Next}, @dfn{Previous}, and @dfn{Up} | |
26901792 DL |
1149 | may appear in any order, anywhere in the header line, but the |
1150 | recommended order is the one in this sentence. Each keyword must be | |
1151 | followed by a colon, spaces and tabs, and then the appropriate name. | |
1152 | The name may be terminated with a tab, a comma, or a newline. A space | |
1153 | does not end it; node names may contain spaces. The case of letters | |
1154 | in the names is insignificant. | |
1155 | ||
b457dbd9 EZ |
1156 | @cindex node name format |
1157 | @cindex Directory node | |
26901792 DL |
1158 | A node name has two forms. A node in the current file is named by |
1159 | what appears after the @samp{Node: } in that node's first line. For | |
1160 | example, this node's name is @samp{Add}. A node in another file is | |
1161 | named by @samp{(@var{filename})@var{node-within-file}}, as in | |
1162 | @samp{(info)Add} for this node. If the file name starts with ``./'', | |
b457dbd9 EZ |
1163 | then it is relative to the current directory; otherwise, it is |
1164 | relative starting from the standard directory for Info files of your | |
1165 | site. The name @samp{(@var{filename})Top} can be abbreviated to just | |
1166 | @samp{(@var{filename})}. By convention, the name @samp{Top} is used | |
1167 | for the ``highest'' node in any single file---the node whose @samp{Up} | |
1168 | points out of the file. The @samp{Directory} node is @file{(dir)}, it | |
1169 | points to a file @file{dir} which holds a large menu listing all the | |
1170 | Info documents installed on your site. The @samp{Top} node of a | |
1171 | document file listed in the @samp{Directory} should have an @samp{Up: | |
26901792 DL |
1172 | (dir)} in it. |
1173 | ||
b457dbd9 | 1174 | @cindex unstructured documents |
26901792 DL |
1175 | The node name @kbd{*} is special: it refers to the entire file. |
1176 | Thus, @kbd{g*} shows you the whole current file. The use of the | |
1177 | node @kbd{*} is to make it possible to make old-fashioned, | |
1178 | unstructured files into nodes of the tree. | |
1179 | ||
1180 | The @samp{Node:} name, in which a node states its own name, must not | |
b457dbd9 EZ |
1181 | contain a file name, since when Info searches for a node, it does not |
1182 | expect a file name to be there. The @samp{Next}, @samp{Previous} and | |
1183 | @samp{Up} names may contain them. In this node, since the @samp{Up} | |
1184 | node is in the same file, it was not necessary to use one. | |
26901792 DL |
1185 | |
1186 | Note that the nodes in this file have a file name in the header | |
1187 | line. The file names are ignored by Info, but they serve as comments | |
1188 | to help identify the node for the user. | |
1189 | ||
9170767d | 1190 | @node Menus, Cross-refs, Add, Expert Info |
26901792 DL |
1191 | @comment node-name, next, previous, up |
1192 | @section How to Create Menus | |
1193 | ||
b457dbd9 | 1194 | Any node in the Info hierarchy may have a @dfn{menu}---a list of subnodes. |
26901792 DL |
1195 | The @kbd{m} command searches the current node's menu for the topic which it |
1196 | reads from the terminal. | |
1197 | ||
b457dbd9 | 1198 | @cindex menu and menu entry format |
bac598bb LT |
1199 | A menu begins with a line starting with @w{@samp{* Menu:}}. The |
1200 | rest of the line is a comment. After the starting line, every line | |
1201 | that begins with a @samp{* } lists a single topic. The name of the | |
1202 | topic--what the user must type at the @kbd{m}'s command prompt to | |
1203 | select this topic---comes right after the star and space, and is | |
1204 | followed by a colon, spaces and tabs, and the name of the node which | |
1205 | discusses that topic. The node name, like node names following | |
1206 | @samp{Next}, @samp{Previous} and @samp{Up}, may be terminated with a | |
1207 | tab, comma, or newline; it may also be terminated with a period. | |
26901792 DL |
1208 | |
1209 | If the node name and topic name are the same, then rather than | |
b457dbd9 EZ |
1210 | giving the name twice, the abbreviation @samp{* @var{name}::} may be |
1211 | used (and should be used, whenever possible, as it reduces the visual | |
26901792 DL |
1212 | clutter in the menu). |
1213 | ||
1214 | It is considerate to choose the topic names so that they differ | |
1215 | from each other very near the beginning---this allows the user to type | |
1216 | short abbreviations. In a long menu, it is a good idea to capitalize | |
1217 | the beginning of each item name which is the minimum acceptable | |
1218 | abbreviation for it (a long menu is more than 5 or so entries). | |
1219 | ||
b457dbd9 EZ |
1220 | The nodes listed in a node's menu are called its ``subnodes'', and it |
1221 | is their ``superior''. They should each have an @samp{Up:} pointing at | |
1222 | the superior. It is often useful to arrange all or most of the subnodes | |
1223 | in a sequence of @samp{Next} and @samp{Previous} pointers so that | |
1224 | someone who wants to see them all need not keep revisiting the Menu. | |
26901792 DL |
1225 | |
1226 | The Info Directory is simply the menu of the node @samp{(dir)Top}---that | |
1227 | is, node @samp{Top} in file @file{.../info/dir}. You can put new entries | |
1228 | in that menu just like any other menu. The Info Directory is @emph{not} the | |
1229 | same as the file directory called @file{info}. It happens that many of | |
b457dbd9 EZ |
1230 | Info's files live in that file directory, but they do not have to; and |
1231 | files in that directory are not automatically listed in the Info | |
26901792 DL |
1232 | Directory node. |
1233 | ||
1234 | Also, although the Info node graph is claimed to be a ``hierarchy'', | |
1235 | in fact it can be @emph{any} directed graph. Shared structures and | |
1236 | pointer cycles are perfectly possible, and can be used if they are | |
1237 | appropriate to the meaning to be expressed. There is no need for all | |
1238 | the nodes in a file to form a connected structure. In fact, this file | |
1239 | has two connected components. You are in one of them, which is under | |
1240 | the node @samp{Top}; the other contains the node @samp{Help} which the | |
1241 | @kbd{h} command goes to. In fact, since there is no garbage | |
1242 | collector, nothing terrible happens if a substructure is not pointed | |
1243 | to, but such a substructure is rather useless since nobody can | |
1244 | ever find out that it exists. | |
1245 | ||
9170767d | 1246 | @node Cross-refs, Tags, Menus, Expert Info |
26901792 DL |
1247 | @comment node-name, next, previous, up |
1248 | @section Creating Cross References | |
1249 | ||
b457dbd9 | 1250 | @cindex cross reference format |
26901792 DL |
1251 | A cross reference can be placed anywhere in the text, unlike a menu |
1252 | item which must go at the front of a line. A cross reference looks | |
b457dbd9 | 1253 | like a menu item except that it has @samp{*note} instead of @samp{*}. |
26901792 DL |
1254 | It @emph{cannot} be terminated by a @samp{)}, because @samp{)}'s are |
1255 | so often part of node names. If you wish to enclose a cross reference | |
1256 | in parentheses, terminate it with a period first. Here are two | |
1257 | examples of cross references pointers: | |
1258 | ||
1259 | @example | |
1260 | *Note details: commands. (See *note 3: Full Proof.) | |
1261 | @end example | |
1262 | ||
b457dbd9 EZ |
1263 | @noindent |
1264 | @emph{These are just examples.} The places they ``lead to'' do not | |
1265 | really exist! | |
26901792 | 1266 | |
768e4b74 KB |
1267 | @menu |
1268 | * Help-Cross:: Target of a cross-reference. | |
1269 | @end menu | |
1270 | ||
1271 | ||
1272 | @node Help-Cross, , , Cross-refs | |
1273 | @subsection The node reached by the cross reference in Info | |
1274 | ||
1275 | This is the node reached by the cross reference named @samp{Cross}. | |
1276 | ||
1277 | While this node is specifically intended to be reached by a cross | |
1278 | reference, most cross references lead to nodes that ``belong'' | |
1279 | someplace else far away in the structure of an Info document. So you | |
1280 | cannot expect this node to have a @samp{Next}, @samp{Previous} or | |
1281 | @samp{Up} links pointing back to where you came from. In general, the | |
1282 | @kbd{l} (el) command is the only way to get back there. | |
1283 | ||
1284 | @format | |
1285 | >> Type @kbd{l} to return to the node where the cross reference was. | |
1286 | @end format | |
1287 | ||
2fc7d480 | 1288 | @node Help-Q, , Help-Int, Getting Started |
768e4b74 KB |
1289 | @comment node-name, next, previous, up |
1290 | @section Quitting Info | |
1291 | ||
1292 | @kindex q @r{(Info mode)} | |
1293 | @findex Info-exit | |
1294 | @cindex quitting Info mode | |
1295 | To get out of Info, back to what you were doing before, type @kbd{q} | |
1296 | for @dfn{Quit}. This runs @code{Info-exit} in Emacs. | |
1297 | ||
1298 | This is the end of the basic course on using Info. You have learned | |
1299 | how to move in an Info document, and how to follow menus and cross | |
1300 | references. This makes you ready for reading manuals top to bottom, | |
1301 | as new users should do when they learn a new package. | |
1302 | ||
1303 | Another set of Info commands is useful when you need to find | |
1304 | something quickly in a manual---that is, when you need to use a manual | |
9170767d | 1305 | as a reference rather than as a tutorial. We urge you to learn |
768e4b74 KB |
1306 | these search commands as well. If you want to do that now, follow this |
1307 | cross reference to @ref{Info Search}. | |
1308 | ||
1309 | Yet another set of commands are meant for experienced users; you can | |
1310 | find them by looking in the Directory node for documentation on Info. | |
1311 | Finding them will be a good exercise in using Info in the usual | |
1312 | manner. | |
1313 | ||
1314 | @format | |
1315 | >> Type @kbd{d} to go to the Info directory node; then type | |
1316 | @kbd{mInfo} and Return, to get to the node about Info and | |
1317 | see what other help is available. | |
1318 | @end format | |
1319 | ||
1320 | ||
9170767d | 1321 | @node Tags, Checking, Cross-refs, Expert Info |
26901792 DL |
1322 | @comment node-name, next, previous, up |
1323 | @section Tags Tables for Info Files | |
1324 | ||
b457dbd9 | 1325 | @cindex tags tables in info files |
26901792 DL |
1326 | You can speed up the access to nodes of a large Info file by giving |
1327 | it a tags table. Unlike the tags table for a program, the tags table for | |
b457dbd9 | 1328 | an Info file lives inside the file itself and is used |
26901792 DL |
1329 | automatically whenever Info reads in the file. |
1330 | ||
b457dbd9 | 1331 | @findex Info-tagify |
26901792 DL |
1332 | To make a tags table, go to a node in the file using Emacs Info mode and type |
1333 | @kbd{M-x Info-tagify}. Then you must use @kbd{C-x C-s} to save the | |
b457dbd9 EZ |
1334 | file. Info files produced by the @code{makeinfo} command that is part |
1335 | of the Texinfo package always have tags tables to begin with. | |
26901792 | 1336 | |
b457dbd9 EZ |
1337 | @cindex stale tags tables |
1338 | @cindex update Info tags table | |
26901792 | 1339 | Once the Info file has a tags table, you must make certain it is up |
b457dbd9 EZ |
1340 | to date. If you edit an Info file directly (as opposed to editing its |
1341 | Texinfo source), and, as a result of deletion of text, any node moves back | |
26901792 DL |
1342 | more than a thousand characters in the file from the position |
1343 | recorded in the tags table, Info will no longer be able to find that | |
b457dbd9 EZ |
1344 | node. To update the tags table, use the @code{Info-tagify} command |
1345 | again. | |
26901792 DL |
1346 | |
1347 | An Info file tags table appears at the end of the file and looks like | |
1348 | this: | |
1349 | ||
1350 | @example | |
b457dbd9 | 1351 | ^_^L |
26901792 DL |
1352 | Tag Table: |
1353 | File: info, Node: Cross-refs^?21419 | |
1354 | File: info, Node: Tags^?22145 | |
1355 | ^_ | |
1356 | End Tag Table | |
1357 | @end example | |
1358 | ||
1359 | @noindent | |
1360 | Note that it contains one line per node, and this line contains | |
1361 | the beginning of the node's header (ending just after the node name), | |
79c43dcd | 1362 | a @samp{DEL} character, and the character position in the file of the |
26901792 DL |
1363 | beginning of the node. |
1364 | ||
b457dbd9 | 1365 | |
9170767d | 1366 | @node Checking, Emacs Info Variables, Tags, Expert Info |
26901792 DL |
1367 | @section Checking an Info File |
1368 | ||
b457dbd9 EZ |
1369 | When creating an Info file, it is easy to forget the name of a node when |
1370 | you are making a pointer to it from another node. If you put in the | |
1371 | wrong name for a node, this is not detected until someone tries to go | |
1372 | through the pointer using Info. Verification of the Info file is an | |
1373 | automatic process which checks all pointers to nodes and reports any | |
1374 | pointers which are invalid. Every @samp{Next}, @samp{Previous}, and | |
26901792 | 1375 | @samp{Up} is checked, as is every menu item and every cross reference. In |
b457dbd9 EZ |
1376 | addition, any @samp{Next} which does not have a @samp{Previous} pointing |
1377 | back is reported. Only pointers within the file are checked, because | |
1378 | checking pointers to other files would be terribly slow. But those are | |
1379 | usually few. | |
26901792 | 1380 | |
b457dbd9 EZ |
1381 | @findex Info-validate |
1382 | To check an Info file, do @kbd{M-x Info-validate} while looking at any | |
1383 | node of the file with Emacs Info mode. | |
26901792 | 1384 | |
9170767d | 1385 | @node Emacs Info Variables, , Checking, Expert Info |
26901792 DL |
1386 | @section Emacs Info-mode Variables |
1387 | ||
b457dbd9 | 1388 | The following variables may modify the behavior of Info-mode in Emacs; |
26901792 DL |
1389 | you may wish to set one or several of these variables interactively, or |
1390 | in your @file{~/.emacs} init file. @xref{Examining, Examining and Setting | |
1391 | Variables, Examining and Setting Variables, emacs, The GNU Emacs | |
b457dbd9 EZ |
1392 | Manual}. The stand-alone Info reader program has its own set of |
1393 | variables, described in @ref{Variables,, Manipulating Variables, | |
1394 | info-stnd, GNU Info}. | |
26901792 | 1395 | |
b457dbd9 | 1396 | @vtable @code |
26901792 DL |
1397 | @item Info-directory-list |
1398 | The list of directories to search for Info files. Each element is a | |
79148ea7 GM |
1399 | string (directory name) or @code{nil} (try default directory). If not |
1400 | initialized Info uses the environment variable @env{INFOPATH} to | |
1401 | initialize it, or @code{Info-default-directory-list} if there is no | |
1402 | @env{INFOPATH} variable in the environment. | |
1403 | ||
56ce34cc RS |
1404 | If you wish to customize the Info directory search list for both Emacs |
1405 | info and stand-alone Info, it is best to set the @env{INFOPATH} | |
1406 | environment variable, since that applies to both programs. | |
1407 | ||
79148ea7 GM |
1408 | @item Info-additional-directory-list |
1409 | A list of additional directories to search for Info documentation files. | |
1410 | These directories are not searched for merging the @file{dir} file. | |
26901792 | 1411 | |
b457dbd9 EZ |
1412 | @item Info-fontify |
1413 | When set to a non-@code{nil} value, enables highlighting of Info | |
1414 | files. The default is @code{t}. You can change how the highlighting | |
1649f3e5 KB |
1415 | looks by customizing the faces @code{info-node}, @code{info-xref}, |
1416 | @code{info-header-xref}, @code{info-header-node}, @code{info-menu-5}, | |
1417 | @code{info-menu-header}, and @code{info-title-@var{n}-face} (where | |
1418 | @var{n} is the level of the section, a number between 1 and 4). To | |
b457dbd9 EZ |
1419 | customize a face, type @kbd{M-x customize-face @key{RET} @var{face} |
1420 | @key{RET}}, where @var{face} is one of the face names listed here. | |
1421 | ||
1422 | @item Info-use-header-line | |
1423 | If non-@code{nil}, Emacs puts in the Info buffer a header line showing | |
1424 | the @samp{Next}, @samp{Prev}, and @samp{Up} links. A header line does | |
1425 | not scroll with the rest of the buffer, making these links always | |
1426 | visible. | |
1427 | ||
bac598bb LT |
1428 | @item Info-hide-note-references |
1429 | As explained in earlier nodes, the Emacs version of Info normally | |
1430 | hides some text in menus and cross-references. You can completely | |
1431 | disable this feature, by setting this option to @code{nil}. Setting | |
1432 | it to a value that is neither @code{nil} nor @code{t} produces an | |
1433 | intermediate behavior, hiding a limited amount of text, but showing | |
1434 | all text that could potentially be useful. | |
1435 | ||
b457dbd9 | 1436 | @item Info-scroll-prefer-subnodes |
3c7625c9 EZ |
1437 | If set to a non-@code{nil} value, @key{SPC} and @key{BACKSPACE} (or |
1438 | @key{DEL}) keys in a menu visit subnodes of the current node before | |
1439 | scrolling to its end or beginning, respectively. For example, if the | |
1440 | node's menu appears on the screen, the next @key{SPC} moves to a | |
1441 | subnode indicated by the following menu item. Setting this option to | |
1442 | @code{nil} results in behavior similar to the stand-alone Info reader | |
1443 | program, which visits the first subnode from the menu only when you | |
bac598bb | 1444 | hit the end of the current node. The default is @code{nil}. |
79148ea7 | 1445 | |
b457dbd9 EZ |
1446 | @item Info-enable-active-nodes |
1447 | When set to a non-@code{nil} value, allows Info to execute Lisp code | |
1448 | associated with nodes. The Lisp code is executed when the node is | |
1449 | selected. The Lisp code to be executed should follow the node | |
79c43dcd | 1450 | delimiter (the @samp{DEL} character) and an @samp{execute: } tag, like |
3c7625c9 | 1451 | this: |
26901792 | 1452 | |
b457dbd9 EZ |
1453 | @example |
1454 | ^_execute: (message "This is an active node!") | |
1455 | @end example | |
1456 | ||
1457 | @item Info-enable-edit | |
1458 | Set to @code{nil}, disables the @samp{e} (@code{Info-edit}) command. A | |
1459 | non-@code{nil} value enables it. @xref{Add, Edit}. | |
1460 | @end vtable | |
1461 | ||
1462 | ||
1463 | @node Creating an Info File | |
1464 | @chapter Creating an Info File from a Texinfo File | |
26901792 DL |
1465 | |
1466 | @code{makeinfo} is a utility that converts a Texinfo file into an Info | |
1467 | file; @code{texinfo-format-region} and @code{texinfo-format-buffer} are | |
1468 | GNU Emacs functions that do the same. | |
1469 | ||
b457dbd9 EZ |
1470 | @xref{Top,, Overview of Texinfo, texinfo, Texinfo: The GNU |
1471 | Documentation Format}, to learn how to write a Texinfo file. | |
1472 | ||
1473 | @xref{Creating an Info File,,, texinfo, Texinfo: The GNU Documentation | |
1474 | Format}, to learn how to create an Info file from a Texinfo file. | |
1475 | ||
1476 | @xref{Installing an Info File,,, texinfo, Texinfo: The GNU | |
1477 | Documentation Format}, to learn how to install an Info file after you | |
1478 | have created one. | |
1479 | ||
1480 | @node Index | |
1481 | @unnumbered Index | |
1482 | ||
1483 | This is an alphabetical listing of all the commands, variables, and | |
1484 | topics discussed in this document. | |
26901792 | 1485 | |
b457dbd9 | 1486 | @printindex cp |
26901792 | 1487 | |
26901792 | 1488 | @bye |
6b61353c KH |
1489 | |
1490 | @ignore | |
1491 | arch-tag: 965c1638-01d6-4156-9227-b10418b9d8e8 | |
1492 | @end ignore |