1
\input texinfo @c -*-texinfo-*-
1
\input texinfo.tex @c -*-texinfo-*-
2
@comment $Id: info-stnd.texi,v 1.9 2004/12/14 16:58:15 karl Exp $
3
@c We must \input texinfo.tex instead of texinfo, otherwise make
4
@c distcheck in the Texinfo distribution fails, because the texinfo Info
5
@c file is made first, and texi2dvi must include . first in the path.
2
6
@comment %**start of header
3
7
@setfilename info-stnd.info
8
@include version-stnd.texi
9
@settitle GNU Info @value{VERSION}
8
13
@comment %**end of header
9
@comment $Id: info-stnd.texi,v 1.33 2002/03/02 15:03:54 karl Exp $
11
@include version-stnd.texi
16
This manual is for GNU Info (version @value{VERSION}, @value{UPDATED}),
17
a program for viewing documents in Info format (usually created from
18
Texinfo source files).
20
Copyright @copyright{} 1992, 1993, 1996, 1997, 1998, 1999, 2001, 2002,
21
2003, 2004 Free Software Foundation, Inc.
24
Permission is granted to copy, distribute and/or modify this document
25
under the terms of the GNU Free Documentation License, Version 1.1 or
26
any later version published by the Free Software Foundation; with no
27
Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
28
and with the Back-Cover Texts as in (a) below. A copy of the
29
license is included in the section entitled ``GNU Free Documentation
32
(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
33
this GNU Manual, like GNU software. Copies published by the Free
34
Software Foundation raise funds for GNU development.''
13
38
@dircategory Texinfo documentation system
16
41
* infokey: (info-stnd)Invoking infokey. Compile Info customizations.
20
This file documents GNU Info, a program for viewing the on-line formatted
21
versions of Texinfo files. This documentation is different from the
22
documentation for the Info reader that is part of GNU Emacs. If you do
23
not know how to use Info, but have a working Info reader, you should
24
read that documentation first.
26
Copyright @copyright{} 1992, 93, 96, 97, 98, 99,
27
2001, 02 Free Software Foundation, Inc.
29
Permission is granted to make and distribute verbatim copies of this
30
manual provided the copyright notice and this permission notice are
31
preserved on all copies.
34
Permission is granted to process this file through TeX and print the
35
results, provided the printed document carries a copying permission
36
notice identical to this one except for the removal of this paragraph
37
(this paragraph not being relevant to the printed manual).
40
Permission is granted to copy and distribute modified versions of this
41
manual under the conditions for verbatim copying, provided also that the
42
sections entitled ``Copying'' and ``GNU General Public License'' are
43
included exactly as in the original, and provided that the entire
44
resulting derived work is distributed under the terms of a permission
45
notice identical to this one.
47
Permission is granted to copy and distribute translations of this manual
48
into another language, under the above conditions for modified versions,
49
except that this permission notice may be stated in a translation
50
approved by the Free Software Foundation.
55
46
@subtitle for version @value{VERSION}, @value{UPDATED}
56
47
@author Brian J. Fox (bfox@@gnu.org)
58
49
@vskip 0pt plus 1filll
59
Copyright @copyright{} 1992, 93, 97, 98, 99, 2001, 02 Free Software Foundation
61
This manual is for GNU Info version @value{VERSION}, @value{UPDATED}.
63
Permission is granted to make and distribute verbatim copies of this
64
manual provided the copyright notice and this permission notice are
65
preserved on all copies.
67
Permission is granted to copy and distribute modified versions of this
68
manual under the conditions for verbatim copying, provided also that the
69
sections entitled ``Copying'' and ``GNU General Public License'' are
70
included exactly as in the original, and provided that the entire
71
resulting derived work is distributed under the terms of a permission
72
notice identical to this one.
74
Permission is granted to copy and distribute translations of this manual
75
into another language, under the above conditions for modified versions,
76
except that this permission notice may be stated in a translation
77
approved by the Free Software Foundation.
86
This file documents GNU Info, a program for viewing the on-line
87
formatted versions of Texinfo files, version @value{VERSION}. This
88
documentation is different from the documentation for the Info reader
89
that is part of GNU Emacs.
91
This manual is for Info version @value{VERSION}, updated @value{UPDATED}.
61
This documentation is different from the documentation for the Info
62
reader that is part of GNU Emacs. If you do not know how to use Info,
63
but have a working Info reader, you should read the Emacs documentation
64
first, as it includes more background information and a thorough tutorial.
103
76
* Printing Nodes:: How to print out the contents of a node.
104
77
* Miscellaneous Commands:: A few commands that defy categories.
105
78
* Variables:: How to change the default behavior of Info.
106
* Custom Key Bindings:: How to define your own key-to-command
79
* Custom Key Bindings:: How to define your own key-to-command bindings.
80
* Copying This Manual:: The GNU Free Documentation License.
108
81
* Index:: Global index containing keystrokes,
109
82
command names, variable names,
110
83
and general concepts.
231
204
@cindex index search, selecting from the command line
232
205
@cindex online help, using Info as
233
206
After processing all command-line arguments, go to the index in the Info
234
file and search for index entries which matche @var{string}. If such an
207
file and search for index entries which match @var{string}. If such an
235
208
entry is found, the Info session begins with displaying the node pointed
236
209
to by the first matching index entry; press @kbd{,} to step through the
237
210
rest of the matching entries. If no such entry exists, print @samp{no
265
238
interactively viewed. A value of @code{-} for @var{filename} specifies
266
239
the standard output.
268
@cindex colors in man pages
269
@cindex ANSI escape sequences in man pages
241
@cindex colors in documents
242
@cindex ANSI escape sequences in documents
270
243
@item --raw-escapes
244
@itemx --no-raw-escapes
272
Do not remove ANSI escape sequences from man pages. Some versions of
246
Do not remove ANSI escape sequences from documents. Some versions of
273
247
Groff, the GNU document formatter, produce man pages with ANSI escape
274
248
sequences for bold, italics, and underlined characters, and for
275
colorized text. By default, Info removes those escape sequences
276
before it displays the man page. If your terminal supports these
277
escapes, use @code{--raw-escapes} to let the terminal handle them and
278
display the man pages with those attributes.
249
colorized text. By default, Info lets those escape sequences pass
250
through directly to the terminal. If your terminal does not support
251
these escapes, use @code{--no-raw-escapes} to make Info remove them.
280
253
@cindex replaying recorded keystrokes
281
254
@item --restore=@var{dribble-file}
329
302
(@xref{Custom Key Bindings},
330
303
for a more general way of altering GNU Info's key bindings.)
305
@cindex Info manual location
306
@cindex Where is an Info manual?
310
Show the filename that would be read and exit, instead of actually
311
reading it and starting Info.
332
313
@item @var{menu-item}
333
314
@cindex menu, following
334
315
@anchor{command-line menu items}
367
348
@cindex moving the cursor
369
350
Many people find that reading screens of text page by page is made
370
easier when one is able to indicate particular pieces of text with some
371
kind of pointing device. Since this is the case, GNU Info (both the
372
Emacs and standalone versions) have several commands which allow you to
373
move the cursor about the screen. The notation used in this manual to
374
describe keystrokes is identical to the notation used within the Emacs
375
manual, and the GNU Readline manual. @xref{Characters, , Character
376
Conventions, emacs, the GNU Emacs Manual}, if you are unfamiliar with the
378
Here's a short summary. @kbd{C-@var{x}} means press the @kbd{CTRL} key
379
and the key @var{x}. @kbd{M-@var{x}} means press the @kbd{META} key and
380
the key @var{x}. On many terminals th @kbd{META} key is known as the
381
@kbd{ALT} key. @kbd{SPC} is the space bar. The other keys are usually
382
called by the names imprinted on them.}.
351
easier when one is able to indicate particular pieces of text with
352
some kind of pointing device. Since this is the case, GNU Info (both
353
the Emacs and standalone versions) have several commands which allow
354
you to move the cursor about the screen. The notation used in this
355
manual to describe keystrokes is identical to the notation used within
356
the Emacs manual, and the GNU Readline manual. @xref{User Input,,,
357
emacs, the GNU Emacs Manual}, if you are unfamiliar with the
358
notation.@footnote{Here's a short summary. @kbd{C-@var{x}} means
359
press the @kbd{CTRL} key and the key @var{x}. @kbd{M-@var{x}} means
360
press the @kbd{META} key and the key @var{x}. On many terminals th
361
@kbd{META} key is known as the @kbd{ALT} key. @kbd{SPC} is the space
362
bar. The other keys are usually called by the names imprinted on
384
365
The following table lists the basic cursor movement commands in Info.
385
366
Each entry consists of the key sequence you should type to execute the
731
712
You can easily select a node that you have already viewed in this window
732
by using the @samp{l} command -- this name stands for "last", and
713
by using the @samp{l} command---this name stands for ``last'', and
733
714
actually moves backwards through the history of visited nodes for this
734
715
window. This is handy when you followed a reference to another node,
735
716
possibly to read about a related issue, and would like then to resume
1058
1039
lets you use a manual as a reference.
1060
1041
If you don't know what manual documents something, try the @kbd{M-x
1061
index-apropos}. It prompts for a string and then looks up that string
1062
in all the indices of all the Info documents installed on your system.
1063
It can also be invoked from the command line; see @ref{--apropos}.
1042
index-apropos} command. It prompts for a string and then looks up
1043
that string in all the indices of all the Info documents installed on
1044
your system. It can also be invoked from the command line; see
1066
1048
@node Xref Commands
1320
1302
Each window is one half the size of the original window, and the cursor
1321
1303
remains in the original window. The variable @code{automatic-tiling}
1322
1304
can cause all of the windows on the screen to be resized for you
1323
automatically, please @pxref{Variables, , automatic-tiling} for more
1305
automatically (@pxref{Variables, , automatic-tiling}).
1326
1307
@item @kbd{C-x @key{0}} (@code{delete-window})
1327
1308
@cindex windows, deleting
1494
1475
The next group of commands deal with @dfn{killing}, and @dfn{yanking}
1496
1477
Some people are used to calling these operations @dfn{cut} and
1497
@dfn{paste}, respectively.}. For an in depth discussion of killing and
1498
yanking, @pxref{Killing, , Killing and Deleting, emacs, the GNU Emacs
1478
@dfn{paste}, respectively.}. For an in-depth discussion of killing and
1479
yanking, see @ref{Killing, , Killing and Deleting, emacs, the GNU Emacs
1502
1483
@item @key{M-d} (@code{echo-area-kill-word})
1839
1820
@item automatic-footnotes
1840
1821
@vindex automatic-footnotes
1841
When set to @code{On}, footnotes appear and disappear automatically.
1842
This variable is @code{On} by default. When a node is selected, a
1843
window containing the footnotes which appear in that node is created,
1844
and the footnotes are displayed within the new window. The window that
1845
Info creates to contain the footnotes is called @samp{*Footnotes*}. If
1846
a node is selected which contains no footnotes, and a @samp{*Footnotes*}
1847
window is on the screen, the @samp{*Footnotes*} window is deleted.
1848
Footnote windows created in this fashion are not automatically tiled so
1849
that they can use as little of the display as is possible.
1822
When set to @code{On}, footnotes appear and disappear automatically;
1823
else, they appear at the bottom of the node text. This variable is
1824
@code{Off} by default. When a node is selected, a window containing
1825
the footnotes which appear in that node is created, and the footnotes
1826
are displayed within the new window. The window that Info creates to
1827
contain the footnotes is called @samp{*Footnotes*}. If a node is
1828
selected which contains no footnotes, and a @samp{*Footnotes*} window
1829
is on the screen, the @samp{*Footnotes*} window is deleted. Footnote
1830
windows created in this fashion are not automatically tiled so that
1831
they can use as little of the display as is possible.
1851
1833
@item automatic-tiling
1852
1834
@vindex automatic-tiling