freebsd-skq/contrib/texinfo/doc/info.1
2005-05-23 10:46:22 +00:00

90 lines
2.5 KiB
Groff

.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.34.
.TH INFO "1" "December 2004" "info 4.8" "User Commands"
.SH NAME
info \- read Info documents
.SH SYNOPSIS
.B info
[\fIOPTION\fR]... [\fIMENU-ITEM\fR...]
.SH DESCRIPTION
Read documentation in Info format.
.SH OPTIONS
.TP
\fB\-\-apropos\fR=\fISTRING\fR
look up STRING in all indices of all manuals.
.TP
\fB\-d\fR, \fB\-\-directory\fR=\fIDIR\fR
add DIR to INFOPATH.
.TP
\fB\-\-dribble\fR=\fIFILENAME\fR
remember user keystrokes in FILENAME.
.TP
\fB\-f\fR, \fB\-\-file\fR=\fIFILENAME\fR
specify Info file to visit.
.TP
\fB\-h\fR, \fB\-\-help\fR
display this help and exit.
.TP
\fB\-\-index\-search\fR=\fISTRING\fR
go to node pointed by index entry STRING.
.TP
\fB\-n\fR, \fB\-\-node\fR=\fINODENAME\fR
specify nodes in first visited Info file.
.TP
\fB\-o\fR, \fB\-\-output\fR=\fIFILENAME\fR
output selected nodes to FILENAME.
.TP
\fB\-R\fR, \fB\-\-raw\-escapes\fR
output "raw" ANSI escapes (default).
.TP
\fB\-\-no\-raw\-escapes\fR
output escapes as literal text.
.TP
\fB\-\-restore\fR=\fIFILENAME\fR
read initial keystrokes from FILENAME.
.TP
\fB\-O\fR, \fB\-\-show\-options\fR, \fB\-\-usage\fR
go to command\-line options node.
.TP
\fB\-\-subnodes\fR
recursively output menu items.
.TP
\fB\-w\fR, \fB\-\-where\fR, \fB\-\-location\fR
print physical location of Info file.
.TP
\fB\-\-vi\-keys\fR
use vi\-like and less\-like key bindings.
.TP
\fB\-\-version\fR
display version information and exit.
.PP
The first non\-option argument, if present, is the menu entry to start from;
it is searched for in all `dir' files along INFOPATH.
If it is not present, info merges all `dir' files and shows the result.
Any remaining arguments are treated as the names of menu
items relative to the initial node visited.
.SH EXAMPLES
.TP
info
show top\-level dir menu
.TP
info emacs
start at emacs node from top\-level dir
.TP
info emacs buffers
start at buffers node within emacs manual
.TP
info \fB\-\-show\-options\fR emacs
start at node with emacs' command line options
.TP
info \fB\-f\fR ./foo.info
show file ./foo.info, not searching dir
.SH "REPORTING BUGS"
Email bug reports to bug\-texinfo@gnu.org,
general questions and discussion to help\-texinfo@gnu.org.
Texinfo home page: http://www.gnu.org/software/texinfo/
.SH COPYRIGHT
Copyright \(co 2004 Free Software Foundation, Inc.
There is NO warranty. You may redistribute this software
under the terms of the GNU General Public License.
For more information about these matters, see the files named COPYING.