texinfo-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[no subject]


From: Gavin D. Smith
Date: Tue, 10 Jan 2023 13:16:13 -0500 (EST)

branch: master
commit cb8fe617207666f2f4d494bcac29247e01c36efb
Author: Gavin Smith <gavinsmith0123@gmail.com>
AuthorDate: Tue Jan 10 18:06:41 2023 +0000

    * doc/info-stnd.texi (Node Commands): Move immediately after
    introductory chapter so that we can immediately introduce the
    important commands 'n', 'p' and 'u'.
---
 ChangeLog          |   6 +
 doc/info-stnd.texi | 436 +++++++++++++++++++++++++++--------------------------
 2 files changed, 225 insertions(+), 217 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 803256735f..1abf3289c8 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2023-01-10  Gavin Smith  <gavinsmith0123@gmail.com>
+
+       * doc/info-stnd.texi (Node Commands): Move immediately after
+       introductory chapter so that we can immediately introduce the
+       important commands 'n', 'p' and 'u'.
+
 2023-01-10  Gavin Smith  <gavinsmith0123@gmail.com>
 
        * doc/info-stnd.texi (MS-DOS/Windows keybindings):
diff --git a/doc/info-stnd.texi b/doc/info-stnd.texi
index d6be0d839f..ec86f0fa81 100644
--- a/doc/info-stnd.texi
+++ b/doc/info-stnd.texi
@@ -65,9 +65,9 @@ and @key{Backspace}) to move forwards and backwards in it.
 
 @menu
 * Stand-alone Info::            What is Info?
+* Node Commands::               Commands for selecting a new node.
 * Cursor Commands::             Commands which move the cursor within a node.
 * Scrolling Commands::          Commands for reading the text within a node.
-* Node Commands::               Commands for selecting a new node.
 * Searching Commands::          Commands for searching an Info file.
 * Index Commands::              Commands for looking up in indices.
 * Xref Commands::               Commands for selecting cross-references.
@@ -117,6 +117,224 @@ Please report bugs in this stand-alone Info program to
 sent to @email{bug-gnu-emacs@@gnu.org}.
 
 
+@node Node Commands
+@chapter Selecting a Node
+@cindex nodes, selection of
+
+This section details the numerous Info commands which select a new node
+to view in the current window.
+
+The most basic node commands are @samp{n}, @samp{p}, @samp{u}, and
+@samp{l}.
+
+When you are viewing a node, the top line of the node contains some Info
+@dfn{pointers} which describe where the next, previous, and up nodes
+are.  Info uses this line to move about the node structure of the file
+when you use the following commands:
+
+@table @asis
+@item @kbd{n} (@code{next-node})
+@kindex n
+@findex next-node
+Select the `Next' node.
+
+@item @kbd{p} (@code{prev-node})
+@kindex p
+@findex prev-node
+Select the `Prev' node.
+
+@item @kbd{u} (@code{up-node})
+@kindex u
+@findex up-node
+Select the `Up' node.
+@end table
+
+You can easily select a node that you have already viewed in this window
+by using the @samp{l} command---this name stands for ``last'', and
+actually moves backwards through the history of visited nodes for this
+window.  This is handy when you followed a reference to another node,
+possibly to read about a related issue, and would like then to resume
+reading at the same place where you started the excursion.
+
+Each node where you press @samp{l} is discarded from the history.  Thus,
+by the time you get to the first node you visited in a window, the
+entire history of that window is discarded.
+
+@table @asis
+@item @kbd{l} (@code{history-node})
+@kindex l
+@findex history-node
+Pop the most recently selected node in this window from the node
+history.
+@end table
+
+Two additional commands make it easy to select the most commonly
+selected nodes; they are @samp{t} and @samp{d}.
+
+@table @asis
+@item @kbd{t} (@code{top-node})
+@kindex t
+@findex top-node
+Select the node @samp{Top} in the current Info file.
+
+@item @kbd{d} (@code{dir-node})
+@kindex d
+@findex dir-node
+Select the directory node (i.e., the node @samp{(dir)}).
+@end table
+
+Here are some other commands which immediately result in the selection
+of a different node in the current window:
+
+@table @asis
+@item @kbd{<} (@code{first-node})
+@kindex <
+@findex first-node
+Selects the first node which appears in this file.  This node is most
+often @samp{Top}, but it does not have to be.  With a numeric argument
+@var{N}, select the @var{N}th node (the first node is node 1).  An
+argument of zero is the same as the argument of 1.
+
+@item @kbd{>} (@code{last-node})
+@kindex >
+@findex last-node
+Select the last node which appears in this file.  With a numeric argument
+@var{N}, select the @var{N}th node (the first node is node 1).  An
+argument of zero is the same as no argument, i.e., it selects the last
+node.
+
+@item @kbd{]} (@code{global-next-node})
+@kindex ]
+@findex global-next-node
+Move forward through the node structure.  If the node that you are
+currently viewing has a menu, select the first menu item.  Otherwise,
+if this node has a @samp{Next} pointer, follow it.  If there is no menu
+and no @samp{Next} pointer, then follow @samp{Up} pointers until there
+is a @samp{Next} pointer, and then follow it.
+
+@item @kbd{[} (@code{global-prev-node})
+@kindex [
+@findex global-prev-node
+Move backward through the node structure.  If the node that you are
+currently viewing has a @samp{Prev} pointer, that node is selected.
+Otherwise, if the node has an @samp{Up} pointer, that node is selected,
+and if it has a menu, the last item in the menu is selected.
+@end table
+
+You can get the same behavior as @code{global-next-node} and
+@code{global-prev-node} while simply scrolling through the file with
+@key{SPC} and @key{DEL} (@pxref{scroll-behavior}).
+
+@table @asis
+@anchor{goto-node}
+@item @kbd{g} (@code{goto-node})
+@kindex g
+@findex goto-node
+Read the name of a node and select it.  If the desired node resides in
+some other file, you must type the node as it appears in that Info file,
+and include the name of the other file.  For example,
+
+@example
+@code{g(emacs)Buffers}
+@end example
+
+@noindent
+finds the node @samp{Buffers} in the Info file @file{emacs}.
+
+While reading the node name, completion (@pxref{The Echo Area,
+completion}) is only done for the nodes which reside in one of the Info
+files that were loaded in the current Info session.
+
+@anchor{goto-invocation}
+@item @kbd{O} (@code{goto-invocation})
+@kindex O
+@findex goto-invocation
+@cindex finding the Invocation node
+Read the name of a program and look for a node in the current Info file
+which describes the invocation and the command-line options for that
+program.  The default program name is derived from the name of the
+current Info file.  This command does the same as the
+@samp{--show-options} command-line option (@pxref{--show-options}), but
+it also allows to specify the program name; this is important for those
+manuals which describe several programs.
+
+If you need to find the Invocation node of a program that is documented
+in another Info file, you need to visit that file before invoking
+@samp{O}.  For example, if you are reading the Emacs manual and want to
+see the command-line options of the @code{makeinfo} program, type @kbd{g
+(texinfo) @key{RET}} and then @kbd{I makeinfo @key{RET}}.  If you don't
+know what Info file documents the command, or if invoking @samp{O}
+doesn't display the right node, go to the @samp{(dir)} node (using the
+@samp{d} command) and invoke @samp{O} from there.
+
+@item @kbd{G} (@code{menu-sequence})
+@kindex G
+@findex menu-sequence
+@cindex menu, following, from inside Info
+Read a sequence of menu entries and follow it.  Info prompts for a
+sequence of menu items separated by commas.  (Since commas are not
+allowed in a node name, they are a natural choice for a delimiter in a
+list of menu items.)  Info then looks up the first item in the menu of
+the node @samp{(dir)} (if the @samp{(dir)} node cannot be found, Info
+uses @samp{Top}).  If such an entry is found, Info goes to the node it
+points to and looks up the second item in the menu of that node, etc.
+In other words, you can specify a complete path which descends through
+the menu hierarchy of a particular Info file starting at the
+@samp{(dir)} node.  This has the same effect as if you typed the menu
+item sequence on Info's command line, see @ref{command-line menu items,,
+Info command-line arguments processing}.  For example,
+
+@example
+ @kbd{G Texinfo,Overview,Reporting Bugs @key{RET}}
+@end example
+
+@noindent
+displays the node @samp{Reporting Bugs} in the Texinfo manual.  (You
+don't actually need to type the menu items in their full length, or in
+their exact letter-case.  However, if you do type the menu items
+exactly, Info will find it faster.)
+
+If any of the menu items you type are not found, Info stops at the last
+entry it did find and reports an error.
+
+@item @kbd{C-x C-f} (@code{view-file})
+@kindex C-x C-f
+@findex view-file
+Read the name of a file and selects the entire file.  The command
+@example
+@code{C-x C-f @var{filename}}
+@end example
+is equivalent to typing
+@example
+@code{g(@var{filename})*}
+@end example
+
+@item @kbd{C-x C-b} (@code{list-visited-nodes})
+@kindex C-x C-b
+@findex list-visited-nodes
+Make a window containing a menu of all of the currently visited nodes.
+This window becomes the selected window, and you may use the standard
+Info commands within it.
+
+@item @kbd{C-x @kbd{b}} (@code{select-visited-node})
+@kindex C-x b
+@findex select-visited-node
+Select a node which has been previously visited in a visible window.
+This is similar to @samp{C-x C-b} followed by @samp{m}, but no window is
+created.
+
+@item @code{@kbd{M-x} man}
+@findex man
+@cindex man pages, displaying
+Read the name of a man page to load and display.  This uses the @command{man}
+command on your system to retrieve the contents of the requested man page.
+See also @ref{--raw-escapes}.
+
+@end table
+
+
+
+
 @node Cursor Commands
 @chapter Moving the Cursor
 @cindex cursor, moving
@@ -341,222 +559,6 @@ The @code{scroll-forward-page-only} and 
@code{scroll-backward-page-only}
 commands never scroll beyond the current node.
 
 
-@node Node Commands
-@chapter Selecting a Node
-@cindex nodes, selection of
-
-This section details the numerous Info commands which select a new node
-to view in the current window.
-
-The most basic node commands are @samp{n}, @samp{p}, @samp{u}, and
-@samp{l}.
-
-When you are viewing a node, the top line of the node contains some Info
-@dfn{pointers} which describe where the next, previous, and up nodes
-are.  Info uses this line to move about the node structure of the file
-when you use the following commands:
-
-@table @asis
-@item @kbd{n} (@code{next-node})
-@kindex n
-@findex next-node
-Select the `Next' node.
-
-@item @kbd{p} (@code{prev-node})
-@kindex p
-@findex prev-node
-Select the `Prev' node.
-
-@item @kbd{u} (@code{up-node})
-@kindex u
-@findex up-node
-Select the `Up' node.
-@end table
-
-You can easily select a node that you have already viewed in this window
-by using the @samp{l} command---this name stands for ``last'', and
-actually moves backwards through the history of visited nodes for this
-window.  This is handy when you followed a reference to another node,
-possibly to read about a related issue, and would like then to resume
-reading at the same place where you started the excursion.
-
-Each node where you press @samp{l} is discarded from the history.  Thus,
-by the time you get to the first node you visited in a window, the
-entire history of that window is discarded.
-
-@table @asis
-@item @kbd{l} (@code{history-node})
-@kindex l
-@findex history-node
-Pop the most recently selected node in this window from the node
-history.
-@end table
-
-Two additional commands make it easy to select the most commonly
-selected nodes; they are @samp{t} and @samp{d}.
-
-@table @asis
-@item @kbd{t} (@code{top-node})
-@kindex t
-@findex top-node
-Select the node @samp{Top} in the current Info file.
-
-@item @kbd{d} (@code{dir-node})
-@kindex d
-@findex dir-node
-Select the directory node (i.e., the node @samp{(dir)}).
-@end table
-
-Here are some other commands which immediately result in the selection
-of a different node in the current window:
-
-@table @asis
-@item @kbd{<} (@code{first-node})
-@kindex <
-@findex first-node
-Selects the first node which appears in this file.  This node is most
-often @samp{Top}, but it does not have to be.  With a numeric argument
-@var{N}, select the @var{N}th node (the first node is node 1).  An
-argument of zero is the same as the argument of 1.
-
-@item @kbd{>} (@code{last-node})
-@kindex >
-@findex last-node
-Select the last node which appears in this file.  With a numeric argument
-@var{N}, select the @var{N}th node (the first node is node 1).  An
-argument of zero is the same as no argument, i.e., it selects the last
-node.
-
-@item @kbd{]} (@code{global-next-node})
-@kindex ]
-@findex global-next-node
-Move forward through the node structure.  If the node that you are
-currently viewing has a menu, select the first menu item.  Otherwise,
-if this node has a @samp{Next} pointer, follow it.  If there is no menu
-and no @samp{Next} pointer, then follow @samp{Up} pointers until there
-is a @samp{Next} pointer, and then follow it.
-
-@item @kbd{[} (@code{global-prev-node})
-@kindex [
-@findex global-prev-node
-Move backward through the node structure.  If the node that you are
-currently viewing has a @samp{Prev} pointer, that node is selected.
-Otherwise, if the node has an @samp{Up} pointer, that node is selected,
-and if it has a menu, the last item in the menu is selected.
-@end table
-
-You can get the same behavior as @code{global-next-node} and
-@code{global-prev-node} while simply scrolling through the file with
-@key{SPC} and @key{DEL} (@pxref{scroll-behavior}).
-
-@table @asis
-@anchor{goto-node}
-@item @kbd{g} (@code{goto-node})
-@kindex g
-@findex goto-node
-Read the name of a node and select it.  If the desired node resides in
-some other file, you must type the node as it appears in that Info file,
-and include the name of the other file.  For example,
-
-@example
-@code{g(emacs)Buffers}
-@end example
-
-@noindent
-finds the node @samp{Buffers} in the Info file @file{emacs}.
-
-While reading the node name, completion (@pxref{The Echo Area,
-completion}) is only done for the nodes which reside in one of the Info
-files that were loaded in the current Info session.
-
-@anchor{goto-invocation}
-@item @kbd{O} (@code{goto-invocation})
-@kindex O
-@findex goto-invocation
-@cindex finding the Invocation node
-Read the name of a program and look for a node in the current Info file
-which describes the invocation and the command-line options for that
-program.  The default program name is derived from the name of the
-current Info file.  This command does the same as the
-@samp{--show-options} command-line option (@pxref{--show-options}), but
-it also allows to specify the program name; this is important for those
-manuals which describe several programs.
-
-If you need to find the Invocation node of a program that is documented
-in another Info file, you need to visit that file before invoking
-@samp{O}.  For example, if you are reading the Emacs manual and want to
-see the command-line options of the @code{makeinfo} program, type @kbd{g
-(texinfo) @key{RET}} and then @kbd{I makeinfo @key{RET}}.  If you don't
-know what Info file documents the command, or if invoking @samp{O}
-doesn't display the right node, go to the @samp{(dir)} node (using the
-@samp{d} command) and invoke @samp{O} from there.
-
-@item @kbd{G} (@code{menu-sequence})
-@kindex G
-@findex menu-sequence
-@cindex menu, following, from inside Info
-Read a sequence of menu entries and follow it.  Info prompts for a
-sequence of menu items separated by commas.  (Since commas are not
-allowed in a node name, they are a natural choice for a delimiter in a
-list of menu items.)  Info then looks up the first item in the menu of
-the node @samp{(dir)} (if the @samp{(dir)} node cannot be found, Info
-uses @samp{Top}).  If such an entry is found, Info goes to the node it
-points to and looks up the second item in the menu of that node, etc.
-In other words, you can specify a complete path which descends through
-the menu hierarchy of a particular Info file starting at the
-@samp{(dir)} node.  This has the same effect as if you typed the menu
-item sequence on Info's command line, see @ref{command-line menu items,,
-Info command-line arguments processing}.  For example,
-
-@example
- @kbd{G Texinfo,Overview,Reporting Bugs @key{RET}}
-@end example
-
-@noindent
-displays the node @samp{Reporting Bugs} in the Texinfo manual.  (You
-don't actually need to type the menu items in their full length, or in
-their exact letter-case.  However, if you do type the menu items
-exactly, Info will find it faster.)
-
-If any of the menu items you type are not found, Info stops at the last
-entry it did find and reports an error.
-
-@item @kbd{C-x C-f} (@code{view-file})
-@kindex C-x C-f
-@findex view-file
-Read the name of a file and selects the entire file.  The command
-@example
-@code{C-x C-f @var{filename}}
-@end example
-is equivalent to typing
-@example
-@code{g(@var{filename})*}
-@end example
-
-@item @kbd{C-x C-b} (@code{list-visited-nodes})
-@kindex C-x C-b
-@findex list-visited-nodes
-Make a window containing a menu of all of the currently visited nodes.
-This window becomes the selected window, and you may use the standard
-Info commands within it.
-
-@item @kbd{C-x @kbd{b}} (@code{select-visited-node})
-@kindex C-x b
-@findex select-visited-node
-Select a node which has been previously visited in a visible window.
-This is similar to @samp{C-x C-b} followed by @samp{m}, but no window is
-created.
-
-@item @code{@kbd{M-x} man}
-@findex man
-@cindex man pages, displaying
-Read the name of a man page to load and display.  This uses the @command{man}
-command on your system to retrieve the contents of the requested man page.
-See also @ref{--raw-escapes}.
-
-@end table
-
-
 @node Searching Commands
 @chapter Searching an Info File
 @cindex searching



reply via email to

[Prev in Thread] Current Thread [Next in Thread]