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