Mercurial > hg > xemacs-beta
comparison man/info-stnd.texi @ 70:131b0175ea99 r20-0b30
Import from CVS: tag r20-0b30
author | cvs |
---|---|
date | Mon, 13 Aug 2007 09:02:59 +0200 |
parents | ee648375d8d6 |
children | 2d532a89d707 |
comparison
equal
deleted
inserted
replaced
69:804d1389bcd6 | 70:131b0175ea99 |
---|---|
1 \input texinfo @c -*-texinfo-*- | 1 @c This file is meant to be included in any arbitrary piece of |
2 @comment %**start of header | 2 @c documentation that wishes to describe the info program. |
3 @setfilename info-stnd.info | 3 @c |
4 @settitle GNU Info | 4 @c This file documents the use of the standalone GNU Info program, |
5 @set InfoProgVer 2.11 | 5 @c versions 2.7 and later. It was authored by Brian Fox (bfox@ai.mit.edu). |
6 @paragraphindent none | 6 |
7 @footnotestyle end | 7 @ifclear InfoProgVer |
8 @set InfoProgVer 2.10 | |
9 @end ifclear | |
8 @synindex vr cp | 10 @synindex vr cp |
9 @synindex fn cp | 11 @synindex fn cp |
10 @synindex ky cp | 12 @synindex ky cp |
11 @comment %**end of header | 13 |
12 @comment $Id: info-stnd.texi,v 1.2 1997/08/30 03:56:39 steve Exp $ | 14 @heading What is Info? |
13 | 15 |
14 @dircategory Texinfo documentation system | 16 This text documents the use of the GNU Info program, version |
15 @direntry | 17 @value{InfoProgVer}. |
16 * info program: (info-stnd). Standalone Info-reading program. | 18 |
17 @end direntry | 19 @dfn{Info} is a program which is used to view info files on an ASCII |
18 | 20 terminal. @dfn{info files} are the result of processing texinfo files |
19 @ifinfo | 21 with the program @code{makeinfo} or with the Emacs command @code{M-x |
20 This file documents GNU Info, a program for viewing the on-line formatted | 22 texinfo-format-buffer}. Finally, @dfn{texinfo} is a documentation |
21 versions of Texinfo files. This documentation is different from the | 23 language which allows a printed manual and online documentation (an info |
22 documentation for the Info reader that is part of GNU Emacs. If you do | 24 file) to be produced from a single source file. |
23 not know how to use Info, but have a working Info reader, you should | |
24 read that documentation first. | |
25 | |
26 Copyright @copyright{} 1992, 93, 96, 97 Free Software Foundation, Inc. | |
27 | |
28 Permission is granted to make and distribute verbatim copies of this | |
29 manual provided the copyright notice and this permission notice are | |
30 preserved on all copies. | |
31 | |
32 @ignore | |
33 Permission is granted to process this file through TeX and print the | |
34 results, provided the printed document carries a copying permission | |
35 notice identical to this one except for the removal of this paragraph | |
36 (this paragraph not being relevant to the printed manual). | |
37 @end ignore | |
38 | |
39 Permission is granted to copy and distribute modified versions of this | |
40 manual under the conditions for verbatim copying, provided also that the | |
41 sections entitled ``Copying'' and ``GNU General Public License'' are | |
42 included exactly as in the original, and provided that the entire | |
43 resulting derived work is distributed under the terms of a permission | |
44 notice identical to this one. | |
45 | |
46 Permission is granted to copy and distribute translations of this manual | |
47 into another language, under the above conditions for modified versions, | |
48 except that this permission notice may be stated in a translation | |
49 approved by the Free Software Foundation. | |
50 @end ifinfo | |
51 | |
52 @titlepage | |
53 @title GNU Info User's Guide | |
54 @subtitle For GNU Info version @value{InfoProgVer} | |
55 @author Brian J. Fox (bfox@@ai.mit.edu) | |
56 @page | |
57 @vskip 0pt plus 1filll | |
58 Copyright @copyright{} 1992, 1993, 1997 Free Software Foundation | |
59 | |
60 Permission is granted to make and distribute verbatim copies of this | |
61 manual provided the copyright notice and this permission notice are | |
62 preserved on all copies. | |
63 | |
64 Permission is granted to copy and distribute modified versions of this | |
65 manual under the conditions for verbatim copying, provided also that the | |
66 sections entitled ``Copying'' and ``GNU General Public License'' are | |
67 included exactly as in the original, and provided that the entire | |
68 resulting derived work is distributed under the terms of a permission | |
69 notice identical to this one. | |
70 | |
71 Permission is granted to copy and distribute translations of this manual | |
72 into another language, under the above conditions for modified versions, | |
73 except that this permission notice may be stated in a translation | |
74 approved by the Free Software Foundation. | |
75 @end titlepage | |
76 | |
77 @ifinfo | |
78 @node Top, What is Info, , (dir) | |
79 @top The GNU Info Program | |
80 | |
81 This file documents GNU Info, a program for viewing the on-line | |
82 formatted versions of Texinfo files, version @value{InfoProgVer}. This | |
83 documentation is different from the documentation for the Info reader | |
84 that is part of GNU Emacs. | |
85 @end ifinfo | |
86 | 25 |
87 @menu | 26 @menu |
88 * What is Info:: | 27 * Options:: Options you can pass on the command line. |
89 * Options:: Options you can pass on the command line. | 28 * Cursor Commands:: Commands which move the cursor within a node. |
90 * Cursor Commands:: Commands which move the cursor within a node. | 29 * Scrolling Commands:: Commands for moving the node around in a window. |
91 * Scrolling Commands:: Commands for moving the node around | 30 * Node Commands:: Commands for selecting a new node. |
92 in a window. | 31 * Searching Commands:: Commands for searching an info file. |
93 * Node Commands:: Commands for selecting a new node. | 32 * Xref Commands:: Commands for selecting cross references. |
94 * Searching Commands:: Commands for searching an Info file. | 33 * Window Commands:: Commands which manipulate multiple windows. |
95 * Xref Commands:: Commands for selecting cross references. | 34 * Printing Nodes:: How to print out the contents of a node. |
96 * Window Commands:: Commands which manipulate multiple windows. | 35 * Miscellaneous Commands:: A few commands that defy categories. |
97 * Printing Nodes:: How to print out the contents of a node. | 36 * Variables:: How to change the default behaviour of Info. |
98 * Miscellaneous Commands:: A few commands that defy categories. | 37 @ifset NOTSET |
99 * Variables:: How to change the default behavior of Info. | 38 * Info for Sys Admins:: How to setup Info. Using special options. |
100 * GNU Info Global Index:: Global index containing keystrokes, | 39 @end ifset |
101 command names, variable names, | 40 @ifset STANDALONE |
102 and general concepts. | 41 * GNU Info Global Index:: Global index containing keystrokes, command names, |
42 variable names, and general concepts. | |
43 @end ifset | |
103 @end menu | 44 @end menu |
104 | 45 |
105 @node What is Info, Options, Top, Top | 46 @node Options |
106 @chapter What is Info? | |
107 | |
108 @iftex | |
109 This file documents GNU Info, a program for viewing the on-line formatted | |
110 versions of Texinfo files, version @value{InfoProgVer}. | |
111 @end iftex | |
112 | |
113 @dfn{Info} is a program which is used to view Info files on an ASCII | |
114 terminal. @dfn{Info files} are the result of processing Texinfo files | |
115 with the program @code{makeinfo} or with one of the Emacs commands, such | |
116 as @code{M-x texinfo-format-buffer}. Texinfo itself is a documentation | |
117 system that uses a single source file to produce both on-line | |
118 information and printed output. You can typeset and print the | |
119 files that you read in Info.@refill | |
120 | |
121 @node Options, Cursor Commands, What is Info, Top | |
122 @chapter Command Line Options | 47 @chapter Command Line Options |
123 @cindex command line options | 48 @cindex command line options |
124 @cindex arguments, command line | 49 @cindex arguments, command line |
125 | 50 |
126 GNU Info accepts several options to control the initial node being | 51 GNU Info accepts several options to control the initial node being |
127 viewed, and to specify which directories to search for Info files. Here | 52 viewed, and to specify which directories to search for info files. Here |
128 is a template showing an invocation of GNU Info from the shell: | 53 is a template showing an invocation of GNU Info from the shell: |
129 | 54 |
130 @example | 55 @example |
131 info [--@var{option-name} @var{option-value}] @var{menu-item}@dots{} | 56 info [--@var{option-name} @var{option-value}] @var{menu-item}@dots{} |
132 @end example | 57 @end example |
136 | 61 |
137 @table @code | 62 @table @code |
138 @cindex directory path | 63 @cindex directory path |
139 @item --directory @var{directory-path} | 64 @item --directory @var{directory-path} |
140 @itemx -d @var{directory-path} | 65 @itemx -d @var{directory-path} |
141 Add @var{directory-path} to the list of directory paths searched when | 66 Adds @var{directory-path} to the list of directory paths searched when |
142 Info needs to find a file. You may issue @code{--directory} multiple | 67 Info needs to find a file. You may issue @code{--directory} multiple |
143 times; once for each directory which contains Info files. | 68 times; once for each directory which contains info files. |
144 Alternatively, you may specify a value for the environment variable | 69 Alternatively, you may specify a value for the environment variable |
145 @code{INFOPATH}; if @code{--directory} is not given, the value of | 70 @code{INFOPATH}; if @code{--directory} is not given, the value of |
146 @code{INFOPATH} is used. The value of @code{INFOPATH} is a colon | 71 @code{INFOPATH} is used. The value of @code{INFOPATH} is a colon |
147 separated list of directory names. If you do not supply @code{INFOPATH} | 72 separated list of directory names. If you do not supply |
148 or @code{--directory-path}, Info uses a default path. | 73 @code{INFOPATH} or @code{--directory-path} a default path is used. |
149 | 74 |
150 @item --file @var{filename} | 75 @item --file @var{filename} |
151 @itemx -f @var{filename} | 76 @itemx -f @var{filename} |
152 @cindex Info file, selecting | 77 @cindex info file, selecting |
153 Specify a particular Info file to visit. By default, Info visits | 78 Specifies a particular info file to visit. Instead of visiting the file |
154 the file @code{dir}; if you use this option, Info will start with | 79 @code{dir}, Info will start with @code{(@var{filename})Top} as the first |
155 @code{(@var{filename})Top} as the first file and node. | 80 file and node. |
156 | |
157 @item --index-search @var{string} | |
158 @cindex index search, selecting | |
159 @cindex online help, using Info as | |
160 Go to the index entry @var{string} in the Info file specified with | |
161 @samp{--file}. If no such entry, print @samp{no entries found} and exit | |
162 with nonzero status. This can used from another program as a way to | |
163 provide online help. | |
164 | 81 |
165 @item --node @var{nodename} | 82 @item --node @var{nodename} |
166 @itemx -n @var{nodename} | 83 @itemx -n @var{nodename} |
167 @cindex node, selecting | 84 @cindex node, selecting |
168 Specify a particular node to visit in the initial file that Info | 85 Specifies a particular node to visit in the initial file loaded. This |
169 loads. This is especially useful in conjunction with | 86 is especially useful in conjunction with @code{--file}@footnote{Of |
170 @code{--file}@footnote{Of course, you can specify both the file and node | 87 course, you can specify both the file and node in a @code{--node} |
171 in a @code{--node} command; but don't forget to escape the open and | 88 command; but don't forget to escape the open and close parentheses from |
172 close parentheses from the shell as in: @code{info --node | 89 the shell as in: @code{info --node '(emacs)Buffers'}}. You may specify |
173 "(emacs)Buffers"}}. You may specify @code{--node} multiple times; for | 90 @code{--node} multiple times; for an interactive Info, each |
174 an interactive Info, each @var{nodename} is visited in its own window, | 91 @var{nodename} is visited in its own window, for a non-interactive Info |
175 for a non-interactive Info (such as when @code{--output} is given) each | 92 (such as when @code{--output} is given) each @var{nodename} is processed |
176 @var{nodename} is processed sequentially. | 93 sequentially. |
177 | 94 |
178 @item --output @var{filename} | 95 @item --output @var{filename} |
179 @itemx -o @var{filename} | 96 @itemx -o @var{filename} |
180 @cindex file, outputting to | 97 @cindex file, outputting to |
181 @cindex outputting to a file | 98 @cindex outputting to a file |
182 Specify @var{filename} as the name of a file to which to direct output. | 99 Specify @var{filename} as the name of a file to output to. Each node |
183 Each node that Info visits will be output to @var{filename} instead of | 100 that Info visits will be output to @var{filename} instead of |
184 interactively viewed. A value of @code{-} for @var{filename} specifies | 101 interactively viewed. A value of @code{-} for @var{filename} specifies |
185 the standard output. | 102 the standard output. |
186 | 103 |
187 @item --subnodes | 104 @item --subnodes |
188 @cindex @code{--subnodes}, command line option | 105 @cindex @code{--subnodes}, command line option |
189 This option only has meaning when given in conjunction with | 106 This option only has meaning when given in conjunction with |
190 @code{--output}. It means to recursively output the nodes appearing in | 107 @code{--output}. It means to recursively output the nodes appearing in |
191 the menus of each node being output. Menu items which resolve to | 108 the menus of each node being output. Menu items which resolve to |
192 external Info files are not output, and neither are menu items which are | 109 external info files are not output, and neither are menu items which are |
193 members of an index. Each node is only output once. | 110 members of an index. Each node is only output once. |
194 | 111 |
195 @item --help | 112 @item --help |
196 @itemx -h | 113 @itemx -h |
197 Produces a relatively brief description of the available Info options. | 114 Produces a relatively brief description of the available Info options. |
200 @cindex version information | 117 @cindex version information |
201 Prints the version information of Info and exits. | 118 Prints the version information of Info and exits. |
202 | 119 |
203 @item @var{menu-item} | 120 @item @var{menu-item} |
204 @cindex menu, following | 121 @cindex menu, following |
205 Info treats its remaining arguments as the names of menu items. The | 122 Remaining arguments to Info are treated as the names of menu items. The |
206 first argument is a menu item in the initial node visited, while | 123 first argument would be a menu item in the initial node visited, while |
207 the second argument is a menu item in the first argument's node. | 124 the second argument would be a menu item in the first argument's node. |
208 You can easily move to the node of your choice by specifying the menu | 125 You can easily move to the node of your choice by specifying the menu |
209 names which describe the path to that node. For example, | 126 names which describe the path to that node. For example, |
210 | 127 |
211 @example | 128 @example |
212 info emacs buffers | 129 info emacs buffers |
213 @end example | 130 @end example |
214 | 131 |
215 @noindent | |
216 first selects the menu item @samp{Emacs} in the node @samp{(dir)Top}, | 132 first selects the menu item @samp{Emacs} in the node @samp{(dir)Top}, |
217 and then selects the menu item @samp{Buffers} in the node | 133 and then selects the menu item @samp{Buffers} in the node |
218 @samp{(emacs)Top}. | 134 @samp{(emacs)Top}. |
219 @end table | 135 |
220 | 136 @end table |
221 @node Cursor Commands, Scrolling Commands, Options, Top | 137 |
138 @node Cursor Commands | |
222 @chapter Moving the Cursor | 139 @chapter Moving the Cursor |
223 @cindex cursor, moving | 140 @cindex cursor, moving |
224 | |
225 Many people find that reading screens of text page by page is made | 141 Many people find that reading screens of text page by page is made |
226 easier when one is able to indicate particular pieces of text with some | 142 easier when one is able to indicate particular pieces of text with some |
227 kind of pointing device. Since this is the case, GNU Info (both the | 143 kind of pointing device. Since this is the case, GNU Info (both the |
228 Emacs and standalone versions) have several commands which allow you to | 144 Emacs and standalone versions) have several commands which allow you to |
229 move the cursor about the screen. The notation used in this manual to | 145 move the cursor about the screen. The notation used in this manual to |
230 describe keystrokes is identical to the notation used within the Emacs | 146 describe keystrokes is identical to the notation used within the Emacs |
231 manual, and the GNU Readline manual. @xref{Characters, , Character | 147 manual, and the GNU Readline manual. @xref{Characters, , Character |
232 Conventions, emacs, the GNU Emacs Manual}, if you are unfamiliar with the | 148 Conventions, emacs, the GNU Emacs Manual}, if you are unfamilar with the |
233 notation. | 149 notation. |
234 | 150 |
235 The following table lists the basic cursor movement commands in Info. | 151 The following table lists the basic cursor movement commands in Info. |
236 Each entry consists of the key sequence you should type to execute the | 152 Each entry consists of the key sequence you should type to execute the |
237 cursor movement, the @code{M-x}@footnote{@code{M-x} is also a command; it | 153 cursor movement, the @code{M-x}@footnote{@code{M-x} is also a command; it |
250 | 166 |
251 @table @asis | 167 @table @asis |
252 @item @code{C-n} (@code{next-line}) | 168 @item @code{C-n} (@code{next-line}) |
253 @kindex C-n | 169 @kindex C-n |
254 @findex next-line | 170 @findex next-line |
255 Move the cursor down to the next line. | 171 Moves the cursor down to the next line. |
256 | 172 |
257 @item @code{C-p} (@code{prev-line}) | 173 @item @code{C-p} (@code{prev-line}) |
258 @kindex C-p | 174 @kindex C-p |
259 @findex prev-line | 175 @findex prev-line |
260 Move the cursor up to the previous line. | 176 Move the cursor up to the previous line. |
265 Move the cursor to the start of the current line. | 181 Move the cursor to the start of the current line. |
266 | 182 |
267 @item @code{C-e} (@code{end-of-line}) | 183 @item @code{C-e} (@code{end-of-line}) |
268 @kindex C-e, in Info windows | 184 @kindex C-e, in Info windows |
269 @findex end-of-line | 185 @findex end-of-line |
270 Move the cursor to the end of the current line. | 186 Moves the cursor to the end of the current line. |
271 | 187 |
272 @item @code{C-f} (@code{forward-char}) | 188 @item @code{C-f} (@code{forward-char}) |
273 @kindex C-f, in Info windows | 189 @kindex C-f, in Info windows |
274 @findex forward-char | 190 @findex forward-char |
275 Move the cursor forward a character. | 191 Move the cursor forward a character. |
280 Move the cursor backward a character. | 196 Move the cursor backward a character. |
281 | 197 |
282 @item @code{M-f} (@code{forward-word}) | 198 @item @code{M-f} (@code{forward-word}) |
283 @kindex M-f, in Info windows | 199 @kindex M-f, in Info windows |
284 @findex forward-word | 200 @findex forward-word |
285 Move the cursor forward a word. | 201 Moves the cursor forward a word. |
286 | 202 |
287 @item @code{M-b} (@code{backward-word}) | 203 @item @code{M-b} (@code{backward-word}) |
288 @kindex M-b, in Info windows | 204 @kindex M-b, in Info winows |
289 @findex backward-word | 205 @findex backward-word |
290 Move the cursor backward a word. | 206 Moves the cursor backward a word. |
291 | 207 |
292 @item @code{M-<} (@code{beginning-of-node}) | 208 @item @code{M-<} (@code{beginning-of-node}) |
293 @itemx @code{b} | 209 @itemx @code{b} |
294 @kindex b, in Info windows | 210 @kindex b, in Info winows |
295 @kindex M-< | 211 @kindex M-< |
296 @findex beginning-of-node | 212 @findex beginning-of-node |
297 Move the cursor to the start of the current node. | 213 Moves the cursor to the start of the current node. |
298 | 214 |
299 @item @code{M->} (@code{end-of-node}) | 215 @item @code{M->} (@code{end-of-node}) |
300 @kindex M-> | 216 @kindex M-> |
301 @findex end-of-node | 217 @findex end-of-node |
302 Move the cursor to the end of the current node. | 218 Moves the cursor to the end of the current node. |
303 | 219 |
304 @item @code{M-r} (@code{move-to-window-line}) | 220 @item @code{M-r} (@code{move-to-window-line}) |
305 @kindex M-r | 221 @kindex M-r |
306 @findex move-to-window-line | 222 @findex move-to-window-line |
307 Move the cursor to a specific line of the window. Without a numeric | 223 Moves the cursor to a specific line of the window. Without a numeric |
308 argument, @code{M-r} moves the cursor to the start of the line in the | 224 argument, @code{M-r} moves the cursor to the start of the line in the |
309 center of the window. With a numeric argument of @var{n}, @code{M-r} | 225 center of the window. With a numeric argument of @var{n}, @code{M-r} |
310 moves the cursor to the start of the @var{n}th line in the window. | 226 moves the cursor to the start of the @var{n}th line in the window. |
311 @end table | 227 @end table |
312 | 228 |
313 @node Scrolling Commands, Node Commands, Cursor Commands, Top | 229 @node Scrolling Commands |
314 @chapter Moving Text Within a Window | 230 @chapter Moving Text Within a Window |
315 @cindex scrolling | 231 @cindex scrolling |
316 | 232 |
317 Sometimes you are looking at a screenful of text, and only part of the | 233 Sometimes you are looking at a screenful of text, and only part of the |
318 current paragraph you are reading is visible on the screen. The | 234 current paragraph you are reading is visible on the screen. The |
339 @kindex DEL, in Info windows | 255 @kindex DEL, in Info windows |
340 @kindex M-v | 256 @kindex M-v |
341 @findex scroll-backward | 257 @findex scroll-backward |
342 Shift the text in this window down. The inverse of | 258 Shift the text in this window down. The inverse of |
343 @code{scroll-forward}. | 259 @code{scroll-forward}. |
260 | |
344 @end table | 261 @end table |
345 | 262 |
346 @cindex scrolling through node structure | 263 @cindex scrolling through node structure |
347 The @code{scroll-forward} and @code{scroll-backward} commands can also | 264 The @code{scroll-forward} and @code{scroll-backward} commands can also |
348 move forward and backward through the node structure of the file. If | 265 move forward and backward through the node structure of the file. If |
349 you press @key{SPC} while viewing the end of a node, or @key{DEL} while | 266 you press @key{SPC} while viewing the end of a node, or @key{DEL} while |
350 viewing the beginning of a node, what happens is controlled by the | 267 viewing the beginning of a node, what happens is controlled by the |
351 variable @code{scroll-behavior}. @xref{Variables, | 268 variable @code{scroll-behaviour}. @xref{Variables, |
352 @code{scroll-behavior}}, for more information. | 269 @code{scroll-behaviour}}, for more information. |
353 | 270 |
354 @table @asis | 271 @table @asis |
355 @item @code{C-l} (@code{redraw-display}) | 272 @item @code{C-l} (@code{redraw-display}) |
356 @kindex C-l | 273 @kindex C-l |
357 @findex redraw-display | 274 @findex redraw-display |
373 space than one screen width to display is displayed, a @samp{$} appears | 290 space than one screen width to display is displayed, a @samp{$} appears |
374 in the rightmost column of the screen, and the remainder of the line is | 291 in the rightmost column of the screen, and the remainder of the line is |
375 invisible. | 292 invisible. |
376 @end table | 293 @end table |
377 | 294 |
378 @node Node Commands, Searching Commands, Scrolling Commands, Top | 295 @node Node Commands |
379 @chapter Selecting a New Node | 296 @chapter Selecting a New Node |
380 @cindex nodes, selection of | 297 @cindex nodes, selection of |
381 | 298 |
382 This section details the numerous Info commands which select a new node | 299 This section details the numerous Info commands which select a new node |
383 to view in the current window. | 300 to view in the current window. |
392 | 309 |
393 @table @asis | 310 @table @asis |
394 @item @code{n} (@code{next-node}) | 311 @item @code{n} (@code{next-node}) |
395 @kindex n | 312 @kindex n |
396 @findex next-node | 313 @findex next-node |
397 Select the `Next' node. | 314 Selects the `Next' node. |
398 | 315 |
399 @item @code{p} (@code{prev-node}) | 316 @item @code{p} (@code{prev-node}) |
400 @kindex p | 317 @kindex p |
401 @findex prev-node | 318 @findex prev-node |
402 Select the `Prev' node. | 319 Selects the `Prev' node. |
403 | 320 |
404 @item @code{u} (@code{up-node}) | 321 @item @code{u} (@code{up-node}) |
405 @kindex u | 322 @kindex u |
406 @findex up-node | 323 @findex up-node |
407 Select the `Up' node. | 324 Selects the `Up' node. |
408 @end table | 325 @end table |
409 | 326 |
410 You can easily select a node that you have already viewed in this window | 327 You can easily select a node that you have already viewed in this window |
411 by using the @samp{l} command -- this name stands for "last", and | 328 by using the @samp{l} command -- this name stands for "last", and |
412 actually moves through the list of already visited nodes for this | 329 actually moves through the list of already visited nodes for this |
416 | 333 |
417 @table @asis | 334 @table @asis |
418 @item @code{l} (@code{history-node}) | 335 @item @code{l} (@code{history-node}) |
419 @kindex l | 336 @kindex l |
420 @findex history-node | 337 @findex history-node |
421 Select the most recently selected node in this window. | 338 Selects the most recently selected node in this window. |
422 @end table | 339 @end table |
423 | 340 |
424 Two additional commands make it easy to select the most commonly | 341 Two additional commands make it easy to select the most commonly |
425 selected nodes; they are @samp{t} and @samp{d}. | 342 selected nodes; they are @samp{t} and @samp{d}. |
426 | 343 |
427 @table @asis | 344 @table @asis |
428 @item @code{t} (@code{top-node}) | 345 @item @code{t} (@code{top-node}) |
429 @kindex t | 346 @kindex t |
430 @findex top-node | 347 @findex top-node |
431 Select the node @samp{Top} in the current Info file. | 348 Selects the node @samp{Top} in the current info file. |
432 | 349 |
433 @item @code{d} (@code{dir-node}) | 350 @item @code{d} (@code{dir-node}) |
434 @kindex d | 351 @kindex d |
435 @findex dir-node | 352 @findex dir-node |
436 Select the directory node (i.e., the node @samp{(dir)}). | 353 Selects the directory node (i.e., the node @samp{(dir)}). |
437 @end table | 354 @end table |
438 | 355 |
439 Here are some other commands which immediately result in the selection | 356 Here are some other commands which immediately result in the selection |
440 of a different node in the current window: | 357 of a different node in the current window: |
441 | 358 |
442 @table @asis | 359 @table @asis |
443 @item @code{<} (@code{first-node}) | 360 @item @code{<} (@code{first-node}) |
444 @kindex < | 361 @kindex < |
445 @findex first-node | 362 @findex first-node |
446 Selects the first node which appears in this file. This node is most | 363 Selects the first node which appears in this file. This node is most |
447 often @samp{Top}, but it does not have to be. | 364 often @samp{Top}, but it doesn't have to be. |
448 | 365 |
449 @item @code{>} (@code{last-node}) | 366 @item @code{>} (@code{last-node}) |
450 @kindex > | 367 @kindex > |
451 @findex last-node | 368 @findex last-node |
452 Select the last node which appears in this file. | 369 Selects the last node which appears in this file. |
453 | 370 |
454 @item @code{]} (@code{global-next-node}) | 371 @item @code{]} (@code{global-next-node}) |
455 @kindex ] | 372 @kindex ] |
456 @findex global-next-node | 373 @findex global-next-node |
457 Move forward or down through node structure. If the node that you are | 374 Moves forward or down through node structure. If the node that you are |
458 currently viewing has a @samp{Next} pointer, that node is selected. | 375 currently viewing has a @samp{Next} pointer, that node is selected. |
459 Otherwise, if this node has a menu, the first menu item is selected. If | 376 Otherwise, if this node has a menu, the first menu item is selected. If |
460 there is no @samp{Next} and no menu, the same process is tried with the | 377 there is no @samp{Next} and no menu, the same process is tried with the |
461 @samp{Up} node of this node. | 378 @samp{Up} node of this node. |
462 | 379 |
463 @item @code{[} (@code{global-prev-node}) | 380 @item @code{[} (@code{global-prev-node}) |
464 @kindex [ | 381 @kindex [ |
465 @findex global-prev-node | 382 @findex global-prev-node |
466 Move backward or up through node structure. If the node that you are | 383 Moves backward or up through node structure. If the node that you are |
467 currently viewing has a @samp{Prev} pointer, that node is selected. | 384 currently viewing has a @samp{Prev} pointer, that node is selected. |
468 Otherwise, if the node has an @samp{Up} pointer, that node is selected, | 385 Otherwise, if the node has an @samp{Up} pointer, that node is selected, |
469 and if it has a menu, the last item in the menu is selected. | 386 and if it has a menu, the last item in the menu is selected. |
470 @end table | 387 @end table |
471 | 388 |
472 You can get the same behavior as @code{global-next-node} and | 389 You can get the same behaviour as @code{global-next-node} and |
473 @code{global-prev-node} while simply scrolling through the file with | 390 @code{global-prev-node} while simply scrolling through the file with |
474 @key{SPC} and @key{DEL}; @xref{Variables, @code{scroll-behavior}}, for | 391 @key{SPC} and @key{DEL}; @xref{Variables, @code{scroll-behaviour}}, for |
475 more information. | 392 more information. |
476 | 393 |
477 @table @asis | 394 @table @asis |
478 @item @code{g} (@code{goto-node}) | 395 @item @code{g} (@code{goto-node}) |
479 @kindex g | 396 @kindex g |
480 @findex goto-node | 397 @findex goto-node |
481 Read the name of a node and select it. No completion is done while | 398 Reads the name of a node and selects it. No completion is done while |
482 reading the node name, since the desired node may reside in a separate | 399 reading the node name, since the desired node may reside in a separate |
483 file. The node must be typed exactly as it appears in the Info file. A | 400 file. The node must be typed exactly as it appears in the info file. A |
484 file name may be included as with any node specification, for example | 401 file name may be included as with any node specification, for example |
485 | 402 |
486 @example | 403 @example |
487 @code{g(emacs)Buffers} | 404 @code{g(emacs)Buffers} |
488 @end example | 405 @end example |
489 | 406 |
490 finds the node @samp{Buffers} in the Info file @file{emacs}. | 407 finds the node @samp{Buffers} in the info file @file{emacs}. |
491 | 408 |
492 @item @code{C-x k} (@code{kill-node}) | 409 @item @code{C-x k} (@code{kill-node}) |
493 @kindex C-x k | 410 @kindex C-x k |
494 @findex kill-node | 411 @findex kill-node |
495 Kill a node. The node name is prompted for in the echo area, with a | 412 Kills a node. The node name is prompted for in the echo area, with a |
496 default of the current node. @dfn{Killing} a node means that Info tries | 413 default of the current node. @dfn{Killing} a node means that Info tries |
497 hard to forget about it, removing it from the list of history nodes kept | 414 hard to forget about it, removing it from the list of history nodes kept |
498 for the window where that node is found. Another node is selected in | 415 for the window where that node is found. Another node is selected in |
499 the window which contained the killed node. | 416 the window which contained the killed node. |
500 | 417 |
501 @item @code{C-x C-f} (@code{view-file}) | 418 @item @code{C-x C-f} (@code{view-file}) |
502 @kindex C-x C-f | 419 @kindex C-x C-f |
503 @findex view-file | 420 @findex view-file |
504 Read the name of a file and selects the entire file. The command | 421 Reads the name of a file and selects the entire file. The command |
505 @example | 422 @example |
506 @code{C-x C-f @var{filename}} | 423 @code{C-x C-f @var{filename}} |
507 @end example | 424 @end example |
508 is equivalent to typing | 425 is equivalent to typing |
509 @example | 426 @example |
511 @end example | 428 @end example |
512 | 429 |
513 @item @code{C-x C-b} (@code{list-visited-nodes}) | 430 @item @code{C-x C-b} (@code{list-visited-nodes}) |
514 @kindex C-x C-b | 431 @kindex C-x C-b |
515 @findex list-visited-nodes | 432 @findex list-visited-nodes |
516 Make a window containing a menu of all of the currently visited nodes. | 433 Makes a window containing a menu of all of the currently visited nodes. |
517 This window becomes the selected window, and you may use the standard | 434 This window becomes the selected window, and you may use the standard |
518 Info commands within it. | 435 Info commands within it. |
519 | 436 |
520 @item @code{C-x b} (@code{select-visited-node}) | 437 @item @code{C-x b} (@code{select-visited-node}) |
521 @kindex C-x b | 438 @kindex C-x b |
522 @findex select-visited-node | 439 @findex select-visited-node |
523 Select a node which has been previously visited in a visible window. | 440 Selects a node which has been previously visited in a visible window. |
524 This is similar to @samp{C-x C-b} followed by @samp{m}, but no window is | 441 This is similar to @samp{C-x C-b} followed by @samp{m}, but no window is |
525 created. | 442 created. |
526 @end table | 443 @end table |
527 | 444 |
528 @node Searching Commands, Xref Commands, Node Commands, Top | 445 @node Searching Commands |
529 @chapter Searching an Info File | 446 @chapter Searching an Info File |
530 @cindex searching | 447 @cindex searching |
531 | 448 |
532 GNU Info allows you to search for a sequence of characters throughout an | 449 GNU Info allows you to search for a sequence of characters throughout an |
533 entire Info file, search through the indices of an Info file, or find | 450 entire info file, search through the indices of an info file, or find |
534 areas within an Info file which discuss a particular topic. | 451 areas within an info file which discuss a particular topic. |
535 | 452 |
536 @table @asis | 453 @table @asis |
537 @item @code{s} (@code{search}) | 454 @item @code{s} (@code{search}) |
538 @kindex s | 455 @kindex s |
539 @findex search | 456 @findex search |
540 Read a string in the echo area and search for it. | 457 Reads a string in the echo area and searches for it. |
541 | 458 |
542 @item @code{C-s} (@code{isearch-forward}) | 459 @item @code{C-s} (@code{isearch-forward}) |
543 @kindex C-s | 460 @kindex C-s |
544 @findex isearch-forward | 461 @findex isearch-forward |
545 Interactively search forward through the Info file for a string as you | 462 Interactively searches forward through the info file for a string as you |
546 type it. | 463 type it. |
547 | 464 |
548 @item @code{C-r} (@code{isearch-backward}) | 465 @item @code{C-r} (@code{isearch-backward}) |
549 @kindex C-r | 466 @kindex C-r |
550 @findex isearch-backward | 467 @findex isearch-backward |
551 Interactively search backward through the Info file for a string as | 468 Interactively searches backward through the info file for a string as |
552 you type it. | 469 you type it. |
553 | 470 |
554 @item @code{i} (@code{index-search}) | 471 @item @code{i} (@code{index-search}) |
555 @kindex i | 472 @kindex i |
556 @findex index-search | 473 @findex index-search |
557 Look up a string in the indices for this Info file, and select a node | 474 Looks up a string in the indices for this info file, and selects a node |
558 where the found index entry points to. | 475 where the found index entry points to. |
559 | 476 |
560 @item @code{,} (@code{next-index-match}) | 477 @item @code{,} (@code{next-index-match}) |
561 @kindex , | 478 @kindex , |
562 @findex next-index-match | 479 @findex next-index-match |
563 Move to the node containing the next matching index item from the last | 480 Moves to the node containing the next matching index item from the last |
564 @samp{i} command. | 481 @samp{i} command. |
565 @end table | 482 @end table |
566 | 483 |
567 The most basic searching command is @samp{s} (@code{search}). The | 484 The most basic searching command is @samp{s} (@code{search}). The |
568 @samp{s} command prompts you for a string in the echo area, and then | 485 @samp{s} command prompts you for a string in the echo area, and then |
569 searches the remainder of the Info file for an occurrence of that string. | 486 searches the remainder of the info file for an ocurrence of that string. |
570 If the string is found, the node containing it is selected, and the | 487 If the string is found, the node containing it is selected, and the |
571 cursor is left positioned at the start of the found string. Subsequent | 488 cursor is left positioned at the start of the found string. Subsequent |
572 @samp{s} commands show you the default search string within @samp{[} and | 489 @samp{s} commands show you the default search string within @samp{[} and |
573 @samp{]}; pressing @key{RET} instead of typing a new string will use the | 490 @samp{]}; pressing @key{RET} instead of typing a new string will use the |
574 default search string. | 491 default search string. |
575 | 492 |
576 @dfn{Incremental searching} is similar to basic searching, but the | 493 @dfn{Incremental searching} is similar to basic searching, but the |
577 string is looked up while you are typing it, instead of waiting until | 494 string is looked up while you are typing it, instead of waiting until |
578 the entire search string has been specified. | 495 the entire search string has been specified. |
579 | 496 |
580 @node Xref Commands, Window Commands, Searching Commands, Top | 497 @node Xref Commands |
581 @chapter Selecting Cross References | 498 @chapter Selecting Cross References |
582 | 499 |
583 We have already discussed the @samp{Next}, @samp{Prev}, and @samp{Up} | 500 We have already discussed the @samp{Next}, @samp{Prev}, and @samp{Up} |
584 pointers which appear at the top of a node. In addition to these | 501 pointers which appear at the top of a node. In addition to these |
585 pointers, a node may contain other pointers which refer you to a | 502 pointers, a node may contain other pointers which refer you to a |
586 different node, perhaps in another Info file. Such pointers are called | 503 different node, perhaps in another info file. Such pointers are called |
587 @dfn{cross references}, or @dfn{xrefs} for short. | 504 @dfn{cross references}, or @dfn{xrefs} for short. |
588 | 505 |
589 @menu | 506 @menu |
590 * Parts of an Xref:: What a cross reference is made of. | 507 * Parts of an Xref:: What a cross reference is made of. |
591 * Selecting Xrefs:: Commands for selecting menu or note items. | 508 * Selecting Xrefs:: Commands for selecting menu or note items. |
592 @end menu | 509 @end menu |
593 | 510 |
594 @node Parts of an Xref, Selecting Xrefs, , Xref Commands | 511 @node Parts of an Xref |
595 @section Parts of an Xref | 512 @section Parts of an Xref |
596 | 513 |
597 Cross references have two major parts: the first part is called the | 514 Cross references have two major parts: the first part is called the |
598 @dfn{label}; it is the name that you can use to refer to the cross | 515 @dfn{label}; it is the name that you can use to refer to the cross |
599 reference, and the second is the @dfn{target}; it is the full name of | 516 reference, and the second is the @dfn{target}; it is the full name of |
603 label appears, and then the target. For example, in the sample menu | 520 label appears, and then the target. For example, in the sample menu |
604 cross reference below, the single colon separates the label from the | 521 cross reference below, the single colon separates the label from the |
605 target. | 522 target. |
606 | 523 |
607 @example | 524 @example |
608 * Foo Label: Foo Target. More information about Foo. | 525 * Foo Label: Foo Target. More information about Foo. |
609 @end example | 526 @end example |
610 | 527 |
611 Note the @samp{.} which ends the name of the target. The @samp{.} is | 528 Note the @samp{.} which ends the name of the target. The @samp{.} is |
612 not part of the target; it serves only to let Info know where the target | 529 not part of the target; it serves only to let Info know where the target |
613 name ends. | 530 name ends. |
614 | 531 |
615 A shorthand way of specifying references allows two adjacent colons to | 532 A shorthand way of specifying references allows two adjacent colons to |
616 stand for a target name which is the same as the label name: | 533 stand for a target name which is the same as the label name: |
617 | 534 |
618 @example | 535 @example |
619 * Foo Commands:: Commands pertaining to Foo. | 536 * Foo Commands:: Commands pertaining to Foo. |
620 @end example | 537 @end example |
621 | 538 |
622 In the above example, the name of the target is the same as the name of | 539 In the above example, the name of the target is the same as the name of |
623 the label, in this case @code{Foo Commands}. | 540 the label, in this case @code{Foo Commands}. |
624 | 541 |
625 You will normally see two types of cross reference while viewing nodes: | 542 You will normally see two types of cross references while viewing nodes: |
626 @dfn{menu} references, and @dfn{note} references. Menu references | 543 @dfn{menu} references, and @dfn{note} references. Menu references |
627 appear within a node's menu; they begin with a @samp{*} at the beginning | 544 appear within a node's menu; they begin with a @samp{*} at the beginning |
628 of a line, and continue with a label, a target, and a comment which | 545 of a line, and continue with a label, a target, and a comment which |
629 describes what the contents of the node pointed to contains. | 546 describes what the contents of the node pointed to contains. |
630 | 547 |
631 Note references appear within the body of the node text; they begin with | 548 Note references appear within the body of the node text; they begin with |
632 @code{*Note}, and continue with a label and a target. | 549 @code{*Note}, and continue with a label and a target. |
633 | 550 |
634 Like @samp{Next}, @samp{Prev}, and @samp{Up} pointers, cross references | 551 Like @samp{Next}, @samp{Prev} and @samp{Up} pointers, cross references |
635 can point to any valid node. They are used to refer you to a place | 552 can point to any valid node. They are used to refer you to a place |
636 where more detailed information can be found on a particular subject. | 553 where more detailed information can be found on a particular subject. |
637 Here is a cross reference which points to a node within the Texinfo | 554 Here is a cross reference which points to a node within the Texinfo |
638 documentation: @xref{xref, , Writing an Xref, texinfo, the Texinfo | 555 documentation: @xref{xref, , Writing an Xref, texinfo, the Texinfo |
639 Manual}, for more information on creating your own texinfo cross | 556 Manual}, for more information on creating your own texinfo cross |
640 references. | 557 references. |
641 | 558 |
642 @node Selecting Xrefs, , Parts of an Xref, Xref Commands | 559 @node Selecting Xrefs |
643 @section Selecting Xrefs | 560 @section Selecting Xrefs |
644 | 561 |
645 The following table lists the Info commands which operate on menu items. | 562 The following table lists the Info commands which operate on menu items. |
646 | 563 |
647 @table @asis | 564 @table @asis |
666 Reads the name of a menu item in the echo area and selects its node. | 583 Reads the name of a menu item in the echo area and selects its node. |
667 Completion is available while reading the menu label. | 584 Completion is available while reading the menu label. |
668 | 585 |
669 @item @code{M-x find-menu} | 586 @item @code{M-x find-menu} |
670 @findex find-menu | 587 @findex find-menu |
671 Move the cursor to the start of this node's menu. | 588 Moves the cursor to the start of this node's menu. |
672 @end table | 589 @end table |
673 | 590 |
674 This table lists the Info commands which operate on note cross references. | 591 This table lists the Info commands which operate on note cross references. |
675 | 592 |
676 @table @asis | 593 @table @asis |
688 | 605 |
689 @table @asis | 606 @table @asis |
690 @item @code{TAB} (@code{move-to-next-xref}) | 607 @item @code{TAB} (@code{move-to-next-xref}) |
691 @kindex TAB, in Info windows | 608 @kindex TAB, in Info windows |
692 @findex move-to-next-xref | 609 @findex move-to-next-xref |
693 Move the cursor to the start of the next nearest menu item or note | 610 Moves the cursor to the start of the next nearest menu item or note |
694 reference in this node. You can then use @key{RET} | 611 reference in this node. You can then use @key{RET} |
695 (@code{select-reference-this-line}) to select the menu or note reference. | 612 (@code{select-reference-this-line} to select the menu or note reference. |
696 | 613 |
697 @item @code{M-TAB} (@code{move-to-prev-xref}) | 614 @item @code{M-TAB} (@code{move-to-prev-xref}) |
698 @kindex M-TAB, in Info windows | 615 @kindex M-TAB, in Info windows |
699 @findex move-to-prev-xref | 616 @findex move-to-prev-xref |
700 Move the cursor the start of the nearest previous menu item or note | 617 Moves the cursor the start of the nearest previous menu item or note |
701 reference in this node. | 618 reference in this node. |
702 | 619 |
703 @item @code{RET} (@code{select-reference-this-line}) | 620 @item @code{RET} (@code{select-reference-this-line}) |
704 @kindex RET, in Info windows | 621 @kindex RET, in Info windows |
705 @findex select-reference-this-line | 622 @findex select-reference-this-line |
706 Select the menu item or note reference appearing on this line. | 623 Selects the menu item or note reference appearing on this line. |
707 @end table | 624 @end table |
708 | 625 |
709 @node Window Commands, Printing Nodes, Xref Commands, Top | 626 @node Window Commands |
710 @chapter Manipulating Multiple Windows | 627 @chapter Manipulating Multiple Windows |
711 @cindex windows, manipulating | 628 @cindex windows, manipulating |
712 | 629 |
713 A @dfn{window} is a place to show the text of a node. Windows have a | 630 A @dfn{window} is a place to show the text of a node. Windows have a |
714 view area where the text of the node is displayed, and an associated | 631 view area where the text of the node is displayed, and an associated |
720 appears. There are commands available for creating windows, changing | 637 appears. There are commands available for creating windows, changing |
721 the size of windows, selecting which window is active, and for deleting | 638 the size of windows, selecting which window is active, and for deleting |
722 windows. | 639 windows. |
723 | 640 |
724 @menu | 641 @menu |
725 * The Mode Line:: What appears in the mode line? | 642 * The Mode Line:: What appears in the mode line? |
726 * Basic Windows:: Manipulating windows in Info. | 643 * Basic Windows:: Manipulating windows in Info. |
727 * The Echo Area:: Used for displaying errors and reading input. | 644 * The Echo Area:: Used for displaying errors and reading input. |
728 @end menu | 645 @end menu |
729 | 646 |
730 @node The Mode Line, Basic Windows, , Window Commands | 647 @node The Mode Line |
731 @section The Mode Line | 648 @section The Mode Line |
732 | 649 |
733 A @dfn{mode line} is a line of inverse video which appears at the bottom | 650 A @dfn{mode line} is a line of inverse video which appears at the bottom |
734 of an Info window. It describes the contents of the window just above | 651 of an info window. It describes the contents of the window just above |
735 it; this information includes the name of the file and node appearing in | 652 it; this information includes the name of the file and node appearing in |
736 that window, the number of screen lines it takes to display the node, | 653 that window, the number of screen lines it takes to display the node, |
737 and the percentage of text that is above the top of the window. It can | 654 and the percentage of text that is above the top of the window. It can |
738 also tell you if the indirect tags table for this Info file needs to be | 655 also tell you if the indirect tags table for this info file needs to be |
739 updated, and whether or not the Info file was compressed when stored on | 656 updated, and whether or not the info file was compressed when stored on |
740 disk. | 657 disk. |
741 | 658 |
742 Here is a sample mode line for a window containing an uncompressed file | 659 Here is a sample mode line for a window containing an uncompressed file |
743 named @file{dir}, showing the node @samp{Top}. | 660 named @file{dir}, showing the node @samp{Top}. |
744 | 661 |
745 @example | 662 @example |
746 @group | |
747 -----Info: (dir)Top, 40 lines --Top--------------------------------------- | 663 -----Info: (dir)Top, 40 lines --Top--------------------------------------- |
748 ^^ ^ ^^^ ^^ | 664 ^^ ^ ^^^ ^^ |
749 (file)Node #lines where | 665 (file)Node #lines where |
750 @end group | |
751 @end example | 666 @end example |
752 | 667 |
753 When a node comes from a file which is compressed on disk, this is | 668 When a node comes from a file which is compressed on disk, this is |
754 indicated in the mode line with two small @samp{z}'s. In addition, if | 669 indicated in the mode line with two small @samp{z}'s. In addition, if |
755 the Info file containing the node has been split into subfiles, the name | 670 the info file containing the node has been split into subfiles, the name |
756 of the subfile containing the node appears in the modeline as well: | 671 of the subfile containing the node appears in the modeline as well: |
757 | 672 |
758 @example | 673 @example |
759 --zz-Info: (emacs)Top, 291 lines --Top-- Subfile: emacs-1.Z--------------- | 674 --zz-Info: (emacs)Top, 291 lines --Top-- Subfile: emacs-1.Z--------------- |
760 @end example | 675 @end example |
767 | 682 |
768 @example | 683 @example |
769 -----Info: *Completions*, 7 lines --All----------------------------------- | 684 -----Info: *Completions*, 7 lines --All----------------------------------- |
770 @end example | 685 @end example |
771 | 686 |
772 @node Basic Windows, The Echo Area, The Mode Line, Window Commands | 687 @node Basic Windows |
773 @section Window Commands | 688 @section Window Commands |
774 | 689 |
775 It can be convenient to view more than one node at a time. To allow | 690 It can be convenient to view more than one node at a time. To allow |
776 this, Info can display more than one @dfn{window}. Each window has its | 691 this, Info can display more than one @dfn{window}. Each window has its |
777 own mode line (@pxref{The Mode Line}) and history of nodes viewed in that | 692 own mode line (@pxref{The Mode Line}) and history of nodes viewed in that |
780 @table @asis | 695 @table @asis |
781 @item @code{C-x o} (@code{next-window}) | 696 @item @code{C-x o} (@code{next-window}) |
782 @cindex windows, selecting | 697 @cindex windows, selecting |
783 @kindex C-x o | 698 @kindex C-x o |
784 @findex next-window | 699 @findex next-window |
785 Select the next window on the screen. Note that the echo area can only be | 700 Selects the next window on the screen. Note that the echo area can only be |
786 selected if it is already in use, and you have left it temporarily. | 701 selected if it is already in use, and you have left it temporarily. |
787 Normally, @samp{C-x o} simply moves the cursor into the next window on | 702 Normally, @samp{C-x o} simply moves the cursor into the next window on |
788 the screen, or if you are already within the last window, into the first | 703 the screen, or if you are already within the last window, into the first |
789 window on the screen. Given a numeric argument, @samp{C-x o} moves over | 704 window on the screen. Given a numeric argument, @samp{C-x o} moves over |
790 that many windows. A negative argument causes @samp{C-x o} to select | 705 that many windows. A negative argument causes @samp{C-x o} to select |
791 the previous window on the screen. | 706 the previous window on the screen. |
792 | 707 |
793 @item @code{M-x prev-window} | 708 @item @code{M-x prev-window} |
794 @findex prev-window | 709 @findex prev-window |
795 Select the previous window on the screen. This is identical to | 710 Selects the previous window on the screen. This is identical to |
796 @samp{C-x o} with a negative argument. | 711 @samp{C-x o} with a negative argument. |
797 | 712 |
798 @item @code{C-x 2} (@code{split-window}) | 713 @item @code{C-x 2} (@code{split-window}) |
799 @cindex windows, creating | 714 @cindex windows, creating |
800 @kindex C-x 2 | 715 @kindex C-x 2 |
801 @findex split-window | 716 @findex split-window |
802 Split the current window into two windows, both showing the same node. | 717 Splits the current window into two windows, both showing the same node. |
803 Each window is one half the size of the original window, and the cursor | 718 Each window is one half the size of the original window, and the cursor |
804 remains in the original window. The variable @code{automatic-tiling} | 719 remains in the original window. The variable @code{automatic-tiling} |
805 can cause all of the windows on the screen to be resized for you | 720 can cause all of the windows on the screen to be resized for you |
806 automatically, please @pxref{Variables, , automatic-tiling} for more | 721 automatically, please @pxref{Variables, , automatic-tiling} for more |
807 information. | 722 information. |
808 | 723 |
809 @item @code{C-x 0} (@code{delete-window}) | 724 @item @code{C-x 0} (@code{delete-window}) |
810 @cindex windows, deleting | 725 @cindex windows, deleting |
811 @kindex C-x 0 | 726 @kindex C-x 0 |
812 @findex delete-window | 727 @findex delete-window |
813 Delete the current window from the screen. If you have made too many | 728 Deletes the current window from the screen. If you have made too many |
814 windows and your screen appears cluttered, this is the way to get rid of | 729 windows and your screen appears cluttered, this is the way to get rid of |
815 some of them. | 730 some of them. |
816 | 731 |
817 @item @code{C-x 1} (@code{keep-one-window}) | 732 @item @code{C-x 1} (@code{keep-one-window}) |
818 @kindex C-x 1 | 733 @kindex C-x 1 |
819 @findex keep-one-window | 734 @findex keep-one-window |
820 Delete all of the windows excepting the current one. | 735 Deletes all of the windows excepting the current one. |
821 | 736 |
822 @item @code{ESC C-v} (@code{scroll-other-window}) | 737 @item @code{ESC C-v} (@code{scroll-other-window}) |
823 @kindex ESC C-v, in Info windows | 738 @kindex ESC C-v, in Info windows |
824 @findex scroll-other-window | 739 @findex scroll-other-window |
825 Scroll the other window, in the same fashion that @samp{C-v} might | 740 Scrolls the other window, in the same fashion that @samp{C-v} might |
826 scroll the current window. Given a negative argument, scroll the | 741 scroll the current window. Given a negative argument, the "other" |
827 "other" window backward. | 742 window is scrolled backward. |
828 | 743 |
829 @item @code{C-x ^} (@code{grow-window}) | 744 @item @code{C-x ^} (@code{grow-window}) |
830 @kindex C-x ^ | 745 @kindex C-x ^ |
831 @findex grow-window | 746 @findex grow-window |
832 Grow (or shrink) the current window. Given a numeric argument, grow | 747 Grows (or shrinks) the current window. Given a numeric argument, grows |
833 the current window that many lines; with a negative numeric argument, | 748 the current window that many lines; with a negative numeric argument, |
834 shrink the window instead. | 749 the window is shrunk instead. |
835 | 750 |
836 @item @code{C-x t} (@code{tile-windows}) | 751 @item @code{C-x t} (@code{tile-windows}) |
837 @cindex tiling | 752 @cindex tiling |
838 @kindex C-x t | 753 @kindex C-x t |
839 @findex tile-windows | 754 @findex tile-windows |
840 Divide the available screen space among all of the visible windows. | 755 Divides the available screen space among all of the visible windows. |
841 Each window is given an equal portion of the screen in which to display | 756 Each window is given an equal portion of the screen in which to display |
842 its contents. The variable @code{automatic-tiling} can cause | 757 its contents. The variable @code{automatic-tiling} can cause |
843 @code{tile-windows} to be called when a window is created or deleted. | 758 @code{tile-windows} to be called when a window is created or deleted. |
844 @xref{Variables, , @code{automatic-tiling}}. | 759 @xref{Variables, , @code{automatic-tiling}}. |
845 @end table | 760 @end table |
846 | 761 |
847 @node The Echo Area, , Basic Windows, Window Commands | 762 @node The Echo Area |
848 @section The Echo Area | 763 @section The Echo Area |
849 @cindex echo area | 764 @cindex echo area |
850 | 765 |
851 The @dfn{echo area} is a one line window which appears at the bottom of | 766 The @dfn{echo area} is a one line window which appears at the bottom of |
852 the screen. It is used to display informative or error messages, and to | 767 the screen. It is used to display informative or error messages, and to |
859 | 774 |
860 @table @asis | 775 @table @asis |
861 @item @code{C-f} (@code{echo-area-forward}) | 776 @item @code{C-f} (@code{echo-area-forward}) |
862 @kindex C-f, in the echo area | 777 @kindex C-f, in the echo area |
863 @findex echo-area-forward | 778 @findex echo-area-forward |
864 Move forward a character. | 779 Moves forward a character. |
865 | 780 |
866 @item @code{C-b} (@code{echo-area-backward}) | 781 @item @code{C-b} (@code{echo-area-backward}) |
867 @kindex C-b, in the echo area | 782 @kindex C-b, in the echo area |
868 @findex echo-area-backward | 783 @findex echo-area-backward |
869 Move backward a character. | 784 Moves backward a character. |
870 | 785 |
871 @item @code{C-a} (@code{echo-area-beg-of-line}) | 786 @item @code{C-a} (@code{echo-area-beg-of-line}) |
872 @kindex C-a, in the echo area | 787 @kindex C-a, in the echo area |
873 @findex echo-area-beg-of-line | 788 @findex echo-area-beg-of-line |
874 Move to the start of the input line. | 789 Moves to the start of the input line. |
875 | 790 |
876 @item @code{C-e} (@code{echo-area-end-of-line}) | 791 @item @code{C-e} (@code{echo-area-end-of-line}) |
877 @kindex C-e, in the echo area | 792 @kindex C-e, in the echo area |
878 @findex echo-area-end-of-line | 793 @findex echo-area-end-of-line |
879 Move to the end of the input line. | 794 Moves to the end of the input line. |
880 | 795 |
881 @item @code{M-f} (@code{echo-area-forward-word}) | 796 @item @code{M-f} (@code{echo-area-forward-word}) |
882 @kindex M-f, in the echo area | 797 @kindex M-f, in the echo area |
883 @findex echo-area-forward-word | 798 @findex echo-area-forward-word |
884 Move forward a word. | 799 Moves forward a word. |
885 | 800 |
886 @item @code{M-b} (@code{echo-area-backward-word}) | 801 @item @code{M-b} (@code{echo-area-backward-word}) |
887 @kindex M-b, in the echo area | 802 @kindex M-b, in the echo area |
888 @findex echo-area-backward-word | 803 @findex echo-area-backward-word |
889 Move backward a word. | 804 Moves backward a word. |
890 | 805 |
891 @item @code{C-d} (@code{echo-area-delete}) | 806 @item @code{C-d} (@code{echo-area-delete}) |
892 @kindex C-d, in the echo area | 807 @kindex C-d, in the echo area |
893 @findex echo-area-delete | 808 @findex echo-area-delete |
894 Delete the character under the cursor. | 809 Deletes the character under the cursor. |
895 | 810 |
896 @item @code{DEL} (@code{echo-area-rubout}) | 811 @item @code{DEL} (@code{echo-area-rubout}) |
897 @kindex DEL, in the echo area | 812 @kindex DEL, in the echo area |
898 @findex echo-area-rubout | 813 @findex echo-area-rubout |
899 Delete the character behind the cursor. | 814 Deletes the character behind the cursor. |
900 | 815 |
901 @item @code{C-g} (@code{echo-area-abort}) | 816 @item @code{C-g} (@code{echo-area-abort}) |
902 @kindex C-g, in the echo area | 817 @kindex C-g, in the echo area |
903 @findex echo-area-abort | 818 @findex echo-area-abort |
904 Cancel or quit the current operation. If completion is being read, | 819 Cancels or quits the current operation. If completion is being read, |
905 @samp{C-g} discards the text of the input line which does not match any | 820 @samp{C-g} discards the text of the input line which does not match any |
906 completion. If the input line is empty, @samp{C-g} aborts the calling | 821 completion. If the input line is empty, @samp{C-g} aborts the calling |
907 function. | 822 function. |
908 | 823 |
909 @item @code{RET} (@code{echo-area-newline}) | 824 @item @code{RET} (@code{echo-area-newline}) |
910 @kindex RET, in the echo area | 825 @kindex RET, in the echo area |
911 @findex echo-area-newline | 826 @findex echo-area-newline |
912 Accept (or forces completion of) the current input line. | 827 Accepts (or forces completion of) the current input line. |
913 | 828 |
914 @item @code{C-q} (@code{echo-area-quoted-insert}) | 829 @item @code{C-q} (@code{echo-area-quoted-insert}) |
915 @kindex C-q, in the echo area | 830 @kindex C-q, in the echo area |
916 @findex echo-area-quoted-insert | 831 @findex echo-area-quoted-insert |
917 Insert the next character verbatim. This is how you can insert control | 832 Inserts the next character verbatim. This is how you can insert control |
918 characters into a search string, for example. | 833 characters into a search string, for example. |
919 | 834 |
920 @item @var{printing character} (@code{echo-area-insert}) | 835 @item @var{printing character} (@code{echo-area-insert}) |
921 @kindex printing characters, in the echo area | 836 @kindex printing characters, in the echo area |
922 @findex echo-area-insert | 837 @findex echo-area-insert |
923 Insert the character. | 838 Inserts the character. |
924 | 839 |
925 @item @code{M-TAB} (@code{echo-area-tab-insert}) | 840 @item @code{M-TAB} (@code{echo-area-tab-insert}) |
926 @kindex M-TAB, in the echo area | 841 @kindex M-TAB, in the echo area |
927 @findex echo-area-tab-insert | 842 @findex echo-area-tab-insert |
928 Insert a TAB character. | 843 Inserts a TAB character. |
929 | 844 |
930 @item @code{C-t} (@code{echo-area-transpose-chars}) | 845 @item @code{C-t} (@code{echo-area-transpose-chars}) |
931 @kindex C-t, in the echo area | 846 @kindex C-t, in the echo area |
932 @findex echo-area-transpose-chars | 847 @findex echo-area-transpose-chars |
933 Transpose the characters at the cursor. | 848 Transposes the characters at the cursor. |
934 @end table | 849 @end table |
935 | 850 |
936 The next group of commands deal with @dfn{killing}, and @dfn{yanking} | 851 The next group of commands deal with @dfn{killing}, and @dfn{yanking} |
937 text. For an in depth discussion of killing and yanking, | 852 text. For an in depth discussion of killing and yanking, |
938 @pxref{Killing, , Killing and Deleting, emacs, the GNU Emacs Manual} | 853 @pxref{Killing, , Killing and Deleting, emacs, the GNU Emacs Manual} |
939 | 854 |
940 @table @asis | 855 @table @asis |
941 @item @code{M-d} (@code{echo-area-kill-word}) | 856 @item @code{M-d} (@code{echo-area-kill-word}) |
942 @kindex M-d, in the echo area | 857 @kindex M-d, in the echo area |
943 @findex echo-area-kill-word | 858 @findex echo-area-kill-word |
944 Kill the word following the cursor. | 859 Kills the word following the cursor. |
945 | 860 |
946 @item @code{M-DEL} (@code{echo-area-backward-kill-word}) | 861 @item @code{M-DEL} (@code{echo-area-backward-kill-word}) |
947 @kindex M-DEL, in the echo area | 862 @kindex M-DEL, in the echo area |
948 @findex echo-area-backward-kill-word | 863 @findex echo-area-backward-kill-word |
949 Kill the word preceding the cursor. | 864 Kills the word preceding the cursor. |
950 | 865 |
951 @item @code{C-k} (@code{echo-area-kill-line}) | 866 @item @code{C-k} (@code{echo-area-kill-line}) |
952 @kindex C-k, in the echo area | 867 @kindex C-k, in the echo area |
953 @findex echo-area-kill-line | 868 @findex echo-area-kill-line |
954 Kill the text from the cursor to the end of the line. | 869 Kills the text from the cursor to the end of the line. |
955 | 870 |
956 @item @code{C-x DEL} (@code{echo-area-backward-kill-line}) | 871 @item @code{C-x DEL} (@code{echo-area-backward-kill-line}) |
957 @kindex C-x DEL, in the echo area | 872 @kindex C-x DEL, in the echo area |
958 @findex echo-area-backward-kill-line | 873 @findex echo-area-backward-kill-line |
959 Kill the text from the cursor to the beginning of the line. | 874 Kills the text from the cursor to the beginning of the line. |
960 | 875 |
961 @item @code{C-y} (@code{echo-area-yank}) | 876 @item @code{C-y} (@code{echo-area-yank}) |
962 @kindex C-y, in the echo area | 877 @kindex C-y, in the echo area |
963 @findex echo-area-yank | 878 @findex echo-area-yank |
964 Yank back the contents of the last kill. | 879 Yanks back the contents of the last kill. |
965 | 880 |
966 @item @code{M-y} (@code{echo-area-yank-pop}) | 881 @item @code{M-y} (@code{echo-area-yank-pop}) |
967 @kindex M-y, in the echo area | 882 @kindex M-y, in the echo area |
968 @findex echo-area-yank-pop | 883 @findex echo-area-yank-pop |
969 Yank back a previous kill, removing the last yanked text first. | 884 Yanks back a previous kill, removing the last yanked text first. |
970 @end table | 885 @end table |
971 | 886 |
972 Sometimes when reading input in the echo area, the command that needed | 887 Sometimes when reading input in the echo area, the command that needed |
973 input will only accept one of a list of several choices. The choices | 888 input will only accept one of a list of several choices. The choices |
974 represent the @dfn{possible completions}, and you must respond with one | 889 represent the @dfn{possible completions}, and you must respond with one |
984 @item @code{TAB} (@code{echo-area-complete}) | 899 @item @code{TAB} (@code{echo-area-complete}) |
985 @itemx @code{SPC} | 900 @itemx @code{SPC} |
986 @kindex TAB, in the echo area | 901 @kindex TAB, in the echo area |
987 @kindex SPC, in the echo area | 902 @kindex SPC, in the echo area |
988 @findex echo-area-complete | 903 @findex echo-area-complete |
989 Insert as much of a completion as is possible. | 904 Inserts as much of a completion as is possible. |
990 | 905 |
991 @item @code{?} (@code{echo-area-possible-completions}) | 906 @item @code{?} (@code{echo-area-possible-completions}) |
992 @kindex ?, in the echo area | 907 @kindex ?, in the echo area |
993 @findex echo-area-possible-completions | 908 @findex echo-area-possible-completions |
994 Display a window containing a list of the possible completions of what | 909 Displays a window containing a list of the possible completions of what |
995 you have typed so far. For example, if the available choices are: | 910 you have typed so far. For example, if the available choices are: |
996 | 911 @example |
997 @example | |
998 @group | |
999 bar | 912 bar |
1000 foliate | 913 foliate |
1001 food | 914 food |
1002 forget | 915 forget |
1003 @end group | |
1004 @end example | 916 @end example |
1005 | |
1006 @noindent | |
1007 and you have typed an @samp{f}, followed by @samp{?}, the possible | 917 and you have typed an @samp{f}, followed by @samp{?}, the possible |
1008 completions would contain: | 918 completions would contain: |
1009 | 919 @example |
1010 @example | |
1011 @group | |
1012 foliate | 920 foliate |
1013 food | 921 food |
1014 forget | 922 forget |
1015 @end group | |
1016 @end example | 923 @end example |
1017 | |
1018 @noindent | |
1019 i.e., all of the choices which begin with @samp{f}. Pressing @key{SPC} | 924 i.e., all of the choices which begin with @samp{f}. Pressing @key{SPC} |
1020 or @key{TAB} would result in @samp{fo} appearing in the echo area, since | 925 or @key{TAB} would result in @samp{fo} appearing in the echo area, since |
1021 all of the choices which begin with @samp{f} continue with @samp{o}. | 926 all of the choices which begin with @samp{f} continue with @samp{o}. |
1022 Now, typing @samp{l} followed by @samp{TAB} results in @samp{foliate} | 927 Now, typing @samp{l} followed by @samp{TAB} results in @samp{foliate} |
1023 appearing in the echo area, since that is the only choice which begins | 928 appearing in the echo area, since that is the only choice which begins |
1024 with @samp{fol}. | 929 with @samp{fol}. |
1025 | 930 |
1026 @item @code{ESC C-v} (@code{echo-area-scroll-completions-window}) | 931 @item @code{ESC C-v} (@code{echo-area-scroll-completions-window}) |
1027 @kindex ESC C-v, in the echo area | 932 @kindex ESC C-v, in the echo area |
1028 @findex echo-area-scroll-completions-window | 933 @findex echo-area-scroll-completions-window |
1029 Scroll the completions window, if that is visible, or the "other" | 934 Scrolls the completions window, if that is visible, or the "other" |
1030 window if not. | 935 window if not. |
1031 @end table | 936 @end table |
1032 | 937 |
1033 @node Printing Nodes, Miscellaneous Commands, Window Commands, Top | 938 @node Printing Nodes |
1034 @chapter Printing Out Nodes | 939 @chapter Printing Out Nodes |
1035 @cindex printing | 940 @cindex printing |
1036 | 941 |
1037 You may wish to print out the contents of a node as a quick reference | 942 You may wish to print out the contents of a node as a quick reference |
1038 document for later use. Info provides you with a command for doing | 943 document for later use. Info provides you with a command for doing |
1039 this. In general, we recommend that you use @TeX{} to format the | 944 this. In general, we recommend that you use @TeX{} to format the |
1040 document and print sections of it, by running @code{tex} on the Texinfo | 945 document and print sections of it, by running @code{tex} on the texinfo |
1041 source file. | 946 source file. |
1042 | 947 |
1043 @table @asis | 948 @table @asis |
1044 @item @code{M-x print-node} | 949 @item @code{M-x print-node} |
1045 @findex print-node | 950 @findex print-node |
1046 @cindex INFO_PRINT_COMMAND, environment variable | 951 @cindex INFO_PRINT_COMMAND, environment variable |
1047 Pipe the contents of the current node through the command in the | 952 Pipes the contents of the current node through the command in the |
1048 environment variable @code{INFO_PRINT_COMMAND}. If the variable does not | 953 environment variable @code{INFO_PRINT_COMMAND}. If the variable doesn't |
1049 exist, the node is simply piped to @code{lpr}. | 954 exist, the node is simply piped to @code{lpr}. |
1050 @end table | 955 @end table |
1051 | 956 |
1052 @node Miscellaneous Commands, Variables, Printing Nodes, Top | 957 @node Miscellaneous Commands |
1053 @chapter Miscellaneous Commands | 958 @chapter Miscellaneous Commands |
1054 | 959 |
1055 GNU Info contains several commands which self-document GNU Info: | 960 GNU Info contains several commands which self-document GNU Info: |
1056 | 961 |
1057 @table @asis | 962 @table @asis |
1058 @item @code{M-x describe-command} | 963 @item @code{M-x describe-command} |
1059 @cindex functions, describing | 964 @cindex functions, describing |
1060 @cindex commands, describing | 965 @cindex commands, describing |
1061 @findex describe-command | 966 @findex describe-command |
1062 Read the name of an Info command in the echo area and then display a | 967 Reads the name of an Info command in the echo area and then displays a |
1063 brief description of what that command does. | 968 brief description of what that command does. |
1064 | 969 |
1065 @item @code{M-x describe-key} | 970 @item @code{M-x describe-key} |
1066 @cindex keys, describing | 971 @cindex keys, describing |
1067 @findex describe-key | 972 @findex describe-key |
1068 Read a key sequence in the echo area, and then display the name and | 973 Reads a key sequence in the echo area, and then displays the name and |
1069 documentation of the Info command that the key sequence invokes. | 974 documentation of the Info command that the key sequence invokes. |
1070 | 975 |
1071 @item @code{M-x describe-variable} | 976 @item @code{M-x describe-variable} |
1072 Read the name of a variable in the echo area and then display a brief | 977 Reads the name of a variable in the echo area and then displays a brief |
1073 description of what the variable affects. | 978 description of what the variable affects. |
1074 | 979 |
1075 @item @code{M-x where-is} | 980 @item @code{M-x where-is} |
1076 @findex where-is | 981 @findex where-is |
1077 Read the name of an Info command in the echo area, and then display | 982 Reads the name of an Info command in the echo area, and then displays |
1078 a key sequence which can be typed in order to invoke that command. | 983 a key sequence which can be typed in order to invoke that command. |
1079 | 984 |
1080 @item @code{C-h} (@code{get-help-window}) | 985 @item @code{C-h} (@code{get-help-window}) |
1081 @itemx @code{?} | 986 @itemx @code{?} |
1082 @kindex C-h | 987 @kindex C-h |
1083 @kindex ?, in Info windows | 988 @kindex ?, in Info windows |
1084 @findex get-help-window | 989 @findex get-help-window |
1085 Create (or Move into) the window displaying @code{*Help*}, and place | 990 Creates (or moves into) the window displaying @code{*Help*}, and places |
1086 a node containing a quick reference card into it. This window displays | 991 a node containing a quick reference card into it. This window displays |
1087 the most concise information about GNU Info available. | 992 the most concise information about GNU Info available. |
1088 | 993 |
1089 @item @code{h} (@code{get-info-help-node}) | 994 @item @code{h} (@code{get-info-help-node}) |
1090 @kindex h | 995 @kindex h |
1091 @findex get-info-help-node | 996 @findex get-info-help-node |
1092 Try hard to visit the node @code{(info)Help}. The Info file | 997 Tries hard to visit the node @code{(info)Help}. The info file |
1093 @file{info.texi} distributed with GNU Info contains this node. Of | 998 @file{info.texi} distributed with GNU Info contains this node. Of |
1094 course, the file must first be processed with @code{makeinfo}, and then | 999 course, the file must first be processed with @code{makeinfo}, and then |
1095 placed into the location of your Info directory. | 1000 placed into the location of your info directory. |
1096 @end table | 1001 @end table |
1097 | 1002 |
1098 Here are the commands for creating a numeric argument: | 1003 Here are the commands for creating a numeric argument: |
1099 | 1004 |
1100 @table @asis | 1005 @table @asis |
1101 @item @code{C-u} (@code{universal-argument}) | 1006 @item @code{C-u} (@code{universal-argument}) |
1102 @cindex numeric arguments | 1007 @cindex numeric arguments |
1103 @kindex C-u | 1008 @kindex C-u |
1104 @findex universal-argument | 1009 @findex universal-argument |
1105 Start (or multiply by 4) the current numeric argument. @samp{C-u} is | 1010 Starts (or multiplies by 4) the current numeric argument. @samp{C-u} is |
1106 a good way to give a small numeric argument to cursor movement or | 1011 a good way to give a small numeric argument to cursor movement or |
1107 scrolling commands; @samp{C-u C-v} scrolls the screen 4 lines, while | 1012 scrolling commands; @samp{C-u C-v} scrolls the screen 4 lines, while |
1108 @samp{C-u C-u C-n} moves the cursor down 16 lines. | 1013 @samp{C-u C-u C-n} moves the cursor down 16 lines. |
1109 | 1014 |
1110 @item @code{M-1} (@code{add-digit-to-numeric-arg}) | 1015 @item @code{M-1} (@code{add-digit-to-numeric-arg}) |
1111 @itemx @code{M-2} @dots{} @code{M-9} | 1016 @itemx @code{M-2} @dots{} @code{M-9} |
1112 @kindex M-1 @dots{} M-9 | 1017 @kindex M-1 @dots{} M-9 |
1113 @findex add-digit-to-numeric-arg | 1018 @findex add-digit-to-numeric-arg |
1114 Add the digit value of the invoking key to the current numeric | 1019 Adds the digit value of the invoking key to the current numeric |
1115 argument. Once Info is reading a numeric argument, you may just type | 1020 argument. Once Info is reading a numeric argument, you may just type |
1116 the digits of the argument, without the Meta prefix. For example, you | 1021 the digits of the argument, without the Meta prefix. For example, you |
1117 might give @samp{C-l} a numeric argument of 32 by typing: | 1022 might give @samp{C-l} a numeric argument of 32 by typing: |
1118 | 1023 |
1119 @example | 1024 @example |
1120 @kbd{C-u 3 2 C-l} | 1025 @kbd{C-u 3 2 C-l} |
1121 @end example | 1026 @end example |
1122 | |
1123 @noindent | |
1124 or | 1027 or |
1125 | |
1126 @example | 1028 @example |
1127 @kbd{M-3 2 C-l} | 1029 @kbd{M-3 2 C-l} |
1128 @end example | 1030 @end example |
1129 @end table | 1031 @end table |
1130 | 1032 |
1136 @item @code{C-g} (@code{abort-key}) | 1038 @item @code{C-g} (@code{abort-key}) |
1137 @cindex cancelling typeahead | 1039 @cindex cancelling typeahead |
1138 @cindex cancelling the current operation | 1040 @cindex cancelling the current operation |
1139 @kindex C-g, in Info windows | 1041 @kindex C-g, in Info windows |
1140 @findex abort-key | 1042 @findex abort-key |
1141 Cancel current operation. | 1043 Cancels current operation. |
1142 @end table | 1044 @end table |
1143 | 1045 |
1144 The @samp{q} command of Info simply quits running Info. | 1046 The @samp{q} command of Info simply quits running Info. |
1145 | 1047 |
1146 @table @asis | 1048 @table @asis |
1147 @item @code{q} (@code{quit}) | 1049 @item @code{q} (@code{quit}) |
1148 @cindex quitting | 1050 @cindex quitting |
1149 @kindex q | 1051 @kindex q |
1150 @findex quit | 1052 @findex quit |
1151 Exit GNU Info. | 1053 Exits GNU Info. |
1152 @end table | 1054 @end table |
1153 | 1055 |
1154 If the operating system tells GNU Info that the screen is 60 lines tall, | 1056 If the operating system tells GNU Info that the screen is 60 lines tall, |
1155 and it is actually only 40 lines tall, here is a way to tell Info that | 1057 and it is actually only 40 lines tall, here is a way to tell Info that |
1156 the operating system is correct. | 1058 the operating system is correct. |
1157 | 1059 |
1158 @table @asis | 1060 @table @asis |
1159 @item @code{M-x set-screen-height} | 1061 @item @code{M-x set-screen-height} |
1160 @findex set-screen-height | 1062 @findex set-screen-height |
1161 @cindex screen, changing the height of | 1063 @cindex screen, changing the height of |
1162 Read a height value in the echo area and set the height of the | 1064 Reads a height value in the echo area and sets the height of the |
1163 displayed screen to that value. | 1065 displayed screen to that value. |
1164 @end table | 1066 @end table |
1165 | 1067 |
1166 Finally, Info provides a convenient way to display footnotes which might | 1068 Finally, Info provides a convenient way to display footnotes which might |
1167 be associated with the current node that you are viewing: | 1069 be associated with the current node that you are viewing: |
1169 @table @asis | 1071 @table @asis |
1170 @item @code{ESC C-f} (@code{show-footnotes}) | 1072 @item @code{ESC C-f} (@code{show-footnotes}) |
1171 @kindex ESC C-f | 1073 @kindex ESC C-f |
1172 @findex show-footnotes | 1074 @findex show-footnotes |
1173 @cindex footnotes, displaying | 1075 @cindex footnotes, displaying |
1174 Show the footnotes (if any) associated with the current node in another | 1076 Shows the footnotes (if any) associated with the current node in another |
1175 window. You can have Info automatically display the footnotes | 1077 window. You can have Info automatically display the footnotes |
1176 associated with a node when the node is selected by setting the variable | 1078 associated with a node when the node is selected by setting the variable |
1177 @code{automatic-footnotes}. @xref{Variables, , @code{automatic-footnotes}}. | 1079 @code{automatic-footnotes}. @xref{Variables, , @code{automatic-footnotes}}. |
1178 @end table | 1080 @end table |
1179 | 1081 |
1180 @node Variables, GNU Info Global Index, Miscellaneous Commands, Top | 1082 @node Variables |
1181 @chapter Manipulating Variables | 1083 @chapter Manipulating Variables |
1182 | 1084 |
1183 GNU Info contains several @dfn{variables} whose values are looked at by | 1085 GNU Info contains several @dfn{variables} whose values are looked at by various |
1184 various Info commands. You can change the values of these variables, | 1086 Info commands. You can change the values of these variables, and thus |
1185 and thus change the behavior of Info to more closely match your | 1087 change the behaviour of Info to more closely match your environment and |
1186 environment and Info file reading manner. | 1088 info file reading manner. |
1187 | 1089 |
1188 @table @asis | 1090 @table @asis |
1189 @item @code{M-x set-variable} | 1091 @item @code{M-x set-variable} |
1190 @cindex variables, setting | 1092 @cindex variables, setting |
1191 @findex set-variable | 1093 @findex set-variable |
1192 Read the name of a variable, and the value for it, in the echo area and | 1094 Reads the name of a variable, and the value for it, in the echo area and |
1193 then set the variable to that value. Completion is available when | 1095 then sets the variable to that value. Completion is available when |
1194 reading the variable name; often, completion is available when reading | 1096 reading the variable name; often, completion is available when reading |
1195 the value to give to the variable, but that depends on the variable | 1097 the value to give to the variable, but that depends on the variable |
1196 itself. If a variable does @emph{not} supply multiple choices to | 1098 itself. If a variable does @emph{not} supply multiple choices to |
1197 complete over, it expects a numeric value. | 1099 complete over, it expects a numeric value. |
1198 | 1100 |
1199 @item @code{M-x describe-variable} | 1101 @item @code{M-x describe-variable} |
1200 @cindex variables, describing | 1102 @cindex variables, describing |
1201 @findex describe-variable | 1103 @findex describe-variable |
1202 Read the name of a variable in the echo area and then display a brief | 1104 Reads the name of a variable in the echo area and then displays a brief |
1203 description of what the variable affects. | 1105 description of what the variable affects. |
1204 @end table | 1106 @end table |
1205 | 1107 |
1206 Here is a list of the variables that you can set in Info. | 1108 Here is a list of the variables that you can set in Info. |
1207 | 1109 |
1245 | 1147 |
1246 @item gc-compressed-files | 1148 @item gc-compressed-files |
1247 @vindex gc-compressed-files | 1149 @vindex gc-compressed-files |
1248 When set to @code{On}, Info garbage collects files which had to be | 1150 When set to @code{On}, Info garbage collects files which had to be |
1249 uncompressed. The default value of this variable is @code{Off}. | 1151 uncompressed. The default value of this variable is @code{Off}. |
1250 Whenever a node is visited in Info, the Info file containing that node | 1152 Whenever a node is visited in Info, the info file containing that node |
1251 is read into core, and Info reads information about the tags and nodes | 1153 is read into core, and Info reads information about the tags and nodes |
1252 contained in that file. Once the tags information is read by Info, it | 1154 contained in that file. Once the tags information is read by Info, it |
1253 is never forgotten. However, the actual text of the nodes does not need | 1155 is never forgotten. However, the actual text of the nodes does not need |
1254 to remain in core unless a particular Info window needs it. For | 1156 to remain in core unless a particular info window needs it. For |
1255 non-compressed files, the text of the nodes does not remain in core when | 1157 non-compressed files, the text of the nodes does not remain in core when |
1256 it is no longer in use. But de-compressing a file can be a time | 1158 it is no longer in use. But de-compressing a file can be a time |
1257 consuming operation, and so Info tries hard not to do it twice. | 1159 consuming operation, and so Info tries hard not to do it twice. |
1258 @code{gc-compressed-files} tells Info it is okay to garbage collect the | 1160 @code{gc-compressed-files} tells Info it is okay to garbage collect the |
1259 text of the nodes of a file which was compressed on disk. | 1161 text of the nodes of a file which was compressed on disk. |
1266 When Info displays the location where an index match was found, | 1168 When Info displays the location where an index match was found, |
1267 (@pxref{Searching Commands, , @code{next-index-match}}), the portion of the | 1169 (@pxref{Searching Commands, , @code{next-index-match}}), the portion of the |
1268 string that you had typed is highlighted by displaying it in the inverse | 1170 string that you had typed is highlighted by displaying it in the inverse |
1269 case from its surrounding characters. | 1171 case from its surrounding characters. |
1270 | 1172 |
1271 @item scroll-behavior | 1173 @item scroll-behaviour |
1272 @vindex scroll-behavior | 1174 @vindex scroll-behaviour |
1273 Control what happens when forward scrolling is requested at the end of | 1175 Controls what happens when forward scrolling is requested at the end of |
1274 a node, or when backward scrolling is requested at the beginning of a | 1176 a node, or when backward scrolling is requested at the beginning of a |
1275 node. The default value for this variable is @code{Continuous}. There | 1177 node. The default value for this variable is @code{Continuous}. There |
1276 are three possible values for this variable: | 1178 are three possible values for this variable: |
1277 | 1179 |
1278 @table @code | 1180 @table @code |
1279 @item Continuous | 1181 @item Continuous |
1280 Try to get the first item in this node's menu, or failing that, the | 1182 Tries to get the first item in this node's menu, or failing that, the |
1281 @samp{Next} node, or failing that, the @samp{Next} of the @samp{Up}. | 1183 @samp{Next} node, or failing that, the @samp{Next} of the @samp{Up}. |
1282 This behavior is identical to using the @samp{]} | 1184 This behaviour is identical to using the @samp{]} |
1283 (@code{global-next-node}) and @samp{[} (@code{global-prev-node}) | 1185 (@code{global-next-node}) and @samp{[} (@code{global-prev-node}) |
1284 commands. | 1186 commands. |
1285 | 1187 |
1286 @item Next Only | 1188 @item Next Only |
1287 Only try to get the @samp{Next} node. | 1189 Only tries to get the @samp{Next} node. |
1288 | 1190 |
1289 @item Page Only | 1191 @item Page Only |
1290 Simply give up, changing nothing. If @code{scroll-behavior} is | 1192 Simply gives up, changing nothing. If @code{scroll-behaviour} is |
1291 @code{Page Only}, no scrolling command can change the node that is being | 1193 @code{Page Only}, no scrolling command can change the node that is being |
1292 viewed. | 1194 viewed. |
1293 @end table | 1195 @end table |
1294 | 1196 |
1295 @item scroll-step | 1197 @item scroll-step |
1305 cursor (and the text it is attached to) in the center of the window. | 1207 cursor (and the text it is attached to) in the center of the window. |
1306 Setting this variable to 1 causes a kind of "smooth scrolling" which | 1208 Setting this variable to 1 causes a kind of "smooth scrolling" which |
1307 some people prefer. | 1209 some people prefer. |
1308 | 1210 |
1309 @item ISO-Latin | 1211 @item ISO-Latin |
1310 @cindex ISO Latin characters | 1212 @cindex ISO Latin-1 characters |
1311 @vindex ISO-Latin | 1213 @vindex ISO-Latin |
1312 When set to @code{On}, Info accepts and displays ISO Latin characters. | 1214 When set to @code{On}, Info accepts and displays ISO Latin-1 characters. |
1313 By default, Info assumes an ASCII character set. @code{ISO-Latin} tells | 1215 By default, Info assumes an ASCII character set. @code{ISO-Latin} tells |
1314 Info that it is running in an environment where the European standard | 1216 Info that it is running in an environment where the European standard |
1315 character set is in use, and allows you to input such characters to | 1217 character set is in use, and allows you to input such characters to |
1316 Info, as well as display them. | 1218 Info, as well as display them. |
1317 @end table | 1219 @end table |
1318 | 1220 |
1319 | 1221 @c The following node and its children are currently unfinished. Please feel |
1320 | 1222 @c free to finish it! |
1321 @c the following is incomplete | 1223 |
1322 @ignore | 1224 @ifset NOTSET |
1323 @c node Info for Sys Admins | 1225 @node Info for Sys Admins |
1324 @c chapter Info for System Administrators | 1226 @chapter Info for System Administrators |
1325 | 1227 |
1326 This text describes some common ways of setting up an Info hierarchy | 1228 This text describes some common ways of setting up an Info heierarchy |
1327 from scratch, and details the various options that are available when | 1229 from scratch, and details the various options that are available when |
1328 installing Info. This text is designed for the person who is installing | 1230 installing Info. This text is designed for the person who is installing |
1329 GNU Info on the system; although users may find the information present | 1231 GNU Info on the system; although users may find the information present |
1330 in this section interesting, none of it is vital to understanding how to | 1232 in this section interesting, none of it is vital to understanding how to |
1331 use GNU Info. | 1233 use GNU Info. |
1332 | 1234 |
1333 @menu | 1235 @menu |
1334 * Setting the INFOPATH:: Where are my Info files kept? | 1236 * Setting the INFOPATH:: Where are my Info files kept? |
1335 * Editing the DIR node:: What goes in `DIR', and why? | 1237 * Editing the DIR node:: What goes in `DIR', and why? |
1336 * Storing Info files:: Alternate formats allow flexibility in setups. | 1238 * Storing Info files:: Alternate formats allow flexibilty in setups. |
1337 * Using `localdir':: Building DIR on the fly. | 1239 * Using `localdir':: Building DIR on the fly. |
1338 * Example setups:: Some common ways to organize Info files. | 1240 * Example setups:: Some common ways to origanize Info files. |
1339 @end menu | 1241 @end menu |
1340 | 1242 |
1341 @c node Setting the INFOPATH | 1243 @node Setting the INFOPATH |
1342 @c section Setting the INFOPATH | 1244 @section Setting the INFOPATH |
1343 | |
1344 Where are my Info files kept? | 1245 Where are my Info files kept? |
1345 | 1246 |
1346 @c node Editing the DIR node | 1247 @node Editing the DIR node |
1347 @c section Editing the DIR node | 1248 @section Editing the DIR node |
1348 | |
1349 What goes in `DIR', and why? | 1249 What goes in `DIR', and why? |
1350 | 1250 |
1351 @c node Storing Info files | 1251 @node Storing Info files |
1352 @c section Storing Info files | 1252 @section Storing Info files |
1353 | 1253 Alternate formats allow flexibilty in setups. |
1354 Alternate formats allow flexibility in setups. | 1254 |
1355 | 1255 @node Using `localdir' |
1356 @c node Using `localdir' | 1256 @section Using `localdir' |
1357 @c section Using `localdir' | |
1358 | |
1359 Building DIR on the fly. | 1257 Building DIR on the fly. |
1360 | 1258 |
1361 @c node Example setups | 1259 @node Example setups |
1362 @c section Example setups | 1260 @section Example setups |
1363 | 1261 Some common ways to origanize Info files. |
1364 Some common ways to organize Info files. | 1262 @end ifset |
1365 @end ignore | 1263 |
1366 | 1264 @ifset STANDALONE |
1367 @node GNU Info Global Index, , Variables, Top | 1265 @node GNU Info Global Index |
1368 @appendix Global Index | 1266 @appendix Global Index |
1369 | |
1370 @printindex cp | 1267 @printindex cp |
1371 | 1268 @end ifset |
1372 @contents | |
1373 @bye |