-\input texinfo @c -*-texinfo-*-
+\input texinfo.tex @c -*-texinfo-*-
+@c We must \input texinfo.tex instead of texinfo, otherwise make
+@c distcheck in the Texinfo distribution fails, because the texinfo Info
+@c file is made first, and texi2dvi must include . first in the path.
@comment %**start of header
@setfilename info.info
@settitle Info
@syncodeindex vr cp
@syncodeindex ky cp
@comment %**end of header
-@comment $Id: info.texi,v 1.18 2002/01/23 00:00:23 rms Exp $
-@dircategory Texinfo documentation system
-@direntry
-* Info: (info). How to use the documentation browsing system.
-@end direntry
-
-@ifinfo
+@copying
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, 1992, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
Free Software Foundation, Inc.
-
+@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation; with no
Documentation License. If you want to distribute this document
separately from the collection, you can do so by adding a copy of the
license to the document, as described in section 6 of the license.
-@end ifinfo
+@end quotation
+@end copying
+
+@dircategory Texinfo documentation system
+@direntry
+* Info: (info). How to use the documentation browsing system.
+@end direntry
@titlepage
@title Info
@author and the GNU Texinfo community
@page
@vskip 0pt plus 1filll
-Copyright @copyright{} 1989, 92, 93, 96, 97, 98, 99, 2000, 2001
-Free Software Foundation, Inc.
-@sp 2
-Published by the Free Software Foundation @*
-59 Temple Place - Suite 330 @*
-Boston, MA 02111-1307, USA.
-
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1 or
-any later version published by the Free Software Foundation; with no
-Invariant Sections, with the Front-Cover texts being ``A GNU
-Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
-license is included in the section entitled ``GNU Free Documentation
-License'' in the Emacs manual.
-
-(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
-this GNU Manual, like GNU software. Copies published by the Free
-Software Foundation raise funds for GNU development.''
-
-This document is part of a collection distributed under the GNU Free
-Documentation License. If you want to distribute this document
-separately from the collection, you can do so by adding a copy of the
-license to the document, as described in section 6 of the license.
+@insertcopying
@end titlepage
+@contents
+
@ifnottex
@node Top
@top Info: An Introduction
-Info is a program, which you are using now, for reading documentation of
-computer programs. The GNU Project distributes most of its on-line
-manuals in the Info format, so you need a program called @dfn{Info
-reader} to read the manuals. One of such programs 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.
+
+There are two primary Info readers: @code{info}, a stand-alone program
+designed just to read Info files, and the @code{info} package in GNU
+Emacs, a general-purpose editor. At present, only the Emacs reader
+supports using a mouse.
@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
-This first part of the Info manual describes how to get around inside
+This first part of this Info manual describes how to get around inside
of Info. The second part of the manual describes various advanced
Info commands, and how to write an Info as distinct from a Texinfo
file. The third part briefly explains how to generate Info files from
@item
Type @code{emacs} at the command line; then type @kbd{C-h i}
(@kbd{Control-h}, followed by @kbd{i}). This approach uses the Info
-mode of the Emacs program, an editor with many other capabilities.
+mode of the Emacs editor.
@end enumerate
In either case, then type @kbd{mInfo} (just the letters), followed by
@end ifnotinfo
@menu
-* Help-Small-Screen:: Starting Info on a Small Screen
-* Help:: How to use Info
-* Help-P:: Returning to the Previous node
+* 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, DEL, B and ^L commands.
-* Help-M:: Menus
-* Help-Xref:: Following cross-references
-* Help-Int:: Some intermediate Info commands
-* Help-Q:: Quitting Info
+* Help-Inv:: Invisible text in Emacs Info.
+* Help-M:: Menus.
+* Help-Xref:: Following cross-references.
+* Help-Int:: Some intermediate Info commands.
+* Help-Q:: Quitting Info.
@end menu
@node Help-Small-Screen
If you have managed to get here, go back to the beginning with
@kbd{DEL} (or @key{BACKSPACE}), and come back here again, then you
understand the about the @samp{Space} and @samp{Backspace} keys. So
-now type an @kbd{n} ---just one character; don't type the quotes and
-don't type the Return key afterward--- to get to the normal start of
+now type an @kbd{n}---just one character; don't type the quotes and
+don't type the Return key afterward---to get to the normal start of
the course.
@end ifinfo
You are talking to the program Info, for reading documentation.
+ There are two ways to use Info: from within Emacs or as a
+stand-alone reader that you can invoke from a shell using the command
+@command{info}.
+
@cindex node, in Info documents
Right now you are looking at one @dfn{Node} of Information.
A node contains text describing a specific topic at a specific
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.
-
- 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
+ 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} link, or an
+@samp{Up} link, or both. As you can see, this node has all of these
links.
@kindex n @r{(Info mode)}
@samp{>>} in the margin means it is really time to try a command.
@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
- the @samp{Next} link to do the same ``the mouse way''.
+>> If you are in Emacs and have a mouse, and if you already practiced
+ typing @kbd{n} 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
@node Help-P, Help-^L, Help, Getting Started
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.
+>> But do not type @kbd{n} yet. First, try the @kbd{p} command, or
+ (in Emacs) 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 (in Emacs) 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
+@node Help-^L, Help-Inv, Help-P, Getting Started
@comment node-name, next, previous, up
-@section The Space, DEL, B and ^L commands.
+@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 display it
-again by typing @kbd{C-l} (@kbd{Control-L}, that is---hold down
+again by typing @kbd{C-l} (@kbd{Control-L}---that is, hold down
@key{CTRL} and type @kbd{L} or @kbd{l}).
@format
@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{SPS}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
@format
>> Type a @key{?} now. Press @key{SPC} to see consecutive screenfuls of
- the list until finished. Then type @key{SPC} several times, until
- it goes away.
+ the list until finished. Then type @key{SPC} several times. If
+ you are using Emacs, the help will then go away automatically.
@end format
(If you are using the stand-alone Info reader, type @kbd{C-x 0} to
return here, that is---press and hold @key{CTRL}, type an @kbd{x},
-then release @key{CTRL} and @kbd{x}, and press @kbd{0}---a zero, not
-the letter ``o''.)
+then release @key{CTRL} and @kbd{x}, and press @kbd{0}; that's a zero,
+not the letter ``o''.)
From now on, you will encounter large nodes without warning, and
will be expected to know how to use @key{SPC} and @key{BACKSPACE} to
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 visit the next node.
@end format
-@node Help-M, Help-Xref, Help-^L, Getting Started
+@node Help-Inv, Help-M, Help-^L, Getting Started
+@comment node-name, next, previous, up
+@section Invisible text in Emacs Info
+
+ Before discussing menus, we need to make some remarks that are only
+relevant to users reading Info using Emacs. Users of the stand-alone
+version can skip this node by typing @kbd{]} now.
+
+@cindex invisible text in Emacs
+ In Emacs, certain text that appears in the stand-alone version is
+normally hidden, technically because it has the @samp{invisibility}
+property. Invisible text is really a part of the text. It becomes
+visible (by default) after killing and yanking, it appears in printed
+output, it gets saved to file just like any other text, and so on.
+Thus it is useful to know it is there.
+
+@findex visible-mode
+You can make invisible text visible by using the command @kbd{M-x
+visible-mode}. Visible mode is a minor mode, so using the command a
+second time will make the text invisible again. Watch the effects of
+the command on the ``menu'' below and the top line of this node.
+
+If you prefer to @emph{always} see the invisible text, you can set
+@code{Info-hide-note-references} to @code{nil}. Enabling Visible mode
+permanently is not a real alternative, because Emacs Info also uses
+(although less extensively) another text property that can change the
+text being displayed, the @samp{display} property. Only the
+invisibility property is affected by Visible mode. When, in this
+tutorial, we refer to the @samp{Emacs} behavior, we mean the
+@emph{default} Emacs behavior.
+
+Now type @kbd{]}, to learn about the @kbd{]} and @kbd{[} commands.
+
+@menu
+* ]: Help-]. Node telling about ].
+* stuff: Help-]. Same node.
+* Help-]:: Yet again, same node.
+@end menu
+
+@node Help-], , , Help-Inv
+@subsection The @kbd{]} and @kbd{[} commands
+
+If you type @kbd{n} now, you get an error message saying that this
+node has no next node. Similarly, if you type @kbd{p}, the error
+message tells you that there is no previous node. (The exact message
+depends on the Info reader you use.) This is because @kbd{n} and
+@kbd{p} carry you to the next and previous node @emph{at the same
+level}. The present node is contained in a menu (see next) of the
+node you came from, and hence is considered to be at a lower level.
+It is the only node in the previous node's menu (even though it was
+listed three times). Hence it has no next or previous node that
+@kbd{n} or @kbd{p} could move to.
+
+If you systematically move through a manual by typing @kbd{n}, you run
+the risk of skipping many nodes. You do not run this risk if you
+systematically use @kbd{@key{SPC}}, because, when you scroll to the
+bottom of a node and type another @kbd{@key{SPC}}, then this carries
+you to the following node in the manual @emph{regardless of level}.
+If you immediately want to go to that node, without having to scroll
+to the bottom of the screen first, you can type @kbd{]}.
+
+Similarly, @kbd{@key{BACKSPACE}} carries you to the preceding node
+regardless of level, after you scrolled to the beginning of the
+present node. If you want to go to the preceding node immediately,
+you can type @kbd{[}.
+
+For instance, typing this sequence will come back here in three steps:
+@kbd{[ n [}. To do the same backward, type @kbd{] p ]}.
+
+Now type @kbd{]} to go to the next node and learn about menus.
+
+@node Help-M, Help-Xref, Help-Inv, Getting Started
@comment node-name, next, previous, up
@section Menus and the @kbd{m} command
@cindex menus in an Info document
@cindex Info menus
- With only the @kbd{n} (next) and @kbd{p} (previous) commands for
-moving between nodes, nodes are restricted to a linear sequence.
-Menus allow a branching structure. A menu is a list of other nodes
-you can move to. It is actually just part of the text of the node
-formatted specially so that Info can interpret it. The beginning of a
-menu is always identified by a line which starts with @samp{* Menu:}.
-A node contains a menu if and only if it has a line in it which starts
-that way. The only menu you can use at any moment is the one in the
-node you are in. To use a menu in any other node, you must move to
-that node first.
+ With only the @kbd{n} (next), @kbd{p} (previous), @kbd{@key{SPC}},
+@kbd{@key{BACKSPACE}}, @kbd{]} and @kbd{[} commands for moving between
+nodes, nodes are restricted to a linear sequence. Menus allow a
+branching structure. A menu is a list of other nodes you can move to.
+It is actually just part of the text of the node formatted specially
+so that Info can interpret it. The beginning of a menu is always
+identified by a line which starts with @w{@samp{* Menu:}}. A node
+contains a menu if and only if it has a line in it which starts that
+way. The only menu you can use at any moment is the one in the node
+you are in. To use a menu in any other node, you must move to that
+node first.
After the start of the menu, each line that starts with a @samp{*}
-identifies one subtopic. The line usually contains a brief name
-for the subtopic (followed by a @samp{:}), the name of the node that talks
-about that subtopic, and optionally some further description of the
+identifies one subtopic. The line usually contains a brief name for
+the subtopic (followed by a @samp{:}, normally hidden in Emacs), the
+name of the node that talks about that subtopic (again, normally
+hidden in Emacs), and optionally some further description of the
subtopic. Lines in the menu that do not start with a @samp{*} have no
special meaning---they are only for the human reader's benefit and do
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
about FOO}. The rest of the line is just for the reader's
Information. [[ But this line is not a real menu item, simply because
-there is no line above it which starts with @samp{* Menu:}.]]
+there is no line above it which starts with @w{@samp{* Menu:}}. Also,
+in a real menu item, the @samp{*} would appear at the very start of
+the line. This is why the ``normally hidden'' text in Emacs, namely
+@samp{: Node about FOO.}, is actually visible in this example, even
+when Visible mode is off.]]
When you use a menu to go to another node (in a way that will be
described soon), what you specify is the subtopic name, the first
abbreviation for this:
@example
-* Foo:: This tells about FOO
+* Foo:: This tells about FOO.
@end example
@noindent
This means that the subtopic name and node name are the same; they are
-both @samp{Foo}.
+both @samp{Foo}. (The @samp{::} is normally hidden in Emacs.)
@format
>> Now use @key{SPC} to find the menu in this node, then come back to
@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.
-
- 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}
-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.
+ 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, in the stand-alone Info, look for the line containing many
+dashes near the bottom of the screen. (This is the stand-alone
+equivalent for the mode line in Emacs.) There is one more line
+beneath that one, but usually it is blank. (In Emacs, this is the
+echo area.) 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 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
+(Turn Visible mode on if you are using Emacs.)
+
@format
>> Now type just an @kbd{m} and see what happens:
@end format
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 displayed 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
end of the node's text @kbd{Mouse-2} moves to the next node, or up if
there's no next node.
- Here is another way to get to Help-FOO, a menu. You can ignore this
-if you want, or else try it by typing @key{TAB} and then @key{RET}, or
-clicking @kbd{Mouse-2} on it (but then please come back to here).
-
-@menu
-* Help-FOO::
-@end menu
-
@format
>> Type @kbd{n} to see more commands.
@end format
(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}.
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}.
+points to the node named @samp{Help-Cross}. (The node name is hidden
+in Emacs. Do @kbd{M-x visible-mode} to show or hide it.)
@kindex f @r{(Info mode)}
@findex Info-follow-reference
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.
+ Sometimes a cross reference (or a node) can lead to another file (in
+other words another ``manual''), or, on occasion, even a file on a
+remote machine (although Info files distributed with Emacs or the
+stand-alone Info avoid using remote links). Such a cross reference
+looks like this: @xref{Top,, Overview of Texinfo, texinfo, Texinfo:
+The GNU Documentation Format}. (After following this link, type
+@kbd{l} to get back to this node.) Here the name @samp{texinfo}
+between parentheses (shown in the stand-alone version) refers to the
+file name. This file name appears in cross references and node names
+if it differs from the current file. In Emacs, the file name is
+hidden (along with other text). (Use @kbd{M-x visible-mode} to show
+or hide it.)
+
+ The remainder of this node applies only to the Emacs version. If
+you use the stand-alone version, you can type @kbd{n} immediately.
+
+ To some users, switching manuals is a much bigger switch than
+switching sections. These users like to know that they are going to
+be switching to another manual (and which one) before actually doing
+so, especially given that, if one does not notice, Info commands like
+@kbd{t} (see the next node) can have confusing results.
+
+ If you put your mouse over the cross reference and if the cross
+reference leads to a different manual, then the information appearing
+in a separate box (tool tip) or in the echo area, will mention the
+file the cross reference will carry you to (between parentheses).
+This is also true for menu subtopic names. If you have a mouse, just
+leave it over the @samp{Overview} cross reference above and watch what
+happens.
+
+ If you always like to have that information available without having
+to move your mouse over the cross reference, set
+@code{Info-hide-note-references} to a value other than t (@pxref{Emacs
+Info Variables}). You might also want to do that if you have a lot of
+cross references to files on remote machines and have non-permanent or
+slow access, since otherwise you might not be able to distinguish
+between local and remote links.
+
+@format
+>> Now type @kbd{n} to learn more commands.
+@end format
+
@node Help-Int, Help-Q, Help-Xref, Getting Started
@comment node-name, next, previous, up
@section Some intermediate Info commands
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.
+ Most Info files have an index, which is actually a large node
+containing little but a menu. The menu has one menu item for each
+topic listed in the index. (As a special feature, menus for indices
+may also include the line number within the node of the index entry.
+This allows Info readers to go to the exact line of an entry, not just
+the start of the containing node.)
+
+ You can get to the index 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 you want.
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
@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
-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}.
-
In Emacs, @kbd{l} runs the command @code{Info-last}.
@format
->> Try typing three @kbd{l}'s, pausing in between to see what each
- @kbd{l} does. Then follow directions again and you will end up
- back here.
+>> Try typing @kbd{p p n} and then three @kbd{l}'s, pausing in between
+to see what each @kbd{l} does. You should wind up right back here.
@end format
Note the difference between @kbd{l} and @kbd{p}: @kbd{l} moves to
where @emph{you} last were, whereas @kbd{p} always moves to the node
which the header says is the @samp{Previous} node (from this node, the
-@samp{Prev} link leads to @samp{Help-M}).
+@samp{Prev} link leads to @samp{Help-Xref}).
@kindex d @r{(Info mode)}
@findex Info-directory
>> Now type @kbd{n} to see the last node of the course.
@end format
- @xref{Advanced Info}, for more advanced Info features.
+ @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, e, and 1 - 9.
* 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
Here are some more Info commands that make it easier to move around.
-@unnumberedsubsec @kbd{g} goes to a node by name
+@subheading @kbd{g} goes to a node by name
@kindex g @r{(Info mode)}
@findex Info-goto-node
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-Int}.) @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.
all of the current file by typing @kbd{g*@key{RET}} or all of any
other file with @kbd{g(@var{filename})@key{RET}}.
-@unnumberedsubsec @kbd{1} -- @kbd{9} choose a menu subtopic by its number
+@subheading @kbd{1}--@kbd{9} choose a menu subtopic by its number
@kindex 1 @r{through} 9 @r{(Info mode)}
@findex Info-nth-menu-item
this is so you need not count how many entries are there. In Emacs,
the digit keys run the command @code{Info-nth-menu-item}.
- If your display supports multiple fonts, and you are using Emacs'
-Info mode to read Info files, the @samp{*} for the fifth menu item
-stands out, either in color or in some other attribute, such as
-underline, and so is the @samp{*} for the ninth item; this makes it
-easy to see at a glance which number to use for an item.
+ If your display supports multiple fonts, colors or underlining, and
+you are using Emacs' Info mode to read Info files, the third, sixth
+and ninth menu items have a @samp{*} that stands out, either in color
+or in some other attribute, such as underline; this makes it easy to
+see at a glance which number to use for an item.
- Some terminals don't support colors or underlining. If you need to
-actually count items, it is better to use @kbd{m} instead, and specify
-the name, or use @key{TAB} to quickly move between menu items.
+ Some terminals don't support either multiple fonts, colors or
+underlining. If you need to actually count items, it is better to use
+@kbd{m} instead, and specify the name, or use @key{TAB} to quickly
+move between menu items.
-@unnumberedsubsec @kbd{e} makes Info document editable
+@subheading @kbd{e} makes Info document editable
@kindex e @r{(Info mode)}
@findex Info-edit
edit the Info file, so typing @kbd{e} there goes to the end of the
current node.
-@node Info Search, Add, Expert, Advanced Info
+@subheading @kbd{M-n} creates a new independent Info buffer in Emacs
+
+@kindex M-n @r{(Info mode)}
+@findex clone-buffer
+@cindex multiple Info buffers
+ If you are reading Info in Emacs, you can select a new independent
+Info buffer in another window by typing @kbd{M-n}. The new buffer
+starts out as an exact copy of the old one, but you will be able to
+move independently between nodes in the two buffers. (In Info mode,
+@kbd{M-n} runs the Emacs command @code{clone-buffer}.)
+
+ In Emacs Info, you can also produce new Info buffers by giving a
+numeric prefix argument to the @kbd{m} and @kbd{g} commands. @kbd{C-u
+m} and @kbd{C-u g} go to a new node in exactly the same way that
+@kbd{m} and @kbd{g} do, but they do so in a new Info buffer which they
+select in another window.
+
+@node Info Search, Add, Advanced, Expert Info
@comment node-name, next, previous, up
@section How to search Info documents for specific subjects
echo area the full index entry it found. Often, the text of the full
index entry already gives you enough information to decide whether it
is relevant to what you are looking for, so we recommend that you read
-what Emacs shows in the echo are before looking at the node it
+what Info shows in the echo area before looking at the node it
displays.
Since @kbd{i} looks for a substring, you can search for subjects even
looking for a description of a command, an option, or a key, just type
their names when @kbd{i} prompts you for a topic. For example, if you
want to read the description of what the @kbd{C-f} key does, type
-@kbd{iC-f@key{RET}}. Here @kbd{C-f} are 3 literal characters
+@kbd{i C - f @key{RET}}. Here @kbd{C-f} are 3 literal characters
@samp{C}, @samp{-}, and @samp{f}, not the ``Control-f'' command key
you type inside Emacs to run the command bound to @kbd{C-f}.
In Emacs, @kbd{i} runs the command @code{Info-index}.
+@findex info-apropos
+If you don't know what manual documents something, try the @kbd{M-x
+info-apropos} command. It prompts for a string and then looks up that
+string in all the indices of all the Info documents installed on your
+system.
+
@kindex s @r{(Info mode)}
@findex Info-search
The @kbd{s} command allows you to search a whole file for a string.
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
reads from the terminal.
@cindex menu and menu entry format
- A menu begins with a line starting with @samp{* Menu:}. The rest of the
-line is a comment. After the starting line, every line that begins
-with a @samp{* } lists a single topic. The name of the topic--what
-the user must type at the @kbd{m}'s command prompt to select this
-topic---comes right after the star and space, and is followed by a
-colon, spaces and tabs, and the name of the node which discusses that
-topic. The node name, like node names following @samp{Next}, @samp{Previous}
-and @samp{Up}, may be terminated with a tab, comma, or newline; it may also
-be terminated with a period.
+ A menu begins with a line starting with @w{@samp{* Menu:}}. The
+rest of the line is a comment. After the starting line, every line
+that begins with a @samp{* } lists a single topic. The name of the
+topic---what the user must type at the @kbd{m}'s command prompt to
+select this topic---comes right after the star and space, and is
+followed by a colon, spaces and tabs, and the name of the node which
+discusses that topic. The node name, like node names following
+@samp{Next}, @samp{Previous} and @samp{Up}, may be terminated with a
+tab, comma, or newline; it may also be terminated with a period.
If the node name and topic name are the same, then rather than
giving the name twice, the abbreviation @samp{* @var{name}::} may be
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
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;
@item Info-fontify
When set to a non-@code{nil} value, enables highlighting of Info
files. The default is @code{t}. You can change how the highlighting
-looks by customizing the faces @code{info-node}, @code{info-menu-5},
-@code{info-xref}, @code{info-header-xref}, @code{info-header-node},
-@code{info-title-@var{n}-face} (where @var{n} is the level of the
-section, a number between 1 and 4), and @code{info-menu-header}. To
+looks by customizing the faces @code{info-node}, @code{info-xref},
+@code{info-header-xref}, @code{info-header-node}, @code{info-menu-5},
+@code{info-menu-header}, and @code{info-title-@var{n}-face} (where
+@var{n} is the level of the section, a number between 1 and 4). To
customize a face, type @kbd{M-x customize-face @key{RET} @var{face}
@key{RET}}, where @var{face} is one of the face names listed here.
not scroll with the rest of the buffer, making these links always
visible.
+@item Info-hide-note-references
+As explained in earlier nodes, the Emacs version of Info normally
+hides some text in menus and cross-references. You can completely
+disable this feature, by setting this option to @code{nil}. Setting
+it to a value that is neither @code{nil} nor @code{t} produces an
+intermediate behavior, hiding a limited amount of text, but showing
+all text that could potentially be useful.
+
@item Info-scroll-prefer-subnodes
If set to a non-@code{nil} value, @key{SPC} and @key{BACKSPACE} (or
@key{DEL}) keys in a menu visit subnodes of the current node before
subnode indicated by the following menu item. Setting this option to
@code{nil} results in behavior similar to the stand-alone Info reader
program, which visits the first subnode from the menu only when you
-hit the end of the current node. The default is @code{t}.
+hit the end of the current node. The default is @code{nil}.
@item Info-enable-active-nodes
When set to a non-@code{nil} value, allows Info to execute Lisp code
@printindex cp
@bye
+
+@ignore
+ arch-tag: 965c1638-01d6-4156-9227-b10418b9d8e8
+@end ignore