[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[5645] info.texi from current emacs trunk
|
From: |
karl |
|
Subject: |
[5645] info.texi from current emacs trunk |
|
Date: |
Sun, 08 Jun 2014 18:29:01 +0000 |
Revision: 5645
http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=5645
Author: karl
Date: 2014-06-08 18:28:59 +0000 (Sun, 08 Jun 2014)
Log Message:
-----------
info.texi from current emacs trunk
Modified Paths:
--------------
trunk/doc/info.texi
Modified: trunk/doc/info.texi
===================================================================
--- trunk/doc/info.texi 2014-06-05 15:56:00 UTC (rev 5644)
+++ trunk/doc/info.texi 2014-06-08 18:28:59 UTC (rev 5645)
@@ -8,19 +8,20 @@
@syncodeindex fn cp
@syncodeindex vr cp
@syncodeindex ky cp
address@hidden UTF-8
@comment %**end of header
@copying
This file describes how to use Info, the on-line, menu-driven GNU
documentation system.
-Copyright @copyright{} 1989, 1992, 1996--2013 Free Software Foundation, Inc.
+Copyright @copyright{} 1989, 1992, 1996--2014 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.3 or
any later version published by the Free Software Foundation; with no
-Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
+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''.
@@ -68,6 +69,8 @@
To read about advanced Info commands, type @kbd{n} twice. This
brings you to @cite{Advanced Info Commands}, skipping over the `Getting
Started' chapter.
+
+Type @kbd{H} to see a summary of all available commands.
@end ifinfo
@end ifnottex
@@ -76,20 +79,18 @@
@menu
* Getting Started:: Getting started using an Info reader.
* Advanced:: Advanced Info commands.
-* Expert Info:: Info commands for experts.
+* Further Reading:: Where to learn more about Info files.
* GNU Free Documentation License:: The license for this documentation.
* Index:: An index of topics, commands, and variables.
@end menu
address@hidden Getting Started, Advanced, Top, Top
address@hidden node-name, next, previous, up
address@hidden Getting Started
@chapter Getting Started
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. The third part briefly explains how to generate Info
-files from Texinfo files, and describes how to write an Info file
-by hand.
+Info commands. The third part contains references to other sources,
+which explain how to generate Info files from Texinfo files.
@ifnotinfo
This manual is primarily designed for browsing with an Info reader
@@ -157,12 +158,12 @@
does not fit. To move forward through the text and see another screen
full, press @key{SPC}, the Space bar. To move back up, press the key
labeled @samp{Backspace} or @samp{DEL} (on some keyboards, this key
-might be labeled @samp{Delete}).
+might be labeled @samp{Delete}), or @key{S-SPC}.
@ifinfo
-Here are 40 lines of junk, so you can try @key{SPC} and @key{DEL} and
-see what they do. At the end are instructions of what you should do
-next.
+Here are 40 lines of junk, so you can try @key{SPC} and @key{DEL} (or
address@hidden) and see what they do. At the end are instructions of
+what you should do next.
@format
This is line 20
@@ -208,15 +209,14 @@
@end format
If you have managed to get here, go back to the beginning with
address@hidden (or @key{BACKSPACE}), and come back here again, then you
address@hidden (or @key{S-SPC}), 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
the course.
@end ifinfo
address@hidden Help, Help-P, Help-Small-Screen, Getting Started
address@hidden node-name, next, previous, up
address@hidden Help
@section How to use Info
You are talking to the program Info, for reading documentation.
@@ -262,8 +262,7 @@
mouse button on the @samp{Next} link to do the same ``the mouse way''.
@end format
address@hidden Help-P, Help-^L, Help, Getting Started
address@hidden node-name, next, previous, up
address@hidden Help-P
@section Returning to the Previous node
@kindex p @r{(Info mode)}
@@ -295,8 +294,7 @@
the @samp{Next} link, to get to the node @samp{Help-^L} and learn more.
@end format
address@hidden Help-^L, Help-Inv, Help-P, Getting Started
address@hidden node-name, next, previous, up
address@hidden Help-^L
@section The Space, DEL, B and ^L commands
This node's mode line tells you that you are now at node
@@ -420,8 +418,7 @@
to visit the next node.
@end format
address@hidden Help-Inv, Help-M, Help-^L, Getting Started
address@hidden node-name, next, previous, up
address@hidden Help-Inv
@section Invisible text in Emacs Info
Before discussing menus, we need to make some remarks that are only
@@ -481,18 +478,17 @@
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, @address@hidden 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{[}.
+Similarly, @address@hidden (or @address@hidden) 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.
address@hidden Help-M, Help-Xref, Help-Inv, Getting Started
address@hidden node-name, next, previous, up
address@hidden Help-M
@section Menus and the @kbd{m} command
@cindex menus in an Info document
@@ -730,8 +726,7 @@
>> Now type @kbd{u} to move back up to @samp{Help-M}.
@end format
address@hidden Help-Xref, Help-Int, Help-M, Getting Started
address@hidden node-name, next, previous, up
address@hidden Help-Xref
@section Following Cross-References
@cindex cross references in Info documents
@@ -813,8 +808,30 @@
>> Now type @kbd{n} to learn more commands.
@end format
address@hidden Help-Int, Help-Q, Help-Xref, Getting Started
address@hidden node-name, next, previous, up
+
address@hidden
+* Help-Cross:: Target of a cross-reference.
address@hidden menu
+
+
address@hidden Help-Cross, , , Help-Xref
address@hidden The node reached by the cross reference in Info
+
+ This is the node reached by the cross reference named @samp{Cross}.
+
+ While this node is specifically intended to be reached by a cross
+reference, most cross references lead to nodes that ``belong''
+someplace else far away in the structure of an Info document. So you
+cannot expect this node to have a @samp{Next}, @samp{Previous} or
address@hidden links pointing back to where you came from. In general, the
address@hidden (el) command is the only way to get back there.
+
address@hidden
+>> Type @kbd{l} to return to the node where the cross reference was.
address@hidden format
+
+
address@hidden Help-Int
@section Some intermediate Info commands
The introductory course is almost over; please continue
@@ -903,8 +920,7 @@
@c If a menu appears at the end of this node, remove it.
@c It is an accident of the menu updating command.
address@hidden Help-Q, , Help-Int, Getting Started
address@hidden node-name, next, previous, up
address@hidden Help-Q
@section Quitting Info
@kindex q @r{(Info mode)}
@@ -963,8 +979,7 @@
@end menu
address@hidden Search Text, Search Index, , Advanced
address@hidden node-name, next, previous, up
address@hidden Search Text
@section @kbd{s} searches Info documents
@cindex searching Info documents
@@ -1005,8 +1020,7 @@
by setting the variable @code{Info-isearch-search} to @code{nil}
(@pxref{Emacs Info Variables}).
address@hidden Search Index, Go to node, Search Text, Advanced
address@hidden node-name, next, previous, up
address@hidden Search Index
@section @kbd{i} searches the indices for specific subjects
@cindex searching Info indices
@@ -1058,8 +1072,7 @@
a string and then looks up that string in all the indices of all the
Info documents installed on your system.
address@hidden Go to node, Choose menu subtopic, Search Index, Advanced
address@hidden node-name, next, previous, up
address@hidden Go to node
@section @kbd{g} goes to a node by name
@kindex g @r{(Info mode)}
@@ -1079,14 +1092,14 @@
node name by putting it at the front, in parentheses. Thus,
@kbd{g(dir)address@hidden would go to the Info Directory node, which is
the node @samp{Top} in the Info file @file{dir}. Likewise,
address@hidden(emacs)address@hidden goes to the top node of the Emacs manual.
address@hidden(emacs)address@hidden (or just @kbd{g(emacs)@key{RET}}) goes to
the
+top node of the Emacs manual.
The node name @samp{*} specifies the whole file. So you can look at
all of the current file by typing @address@hidden or all of any
other file with @kbd{g(@var{filename})address@hidden
address@hidden Choose menu subtopic, Create Info buffer, Go to node, Advanced
address@hidden node-name, next, previous, up
address@hidden Choose menu subtopic
@section @address@hidden choose a menu subtopic by its number
@kindex 1 @r{through} 9 @r{(Info mode)}
@@ -1111,8 +1124,7 @@
@kbd{m} instead, and specify the name, or use @key{TAB} to quickly
move between menu items.
address@hidden Create Info buffer, Emacs Info Variables, Choose menu subtopic,
Advanced
address@hidden node-name, next, previous, up
address@hidden Create Info buffer
@section @kbd{M-n} creates a new independent Info buffer in Emacs
@kindex M-n @r{(Info mode)}
@@ -1133,7 +1145,7 @@
Another way to produce new Info buffers in Emacs is to use a numeric
prefix argument for the @kbd{C-h i} command (@code{info}) which
switches to the Info buffer with that number. Thus, @kbd{C-u 2 C-h i}
-switches to the buffer @samp{*info*<2>}, creating it if necessary.
+switches to the buffer @file{*info*<2>}, creating it if necessary.
@findex info-display-manual
If you have created many Info buffers in Emacs, you might find it
@@ -1141,8 +1153,7 @@
use the command @kbd{M-x info-display-manual} to show an Info manual
by name, reusing an existing buffer if there is one.
address@hidden Emacs Info Variables, , Create Info buffer, Advanced
address@hidden node-name, next, previous, up
address@hidden Emacs Info Variables
@section Emacs Info-mode Variables
The following variables may modify the behavior of Info-mode in Emacs;
@@ -1203,13 +1214,14 @@
@item Info-scroll-prefer-subnodes
If set to a address@hidden value, @key{SPC} and @key{BACKSPACE} (or
address@hidden) keys in a menu visit subnodes of the current node before
-scrolling to its end or beginning, respectively. For example, if the
-node's menu appears on the screen, the next @key{SPC} moves to a
-subnode indicated by the following menu item. Setting this option to
address@hidden 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{nil}.
address@hidden, or @key{S-SPC}) keys in a menu visit subnodes of the
+current node before scrolling to its end or beginning, respectively.
+For example, if the node's menu appears on the screen, the next
address@hidden moves to a 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{nil}.
@item Info-isearch-search
If address@hidden, isearch in Info searches through multiple nodes.
@@ -1227,14 +1239,13 @@
@end vtable
address@hidden Expert Info
address@hidden Info for Experts
address@hidden Further Reading
address@hidden Further Reading
@cindex Texinfo
- This chapter explains how to write an Info file by hand. However,
-in most cases, writing a Texinfo file is 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.
+ Info files are created from Texinfo source files. You can use the
+same source file to make a printed manual or produce other formats,
+such as HTML and DocBook.
The @code{makeinfo} command converts a Texinfo file into an Info file;
@code{texinfo-format-region} and @code{texinfo-format-buffer} are GNU
@@ -1250,254 +1261,6 @@
Documentation Format}, for how to install an Info file after you
have created one.
-However, if you want to edit an Info file manually and install it manually,
-here is how.
-
address@hidden
-* Add:: Describes how to add new nodes to the hierarchy.
- Also tells what nodes look like.
-* Menus:: How to add to or create menus in Info nodes.
-* Cross-refs:: How to add cross-references to Info nodes.
-* Tags:: How to make tags tables for Info files.
-* Checking:: Checking an Info File.
address@hidden menu
-
address@hidden Add, Menus, , Expert Info
address@hidden node-name, next, previous, up
address@hidden Adding a new node to Info
-
-To add a new topic to the list in the Info directory, you must:
-
address@hidden
address@hidden
-Create some nodes, in some file, to document that topic.
address@hidden
-Put that topic in the menu in the directory. @xref{Menus, Menu}.
address@hidden enumerate
-
address@hidden node delimiters
- The new node can live in an existing documentation file, or in a new
-one. It must have a @samp{^_} character before it (invisible to the
-user; this node has one but you cannot see it), and it ends with either
-a @samp{^_}, a @samp{^L} (``formfeed''), or the end of address@hidden
-you put in a @samp{^L} to end a new node, be sure that there is a
address@hidden after it to start the next one, since @samp{^L} cannot
address@hidden a node. Also, a nicer way to make a node boundary be a
-page boundary as well is to put a @samp{^L} @emph{right after} the
address@hidden
-
- The @samp{^_} starting a node must be followed by a newline or a
address@hidden 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}.
-
address@hidden node header line format
address@hidden format of node headers
- The keywords @dfn{Node}, @dfn{Next}, @dfn{Previous}, and @dfn{Up}
-may appear in any order, anywhere in the header line, but the
-recommended order is the one in this sentence. Each keyword must be
-followed by a colon, spaces and tabs, and then the appropriate name.
-The name may be terminated with a tab, a comma, or a newline. A space
-does not end it; node names may contain spaces. The case of letters
-in the names is insignificant.
-
address@hidden node name format
address@hidden Directory node
- A node name has two forms. A node in the current file is named by
-what appears after the @samp{Node: } in that node's first line. For
-example, this node's name is @samp{Add}. A node in another file is
-named by @samp{(@var{filename})@var{node-within-file}}, as in
address@hidden(info)Add} for this node. If the file name starts with @samp{./},
-then it is relative to the current directory; otherwise, it is
-relative starting from the standard directory for Info files of your
-site. The name @samp{(@var{filename})Top} can be abbreviated to just
address@hidden(@var{filename})}. By convention, the name @samp{Top} is used
-for the ``highest'' node in any single file---the node whose @samp{Up}
-points out of the file. The @samp{Directory} node is @file{(dir)}, it
-points to a file @file{dir} which holds a large menu listing all the
-Info documents installed on your site. The @samp{Top} node of a
-document file listed in the @samp{Directory} should have an @samp{Up:
-(dir)} in it.
-
address@hidden unstructured documents
- The node name @kbd{*} is special: it refers to the entire file.
-Thus, @kbd{g*} shows you the whole current file. The use of the
-node @kbd{*} is to make it possible to make old-fashioned,
-unstructured files into nodes of the tree.
-
- The @samp{Node:} name, in which a node states its own name, must not
-contain a file name, since when Info searches for a node, it does not
-expect a file name to be there. The @samp{Next}, @samp{Previous} and
address@hidden names may contain them. In this node, since the @samp{Up}
-node is in the same file, it was not necessary to use one.
-
- Note that the nodes in this file have a file name in the header
-line. The file names are ignored by Info, but they serve as comments
-to help identify the node for the user.
-
address@hidden Menus, Cross-refs, Add, Expert Info
address@hidden node-name, next, previous, up
address@hidden How to Create Menus
-
- Any node in the Info hierarchy may have a @dfn{menu}---a list of subnodes.
-The @kbd{m} command searches the current node's menu for the topic which it
-reads from the terminal.
-
address@hidden menu and menu entry format
- A menu begins with a line starting with @address@hidden 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
address@hidden, @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
-used (and should be used, whenever possible, as it reduces the visual
-clutter in the menu).
-
- It is considerate to choose the topic names so that they differ
-from each other very near the beginning---this allows the user to type
-short abbreviations. In a long menu, it is a good idea to capitalize
-the beginning of each item name which is the minimum acceptable
-abbreviation for it (a long menu is more than 5 or so entries).
-
- The nodes listed in a node's menu are called its ``subnodes,'' and it
-is their ``superior''. They should each have an @samp{Up:} pointing at
-the superior. It is often useful to arrange all or most of the subnodes
-in a sequence of @samp{Next} and @samp{Previous} pointers so that
-someone who wants to see them all need not keep revisiting the Menu.
-
- The Info Directory is simply the menu of the node @samp{(dir)Top}---that
-is, node @samp{Top} in file @file{.../info/dir}. You can put new entries
-in that menu just like any other menu. The Info Directory is @emph{not} the
-same as the file directory called @file{info}. It happens that many of
-Info's files live in that file directory, but they do not have to; and
-files in that directory are not automatically listed in the Info
-Directory node.
-
- Also, although the Info node graph is claimed to be a ``hierarchy,''
-in fact it can be @emph{any} directed graph. Shared structures and
-pointer cycles are perfectly possible, and can be used if they are
-appropriate to the meaning to be expressed. There is no need for all
-the nodes in a file to form a connected structure. In fact, this file
-has two connected components. You are in one of them, which is under
-the node @samp{Top}; the other contains the node @samp{Help} which the
address@hidden command goes to. In fact, since there is no garbage
-collector on the node graph, nothing terrible happens if a substructure
-is not pointed to, but such a substructure is rather useless since nobody
-can ever find out that it exists.
-
address@hidden Cross-refs, Tags, Menus, Expert Info
address@hidden node-name, next, previous, up
address@hidden Creating Cross References
-
address@hidden cross reference format
- A cross reference can be placed anywhere in the text, unlike a menu
-item which must go at the front of a line. A cross reference looks
-like a menu item except that it has @samp{*note} instead of @samp{*}.
-It @emph{cannot} be terminated by a @samp{)}, because @samp{)}'s are
-so often part of node names. If you wish to enclose a cross reference
-in parentheses, terminate it with a period first. Here are two
-examples of cross references pointers:
-
address@hidden
-*Note details: commands. (See *note 3: Full Proof.)
address@hidden example
-
address@hidden
address@hidden are just examples.} The places they ``lead to'' do not
-really exist!
-
address@hidden
-* Help-Cross:: Target of a cross-reference.
address@hidden menu
-
-
address@hidden Help-Cross, , , Cross-refs
address@hidden The node reached by the cross reference in Info
-
- This is the node reached by the cross reference named @samp{Cross}.
-
- While this node is specifically intended to be reached by a cross
-reference, most cross references lead to nodes that ``belong''
-someplace else far away in the structure of an Info document. So you
-cannot expect this node to have a @samp{Next}, @samp{Previous} or
address@hidden links pointing back to where you came from. In general, the
address@hidden (el) command is the only way to get back there.
-
address@hidden
->> Type @kbd{l} to return to the node where the cross reference was.
address@hidden format
-
address@hidden Tags, Checking, Cross-refs, Expert Info
address@hidden node-name, next, previous, up
address@hidden Tags Tables for Info Files
-
address@hidden tags tables in Info files
- You can speed up the access to nodes of a large Info file by giving
-it a tags table. Unlike the tags table for a program, the tags table for
-an Info file lives inside the file itself and is used
-automatically whenever Info reads in the file.
-
address@hidden Info-tagify
- To make a tags table, go to a node in the file using Emacs Info mode and type
address@hidden Info-tagify}. Then you must use @kbd{C-x C-s} to save the
-file. Info files produced by the @code{makeinfo} command that is part
-of the Texinfo package always have tags tables to begin with.
-
address@hidden stale tags tables
address@hidden update Info tags table
- Once the Info file has a tags table, you must make certain it is up
-to date. If you edit an Info file directly (as opposed to editing its
-Texinfo source), and, as a result of deletion of text, any node moves back
-more than a thousand characters in the file from the position
-recorded in the tags table, Info will no longer be able to find that
-node. To update the tags table, use the @code{Info-tagify} command
-again.
-
- An Info file tags table appears at the end of the file and looks like
-this:
-
address@hidden
-^_^L
-Tag Table:
-File: info, Node: Cross-refs^?21419
-File: info, Node: Tags^?22145
-^_
-End Tag Table
address@hidden example
-
address@hidden
-Note that it contains one line per node, and this line contains
-the beginning of the node's header (ending just after the node name),
-a @samp{DEL} character, and the character position in the file of the
-beginning of the node.
-
address@hidden Checking, , Tags, Expert Info
address@hidden Checking an Info File
-
-When creating an Info file, it is easy to forget the name of a node when
-you are making a pointer to it from another node. If you put in the
-wrong name for a node, this is not detected until someone tries to go
-through the pointer using Info. Verification of the Info file is an
-automatic process which checks all pointers to nodes and reports any
-pointers which are invalid. Every @samp{Next}, @samp{Previous}, and
address@hidden is checked, as is every menu item and every cross reference. In
-addition, any @samp{Next} which does not have a @samp{Previous} pointing
-back is reported. Only pointers within the file are checked, because
-checking pointers to other files would be terribly slow. But those are
-usually few.
-
address@hidden Info-validate
-To check an Info file, do @kbd{M-x Info-validate} while looking at any
-node of the file with Emacs Info mode.
-
@node GNU Free Documentation License
@appendix GNU Free Documentation License
@include fdl.texi
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [5645] info.texi from current emacs trunk,
karl <=