texinfo-commits
[Top][All Lists]
Advanced

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

[5532] info-stnd.texi


From: Gavin D. Smith
Subject: [5532] info-stnd.texi
Date: Thu, 08 May 2014 00:46:44 +0000

Revision: 5532
          http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=5532
Author:   gavin
Date:     2014-05-08 00:46:43 +0000 (Thu, 08 May 2014)
Log Message:
-----------
info-stnd.texi

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/doc/info-stnd.texi

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog     2014-05-07 23:41:49 UTC (rev 5531)
+++ trunk/ChangeLog     2014-05-08 00:46:43 UTC (rev 5532)
@@ -1,5 +1,9 @@
 2014-05-08  Gavin Smith  <address@hidden>
 
+       * doc/info-stnd.texi: Give overview of invocation.
+
+2014-05-08  Gavin Smith  <address@hidden>
+
        * info/info.c (main): If slash in first non-option argument,
        interpret as if it had been passed with --file.
        * info/session.c (info_select_reference): Null check for label

Modified: trunk/doc/info-stnd.texi
===================================================================
--- trunk/doc/info-stnd.texi    2014-05-07 23:41:49 UTC (rev 5531)
+++ trunk/doc/info-stnd.texi    2014-05-08 00:46:43 UTC (rev 5532)
@@ -131,16 +131,62 @@
 @cindex options, command line
 @cindex arguments, command line
 
-GNU Info accepts several options to control the initial node being
-viewed, and to specify which directories to search for Info files.
+GNU Info accepts several options to control the initial node or nodes
+being viewed, and to specify which directories to search for Info files.
 Here is a template showing an invocation of GNU Info from the shell:
 
 @example
-info address@hidden@dots{} address@hidden@dots{}]
+info address@hidden@dots{}] @var{manual} address@hidden@dots{}]
 @end example
 
-The program accepts the following options:
+Info will look for an entry called @var{manual} in the directory
+files it finds in its search path.  For example:
 
address@hidden
+info ls
address@hidden example
+
+This looks for an entry labelled as @code{ls}, and if found, displays the
+referenced file at the location given.
+
+If no entry is found, Info looks for files in its search path with names
+based on @var{manual}; for example, @file{ls.info}.  (To bypass the directory
+lookup and look for Info files by their file name only, use the
address@hidden option, described below.)
+
+If you want to load a file without looking in the search path, specify
address@hidden either as an absolute path, or as a path relative to the
+current directory which contains at least one slash character.  Examples:
+
address@hidden
+info /usr/local/share/info/bash.info
+info ./document.info
address@hidden example
+
+The @var{menu-item} arguments are used to specify a node in the file to 
+be displayed.  Info first tries to follow menus in the file to reach a node.
+For example:
+
address@hidden
+info texinfo Overview 'Using Texinfo'
address@hidden example
+
+This loads the @code{texinfo} file and looks in its top-level menu for a
address@hidden item, looks in the menu of the node referenced, and
+finally displays the node referenced by the @code{Using Texinfo} item.
+
+If there was only one @var{menu-item} argument and it wasn't found as a
+menu item, Info looks for it as an index entry. For example:
+
address@hidden
+info libc printf
address@hidden example
+
+This loads the libc manual and looks for @code{printf} in its indices; and
+if found, displays the file at the relevant location.
+
+A complete list of options follows.
+
 @table @code
 @anchor{--all}
 @item --all




reply via email to

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