Commit | Line | Data |
---|---|---|
4009494e GM |
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. | |
5 | @comment %**start of header | |
6 | @setfilename info.info | |
7 | @settitle Info | |
8 | @syncodeindex fn cp | |
9 | @syncodeindex vr cp | |
10 | @syncodeindex ky cp | |
c6ab4664 | 11 | @documentencoding UTF-8 |
4009494e GM |
12 | @comment %**end of header |
13 | ||
14 | @copying | |
15 | This file describes how to use Info, the on-line, menu-driven GNU | |
16 | documentation system. | |
17 | ||
6bc383b1 | 18 | Copyright @copyright{} 1989, 1992, 1996--2014 Free Software Foundation, Inc. |
4009494e GM |
19 | |
20 | @quotation | |
21 | Permission is granted to copy, distribute and/or modify this document | |
6a2c4aec | 22 | under the terms of the GNU Free Documentation License, Version 1.3 or |
4009494e | 23 | any later version published by the Free Software Foundation; with no |
551a89e1 | 24 | Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,'' |
0b1af106 GM |
25 | and with the Back-Cover Texts as in (a) below. A copy of the license |
26 | is included in the section entitled ``GNU Free Documentation License''. | |
4009494e | 27 | |
6f093307 | 28 | (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and |
6bf430d1 | 29 | modify this GNU manual.'' |
4009494e GM |
30 | @end quotation |
31 | @end copying | |
32 | ||
33 | @dircategory Texinfo documentation system | |
34 | @direntry | |
62e034c2 | 35 | * Info: (info). How to use the documentation browsing system. |
4009494e GM |
36 | @end direntry |
37 | ||
38 | @titlepage | |
39 | @title Info | |
40 | @subtitle The online, hyper-text GNU documentation system | |
41 | @author Brian Fox | |
42 | @author and the GNU Texinfo community | |
43 | @page | |
44 | @vskip 0pt plus 1filll | |
45 | @insertcopying | |
46 | @end titlepage | |
47 | ||
48 | @contents | |
49 | ||
50 | @ifnottex | |
51 | @node Top | |
52 | @top Info: An Introduction | |
53 | ||
54 | The GNU Project distributes most of its on-line manuals in the | |
55 | @dfn{Info format}, which you read using an @dfn{Info reader}. You are | |
56 | probably using an Info reader to read this now. | |
57 | ||
58 | There are two primary Info readers: @code{info}, a stand-alone program | |
149a3837 | 59 | designed just to read Info files (@pxref{Top,,What is Info?, |
0549d8fc | 60 | info-stnd, GNU Info}), and the @code{info} package in GNU Emacs, a |
149a3837 KB |
61 | general-purpose editor. At present, only the Emacs reader supports |
62 | using a mouse. | |
4009494e GM |
63 | |
64 | @ifinfo | |
65 | If you are new to the Info reader and want to learn how to use it, | |
66 | type the command @kbd{h} now. It brings you to a programmed | |
67 | instruction sequence. | |
68 | ||
69 | To read about advanced Info commands, type @kbd{n} twice. This | |
70 | brings you to @cite{Advanced Info Commands}, skipping over the `Getting | |
71 | Started' chapter. | |
6deb314e KB |
72 | |
73 | Type @kbd{H} to see a summary of all available commands. | |
4009494e GM |
74 | @end ifinfo |
75 | @end ifnottex | |
76 | ||
1df7defd | 77 | @insertcopying |
5dc584b5 | 78 | |
4009494e GM |
79 | @menu |
80 | * Getting Started:: Getting started using an Info reader. | |
81 | * Advanced:: Advanced Info commands. | |
4486e5eb | 82 | * Further Reading:: Where to learn more about Info files. |
0b1af106 | 83 | * GNU Free Documentation License:: The license for this documentation. |
4009494e GM |
84 | * Index:: An index of topics, commands, and variables. |
85 | @end menu | |
86 | ||
4a6311cd | 87 | @node Getting Started |
4009494e GM |
88 | @chapter Getting Started |
89 | ||
90 | This first part of this Info manual describes how to get around inside | |
91 | of Info. The second part of the manual describes various advanced | |
4486e5eb GM |
92 | Info commands. The third part contains references to other sources, |
93 | which explain how to generate Info files from Texinfo files. | |
4009494e GM |
94 | |
95 | @ifnotinfo | |
96 | This manual is primarily designed for browsing with an Info reader | |
97 | program on a computer, so that you can try Info commands while reading | |
98 | about them. Reading it on paper or with an HTML browser is less | |
99 | effective, since you must take it on faith that the commands described | |
100 | really do what the manual says. By all means go through this manual | |
101 | now that you have it; but please try going through the on-line version | |
102 | as well. | |
103 | ||
104 | @cindex Info reader, how to invoke | |
105 | @cindex entering Info | |
106 | There are two ways of looking at the online version of this manual: | |
107 | ||
108 | @enumerate | |
109 | @item | |
110 | Type @code{info} at your shell's command line. This approach uses a | |
111 | stand-alone program designed just to read Info files. | |
112 | ||
113 | @item | |
114 | Type @code{emacs} at the command line; then type @kbd{C-h i} | |
115 | (@kbd{Control-h}, followed by @kbd{i}). This approach uses the Info | |
116 | mode of the Emacs editor. | |
117 | @end enumerate | |
118 | ||
119 | In either case, then type @kbd{mInfo} (just the letters), followed by | |
120 | @key{RET}---the ``Return'' or ``Enter'' key. At this point, you should | |
121 | be ready to follow the instructions in this manual as you read them on | |
122 | the screen. | |
123 | @c FIXME! (pesch@cygnus.com, 14 dec 1992) | |
124 | @c Is it worth worrying about what-if the beginner goes to somebody | |
125 | @c else's Emacs session, which already has an Info running in the middle | |
126 | @c of something---in which case these simple instructions won't work? | |
127 | @end ifnotinfo | |
128 | ||
129 | @menu | |
130 | * Help-Small-Screen:: Starting Info on a Small Screen. | |
131 | * Help:: How to use Info. | |
132 | * Help-P:: Returning to the Previous node. | |
133 | * Help-^L:: The Space, DEL, B and ^L commands. | |
134 | * Help-Inv:: Invisible text in Emacs Info. | |
135 | * Help-M:: Menus. | |
136 | * Help-Xref:: Following cross-references. | |
137 | * Help-Int:: Some intermediate Info commands. | |
138 | * Help-Q:: Quitting Info. | |
139 | @end menu | |
140 | ||
141 | @node Help-Small-Screen | |
142 | @section Starting Info on a Small Screen | |
143 | ||
144 | @ifnotinfo | |
145 | (In Info, you only see this section if your terminal has a small | |
146 | number of lines; most readers pass by it without seeing it.) | |
147 | @end ifnotinfo | |
148 | ||
149 | @cindex small screen, moving around | |
150 | Since your terminal has a relatively small number of lines on its | |
151 | screen, it is necessary to give you special advice at the beginning. | |
152 | ||
153 | If the entire text you are looking at fits on the screen, the text | |
8f356841 KB |
154 | @samp{All} will be displayed near the bottom of the screen, on the |
155 | mode line (usually, the line in inverse video). If you see the text | |
156 | @samp{Top} instead, it means that there is more text below that does | |
157 | not fit. To move forward through the text and see another screenful, | |
158 | press @key{SPC}, the Space bar. To move back up, press the key | |
4009494e | 159 | labeled @samp{Backspace} or @samp{DEL} (on some keyboards, this key |
b6542afe GM |
160 | might be labeled @samp{Delete}). In a graphical Emacs, you can also use |
161 | @kbd{S-@key{SPC}} (press and hold the @key{Shift} key and then press | |
162 | @key{SPC}) to move backwards, but this does not work in the | |
163 | stand-alone Info reader (nor in Emacs, if you are using it in a | |
164 | text-mode terminal). | |
4009494e GM |
165 | |
166 | @ifinfo | |
b6542afe GM |
167 | Here are 40 lines of junk, so you can try @key{SPC} and @key{DEL} and |
168 | see what they do. At the end are instructions of what you should do | |
169 | next. | |
4009494e GM |
170 | |
171 | @format | |
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 | |
209 | This is line 57 | |
210 | This is line 58 | |
211 | This is line 59 | |
212 | @end format | |
213 | ||
214 | If you have managed to get here, go back to the beginning with | |
b6542afe GM |
215 | @key{DEL} (or @key{BACKSPACE}), and come back here again, then you |
216 | understand about the @samp{Space} and @samp{Backspace} keys. So now | |
217 | type an @kbd{n}---just one character; don't type the quotes and don't | |
218 | type the Return key afterward---to get to the normal start of the | |
219 | course. | |
4009494e GM |
220 | @end ifinfo |
221 | ||
4a6311cd | 222 | @node Help |
4009494e GM |
223 | @section How to use Info |
224 | ||
225 | You are talking to the program Info, for reading documentation. | |
226 | ||
227 | There are two ways to use Info: from within Emacs or as a | |
228 | stand-alone reader that you can invoke from a shell using the command | |
229 | @command{info}. | |
230 | ||
231 | @cindex node, in Info documents | |
232 | Right now you are looking at one @dfn{Node} of Information. | |
233 | A node contains text describing a specific topic at a specific | |
234 | level of detail. This node's topic is ``how to use Info''. The mode | |
235 | line says that this is node @samp{Help} in the file @file{info}. | |
236 | ||
237 | @cindex header of Info node | |
238 | The top line of a node is its @dfn{header}. This node's header | |
239 | (look at it now) says that the @samp{Next} node after this one is the | |
240 | node called @samp{Help-P}. An advanced Info command lets you go to | |
241 | any node whose name you know. In the stand-alone Info reader program, | |
242 | the header line shows the names of this node and the Info file as | |
243 | well. In Emacs, the header line is displayed with a special typeface, | |
244 | and remains at the top of the window all the time even if you scroll | |
245 | through the node. | |
246 | ||
247 | Besides a @samp{Next}, a node can have a @samp{Previous} link, or an | |
248 | @samp{Up} link, or both. As you can see, this node has all of these | |
249 | links. | |
250 | ||
251 | @kindex n @r{(Info mode)} | |
252 | Now it is time to move on to the @samp{Next} node, named @samp{Help-P}. | |
253 | ||
254 | @format | |
255 | >> Type @kbd{n} to move there. Type just one character; | |
256 | do not type the quotes and do not type a @key{RET} afterward. | |
257 | @end format | |
258 | ||
259 | @noindent | |
260 | @samp{>>} in the margin means it is really time to try a command. | |
261 | ||
262 | @format | |
263 | >> If you are in Emacs and have a mouse, and if you already practiced | |
1df7defd | 264 | typing @kbd{n} to get to the next node, click now with the left |
4009494e GM |
265 | mouse button on the @samp{Next} link to do the same ``the mouse way''. |
266 | @end format | |
267 | ||
4a6311cd | 268 | @node Help-P |
4009494e GM |
269 | @section Returning to the Previous node |
270 | ||
271 | @kindex p @r{(Info mode)} | |
272 | This node is called @samp{Help-P}. The @samp{Previous} node, as you see, | |
273 | is @samp{Help}, which is the one you just came from using the @kbd{n} | |
274 | command. Another @kbd{n} command now would take you to the next | |
275 | node, @samp{Help-^L}. | |
276 | ||
277 | @format | |
278 | >> But do not type @kbd{n} yet. First, try the @kbd{p} command, or | |
279 | (in Emacs) click on the @samp{Prev} link. That takes you to | |
280 | the @samp{Previous} node. Then use @kbd{n} to return here. | |
281 | @end format | |
282 | ||
283 | If you read this in Emacs, you will see an @samp{Info} item in the | |
284 | menu bar, close to its right edge. Clicking the mouse on the | |
285 | @samp{Info} menu-bar item opens a menu of commands which include | |
286 | @samp{Next} and @samp{Previous} (and also some others which you didn't yet | |
287 | learn about). | |
288 | ||
289 | This all probably seems insultingly simple so far, but @emph{please | |
290 | don't} start skimming. Things will get complicated soon enough! | |
291 | Also, please do not try a new command until you are told it is time | |
292 | to. You could make Info skip past an important warning that was | |
293 | coming up. | |
294 | ||
295 | @format | |
296 | >> Now do an @kbd{n}, or (in Emacs) click the middle mouse button on | |
297 | the @samp{Next} link, to get to the node @samp{Help-^L} and learn more. | |
298 | @end format | |
299 | ||
4a6311cd | 300 | @node Help-^L |
4009494e GM |
301 | @section The Space, DEL, B and ^L commands |
302 | ||
303 | This node's mode line tells you that you are now at node | |
304 | @samp{Help-^L}, and the header line tells you that @kbd{p} would get | |
305 | you back to @samp{Help-P}. The node's title is highlighted and may be | |
306 | underlined as well; it says what the node is about. | |
307 | ||
308 | This is a big node and it does not all fit on your display screen. | |
309 | You can tell that there is more that is not visible because you | |
310 | can see the text @samp{Top} rather than @samp{All} near the bottom of | |
311 | the screen. | |
312 | ||
313 | @kindex SPC @r{(Info mode)} | |
314 | @kindex DEL @r{(Info mode)} | |
315 | @kindex BACKSPACE @r{(Info mode)} | |
316 | @findex Info-scroll-up | |
317 | @findex Info-scroll-down | |
318 | The @key{SPC}, @key{BACKSPACE} (or @key{DEL})@footnote{The key which | |
319 | we call ``Backspace or DEL'' in this manual is labeled differently on | |
320 | different keyboards. Look for a key which is a little ways above the | |
321 | @key{ENTER} or @key{RET} key and which you normally use outside Emacs | |
1df7defd | 322 | to erase the character before the cursor, i.e., the character you |
4009494e GM |
323 | typed last. It might be labeled @samp{Backspace} or @samp{<-} or |
324 | @samp{DEL}, or sometimes @samp{Delete}.} and @kbd{b} commands exist to | |
325 | allow you to ``move around'' in a node that does not all fit on the | |
326 | screen at once. @key{SPC} moves forward, to show what was below the | |
327 | bottom of the screen. @key{DEL} or @key{BACKSPACE} moves backward, to | |
328 | show what was above the top of the screen (there is not anything above | |
329 | the top until you have typed some spaces). | |
330 | ||
331 | @format | |
332 | >> Now try typing a @key{SPC} (afterward, type a @key{BACKSPACE} to | |
333 | return here). | |
334 | @end format | |
335 | ||
336 | When you type the @key{SPC}, the two lines that were at the bottom of | |
337 | the screen appear at the top, followed by more lines. @key{DEL} or | |
338 | @key{BACKSPACE} takes the two lines from the top and moves them to the | |
339 | bottom, @emph{usually}, but if there are not a full screen's worth of | |
340 | lines above them they may not make it all the way to the bottom. | |
341 | ||
342 | If you are reading this in Emacs, note that the header line is | |
343 | always visible, never scrolling off the display. That way, you can | |
344 | always see the @samp{Next}, @samp{Prev}, and @samp{Up} links, and you | |
345 | can conveniently go to one of these links at any time by | |
346 | clicking the middle mouse button on the link. | |
347 | ||
348 | @cindex reading Info documents top to bottom | |
349 | @cindex Info documents as tutorials | |
350 | @key{SPC} and @key{DEL} not only move forward and backward through | |
351 | the current node. They also move between nodes. @key{SPC} at the end | |
352 | of a node moves to the next node; @key{DEL} (or @key{BACKSPACE}) at | |
353 | the beginning of a node moves to the previous node. In effect, these | |
354 | commands scroll through all the nodes in an Info file as a single | |
355 | logical sequence. You can read an entire manual top to bottom by just | |
356 | typing @key{SPC}, and move backward through the entire manual from | |
357 | bottom to top by typing @key{DEL} (or @key{BACKSPACE}). | |
358 | ||
359 | In this sequence, a node's subnodes appear following their parent. | |
360 | If a node has a menu, @key{SPC} takes you into the subnodes listed in | |
361 | the menu, one by one. Once you reach the end of a node, and have seen | |
362 | all of its subnodes, @key{SPC} takes you to the next node or to the | |
363 | parent's next node. | |
364 | ||
365 | @kindex PAGEUP @r{(Info mode)} | |
366 | @kindex PAGEDOWN @r{(Info mode)} | |
367 | Many keyboards nowadays have two scroll keys labeled @samp{PageUp} | |
368 | and @samp{PageDown} (or maybe @samp{Prior} and @samp{Next}). If your | |
369 | keyboard has these keys, you can use them to move forward and backward | |
370 | through the text of one node, like @key{SPC} and @key{BACKSPACE} (or | |
371 | @key{DEL}). However, @key{PAGEUP} and @key{PAGEDOWN} keys never | |
372 | scroll beyond the beginning or the end of the current node. | |
373 | ||
374 | @kindex C-l @r{(Info mode)} | |
375 | If your screen is ever garbaged, you can tell Info to display it | |
376 | again by typing @kbd{C-l} (@kbd{Control-L}---that is, hold down | |
377 | @key{CTRL} and type @kbd{L} or @kbd{l}). | |
378 | ||
379 | @format | |
380 | >> Type @kbd{C-l} now. | |
381 | @end format | |
382 | ||
383 | @kindex b @r{(Info mode)} | |
384 | To move back to the beginning of the node you are on, you can type | |
385 | the @key{BACKSPACE} key (or @key{DEL}) many times. You can also type | |
386 | @kbd{b} just once. @kbd{b} stands for ``beginning.'' | |
387 | ||
388 | @format | |
389 | >> Try that now. (We have put in enough verbiage to push this past | |
390 | the first screenful, but screens are so big nowadays that perhaps it | |
391 | isn't enough. You may need to shrink your Emacs or Info window.) | |
392 | Then come back, by typing @key{SPC} one or more times. | |
393 | @end format | |
394 | ||
395 | @kindex ? @r{(Info mode)} | |
396 | @findex Info-summary | |
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 | |
399 | @kbd{?}, which displays a brief list of commands. When you are | |
400 | finished looking at the list, make it go away by typing @key{SPC} | |
401 | repeatedly. | |
402 | ||
403 | @format | |
404 | >> Type a @key{?} now. Press @key{SPC} to see consecutive screenfuls of | |
405 | the list until finished. Then type @key{SPC} several times. If | |
406 | you are using Emacs, the help will then go away automatically. | |
8f356841 KB |
407 | If you are using the stand-alone Info reader, type @kbd{x} to |
408 | return here. | |
4009494e GM |
409 | @end format |
410 | ||
4009494e GM |
411 | From now on, you will encounter large nodes without warning, and |
412 | will be expected to know how to use @key{SPC} and @key{BACKSPACE} to | |
413 | move around in them without being told. Since not all terminals have | |
414 | the same size screen, it would be impossible to warn you anyway. | |
415 | ||
416 | @format | |
417 | >> Now type @kbd{n}, or click the middle mouse button on the @samp{Next} link, | |
418 | to visit the next node. | |
419 | @end format | |
420 | ||
4a6311cd | 421 | @node Help-Inv |
4009494e GM |
422 | @section Invisible text in Emacs Info |
423 | ||
424 | Before discussing menus, we need to make some remarks that are only | |
425 | relevant to users reading Info using Emacs. Users of the stand-alone | |
426 | version can skip this node by typing @kbd{]} now. | |
427 | ||
428 | @cindex invisible text in Emacs | |
429 | In Emacs, certain text that appears in the stand-alone version is | |
430 | normally hidden, technically because it has the @samp{invisibility} | |
431 | property. Invisible text is really a part of the text. It becomes | |
432 | visible (by default) after killing and yanking, it appears in printed | |
433 | output, it gets saved to file just like any other text, and so on. | |
434 | Thus it is useful to know it is there. | |
435 | ||
436 | @findex visible-mode | |
437 | You can make invisible text visible by using the command @kbd{M-x | |
438 | visible-mode}. Visible mode is a minor mode, so using the command a | |
439 | second time will make the text invisible again. Watch the effects of | |
440 | the command on the ``menu'' below and the top line of this node. | |
441 | ||
442 | If you prefer to @emph{always} see the invisible text, you can set | |
443 | @code{Info-hide-note-references} to @code{nil}. Enabling Visible mode | |
444 | permanently is not a real alternative, because Emacs Info also uses | |
445 | (although less extensively) another text property that can change the | |
446 | text being displayed, the @samp{display} property. Only the | |
447 | invisibility property is affected by Visible mode. When, in this | |
448 | tutorial, we refer to the @samp{Emacs} behavior, we mean the | |
449 | @emph{default} Emacs behavior. | |
450 | ||
451 | Now type @kbd{]}, to learn about the @kbd{]} and @kbd{[} commands. | |
452 | ||
453 | @menu | |
454 | * ]: Help-]. Node telling about ]. | |
455 | * stuff: Help-]. Same node. | |
456 | * Help-]:: Yet again, same node. | |
457 | @end menu | |
458 | ||
459 | @node Help-], , , Help-Inv | |
460 | @subsection The @kbd{]} and @kbd{[} commands | |
461 | ||
462 | If you type @kbd{n} now, you get an error message saying that this | |
463 | node has no next node. Similarly, if you type @kbd{p}, the error | |
464 | message tells you that there is no previous node. (The exact message | |
465 | depends on the Info reader you use.) This is because @kbd{n} and | |
466 | @kbd{p} carry you to the next and previous node @emph{at the same | |
467 | level}. The present node is contained in a menu (see next) of the | |
468 | node you came from, and hence is considered to be at a lower level. | |
469 | It is the only node in the previous node's menu (even though it was | |
470 | listed three times). Hence it has no next or previous node that | |
471 | @kbd{n} or @kbd{p} could move to. | |
472 | ||
473 | If you systematically move through a manual by typing @kbd{n}, you run | |
474 | the risk of skipping many nodes. You do not run this risk if you | |
475 | systematically use @kbd{@key{SPC}}, because, when you scroll to the | |
476 | bottom of a node and type another @kbd{@key{SPC}}, then this carries | |
477 | you to the following node in the manual @emph{regardless of level}. | |
478 | If you immediately want to go to that node, without having to scroll | |
479 | to the bottom of the screen first, you can type @kbd{]}. | |
480 | ||
b6542afe GM |
481 | Similarly, @kbd{@key{BACKSPACE}} carries you to the preceding node |
482 | regardless of level, after you scrolled to the beginning of the | |
483 | present node. If you want to go to the preceding node immediately, | |
484 | you can type @kbd{[}. | |
4009494e GM |
485 | |
486 | For instance, typing this sequence will come back here in three steps: | |
487 | @kbd{[ n [}. To do the same backward, type @kbd{] p ]}. | |
488 | ||
489 | Now type @kbd{]} to go to the next node and learn about menus. | |
490 | ||
4a6311cd | 491 | @node Help-M |
4009494e GM |
492 | @section Menus and the @kbd{m} command |
493 | ||
494 | @cindex menus in an Info document | |
495 | @cindex Info menus | |
496 | With only the @kbd{n} (next), @kbd{p} (previous), @kbd{@key{SPC}}, | |
497 | @kbd{@key{BACKSPACE}}, @kbd{]} and @kbd{[} commands for moving between | |
498 | nodes, nodes are restricted to a linear sequence. Menus allow a | |
499 | branching structure. A menu is a list of other nodes you can move to. | |
500 | It is actually just part of the text of the node formatted specially | |
501 | so that Info can interpret it. The beginning of a menu is always | |
502 | identified by a line which starts with @w{@samp{* Menu:}}. A node | |
503 | contains a menu if and only if it has a line in it which starts that | |
504 | way. The only menu you can use at any moment is the one in the node | |
505 | you are in. To use a menu in any other node, you must move to that | |
506 | node first. | |
507 | ||
508 | After the start of the menu, each line that starts with a @samp{*} | |
509 | identifies one subtopic. The line usually contains a brief name for | |
510 | the subtopic (followed by a @samp{:}, normally hidden in Emacs), the | |
511 | name of the node that talks about that subtopic (again, normally | |
512 | hidden in Emacs), and optionally some further description of the | |
513 | subtopic. Lines in the menu that do not start with a @samp{*} have no | |
514 | special meaning---they are only for the human reader's benefit and do | |
515 | not define additional subtopics. Here is an example: | |
516 | ||
517 | @example | |
518 | * Foo: Node about FOO. This tells about FOO. | |
519 | @end example | |
520 | ||
521 | The subtopic name is Foo, and the node describing it is @samp{Node | |
522 | about FOO}. The rest of the line is just for the reader's | |
523 | Information. [[ But this line is not a real menu item, simply because | |
524 | there is no line above it which starts with @w{@samp{* Menu:}}. Also, | |
525 | in a real menu item, the @samp{*} would appear at the very start of | |
526 | the line. This is why the ``normally hidden'' text in Emacs, namely | |
527 | @samp{: Node about FOO.}, is actually visible in this example, even | |
528 | when Visible mode is off.]] | |
529 | ||
530 | When you use a menu to go to another node (in a way that will be | |
531 | described soon), what you specify is the subtopic name, the first | |
532 | thing in the menu line. Info uses it to find the menu line, extracts | |
533 | the node name from it, and goes to that node. The reason that there | |
534 | is both a subtopic name and a node name is that the node name must be | |
535 | meaningful to the computer and may therefore have to be ugly looking. | |
536 | The subtopic name can be chosen just to be convenient for the user to | |
537 | specify. Often the node name is convenient for the user to specify | |
538 | and so both it and the subtopic name are the same. There is an | |
539 | abbreviation for this: | |
540 | ||
541 | @example | |
542 | * Foo:: This tells about FOO. | |
543 | @end example | |
544 | ||
545 | @noindent | |
546 | This means that the subtopic name and node name are the same; they are | |
547 | both @samp{Foo}. (The @samp{::} is normally hidden in Emacs.) | |
548 | ||
549 | @format | |
550 | >> Now use @key{SPC} to find the menu in this node, then come back to | |
551 | the front with a @kbd{b} and some @key{SPC}s. As you see, a menu is | |
552 | actually visible in its node. If you cannot find a menu in a node | |
553 | by looking at it, then the node does not have a menu and the | |
554 | @kbd{m} command is not available. | |
555 | @end format | |
556 | ||
557 | If you keep typing @key{SPC} once the menu appears on the screen, it | |
558 | will move to another node (the first one in the menu). If that | |
559 | happens, type @key{BACKSPACE} to come back. | |
560 | ||
561 | @kindex m @r{(Info mode)} | |
562 | The command to go to one of the subnodes is @kbd{m}. This is very | |
563 | different from the commands you have used: it is a command that | |
564 | prompts you for more input. | |
565 | ||
566 | The Info commands you know do not need additional input; when you | |
567 | type one of them, Info processes it instantly and then is ready for | |
568 | another command. The @kbd{m} command is different: it needs to know | |
569 | the @dfn{name of the subtopic}. Once you have typed @kbd{m}, Info | |
570 | tries to read the subtopic name. | |
571 | ||
572 | Now, in the stand-alone Info, look for the line containing many | |
573 | dashes near the bottom of the screen. (This is the stand-alone | |
574 | equivalent for the mode line in Emacs.) There is one more line | |
575 | beneath that one, but usually it is blank. (In Emacs, this is the | |
576 | echo area.) When it is blank, Info is ready for a command, such as | |
577 | @kbd{n} or @kbd{b} or @key{SPC} or @kbd{m}. If that line contains | |
578 | text ending in a colon, it means Info is reading more input for the | |
579 | last command. You can't type an Info command then, because Info is | |
580 | trying to read input, not commands. You must either give the input | |
581 | and finish the command you started, or type @kbd{Control-g} to cancel | |
582 | the command. When you have done one of those things, the input entry | |
583 | line becomes blank again. Then you can type Info commands again. | |
584 | ||
585 | @findex Info-menu | |
586 | The command to go to a subnode via a menu is @kbd{m}. After you type | |
587 | the @kbd{m}, the line at the bottom of the screen says @samp{Menu item: }. | |
588 | You must then type the name of the subtopic you want, and end it with | |
589 | a @key{RET}. | |
590 | ||
591 | @cindex abbreviating Info subnodes | |
592 | You can abbreviate the subtopic name. If the abbreviation is not | |
593 | unique, the first matching subtopic is chosen. Some menus put | |
594 | the shortest possible abbreviation for each subtopic name in capital | |
595 | letters, so you can see how much you need to type. It does not | |
596 | matter whether you use upper case or lower case when you type the | |
597 | subtopic. You should not put any spaces at the end, or inside of the | |
598 | item name, except for one space where a space appears in the item in | |
599 | the menu. | |
600 | ||
601 | @cindex completion of Info node names | |
602 | You can also use the @dfn{completion} feature to help enter the | |
603 | subtopic name. If you type the @key{TAB} key after entering part of a | |
604 | name, it will fill in more of the name---as much as Info can deduce | |
605 | from the part you have entered. | |
606 | ||
607 | If you move the cursor to one of the menu subtopic lines, then you do | |
608 | not need to type the argument: you just type a @key{RET}, and it | |
609 | stands for the subtopic of the line you are on. You can also click | |
610 | the middle mouse button directly on the subtopic line to go there. | |
611 | ||
612 | Here is a menu to give you a chance to practice. This menu gives you | |
613 | three ways of going to one place, Help-FOO: | |
614 | ||
615 | @menu | |
616 | * Foo: Help-FOO. A node you can visit for fun. | |
617 | * Bar: Help-FOO. We have made two ways to get to the same place. | |
618 | * Help-FOO:: And yet another! | |
619 | @end menu | |
620 | ||
621 | (Turn Visible mode on if you are using Emacs.) | |
622 | ||
623 | @format | |
624 | >> Now type just an @kbd{m} and see what happens: | |
625 | @end format | |
626 | ||
627 | Now you are ``inside'' an @kbd{m} command. Commands cannot be used | |
628 | now; the next thing you will type must be the name of a subtopic. | |
629 | ||
630 | You can change your mind about doing the @kbd{m} by typing | |
631 | @kbd{Control-g}. | |
632 | ||
633 | @format | |
634 | >> Try that now; notice the bottom line clear. | |
635 | @end format | |
636 | ||
637 | @format | |
638 | >> Then type another @kbd{m}. | |
639 | @end format | |
640 | ||
641 | @format | |
642 | >> Now type @kbd{BAR}, the item name. Do not type @key{RET} yet. | |
643 | @end format | |
644 | ||
645 | While you are typing the item name, you can use the @key{DEL} (or | |
646 | @key{BACKSPACE}) key to cancel one character at a time if you make a | |
647 | mistake. | |
648 | ||
649 | @format | |
650 | >> Press @key{DEL} to cancel the @samp{R}. You could type another @kbd{R} | |
651 | to replace it. But you do not have to, since @samp{BA} is a valid | |
652 | abbreviation. | |
653 | @end format | |
654 | ||
655 | @format | |
656 | >> Now you are ready to go. Type a @key{RET}. | |
657 | @end format | |
658 | ||
659 | After visiting @samp{Help-FOO}, you should return here. | |
660 | ||
661 | Another way to move to the menu subtopic lines and between them is | |
662 | to type @key{TAB}. Each time you type a @key{TAB}, you move to the | |
663 | next subtopic line. To move to a previous subtopic line in the | |
664 | stand-alone reader, type @kbd{M-@key{TAB}}---that is, press and hold | |
665 | the @key{META} key and then press @key{TAB}. (On some keyboards, the | |
666 | @key{META} key might be labeled @samp{Alt}.) In Emacs Info, type | |
667 | @kbd{S-@key{TAB}} to move to a previous subtopic line (press and hold | |
668 | the @key{Shift} key and then press @key{TAB}). | |
669 | ||
670 | Once you move cursor to a subtopic line, press @key{RET} to go to | |
671 | that subtopic's node. | |
672 | ||
673 | @cindex mouse support in Info mode | |
674 | @kindex Mouse-2 @r{(Info mode)} | |
675 | If your terminal supports a mouse, you have yet another way of going | |
676 | to a subtopic. Move your mouse pointer to the subtopic line, | |
677 | somewhere between the beginning @samp{*} and the colon @samp{:} which | |
678 | ends the subtopic's brief name. You will see the subtopic's name | |
679 | change its appearance (usually, its background color will change), and | |
680 | the shape of the mouse pointer will change if your platform supports | |
681 | that. After a while, if you leave the mouse on that spot, a small | |
682 | window will pop up, saying ``Mouse-2: go to that node,'' or the same | |
683 | message may appear at the bottom of the screen. | |
684 | ||
685 | @kbd{Mouse-2} is the second button of your mouse counting from the | |
686 | left---the middle button on a 3-button mouse. (On a 2-button mouse, | |
687 | you may have to press both buttons together to ``press the middle | |
688 | button''.) The message tells you pressing @kbd{Mouse-2} with the | |
689 | current position of the mouse pointer (on subtopic in the menu) will | |
690 | go to that subtopic. | |
691 | ||
692 | @findex Info-mouse-follow-nearest-node | |
693 | More generally, @kbd{Mouse-2} in an Info buffer finds the nearest | |
694 | link to another node and goes there. For example, near a cross | |
695 | reference it acts like @kbd{f}, in a menu it acts like @kbd{m}, on the | |
696 | node's header line it acts like @kbd{n}, @kbd{p}, or @kbd{u}, etc. At | |
697 | end of the node's text @kbd{Mouse-2} moves to the next node, or up if | |
698 | there's no next node. | |
699 | ||
700 | @format | |
701 | >> Type @kbd{n} to see more commands. | |
702 | @end format | |
703 | ||
704 | @node Help-FOO, , , Help-M | |
705 | @subsection The @kbd{u} command | |
706 | ||
707 | Congratulations! This is the node @samp{Help-FOO}. It has an @samp{Up} | |
708 | pointer @samp{Help-M}, the node you just came from via the @kbd{m} | |
709 | command. This is the usual convention---the nodes you reach from a menu | |
710 | have @samp{Up} nodes that lead back to the menu. Menus move Down in the | |
711 | tree, and @samp{Up} moves Up. @samp{Previous}, on the other hand, is | |
712 | usually used to ``stay on the same level but go backwards''. | |
713 | ||
714 | @kindex u @r{(Info mode)} | |
715 | @findex Info-up | |
716 | You can go back to the node @samp{Help-M} by typing the command | |
717 | @kbd{u} for ``Up''. This puts you at the menu subtopic line pointing | |
718 | to the subnode that the @kbd{u} command brought you from. (Some Info | |
719 | readers may put you at the @emph{front} of the node instead---to get | |
720 | back to where you were reading, you have to type some @key{SPC}s.) | |
721 | ||
722 | Another way to go Up is to click @kbd{Mouse-2} on the @samp{Up} | |
723 | pointer shown in the header line (provided that you have a mouse). | |
724 | ||
725 | @format | |
726 | >> Now type @kbd{u} to move back up to @samp{Help-M}. | |
727 | @end format | |
728 | ||
4a6311cd | 729 | @node Help-Xref |
4009494e GM |
730 | @section Following Cross-References |
731 | ||
732 | @cindex cross references in Info documents | |
733 | In Info documentation, you will see many @dfn{cross references}. | |
734 | Cross references look like this: @xref{Help-Cross, Cross}. That text | |
735 | is a real, live cross reference, whose name is @samp{Cross} and which | |
736 | points to the node named @samp{Help-Cross}. (The node name is hidden | |
737 | in Emacs. Do @kbd{M-x visible-mode} to show or hide it.) | |
738 | ||
739 | @kindex f @r{(Info mode)} | |
740 | @findex Info-follow-reference | |
741 | You can follow a cross reference by moving the cursor to it and | |
742 | press @key{RET}, just as in a menu. In Emacs, you can also click | |
743 | @kbd{Mouse-1} on a cross reference to follow it; you can see that the | |
744 | cross reference is mouse-sensitive by moving the mouse pointer to the | |
745 | reference and watching how the underlying text and the mouse pointer | |
746 | change in response. | |
747 | ||
748 | Another way to follow a cross reference is to type @kbd{f} and then | |
749 | specify the name of the cross reference (in this case, @samp{Cross}) | |
750 | as an argument. For this command, it does not matter where the cursor | |
751 | was. If the cursor is on or near a cross reference, @kbd{f} suggests | |
752 | that reference name in parentheses as the default; typing @key{RET} | |
753 | will follow that reference. However, if you type a different | |
754 | reference name, @kbd{f} will follow the other reference which has that | |
755 | name. | |
756 | ||
757 | @format | |
758 | >> Type @kbd{f}, followed by @kbd{Cross}, and then @key{RET}. | |
759 | @end format | |
760 | ||
761 | As you enter the reference name, you can use the @key{DEL} (or | |
762 | @key{BACKSPACE}) key to edit your input. If you change your mind | |
763 | about following any reference, you can use @kbd{Control-g} to cancel | |
764 | the command. Completion is available in the @kbd{f} command; you can | |
765 | complete among all the cross reference names in the current node by | |
766 | typing a @key{TAB}. | |
767 | ||
768 | To get a list of all the cross references in the current node, you | |
769 | can type @kbd{?} after an @kbd{f}. The @kbd{f} continues to await a | |
770 | cross reference name even after displaying the list, so if you don't | |
771 | actually want to follow a reference, you should type a @kbd{Control-g} | |
772 | to cancel the @kbd{f}. | |
773 | ||
774 | @format | |
775 | >> Type @kbd{f?} to get a list of the cross references in this node. Then | |
776 | type a @kbd{Control-g} and see how the @samp{f} gives up. | |
777 | @end format | |
778 | ||
779 | The @key{TAB}, @kbd{M-@key{TAB}} and @kbd{S-@key{TAB}} keys, | |
780 | which move between menu items in a menu, also move between cross | |
781 | references outside of menus. | |
782 | ||
783 | Sometimes a cross reference (or a node) can lead to another file (in | |
784 | other words another ``manual''), or, on occasion, even a file on a | |
785 | remote machine (although Info files distributed with Emacs or the | |
786 | stand-alone Info avoid using remote links). Such a cross reference | |
787 | looks like this: @xref{Top,, Overview of Texinfo, texinfo, Texinfo: | |
788 | The GNU Documentation Format}. (After following this link, type | |
789 | @kbd{l} to get back to this node.) Here the name @samp{texinfo} | |
790 | between parentheses refers to the file name. This file name appears | |
791 | in cross references and node names if it differs from the current | |
792 | file, so you can always know that you are going to be switching to | |
793 | another manual and which one. | |
794 | ||
795 | However, Emacs normally hides some other text in cross-references. | |
796 | If you put your mouse over the cross reference, then the information | |
797 | appearing in a separate box (tool tip) or in the echo area will show | |
798 | the full cross-reference including the file name and the node name of | |
799 | the cross reference. If you have a mouse, just leave it over the | |
800 | cross reference @xref{Top,, Overview of Texinfo, texinfo, Texinfo: | |
801 | The GNU Documentation Format}, and watch what happens. If you | |
802 | always like to have that information visible without having to move | |
803 | your mouse over the cross reference, use @kbd{M-x visible-mode}, or | |
804 | set @code{Info-hide-note-references} to a value other than @code{t} | |
805 | (@pxref{Emacs Info Variables}). | |
806 | ||
807 | @format | |
808 | >> Now type @kbd{n} to learn more commands. | |
809 | @end format | |
810 | ||
4486e5eb | 811 | |
c89f0e99 GM |
812 | @menu |
813 | * Help-Cross:: Target of a cross-reference. | |
814 | @end menu | |
815 | ||
816 | ||
4486e5eb GM |
817 | @node Help-Cross, , , Help-Xref |
818 | @subsection The node reached by the cross reference in Info | |
819 | ||
820 | This is the node reached by the cross reference named @samp{Cross}. | |
821 | ||
822 | While this node is specifically intended to be reached by a cross | |
823 | reference, most cross references lead to nodes that ``belong'' | |
824 | someplace else far away in the structure of an Info document. So you | |
825 | cannot expect this node to have a @samp{Next}, @samp{Previous} or | |
826 | @samp{Up} links pointing back to where you came from. In general, the | |
827 | @kbd{l} (el) command is the only way to get back there. | |
828 | ||
829 | @format | |
830 | >> Type @kbd{l} to return to the node where the cross reference was. | |
831 | @end format | |
832 | ||
833 | ||
4a6311cd | 834 | @node Help-Int |
4009494e GM |
835 | @section Some intermediate Info commands |
836 | ||
837 | The introductory course is almost over; please continue | |
838 | a little longer to learn some intermediate-level commands. | |
839 | ||
840 | Most Info files have an index, which is actually a large node | |
841 | containing little but a menu. The menu has one menu item for each | |
842 | topic listed in the index. (As a special feature, menus for indices | |
843 | may also include the line number within the node of the index entry. | |
844 | This allows Info readers to go to the exact line of an entry, not just | |
845 | the start of the containing node.) | |
846 | ||
847 | You can get to the index from the main menu of the file with the | |
848 | @kbd{m} command and the name of the index node; then you can use the | |
849 | @kbd{m} command again in the index node to go to the node that | |
850 | describes the topic you want. | |
851 | ||
852 | There is also a short-cut Info command, @kbd{i}, which does all of | |
853 | that for you. It searches the index for a given topic (a string) and | |
854 | goes to the node which is listed in the index for that topic. | |
855 | @xref{Search Index}, for a full explanation. | |
856 | ||
857 | @kindex l @r{(Info mode)} | |
858 | @findex Info-history-back | |
859 | @cindex going back in Info history | |
860 | If you have been moving around to different nodes and wish to | |
861 | retrace your steps, the @kbd{l} command (@kbd{l} for @dfn{last}) will | |
862 | do that, one node-step at a time. As you move from node to node, Info | |
863 | records the nodes where you have been in a special history list. The | |
864 | @kbd{l} command revisits nodes in the history list; each successive | |
865 | @kbd{l} command moves one step back through the history. | |
866 | ||
867 | @format | |
868 | >> Try typing @kbd{p p n} and then three @kbd{l}'s, pausing in between | |
869 | to see what each @kbd{l} does. You should wind up right back here. | |
870 | @end format | |
871 | ||
872 | Note the difference between @kbd{l} and @kbd{p}: @kbd{l} moves to | |
873 | where @emph{you} last were, whereas @kbd{p} always moves to the node | |
874 | which the header says is the @samp{Previous} node (from this node, the | |
875 | @samp{Prev} link leads to @samp{Help-Xref}). | |
876 | ||
877 | @kindex r @r{(Info mode)} | |
878 | @findex Info-history-forward | |
879 | @cindex going forward in Info history | |
880 | You can use the @kbd{r} command (@code{Info-history-forward} in Emacs) | |
881 | to revisit nodes in the history list in the forward direction, so that | |
882 | @kbd{r} will return you to the node you came from by typing @kbd{l}. | |
883 | ||
17afb4cb JL |
884 | @kindex L @r{(Info mode)} |
885 | @findex Info-history | |
886 | @cindex history list of visited nodes | |
887 | The @kbd{L} command (@code{Info-history} in Emacs) creates a virtual | |
888 | node that contains a list of all nodes you visited. You can select | |
889 | a previously visited node from this menu to revisit it. | |
890 | ||
4009494e GM |
891 | @kindex d @r{(Info mode)} |
892 | @findex Info-directory | |
893 | @cindex go to Directory node | |
894 | The @kbd{d} command (@code{Info-directory} in Emacs) gets you | |
895 | instantly to the Directory node. This node, which is the first one | |
896 | you saw when you entered Info, has a menu which leads (directly or | |
897 | indirectly, through other menus), to all the nodes that exist. The | |
898 | Directory node lists all the manuals and other Info documents that | |
899 | are, or could be, installed on your system. | |
900 | ||
901 | @format | |
902 | >> Try doing a @kbd{d}, then do an @kbd{l} to return here (yes, | |
903 | @emph{do} return). | |
904 | @end format | |
905 | ||
906 | @kindex t @r{(Info mode)} | |
907 | @findex Info-top-node | |
908 | @cindex go to Top node | |
909 | The @kbd{t} command moves to the @samp{Top} node of the manual. | |
910 | This is useful if you want to browse the manual's main menu, or select | |
911 | some specific top-level menu item. The Emacs command run by @kbd{t} | |
912 | is @code{Info-top-node}. | |
913 | ||
914 | @format | |
915 | >> Now type @kbd{n} to see the last node of the course. | |
916 | @end format | |
917 | ||
918 | @xref{Advanced}, for more advanced Info features. | |
919 | ||
920 | @c If a menu appears at the end of this node, remove it. | |
921 | @c It is an accident of the menu updating command. | |
922 | ||
4a6311cd | 923 | @node Help-Q |
4009494e GM |
924 | @section Quitting Info |
925 | ||
926 | @kindex q @r{(Info mode)} | |
927 | @findex Info-exit | |
928 | @cindex quitting Info mode | |
929 | To get out of Info, back to what you were doing before, type @kbd{q} | |
930 | for @dfn{Quit}. This runs @code{Info-exit} in Emacs. | |
931 | ||
932 | This is the end of the basic course on using Info. You have learned | |
933 | how to move in an Info document, and how to follow menus and cross | |
934 | references. This makes you ready for reading manuals top to bottom, | |
935 | as new users should do when they learn a new package. | |
936 | ||
937 | Another set of Info commands is useful when you need to find | |
938 | something quickly in a manual---that is, when you need to use a manual | |
939 | as a reference rather than as a tutorial. We urge you to learn | |
940 | these search commands as well. If you want to do that now, follow this | |
941 | cross reference to @ref{Advanced}. | |
942 | ||
943 | Yet another set of commands are meant for experienced users; you can | |
944 | find them by looking in the Directory node for documentation on Info. | |
945 | Finding them will be a good exercise in using Info in the usual | |
946 | manner. | |
947 | ||
948 | @format | |
949 | >> Type @kbd{d} to go to the Info directory node; then type | |
950 | @kbd{mInfo} and Return, to get to the node about Info and | |
951 | see what other help is available. | |
952 | @end format | |
953 | ||
954 | ||
955 | @node Advanced | |
956 | @chapter Advanced Info Commands | |
957 | ||
958 | This chapter describes various advanced Info commands. (If you | |
959 | are using a stand-alone Info reader, there are additional commands | |
960 | specific to it, which are documented in several chapters of @ref{Top,, | |
961 | GNU Info, info-stnd, GNU Info}.) | |
962 | ||
963 | @kindex C-q @r{(Info mode)} | |
964 | One advanced command useful with most of the others described here | |
965 | is @kbd{C-q}, which ``quotes'' the next character so that it is | |
966 | entered literally (@pxref{Inserting Text,,,emacs,The GNU Emacs | |
967 | Manual}). For example, pressing @kbd{?} ordinarily brings up a list | |
968 | of completion possibilities. If you want to (for example) search for | |
969 | an actual @samp{?} character, the simplest way is to insert it using | |
970 | @kbd{C-q ?}. This works the same in Emacs and stand-alone Info. | |
971 | ||
972 | @menu | |
973 | * Search Text:: How to search Info documents. | |
974 | * Search Index:: How to search the indices for specific subjects. | |
975 | * Go to node:: How to go to a node by name. | |
976 | * Choose menu subtopic:: How to choose a menu subtopic by its number. | |
977 | * Create Info buffer:: How to create a new Info buffer in Emacs. | |
978 | * Emacs Info Variables:: Variables modifying the behavior of Emacs Info. | |
979 | @end menu | |
980 | ||
981 | ||
4a6311cd | 982 | @node Search Text |
2bc43980 | 983 | @section @kbd{s} searches Info documents |
4009494e GM |
984 | |
985 | @cindex searching Info documents | |
986 | @cindex Info document as a reference | |
987 | The commands which move between and inside nodes allow you to read | |
988 | the entire manual or its large portions. But what if you need to find | |
989 | some information in the manual as fast as you can, and you don't know | |
990 | or don't remember in what node to look for it? This need arises when | |
991 | you use a manual as a @dfn{reference}, or when it is impractical to | |
992 | read the entire manual before you start using the programs it | |
993 | describes. | |
994 | ||
995 | Info has powerful searching facilities that let you find things | |
996 | quickly. You can search either the manual text or its indices. | |
997 | ||
998 | @kindex s @r{(Info mode)} | |
999 | @findex Info-search | |
1000 | The @kbd{s} command allows you to search a whole Info file for a string. | |
1001 | It switches to the next node if and when that is necessary. You | |
1002 | type @kbd{s} followed by the string to search for, terminated by | |
1003 | @key{RET}. To search for the same string again, just @kbd{s} followed | |
1004 | by @key{RET} will do. The file's nodes are scanned in the order | |
1005 | they are in the file, which has no necessary relationship to the | |
1006 | order that they may be in the tree structure of menus and @samp{next} | |
1007 | pointers. But normally the two orders are not very different. In any | |
1008 | case, you can always look at the mode line to find out what node you have | |
1009 | reached, if the header is not visible (this can happen, because @kbd{s} | |
1010 | puts your cursor at the occurrence of the string, not at the beginning | |
1011 | of the node). | |
1012 | ||
4009494e GM |
1013 | @kindex C-s @r{(Info mode)} |
1014 | @kindex C-r @r{(Info mode)} | |
1015 | @findex isearch | |
1016 | Instead of using @kbd{s} in Emacs Info and in the stand-alone Info, | |
1017 | you can use an incremental search started with @kbd{C-s} or @kbd{C-r}. | |
1018 | It can search through multiple Info nodes. @xref{Incremental Search,,, | |
1019 | emacs, The GNU Emacs Manual}. In Emacs, you can disable this behavior | |
1020 | by setting the variable @code{Info-isearch-search} to @code{nil} | |
1021 | (@pxref{Emacs Info Variables}). | |
1022 | ||
4a6311cd | 1023 | @node Search Index |
2bc43980 | 1024 | @section @kbd{i} searches the indices for specific subjects |
4009494e GM |
1025 | |
1026 | @cindex searching Info indices | |
1027 | @kindex i @r{(Info mode)} | |
1028 | @findex Info-index | |
1029 | Since most topics in the manual should be indexed, you should try | |
1030 | the index search first before the text search. The @kbd{i} command | |
1031 | prompts you for a subject and then looks up that subject in the | |
1032 | indices. If it finds an index entry with the subject you typed, it | |
1033 | goes to the node to which that index entry points. You should browse | |
1034 | through that node to see whether the issue you are looking for is | |
1035 | described there. If it isn't, type @kbd{,} one or more times to go | |
1036 | through additional index entries which match your subject. | |
1037 | ||
1038 | The @kbd{i} command and subsequent @kbd{,} commands find all index | |
1039 | entries which include the string you typed @emph{as a substring}. | |
1040 | For each match, Info shows in the echo area the full index entry it | |
1041 | found. Often, the text of the full index entry already gives you | |
1042 | enough information to decide whether it is relevant to what you are | |
1043 | looking for, so we recommend that you read what Info shows in the echo | |
1044 | area before looking at the node it displays. | |
1045 | ||
1046 | Since @kbd{i} looks for a substring, you can search for subjects even | |
1047 | if you are not sure how they are spelled in the index. For example, | |
1048 | suppose you want to find something that is pertinent to commands which | |
1049 | complete partial input (e.g., when you type @key{TAB}). If you want | |
1050 | to catch index entries that refer to ``complete,'' ``completion,'' and | |
1051 | ``completing,'' you could type @kbd{icomplet@key{RET}}. | |
1052 | ||
1053 | Info documents which describe programs should index the commands, | |
1054 | options, and key sequences that the program provides. If you are | |
1055 | looking for a description of a command, an option, or a key, just type | |
1056 | their names when @kbd{i} prompts you for a topic. For example, if you | |
1057 | want to read the description of what the @kbd{C-l} key does, type | |
1058 | @kbd{iC-l@key{RET}} literally. | |
1059 | ||
2bf1d02d GM |
1060 | @findex Info-virtual-index |
1061 | @kindex I @r{(Info mode)} | |
1062 | Emacs provides the command @code{Info-virtual-index}, bound to the | |
1063 | @kbd{I} key. This behaves like @kbd{i}, but constructs a virtual | |
1064 | info node displaying the results of an index search, making it easier | |
1065 | to select the one you want. | |
1066 | ||
4009494e GM |
1067 | @findex info-apropos |
1068 | @findex index-apropos | |
1069 | If you aren't sure which manual documents the topic you are looking | |
1070 | for, try the @kbd{M-x info-apropos} command in Emacs, or the @kbd{M-x | |
1071 | index-apropos} command in the stand-alone reader. It prompts for | |
1072 | a string and then looks up that string in all the indices of all the | |
1073 | Info documents installed on your system. | |
1074 | ||
4a6311cd | 1075 | @node Go to node |
4009494e GM |
1076 | @section @kbd{g} goes to a node by name |
1077 | ||
1078 | @kindex g @r{(Info mode)} | |
1079 | @findex Info-goto-node | |
1080 | @cindex go to a node by name | |
1081 | If you know a node's name, you can go there by typing @kbd{g}, the | |
1082 | name, and @key{RET}. Thus, @kbd{gTop@key{RET}} would go to the node | |
1083 | called @samp{Top} in this file. (This is equivalent to @kbd{t}, see | |
1084 | @ref{Help-Int}.) @kbd{gGo to node@key{RET}} would come back here. | |
1085 | ||
1086 | Unlike @kbd{m}, @kbd{g} does not allow the use of abbreviations. | |
1087 | But it does allow completion, so you can type @key{TAB} to complete a | |
1088 | partial node name. | |
1089 | ||
1090 | @cindex go to another Info file | |
1091 | To go to a node in another file, you can include the file name in the | |
1092 | node name by putting it at the front, in parentheses. Thus, | |
1093 | @kbd{g(dir)Top@key{RET}} would go to the Info Directory node, which is | |
1094 | the node @samp{Top} in the Info file @file{dir}. Likewise, | |
c6a22ce2 JL |
1095 | @kbd{g(emacs)Top@key{RET}} (or just @kbd{g(emacs)@key{RET}}) goes to the |
1096 | top node of the Emacs manual. | |
4009494e GM |
1097 | |
1098 | The node name @samp{*} specifies the whole file. So you can look at | |
1099 | all of the current file by typing @kbd{g*@key{RET}} or all of any | |
1100 | other file with @kbd{g(@var{filename})*@key{RET}}. | |
1101 | ||
4a6311cd | 1102 | @node Choose menu subtopic |
4009494e GM |
1103 | @section @kbd{1}--@kbd{9} choose a menu subtopic by its number |
1104 | ||
1105 | @kindex 1 @r{through} 9 @r{(Info mode)} | |
1106 | @findex Info-nth-menu-item | |
1107 | @cindex select @var{n}'th menu item | |
1108 | If you begrudge each character of type-in which your system requires, | |
1109 | you might like to use the commands @kbd{1}, @kbd{2}, @kbd{3}, @kbd{4}, | |
1110 | @dots{}, @kbd{9}. They are short for the @kbd{m} command together | |
1111 | with a name of a menu subtopic. @kbd{1} goes through the first item | |
1112 | in the current node's menu; @kbd{2} goes through the second item, etc. | |
1113 | In the stand-alone reader, @kbd{0} goes through the last menu item; | |
1114 | this is so you need not count how many entries are there. | |
1115 | ||
1116 | If your display supports multiple fonts, colors or underlining, and | |
44e97401 | 1117 | you are using Emacs's Info mode to read Info files, the third, sixth |
4009494e GM |
1118 | and ninth menu items have a @samp{*} that stands out, either in color |
1119 | or in some other attribute, such as underline; this makes it easy to | |
1120 | see at a glance which number to use for an item. | |
1121 | ||
1122 | Some terminals don't support either multiple fonts, colors or | |
1123 | underlining. If you need to actually count items, it is better to use | |
1124 | @kbd{m} instead, and specify the name, or use @key{TAB} to quickly | |
1125 | move between menu items. | |
1126 | ||
4a6311cd | 1127 | @node Create Info buffer |
4009494e GM |
1128 | @section @kbd{M-n} creates a new independent Info buffer in Emacs |
1129 | ||
1130 | @kindex M-n @r{(Info mode)} | |
1131 | @findex clone-buffer | |
1132 | @cindex multiple Info buffers | |
1133 | If you are reading Info in Emacs, you can select a new independent | |
1134 | Info buffer in a new Emacs window by typing @kbd{M-n}. The new buffer | |
1135 | starts out as an exact copy of the old one, but you will be able to | |
1136 | move independently between nodes in the two buffers. (In Info mode, | |
1137 | @kbd{M-n} runs the Emacs command @code{clone-buffer}.) | |
1138 | ||
1139 | In Emacs Info, you can also produce new Info buffers by giving a | |
1140 | numeric prefix argument to the @kbd{m} and @kbd{g} commands. @kbd{C-u | |
1141 | m} and @kbd{C-u g} go to a new node in exactly the same way that | |
1142 | @kbd{m} and @kbd{g} do, but they do so in a new Info buffer which they | |
1143 | select in another window. | |
1144 | ||
1145 | Another way to produce new Info buffers in Emacs is to use a numeric | |
1146 | prefix argument for the @kbd{C-h i} command (@code{info}) which | |
1147 | switches to the Info buffer with that number. Thus, @kbd{C-u 2 C-h i} | |
d29fbf47 | 1148 | switches to the buffer @file{*info*<2>}, creating it if necessary. |
4009494e | 1149 | |
2ebc3b94 GM |
1150 | @findex info-display-manual |
1151 | If you have created many Info buffers in Emacs, you might find it | |
1152 | difficult to remember which buffer is showing which manual. You can | |
1153 | use the command @kbd{M-x info-display-manual} to show an Info manual | |
90d5efda | 1154 | by name, reusing an existing buffer if there is one. |
2ebc3b94 | 1155 | |
4a6311cd | 1156 | @node Emacs Info Variables |
4009494e GM |
1157 | @section Emacs Info-mode Variables |
1158 | ||
1159 | The following variables may modify the behavior of Info-mode in Emacs; | |
1160 | you may wish to set one or several of these variables interactively, | |
1161 | or in your init file. @xref{Examining, Examining and Setting | |
1162 | Variables, Examining and Setting Variables, emacs, The GNU Emacs | |
1163 | Manual}. The stand-alone Info reader program has its own set of | |
1164 | variables, described in @ref{Variables,, Manipulating Variables, | |
1165 | info-stnd, GNU Info}. | |
1166 | ||
1167 | @vtable @code | |
1168 | @item Info-directory-list | |
1169 | The list of directories to search for Info files. Each element is a | |
1170 | string (directory name) or @code{nil} (try default directory). If not | |
1171 | initialized Info uses the environment variable @env{INFOPATH} to | |
1172 | initialize it, or @code{Info-default-directory-list} if there is no | |
1173 | @env{INFOPATH} variable in the environment. | |
1174 | ||
1175 | If you wish to customize the Info directory search list for both Emacs | |
1176 | Info and stand-alone Info, it is best to set the @env{INFOPATH} | |
1177 | environment variable, since that applies to both programs. | |
1178 | ||
1179 | @item Info-additional-directory-list | |
1180 | A list of additional directories to search for Info documentation files. | |
1181 | These directories are not searched for merging the @file{dir} file. | |
1182 | ||
1183 | @item Info-mode-hook | |
1184 | Hooks run when @code{Info-mode} is called. By default, it contains | |
1185 | the hook @code{turn-on-font-lock} which enables highlighting of Info | |
1186 | files. You can change how the highlighting looks by customizing the | |
1187 | faces @code{info-node}, @code{info-xref}, @code{info-xref-visited}, | |
1188 | @code{info-header-xref}, @code{info-header-node}, @code{info-menu-header}, | |
1189 | @code{info-menu-star}, and @code{info-title-@var{n}} (where @var{n} | |
1190 | is the level of the section, a number between 1 and 4). To customize | |
1191 | a face, type @kbd{M-x customize-face @key{RET} @var{face} @key{RET}}, | |
1192 | where @var{face} is one of the face names listed here. | |
1193 | ||
1194 | @item Info-fontify-maximum-menu-size | |
1195 | Maximum size of menu to fontify if @code{font-lock-mode} is non-@code{nil}. | |
1196 | ||
1197 | @item Info-fontify-visited-nodes | |
1198 | If non-@code{nil}, menu items and cross-references pointing to visited | |
1199 | nodes are displayed in the @code{info-xref-visited} face. | |
1200 | ||
1201 | @item Info-use-header-line | |
1202 | If non-@code{nil}, Emacs puts in the Info buffer a header line showing | |
1203 | the @samp{Next}, @samp{Prev}, and @samp{Up} links. A header line does | |
1204 | not scroll with the rest of the buffer, making these links always | |
1205 | visible. | |
1206 | ||
1207 | @item Info-hide-note-references | |
1208 | As explained in earlier nodes, the Emacs version of Info normally | |
1209 | hides some text in menus and cross-references. You can completely | |
1210 | disable this feature, by setting this option to @code{nil}. Setting | |
1211 | it to a value that is neither @code{nil} nor @code{t} produces an | |
1212 | intermediate behavior, hiding a limited amount of text, but showing | |
1213 | all text that could potentially be useful. | |
1214 | ||
1215 | @item Info-scroll-prefer-subnodes | |
1216 | If set to a non-@code{nil} value, @key{SPC} and @key{BACKSPACE} (or | |
b6542afe | 1217 | @key{DEL}, or @kbd{S-@key{SPC}}) keys in a menu visit subnodes of the |
30aafaf5 TH |
1218 | current node before scrolling to its end or beginning, respectively. |
1219 | For example, if the node's menu appears on the screen, the next | |
1220 | @key{SPC} moves to a subnode indicated by the following menu item. | |
1221 | Setting this option to @code{nil} results in behavior similar to the | |
1222 | stand-alone Info reader program, which visits the first subnode from | |
1223 | the menu only when you hit the end of the current node. The default | |
1224 | is @code{nil}. | |
4009494e GM |
1225 | |
1226 | @item Info-isearch-search | |
1227 | If non-@code{nil}, isearch in Info searches through multiple nodes. | |
1228 | ||
1229 | @item Info-enable-active-nodes | |
1230 | When set to a non-@code{nil} value, allows Info to execute Lisp code | |
1231 | associated with nodes. The Lisp code is executed when the node is | |
1232 | selected. The Lisp code to be executed should follow the node | |
1233 | delimiter (the @samp{DEL} character) and an @samp{execute: } tag, like | |
1234 | this: | |
1235 | ||
1236 | @example | |
1237 | ^_execute: (message "This is an active node!") | |
1238 | @end example | |
1239 | @end vtable | |
1240 | ||
1241 | ||
4486e5eb GM |
1242 | @node Further Reading |
1243 | @chapter Further Reading | |
589ce070 | 1244 | @cindex Texinfo |
4009494e | 1245 | |
4486e5eb GM |
1246 | Info files are created from Texinfo source files. You can use the |
1247 | same source file to make a printed manual or produce other formats, | |
1248 | such as HTML and DocBook. | |
4009494e GM |
1249 | |
1250 | The @code{makeinfo} command converts a Texinfo file into an Info file; | |
1251 | @code{texinfo-format-region} and @code{texinfo-format-buffer} are GNU | |
1252 | Emacs functions that do the same. | |
1253 | ||
1254 | @xref{Top,, Overview of Texinfo, texinfo, Texinfo: The GNU | |
1255 | Documentation Format}, for how to write a Texinfo file. | |
1256 | ||
1257 | @xref{Creating an Info File,,, texinfo, Texinfo: The GNU Documentation | |
1258 | Format}, for how to create an Info file from a Texinfo file. | |
1259 | ||
1260 | @xref{Installing an Info File,,, texinfo, Texinfo: The GNU | |
1261 | Documentation Format}, for how to install an Info file after you | |
1262 | have created one. | |
1263 | ||
0b1af106 GM |
1264 | @node GNU Free Documentation License |
1265 | @appendix GNU Free Documentation License | |
1266 | @include doclicense.texi | |
1267 | ||
4009494e GM |
1268 | @node Index |
1269 | @unnumbered Index | |
1270 | ||
1271 | This is an alphabetical listing of all the commands, variables, and | |
1272 | topics discussed in this document. | |
1273 | ||
1274 | @printindex cp | |
1275 | ||
1276 | @bye |