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