@syncodeindex vr cp
@syncodeindex ky cp
@comment %**end of header
-@comment $Id: info.texi,v 1.20 2001/05/03 14:02:33 karl Exp $
+@comment $Id: info.texi,v 1.23 2002/04/26 11:56:35 eliz Exp $
@dircategory Texinfo documentation system
@direntry
-* Info: (info). Documentation browsing system.
+* Info: (info). How to use the documentation browsing system.
@end direntry
@ifinfo
This file describes how to use Info, the on-line, menu-driven GNU
documentation system.
-Copyright (C) 1989, 92, 96, 97, 98, 99, 2000, 2001
+Copyright (C) 1989, 92, 96, 97, 98, 99, 2000, 2001, 2002
Free Software Foundation, Inc.
@node Top
@top Info: An Introduction
-Info is a program for reading documentation, which you are using now.
+The GNU Project distributes most of its on-line manuals in the
+@dfn{Info format}, which you read using an @dfn{Info reader}. You are
+probably using an Info reader to read this now.
@ifinfo
-If you are new to Info and want to learn how to use it, type the
-command @kbd{h} now. It brings you to a programmed instruction
-sequence.
+If you are new to the Info reader and want to learn how to use it,
+type the command @kbd{h} now. It brings you to a programmed
+instruction sequence.
-To learn advanced Info commands, type @kbd{n} twice. This brings you to
-@cite{Info for Experts}, skipping over the `Getting Started' chapter.
+To read about expert-level Info commands, type @kbd{n} twice. This
+brings you to @cite{Info for Experts}, skipping over the `Getting
+Started' chapter.
@end ifinfo
@end ifnottex
@menu
* Getting Started:: Getting started using an Info reader.
-* Advanced Info:: Advanced commands within Info.
+* Expert Info:: Info commands for experts.
* Creating an Info File:: How to make your own Info file.
* Index:: An index of topics, commands, and variables.
@end menu
-@node Getting Started, Advanced Info, Top, Top
+@node Getting Started, Expert Info, Top, Top
@comment node-name, next, previous, up
@chapter Getting Started
* Help-Small-Screen:: Starting Info on a Small Screen
* Help:: How to use Info
* Help-P:: Returning to the Previous node
-* Help-^L:: The Space, Rubout, B and ^L commands.
+* Help-^L:: The Space, DEL, B and ^L commands.
* Help-M:: Menus
-* Help-Adv:: Some advanced Info commands
+* Help-Xref:: Following cross-references
+* Help-Int:: Some intermediate Info commands
* Help-Q:: Quitting Info
@end menu
line says that this is node @samp{Help} in the file @file{info}.
@cindex header of Info node
- The top line of a node is its @dfn{header}. This node's header (look at
-it now) says that the @samp{Next} node after this one is the node
-called @samp{Help-P}. An advanced Info command lets you go to any node
-whose name you know. In the stand-alone Info reader program, the
-header line shows the names of this node and the info file as well.
-In Emacs, the header line is displayed in a special typeface, and it
-doesn't scroll off the screen when you scroll the display. The names
-of this node and of its Info file are omitted by Emacs from the header
-line.
+ The top line of a node is its @dfn{header}. This node's header
+(look at it now) says that the @samp{Next} node after this one is the
+node called @samp{Help-P}. An advanced Info command lets you go to
+any node whose name you know. In the stand-alone Info reader program,
+the header line shows the names of this node and the info file as
+well. In Emacs, the header line is duplicated in a special typeface,
+and the duplicate remains at the top of the window all the time even
+if you scroll through the node.
Besides a @samp{Next}, a node can have a @samp{Previous} or an
@samp{Up} links, or both. As you can see, this node has all of these
@format
>> If you have a mouse, and if you already practiced typing @kbd{n}
- to get to the next node, click now with the right mouse button on
+ to get to the next node, click now with the middle mouse button on
the @samp{Next} link to do the same ``the mouse way''.
@end format
This node is called @samp{Help-P}. The @samp{Previous} node, as you see,
is @samp{Help}, which is the one you just came from using the @kbd{n}
command. Another @kbd{n} command now would take you to the next
-node, @samp{Help-^L}. In Emacs, @kbd{n} runs the Emacs command
-@code{Info-next}, and @kbd{p} runs @code{Info-prev}.
+node, @samp{Help-^L}.
@format
>> But do not type @kbd{n} yet. First, try the @kbd{p} command,
- or click the mouse on the @samp{Prev} link, which takes you to the
- @samp{Previous} node. When you get there, you can do an @kbd{n}
- again to return here.
+ or click the middle mouse button on the @samp{Prev} link. That
+ takes you to the @samp{Previous} node. Then use @kbd{n} to return here.
@end format
If you read this in Emacs, you will see an @samp{Info} item in the
-menu bar, close to its right edge. Clicking your mouse on the
+menu bar, close to its right edge. Clicking the mouse on the
@samp{Info} menu-bar item opens a menu of commands which include
@samp{Next} and @samp{Prev} (and also some others which you didn't yet
learn about).
- This all probably seems insultingly simple so far, but @emph{do not} be
-led into skimming. Things will get more complicated soon. Also,
-do not try a new command until you are told it is time to. Otherwise,
-you may make Info skip past an important warning that was coming up.
+ This all probably seems insultingly simple so far, but @emph{please
+don't} start skimming. Things will get complicated soon enough!
+Also, please do not try a new command until you are told it is time
+to. You could make Info skip past an important warning that was
+coming up.
@format
->> Now do an @kbd{n}, or click the mouse on the @samp{Next} link, to
- get to the node @samp{Help-^L} and learn more.
+>> Now do an @kbd{n}, or click the middle mouse button on the @samp{Next}
+ link, to get to the node @samp{Help-^L} and learn more.
@end format
@node Help-^L, Help-M, Help-P, Getting Started
@comment node-name, next, previous, up
@section The Space, DEL, B and ^L commands.
- This node's mode line tells you that you are now at node @samp{Help-^L},
-and the header line tells you that @kbd{p} would get you back to
-@samp{Help-P}. The node's title is underlined; it says what the node
-is about (most nodes have titles).
+ This node's mode line tells you that you are now at node
+@samp{Help-^L}, and the header line tells you that @kbd{p} would get
+you back to @samp{Help-P}. The node's title is highlighted and may be
+underlined as well; it says what the node is about.
This is a big node and it does not all fit on your display screen.
You can tell that there is more that is not visible because you
screen at once. @key{SPC} moves forward, to show what was below the
bottom of the screen. @key{DEL} or @key{BACKSPACE} moves backward, to
show what was above the top of the screen (there is not anything above
-the top until you have typed some spaces). In Emacs, @key{SPC} runs
-the command @code{Info-scroll-up}, while @key{BACKSPACE} runs
-@code{Info-scroll-down}.
+the top until you have typed some spaces).
@format
>> Now try typing a @key{SPC} (afterward, type a @key{BACKSPACE} to
If you are reading this in Emacs, note that the header line is
always visible, never scrolling off the display. That way, you can
always see the @samp{Next}, @samp{Prev}, and @samp{Up} links, and you
-can conveniently go to one of these links from anywhere in the node by
-clicking the mouse on one of these links.
+can conveniently go to one of these links at any time by
+clicking the middle mouse button on the link.
@cindex reading Info documents top to bottom
@cindex Info documents as tutorials
@key{SPC} and @key{DEL} not only move forward and backward through
-the current node. When these keys hit the beginning or the end of the
-current node, they move to preceding or subsequent nodes.
-Specifically, they scroll through all the nodes in an Info file as a
-single logical sequence. In this sequence, a node's subnodes appear
-following their parent. If a node has a menu, @key{SPC} takes you
-into the subnodes listed in the menu, one by one. Once you reach the
-end of a node, and have seen all of its subnodes, @key{SPC} takes you
-to the next node or to the parent's next node. This is so you could
-read the entire manual top to bottom by just typing @key{SPC}.
+the current node. They also move between nodes. @key{SPC} at the end
+of a node moves to the next node; @key{DEL} (or @key{BACKSPACE}) at
+the beginning of a node moves to the previous node. In effect, these
+commands scroll through all the nodes in an Info file as a single
+logical sequence. You can read an entire manual top to bottom by just
+typing @key{SPC}, and move backward through the entire manual from
+bottom to top by typing @key{DEL} (or @key{BACKSPACE}).
+
+ In this sequence, a node's subnodes appear following their parent.
+If a node has a menu, @key{SPC} takes you into the subnodes listed in
+the menu, one by one. Once you reach the end of a node, and have seen
+all of its subnodes, @key{SPC} takes you to the next node or to the
+parent's next node.
@kindex PAGEUP @r{(Info mode)}
@kindex PAGEDOWN @r{(Info mode)}
Many keyboards nowadays have two scroll keys labeled @samp{PageUp}
and @samp{PageDown} (or maybe @samp{Prior} and @samp{Next}). If your
keyboard has these keys, you can use them to move forward and backward
-through the text, like with @key{SPC} and @key{BACKSPACE}. However,
-unlike @key{SPC} and @key{BACKSPACE}, @key{PAGEUP} and @key{PAGEDOWN}
-keys will never scroll beyond the beginning or the end of the current
-node.
+through the text of one node, like @key{SPC} and @key{BACKSPACE} (or
+@key{DEL}). However, @key{PAGEUP} and @key{PAGEDOWN} keys never
+scroll beyond the beginning or the end of the current node.
@kindex C-l @r{(Info mode)}
- If your screen is ever garbaged, you can tell Info to print it out
+ If your screen is ever garbaged, you can tell Info to display it
again by typing @kbd{C-l} (@kbd{Control-L}, that is---hold down
@key{CTRL} and type @kbd{L} or @kbd{l}).
@kindex b @r{(Info mode)}
To move back to the beginning of the node you are on, you can type
-a lot of @key{BACKSPACE} keys. You can also type simply @kbd{b} for
-beginning.
+the @key{BACKSPACE} key (or @key{DEL}) many times. You can also type
+@kbd{b} just once. @kbd{b} stands for ``beginning.''
@format
>> Try that now. (We have put in enough verbiage to push this past
the first screenful, but screens are so big nowadays that perhaps it
isn't enough. You may need to shrink your Emacs or Info window.)
- Then come back, with @key{SCS}s.
+ Then come back, by typing @key{SPC} one or more times.
@end format
- If your screen is very tall, all of this node might fit at once.
-In that case, @kbd{b} won't do anything. Sorry; what can we do?
+ If your screen is very tall, all of this node might fit at once. In
+that case, @kbd{b} won't do anything. But you could observe the
+effect of the @kbd{b} key if you use a smaller window.
@kindex ? @r{(Info mode)}
@findex Info-summary
You have just learned a considerable number of commands. If you
want to use one but have trouble remembering which, you should type
a @kbd{?} (in Emacs it runs the @code{Info-summary} command) which
-prints out a brief list of commands. When you are finished looking at
+displays a brief list of commands. When you are finished looking at
the list, make it go away by typing a @key{SPC} repeatedly.
@format
the same size screen, it would be impossible to warn you anyway.
@format
->> Now type @kbd{n}, or click the mouse on the @samp{Next} link, to
- see the description of the @kbd{m} command.
+>> Now type @kbd{n}, or click the middle mouse button on the @samp{Next} link,
+ to see the description of the @kbd{m} command.
@end format
-@node Help-M, Help-Adv, Help-^L, Getting Started
+@node Help-M, Help-Xref, Help-^L, Getting Started
@comment node-name, next, previous, up
@section Menus and the @kbd{m} command
not define additional subtopics. Here is an example:
@example
-* Foo: Node about FOO This tells about FOO
+* Foo: Node about FOO. This tells about FOO.
@end example
The subtopic name is Foo, and the node describing it is @samp{Node
abbreviation for this:
@example
-* Foo:: This tells about FOO
+* Foo:: This tells about FOO.
@end example
@noindent
@kbd{m} command is not available.
@end format
+If you keep typing @key{SPC} once the menu appears on the screen, it
+will move to another node (the first one in the menu). If that
+happens, type @key{BACKSPACE} to come back.
+
@kindex m @r{(Info mode)}
- The command to go to one of the subnodes is @kbd{m}---but @emph{do
-not do it yet!} Before you use @kbd{m}, you need to learn about
-commands which prompt you for more input. So far, you have learned
-several commands that do not need additional input; when you typed
-one, Info processed it and was instantly ready for another command.
-The @kbd{m} command is different: it is incomplete without the
-@dfn{name of the subtopic}. Once you have typed @kbd{m}, Info tries
-to read the subtopic name.
+ The command to go to one of the subnodes is @kbd{m}. This is very
+different from the commands you have used: it is a command that
+prompts you for more input.
+
+ The Info commands you know do not need additional input; when you
+type one of them, Info processes it instantly and then is ready for
+another command. The @kbd{m} command is different: it needs to know
+the @dfn{name of the subtopic}. Once you have typed @kbd{m}, Info
+tries to read the subtopic name.
Now look for the line containing many dashes near the bottom of the
screen. There is one more line beneath that one, but usually it is
-blank. If it is empty, Info is ready for a command, such as @kbd{n}
+blank. When it is blank, Info is ready for a command, such as @kbd{n}
or @kbd{b} or @key{SPC} or @kbd{m}. If that line contains text ending
-in a colon, it means Info is trying to read more input for the last
-command. At such times, commands do not work, because Info tries to
-use them as the input it needs. You must either type your response and
-finish the command you started, or type @kbd{Control-g} to cancel the
-command. When you have done one of those things, the line becomes
-blank again.
+in a colon, it means Info is reading more input for the last command.
+You can't type an Info command then, because Info is trying to read
+input, not commands. You must either give the input and finish the
+command you started, or type @kbd{Control-g} to cancel the command.
+When you have done one of those things, the input entry line becomes
+blank again. Then you can type Info commands again.
@findex Info-menu
The command to go to a subnode via a menu is @kbd{m}. After you type
the menu.
@cindex completion of Info node names
- You can also use the @dfn{completion} feature to help enter the subtopic
-name. If you type the @key{TAB} key after entering part of a name, it will
-magically fill in more of the name---as much as follows uniquely from
-what you have entered.
+ You can also use the @dfn{completion} feature to help enter the
+subtopic name. If you type the @key{TAB} key after entering part of a
+name, it will fill in more of the name---as much as Info can deduce
+from the part you have entered.
If you move the cursor to one of the menu subtopic lines, then you do
not need to type the argument: you just type a @key{RET}, and it
-stands for the subtopic of the line you are on.
+stands for the subtopic of the line you are on. You can also click
+the middle mouse button directly on the subtopic line to go there.
Here is a menu to give you a chance to practice. This menu gives you
three ways of going to one place, Help-FOO:
@menu
* Foo: Help-FOO. A node you can visit for fun.
-* Bar: Help-FOO. Strange! two ways to get to the same place.
+* Bar: Help-FOO. We have made two ways to get to the same place.
* Help-FOO:: And yet another!
@end menu
ends the subtopic's brief name. You will see the subtopic's name
change its appearance (usually, its background color will change), and
the shape of the mouse pointer will change if your platform supports
-that. After a while, if you leave the mouse on that spot, a tooltip
-will pop up saying ``Mouse-2: go to that node''. (If the tooltips are
-turned off or unavailable, this message is printed in the @dfn{echo
-area}, the bottom screen line where you typed the menu subtopics in
-response to the prompt.) @kbd{Mouse-2} is the second button of your
-mouse counting from the left---the rightmost button for two-button
-mice, the middle button for 3-button mice. So pressing @kbd{Mouse-2}
-while the mouse pointer is on a menu subtopic goes to that subtopic.
+that. After a while, if you leave the mouse on that spot, a small
+window will pop up, saying ``Mouse-2: go to that node'', or the same
+message may appear at the bottom of the screen.
+
+ @kbd{Mouse-2} is the second button of your mouse counting from the
+left---the middle button on a 3-button mouse. (On a 2-button mouse,
+you may have to press both buttons together to ``press the middle
+button''.) The message tells you pressing @kbd{Mouse-2} with the
+current position of the mouse pointer (on subtopic in the menu) will
+go to that subtopic.
@findex Info-mouse-follow-nearest-node
- More generally, @kbd{Mouse-2} in an Info buffer runs the Emacs
-command @code{Info-mouse-follow-nearest-node}, which finds the nearest
+ More generally, @kbd{Mouse-2} in an Info buffer finds the nearest
link to another node and goes there. For example, near a cross
reference it acts like @kbd{f}, in a menu it acts like @kbd{m}, on the
node's header line it acts like @kbd{n}, @kbd{p}, or @kbd{u}, etc. At
(Some Info readers, such as the one built into Emacs, put you at the
same place where you were reading in @samp{Help-M}.)
- Another way to go Up is to click on the @samp{Up} pointer shown in
-the header line (provided that you have a mouse).
+ Another way to go Up is to click @kbd{Mouse-2} on the @samp{Up}
+pointer shown in the header line (provided that you have a mouse).
@format
>> Now type @kbd{u} to move back up to @samp{Help-M}.
@end format
-@node Help-Adv, Help-Q, Help-M, Getting Started
+@node Help-Xref, Help-Int, Help-M, Getting Started
+@comment node-name, next, previous, up
+@section Following Cross-References
+
+@cindex cross references in Info documents
+ In Info documentation, you will see many @dfn{cross references}.
+Cross references look like this: @xref{Help-Cross, Cross}. That text
+is a real, live cross reference, whose name is @samp{Cross} and which
+points to the node named @samp{Help-Cross}.
+
+@kindex f @r{(Info mode)}
+@findex Info-follow-reference
+ There are two ways to follow a cross reference. You can move the
+cursor to it and press @key{RET}, just as in a menu. @key{RET}
+follows the cross reference that the cursor is on. Or you can type
+@kbd{f} and then specify the name of the cross reference (in this
+case, @samp{Cross}) as an argument. In Emacs Info, @kbd{f} runs
+@code{Info-follow-reference},
+
+ In the @kbd{f} command, you select the cross reference with its
+name, so it does not matter where the cursor was. If the cursor is on
+or near a cross reference, @kbd{f} suggests that reference name in
+parentheses as the default; typing @key{RET} will follow that
+reference. However, if you type a different reference name, @kbd{f}
+will follow the other reference which has that name.
+
+@format
+>> Type @kbd{f}, followed by @kbd{Cross}, and then @key{RET}.
+@end format
+
+ As you enter the reference name, you can use the @key{DEL} (or
+@key{BACKSPACE}) key to edit your input. If you change your mind
+about following any reference, you can use @kbd{Control-g} to cancel
+the command. Completion is available in the @kbd{f} command; you can
+complete among all the cross reference names in the current node by
+typing a @key{TAB}.
+
+ To get a list of all the cross references in the current node, you
+can type @kbd{?} after an @kbd{f}. The @kbd{f} continues to await a
+cross reference name even after displaying the list, so if you don't
+actually want to follow a reference, you should type a @kbd{Control-g}
+to cancel the @kbd{f}.
+
+@format
+>> Type @kbd{f?} to get a list of the cross references in this node. Then
+ type a @kbd{Control-g} and see how the @samp{f} gives up.
+@end format
+
+ The @key{TAB} and @kbd{M-@key{TAB}} key, which move between menu
+items in a menu, also move between cross references outside of menus.
+
+@node Help-Int, Help-Q, Help-Xref, Getting Started
@comment node-name, next, previous, up
-@section Some advanced Info commands
+@section Some intermediate Info commands
- The course is almost over, so please stick with it to the end.
+ The introductory course is almost over; please continue
+a little longer to learn some intermediate-level commands.
+
+ Most Info files have an index, which is actually a large node that
+contains nothing but a menu. The menu has one menu item for each
+topic listed in the index. You can find the index node from the main
+menu of the file, with the @kbd{m} command; then you can use the
+@kbd{m} command again in the index node to go to the node that
+describes the topic.
+
+ There is also a short-cut Info command, @kbd{i}, which does all of
+that for you. It searches the index for a given topic (a string) and
+goes to the node which is listed in the index for that topic.
+@xref{Info Search}, for a full explanation.
@kindex l @r{(Info mode)}
@findex Info-last
@kbd{l} command revisits nodes in the history list; each successive
@kbd{l} command moves one step back through the history.
- If you have been following directions, ad @kbd{l} command now will get
+ If you have been following directions, an @kbd{l} command now will get
you back to @samp{Help-M}. Another @kbd{l} command would undo the
@kbd{u} and get you back to @samp{Help-FOO}. Another @kbd{l} would undo
the @kbd{m} and get you back to @samp{Help-M}.
some specific top-level menu item. The Emacs command run by @kbd{t}
is @code{Info-top-node}.
- Sometimes, in Info documentation, you will see a cross reference.
-Cross references look like this: @xref{Help-Cross, Cross}. That is a
-real, live cross reference which is named @samp{Cross} and points at
-the node named @samp{Help-Cross}.
-
-@kindex f @r{(Info mode)}
-@findex Info-follow-reference
-@cindex cross references in Info documents
- If you wish to follow a cross reference, you must use the @kbd{f}
-command. The @kbd{f} must be followed by the cross reference name
-(in this case, @samp{Cross}). If the cursor is on or near the cross
-reference, Info suggests the name if the nearest reference in
-parentheses; typing @key{RET} will follow that reference. You can
-also type a different name, if the default is not what you want.
-While you enter the name, you can use the @key{DEL} (or
-@key{BACKSPACE}) key to edit your input. If you change your mind
-about following any reference, you can use @kbd{Control-g} to cancel
-the command.
-
- Completion is available in the @kbd{f} command; you can complete among
-all the cross reference names in the current node by typing a @key{TAB}.
-
- @kbd{f} runs @code{Info-follow-reference} in Emacs.
-
-@format
->> Type @kbd{f}, followed by @kbd{Cross}, and a @key{RET}.
-@end format
-
- To get a list of all the cross references in the current node, you can
-type @kbd{?} after an @kbd{f}. The @kbd{f} continues to await a
-cross reference name even after printing the list, so if you don't
-actually want to follow a reference, you should type a @kbd{Control-g}
-to cancel the @kbd{f}.
-
-@format
->> Type @kbd{f?} to get a list of the cross references in this node. Then
- type a @kbd{Control-g} and see how the @samp{f} gives up.
-@end format
-
- The @key{TAB} and @kbd{M-@key{TAB}} key, which move between
-subtopics in a menu can move between cross references as well. Once
-the cursor is on a cross reference, you can press @key{RET} to follow
-that reference, just like you do in a menu.
-
Clicking @kbd{Mouse-2} on or near a cross reference also follows the
reference. You can see that the cross reference is mouse-sensitive by
moving the mouse pointer to the reference and watching how the
>> Now type @kbd{n} to see the last node of the course.
@end format
+ @xref{Expert Info}, for more advanced Info features.
+
@c If a menu appears at the end of this node, remove it.
@c It is an accident of the menu updating command.
-@node Advanced Info
+@node Expert Info
@chapter Info for Experts
- This chapter describes various advanced Info commands. (If you are
-using a stand-alone Info reader, there are additional commands
+ This chapter describes various Info commands for experts. (If you
+are using a stand-alone Info reader, there are additional commands
specific to it, which are documented in several chapters of @ref{Top,,
GNU Info, info-stnd, GNU Info}.)
This chapter also explains how to write an Info as distinct from a
Texinfo file. (However, in most cases, writing a Texinfo file is
-better, since you can use it @emph{both} to generate an Info file and
-to make a printed manual. @xref{Top,, Overview of Texinfo, texinfo,
-Texinfo: The GNU Documentation Format}.)
+better, since you can use it to make a printed manual or produce other
+formats, such as HTML and DocBook, as well as for generating Info
+files.) @xref{Top,, Overview of Texinfo, texinfo, Texinfo: The GNU
+Documentation Format}.)
@menu
-* Expert:: Advanced Info commands: g, s, e, and 1 - 5.
+* Advanced:: Advanced Info commands: g, s, e, and 1 - 5.
* Info Search:: How to search Info documents for specific subjects.
* Add:: Describes how to add new nodes to the hierarchy.
Also tells what nodes look like.
* Emacs Info Variables:: Variables modifying the behavior of Emacs Info.
@end menu
-@node Expert, Info Search, , Advanced Info
+@node Advanced, Info Search, , Expert Info
@comment node-name, next, previous, up
@section Advanced Info Commands
If you know a node's name, you can go there by typing @kbd{g}, the
name, and @key{RET}. Thus, @kbd{gTop@key{RET}} would go to the node
called @samp{Top} in this file. (This is equivalent to @kbd{t}, see
-@ref{Help-Adv}.) @kbd{gExpert@key{RET}} would come back here.
+@ref{Help-Int}.) @kbd{gAdvanced@key{RET}} would come back here.
@kbd{g} in Emacs runs the command @code{Info-goto-node}.
Unlike @kbd{m}, @kbd{g} does not allow the use of abbreviations.
edit the Info file, so typing @kbd{e} there goes to the end of the
current node.
-@node Info Search, Add, Expert, Advanced Info
+@node Info Search, Add, Advanced, Expert Info
@comment node-name, next, previous, up
@section How to search Info documents for specific subjects
command @code{Info-search}.
-@node Add, Menus, Info Search, Advanced Info
+@node Add, Menus, Info Search, Expert Info
@comment node-name, next, previous, up
@section Adding a new node to Info
Usually, the way to create the nodes is with Texinfo (@pxref{Top,,
Overview of Texinfo, texinfo, Texinfo: The GNU Documentation Format});
-this has the advantage that you can also make a printed manual from
-them. However, if you want to edit an Info file, here is how.
+this has the advantage that you can also make a printed manual or HTML
+from them. You would use the @samp{@@dircategory} and
+@samp{@@direntry} commands to put the manual into the Info directory.
+However, if you want to edit an Info file manually and install it
+manually, here is how.
@cindex node delimiters
The new node can live in an existing documentation file, or in a new
@samp{^_}.}
The @samp{^_} starting a node must be followed by a newline or a
-@samp{^L} newline, after which comes the node's header line. The header
-line must give the node's name (by which Info finds it), and state the
-names of the @samp{Next}, @samp{Previous}, and @samp{Up} nodes (if there
-are any). As you can see, this node's @samp{Up} node is the node
-@samp{Top}, which points at all the documentation for Info. The
-@samp{Next} node is @samp{Menus}.
+@samp{^L} newline, after which comes the node's header line. The
+header line must give the node's name (by which Info finds it), and
+state the names of the @samp{Next}, @samp{Previous}, and @samp{Up}
+nodes (if there are any). As you can see, this node's @samp{Up} node
+is the node @samp{Expert Info}. The @samp{Next} node is @samp{Menus}.
@cindex node header line format
@cindex format of node headers
line. The file names are ignored by Info, but they serve as comments
to help identify the node for the user.
-@node Menus, Cross-refs, Add, Advanced Info
+@node Menus, Cross-refs, Add, Expert Info
@comment node-name, next, previous, up
@section How to Create Menus
to, but such a substructure is rather useless since nobody can
ever find out that it exists.
-@node Cross-refs, Tags, Menus, Advanced Info
+@node Cross-refs, Tags, Menus, Expert Info
@comment node-name, next, previous, up
@section Creating Cross References
>> Type @kbd{l} to return to the node where the cross reference was.
@end format
-@node Help-Q, , Help-Adv, Getting Started
+@node Help-Q, , Help-Int, Getting Started
@comment node-name, next, previous, up
@section Quitting Info
Another set of Info commands is useful when you need to find
something quickly in a manual---that is, when you need to use a manual
-as a reference rather than as a tutorial. We urge you to make learn
+as a reference rather than as a tutorial. We urge you to learn
these search commands as well. If you want to do that now, follow this
cross reference to @ref{Info Search}.
@end format
-@node Tags, Checking, Cross-refs, Advanced Info
+@node Tags, Checking, Cross-refs, Expert Info
@comment node-name, next, previous, up
@section Tags Tables for Info Files
beginning of the node.
-@node Checking, Emacs Info Variables, Tags, Advanced Info
+@node Checking, Emacs Info Variables, Tags, Expert Info
@section Checking an Info File
When creating an Info file, it is easy to forget the name of a node when
To check an Info file, do @kbd{M-x Info-validate} while looking at any
node of the file with Emacs Info mode.
-@node Emacs Info Variables, , Checking, Advanced Info
+@node Emacs Info Variables, , Checking, Expert Info
@section Emacs Info-mode Variables
The following variables may modify the behavior of Info-mode in Emacs;
initialize it, or @code{Info-default-directory-list} if there is no
@env{INFOPATH} variable in the environment.
+If you wish to customize the Info directory search list for both Emacs
+info and stand-alone Info, it is best to set the @env{INFOPATH}
+environment variable, since that applies to both programs.
+
@item Info-additional-directory-list
A list of additional directories to search for Info documentation files.
These directories are not searched for merging the @file{dir} file.
HCoop / bpt / emacs.git / blobdiff