[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[5676] document infokey removal
From: |
Gavin D. Smith |
Subject: |
[5676] document infokey removal |
Date: |
Fri, 20 Jun 2014 13:58:38 +0000 |
Revision: 5676
http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=5676
Author: gavin
Date: 2014-06-20 13:58:36 +0000 (Fri, 20 Jun 2014)
Log Message:
-----------
document infokey removal
Modified Paths:
--------------
trunk/ChangeLog
trunk/doc/info-stnd.texi
trunk/util/dir-example
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2014-06-20 08:57:39 UTC (rev 5675)
+++ trunk/ChangeLog 2014-06-20 13:58:36 UTC (rev 5676)
@@ -10,6 +10,8 @@
* info/infokey.c (error_message): Merged into calling code.
+ * NEWS, doc/info-stnd.texi, util/dir-example: Document infokey change.
+
2014-06-19 Gavin Smith <address@hidden>
* info/infokey.c (lookup_action): Use function_doc_array instead of
Modified: trunk/doc/info-stnd.texi
===================================================================
--- trunk/doc/info-stnd.texi 2014-06-20 08:57:39 UTC (rev 5675)
+++ trunk/doc/info-stnd.texi 2014-06-20 13:58:36 UTC (rev 5676)
@@ -44,7 +44,6 @@
@dircategory Texinfo documentation system
@direntry
* info stand-alone: (info-stnd). Read Info documents without Emacs.
-* infokey: (info-stnd)Invoking infokey. Compile Info customizations.
@end direntry
@titlepage
@@ -404,7 +403,8 @@
@anchor{--init-file}
@cindex @code{--init-file} command line option
Read key bindings and variable settings from @var{INIT-FILE} instead
-of the @file{.info} file in your home directory. @xref{Custom Key Bindings}.
+of the @file{.infokey} file in your home directory. @xref{Custom Key
+Bindings}.
@item --node @var{nodename}
@itemx -n @var{nodename}
@@ -2276,68 +2276,36 @@
option rebinds many keys at once; @pxref{--vi-keys}.)
On startup, GNU Info looks for a configuration file in the invoker's
address@hidden directory called @file{.info}, i.e.,
address@hidden/address@hidden to the limitations of DOS filesystems,
-the MS-DOS version of Info looks for a file @file{_info} instead. If
address@hidden directory called @file{.infokey}, i.e.,
address@hidden/address@hidden to the limitations of DOS filesystems,
+the MS-DOS version of Info looks for a file @file{_infokey} instead. If
the @env{HOME} variable is not defined, Info additionally looks in the
-current directory.} If it is present and appears to have been created
-with a compatible version of the @code{infokey} command, then Info
-adopts the key bindings and variable settings contained therein. To
-use an alternative configuration file, use the @option{--init-file}
-option (@pxref{--init-file}).
+current directory.} If it is present, then Info adopts the key bindings
+and variable settings contained therein. To use an alternative
+configuration file, use the @option{--init-file} option
+(@pxref{--init-file}).
-The @file{.info} file contains compact, non-textual data for reasons
-of efficiency---and because its design was lifted wholesale from the
-GNU Less program, which does it that way. It must be created by
-compiling a textual source file using the @code{infokey} command.
-
Variables may also be set on the command line with the
@option{--variable} option (@pxref{variable-assignment}). Variable
-settings on the command line override settings from the @file{.info}
+settings on the command line override settings from the @file{.infokey}
file.
@menu
-* Invoking @t{infokey}::
-* @t{infokey} source format::
+* @t{infokey} format::
@end menu
address@hidden @t{infokey} format
address@hidden @command{infokey} format
address@hidden Invoking @t{infokey}
address@hidden Invoking @command{infokey}
address@hidden @command{infokey} format
address@hidden @file{.infokey} format
address@hidden format of @file{.infokey}
address@hidden invoking @command{infokey}
address@hidden @command{infokey}, invoking
address@hidden @file{_infokey} file (MS-DOS)
+The format of the @file{.infokey} file is most easily illustrated by
+example. For instance, here is a sample init file suitable for aficionados
+of @command{vi} or @command{less}:
-By default, @command{infokey} reads a source file
-(@file{$HOME/.infokey} containing Info customizations. (This file is
-named @file{_infokey} in the MS-DOS version, and is looked for in the
-current directory if @env{HOME} is undefined.) It compiles this into
-a binary format, @file{$HOME/.info} by default. GNU Info reads the
-binary file at startup to override the default key bindings and
-variable definitions. Synopsis:
-
@example
-infokey address@hidden@dots{}] address@hidden
address@hidden example
-
-Besides the standard @option{--help} and @option{--version}, the only
-option is @option{--output @var{file}}. This tells @command{infokey} to
-write the binary data to @var{file} instead of @file{$HOME/.info}.
-
-
address@hidden @t{infokey} source format
address@hidden @command{infokey} source format
-
address@hidden @command{infokey} source format
address@hidden @file{.infokey} source format
address@hidden format of @file{.infokey} source
-
-The format of the source file read by @command{infokey} is most easily
-illustrated by example. For instance, here is a sample @file{.infokey}
-source file suitable for aficionados of @command{vi} or @command{less}:
-
address@hidden
#info
j next-line
k prev-line
@@ -2366,9 +2334,8 @@
scroll-step=1
@end example
-The source file consists of one or more @dfn{sections}.
-Each section starts with a line that identifies the type of section.
-Possible sections are:
+The file consists of one or more @dfn{sections}. Each section starts with
+a line that identifies the type of section. The possible sections are:
@table @code
@item #info
@@ -2447,9 +2414,9 @@
Blank lines and lines starting with @code{#} are ignored, except for
the special section header lines.
-Key bindings defined in the @file{.info} file take precedence over GNU
+Key bindings defined in the @file{.infokey} file take precedence over GNU
Info's default key bindings, whether or not @samp{--vi-keys} is used. A
-default key binding may be disabled by overriding it in the @file{.info}
+default key binding may be disabled by overriding it in the @file{.infokey}
file with the action @code{invalid}. In addition, @emph{all} default
key bindings can be disabled by adding this line @emph{anywhere} in the
relevant section:
@@ -2466,7 +2433,7 @@
necessary actions. Failure to bind any key to the @code{quit} command,
for example, can lead to frustration.
-The order in which key bindings are defined in the @file{.info} file is
+The order in which key bindings are defined in the @file{.infokey} file is
not important, except that the command summary produced by the
@code{get-help-window} command only displays the @emph{first} key that
is bound to each command.
Modified: trunk/util/dir-example
===================================================================
--- trunk/util/dir-example 2014-06-20 08:57:39 UTC (rev 5675)
+++ trunk/util/dir-example 2014-06-20 13:58:36 UTC (rev 5676)
@@ -58,7 +58,6 @@
* Texi2HTML: (texi2html). Texinfo to HTML Converter.
* Texinfo: (texinfo). The GNU documentation format.
* info standalone: (info-stnd). Standalone Info reader.
-* infokey: (info-stnd)Invoking infokey. Compile Info customizations.
* install-info: (texinfo)Invoking install-info. Updating info/dir entries.
* makeinfo: (texinfo)Creating an Info File. Translate Texinfo source.
* texi2dvi: (texinfo)Format with texi2dvi. Printing Texinfo documentation.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [5676] document infokey removal,
Gavin D. Smith <=