Tweaks.
[official-gcc.git] / texinfo / info / info.1
blobf95687303d221aa11680ff46c9f962418b7873f3
1 .TH info 1 "7th December 1990"
2 .SH NAME
3 info \- GNU's hypertext system
4 .SH SYNOPSIS
5 .B info
7 .B \-\-option-name option-value
9 .B \menu-item...
10 .SH COPYRIGHT
11 .if n Copyright (C) 1989, 1993 Free Software Foundation, Inc.
12 .if t Copyright \(co 1989, 1993 Free Software Foundation, Inc.
13 .SH DESCRIPTION
14 .LP
15 The GNU project has a hypertext system called
16 .I Info
17 which allows the same source file to be either printed as a
18 paper manual, or viewed using
19 .B info.
20 It is possible to use the
21 .B info
22 program from inside Emacs, or to use the stand-alone version described here.
23 This manual page gives a brief summary of its capabilities.
25 .SH OPTIONS
26 .TP
27 .B \-\-directory directory-path
28 Add 
29 .B directory-path 
30 to the list of directory paths searched when
31 .B info
32 needs to find a file.  You may issue 
33 .B \-\-directory 
34 multiple times.
35 Alternatively, you may specify a value for the environment variable
36 .B INFOPATH;
37 if 
38 .B \-\-directory
39 is not given, the value of 
40 .B INFOPATH
41 is used.  The value of 
42 .B INFOPATH 
43 is a colon separated list of directory names.  If you do not supply either
44 .B INFOPATH
46 .B \-\-directory-path,
47 .B info
48 uses a default path.
49 .TP
50 .B \-f filename
51 Specify a particular 
52 .B info
53 file to visit.  By default,
54 .B info
55 visits
56 the file 
57 .B dir;
58 if you use this option, 
59 .B info
60 will start with
61 .B (FILENAME)Top 
62 as the first file and node.
63 .TP
64 .B \-n nodename
65 Specify a particular node to visit in the initial file that 
66 .B info
67 loads.  This is especially useful in conjunction with 
68 .B \-\-file.
69 You may specify 
70 .B \-\-node
71 multiple times.
72 .TP
73 .B -o file
74 Direct output to
75 .B file
76 instead of starting an interactive
77 .B info
78 session.
79 .TP
80 .B \-h
81 Produce a relatively brief description of the available 
82 .B info
83 options.
84 .TP
85 .B \-\-version
86 Print the version information of 
87 .B info
88 and exit.
89 .TP
90 .B menu-item
91 .B info
92 treats its remaining arguments as the names of menu items.
93 The first argument is a menu item in the initial node visited,
94 while the second argument is a menu item in the first argument's
95 node.  You can easily move to the node of your choice by
96 specifying the menu names which describe the path to that node.
97 For example,
99 .B       info emacs buffers
101 first selects the menu item 
102 .B emacs 
103 in the node 
104 .B (dir)Top,
105 and then selects the menu item 
106 .B buffers
107 in the node 
108 .B (emacs)Top.
109 .SH COMMANDS
110 When in
111 .B info
112 the following commands are available:
114 .B h
115 Invoke the Info tutorial.
117 .B ?
118 Get a short summary of
119 .B info
120 commands.
122 .B h
123 Select the
124 .B info
125 node from the main directory; this is much more complete than just
126 using 
127 .B ?.
129 .B Ctrl-g
130 Abort whatever you are doing.
132 .B Ctrl-l
133 Redraw the screen.
135 Selecting other nodes:
137 .B n
138 Move to the "next" node of this node.
140 .B p
141 Move to the "previous" node of this node.
143 .B u
144 Move to this node's "up" node.
146 .B m
147 Pick a menu item specified by name. Picking a menu item causes another
148 node to be selected. You do not need to type a complete nodename; if
149 you type a few letters and then a space or tab
150 .B info
151 will will try to fill in the rest of the nodename. If you ask for further
152 completion without typing any more characters you'll be given a list
153 of possibilities; you can also get the list with 
154 .B ?. 
155 If you type a few characters and then hit return
156 .B info
157 will try to do a completion, and if it is ambigous use the first possibility.
159 .B f
160 Follow a cross reference. You are asked for the name of the reference,
161 using command completion as for
162 .B m.
164 .B l
165 Move to the last node you were at.
167 Moving within a node:
169 .B Space
170 Scroll forward a page.
172 .B DEL
173 Scroll backward a page.
175 .B b
176 Go to the beginning of this node.
178 Advanced commands:
180 .B q
181 Quit 
182 .B info.
184 .B 1
185 Pick first item in node's menu.
187 .B 2 \-\- 5
188 Pick second ... fifth item in node's menu.
190 .B g
191 Move to node specified by name. You may include a filename as well,
192 as 
193 .B (FILENAME)NODENAME.
195 .B s
196 Search through this 
197 .B info
198 file for a specified string, and select the node in which 
199 the next occurrence is found.
201 .B M-x print-node
202 Pipe the contents of the current node through the command in the
203 environment variable 
204 .B INFO_PRINT_COMMAND.
205 If the variable does not exist, the node is simply piped to 
206 .B lpr.
207 .SH ENVIRONMENT
209 .B INFOPATH
210 A colon-separated list of directories to search for 
211 .B info
212 files.  Used if 
213 .B \-\-directory
214 is not given.
216 .B INFO_PRINT_COMMAND
217 The command used for printing.
218 .SH SEE ALSO
219 .BR emacs (1)
220 .SH AUTHOR
222 Brian Fox, Free Software Foundation
224 bfox@ai.mit.edu
225 .SH MANUAL AUTHOR
227 Robert Lupton; updated by Robert J. Chassell.
229 rhl@astro.princeton.edu; bob@gnu.ai.mit.edu