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