Mercurial > emacs
annotate man/info.texi @ 37355:981fa38deecf
(Help-Small-Screen): Mention Backspace.
(Help-^L): Explain what does "Backspace or DEL" stand for.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Sun, 15 Apr 2001 08:43:53 +0000 |
parents | 7ebf3c6391d2 |
children | f3e3f00c30fc |
rev | line source |
---|---|
25839 | 1 \input texinfo @c -*-texinfo-*- |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
2 @comment %**start of header |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
3 @setfilename info.info |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
4 @settitle Info |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
5 @syncodeindex fn cp |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
6 @syncodeindex vr cp |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
7 @syncodeindex ky cp |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
8 @comment %**end of header |
37355
981fa38deecf
(Help-Small-Screen): Mention Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37344
diff
changeset
|
9 @comment $Id: info.texi,v 1.9 2001/04/14 11:52:21 eliz Exp $ |
25839 | 10 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
11 @dircategory Texinfo documentation system |
25839 | 12 @direntry |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
13 * Info: (info). Documentation browsing system. |
25839 | 14 @end direntry |
15 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
16 @ifinfo |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
17 This file describes how to use Info, the on-line, menu-driven GNU |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
18 documentation system. |
25839 | 19 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
20 Copyright (C) 1989, 92, 96, 97, 98, 99, 2000, 2001 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
21 Free Software Foundation, Inc. |
25839 | 22 |
23 | |
32315 | 24 Permission is granted to copy, distribute and/or modify this document |
25 under the terms of the GNU Free Documentation License, Version 1.1 or | |
26 any later version published by the Free Software Foundation; with no | |
27 Invariant Sections, with the Front-Cover texts being ``A GNU | |
28 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the | |
29 license is included in the section entitled ``GNU Free Documentation | |
30 License'' in the Emacs manual. | |
25839 | 31 |
32315 | 32 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify |
33 this GNU Manual, like GNU software. Copies published by the Free | |
34 Software Foundation raise funds for GNU development.'' | |
25839 | 35 |
32315 | 36 This document is part of a collection distributed under the GNU Free |
37 Documentation License. If you want to distribute this document | |
38 separately from the collection, you can do so by adding a copy of the | |
39 license to the document, as described in section 6 of the license. | |
25839 | 40 @end ifinfo |
41 | |
42 @titlepage | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
43 @title Info |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
44 @subtitle The online, hyper-text GNU documentation system |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
45 @author Brian Fox |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
46 @author and the GNU Texinfo community |
25839 | 47 @page |
48 @vskip 0pt plus 1filll | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
49 Copyright @copyright{} 1989, 92, 93, 96, 97, 98, 99, 2000, 2001 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
50 Free Software Foundation, Inc. |
25839 | 51 @sp 2 |
52 Published by the Free Software Foundation @* | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
53 59 Temple Place - Suite 330 @* |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
54 Boston, MA 02111-1307, USA. |
25839 | 55 |
32315 | 56 Permission is granted to copy, distribute and/or modify this document |
57 under the terms of the GNU Free Documentation License, Version 1.1 or | |
58 any later version published by the Free Software Foundation; with no | |
59 Invariant Sections, with the Front-Cover texts being ``A GNU | |
60 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the | |
61 license is included in the section entitled ``GNU Free Documentation | |
62 License'' in the Emacs manual. | |
25839 | 63 |
32315 | 64 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify |
65 this GNU Manual, like GNU software. Copies published by the Free | |
66 Software Foundation raise funds for GNU development.'' | |
25839 | 67 |
32315 | 68 This document is part of a collection distributed under the GNU Free |
69 Documentation License. If you want to distribute this document | |
70 separately from the collection, you can do so by adding a copy of the | |
71 license to the document, as described in section 6 of the license. | |
25839 | 72 @end titlepage |
73 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
74 @ifnottex |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
75 @node Top |
25839 | 76 @top Info: An Introduction |
77 | |
78 Info is a program for reading documentation, which you are using now. | |
79 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
80 @ifinfo |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
81 If you are new to Info and want to learn how to use it, type the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
82 command @kbd{h} now. It brings you to a programmed instruction |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
83 sequence. |
25839 | 84 |
85 To learn advanced Info commands, type @kbd{n} twice. This brings you to | |
86 @cite{Info for Experts}, skipping over the `Getting Started' chapter. | |
87 @end ifinfo | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
88 @end ifnottex |
25839 | 89 |
90 @menu | |
91 * Getting Started:: Getting started using an Info reader. | |
92 * Advanced Info:: Advanced commands within Info. | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
93 * Creating an Info File:: How to make your own Info file. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
94 * Index:: An Index of topics, commands, and variables. |
25839 | 95 @end menu |
96 | |
97 @node Getting Started, Advanced Info, Top, Top | |
98 @comment node-name, next, previous, up | |
99 @chapter Getting Started | |
100 | |
101 This first part of the Info manual describes how to get around inside | |
102 of Info. The second part of the manual describes various advanced | |
103 Info commands, and how to write an Info as distinct from a Texinfo | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
104 file. The third part briefly explains how to generate Info files from |
25839 | 105 Texinfo files. |
106 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
107 @ifnotinfo |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
108 This manual is primarily designed for browsing with an Info reader |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
109 program on a computer, so that you can try Info commands while reading |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
110 about them. Reading it on paper or with an HTML browser is less |
25839 | 111 effective, since you must take it on faith that the commands described |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
112 really do what the manual says. By all means go through this manual |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
113 now that you have it; but please try going through the on-line version |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
114 as well. |
25839 | 115 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
116 @cindex Info reader, how to invoke |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
117 @cindex entering Info |
25839 | 118 There are two ways of looking at the online version of this manual: |
119 | |
120 @enumerate | |
121 @item | |
122 Type @code{info} at your shell's command line. This approach uses a | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
123 small stand-alone program designed just to read Info files. |
25839 | 124 |
125 @item | |
126 Type @code{emacs} at the command line; then type @kbd{C-h i} (Control | |
127 @kbd{h}, followed by @kbd{i}). This approach uses the Info mode of the | |
128 Emacs program, an editor with many other capabilities. | |
129 @end enumerate | |
130 | |
131 In either case, then type @kbd{mInfo} (just the letters), followed by | |
132 @key{RET}---the ``Return'' or ``Enter'' key. At this point, you should | |
133 be ready to follow the instructions in this manual as you read them on | |
134 the screen. | |
135 @c FIXME! (pesch@cygnus.com, 14 dec 1992) | |
136 @c Is it worth worrying about what-if the beginner goes to somebody | |
137 @c else's Emacs session, which already has an Info running in the middle | |
138 @c of something---in which case these simple instructions won't work? | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
139 @end ifnotinfo |
25839 | 140 |
141 @menu | |
142 * Help-Small-Screen:: Starting Info on a Small Screen | |
143 * Help:: How to use Info | |
144 * Help-P:: Returning to the Previous node | |
145 * Help-^L:: The Space, Rubout, B and ^L commands. | |
146 * Help-M:: Menus | |
147 * Help-Adv:: Some advanced Info commands | |
148 * Help-Q:: Quitting Info | |
149 @end menu | |
150 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
151 @node Help-Small-Screen |
25839 | 152 @section Starting Info on a Small Screen |
153 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
154 @ifnotinfo |
25839 | 155 (In Info, you only see this section if your terminal has a small |
156 number of lines; most readers pass by it without seeing it.) | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
157 @end ifnotinfo |
25839 | 158 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
159 @cindex small screen, moving around |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
160 Since your terminal has a relatively small number of lines on its |
25839 | 161 screen, it is necessary to give you special advice at the beginning. |
162 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
163 If you see the text @samp{--All----} near the bottom right corner |
25839 | 164 of the screen, it means the entire text you are looking at fits on the |
165 screen. If you see @samp{--Top----} instead, it means that there is | |
166 more text below that does not fit. To move forward through the text | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
167 and see another screen full, press @key{SPC}, the Space bar. To move |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
168 back up, press the key labeled @samp{Backspace} or @samp{DEL} (on some |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
169 keyboards, this key might be labeled @samp{Delete}). |
25839 | 170 |
171 @ifinfo | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
172 Here are 40 lines of junk, so you can try Spaces and DEL and |
25839 | 173 see what they do. At the end are instructions of what you should do |
174 next. | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
175 |
25839 | 176 @format |
177 This is line 20 | |
178 This is line 21 | |
179 This is line 22 | |
180 This is line 23 | |
181 This is line 24 | |
182 This is line 25 | |
183 This is line 26 | |
184 This is line 27 | |
185 This is line 28 | |
186 This is line 29 | |
187 This is line 30 | |
188 This is line 31 | |
189 This is line 32 | |
190 This is line 33 | |
191 This is line 34 | |
192 This is line 35 | |
193 This is line 36 | |
194 This is line 37 | |
195 This is line 38 | |
196 This is line 39 | |
197 This is line 40 | |
198 This is line 41 | |
199 This is line 42 | |
200 This is line 43 | |
201 This is line 44 | |
202 This is line 45 | |
203 This is line 46 | |
204 This is line 47 | |
205 This is line 48 | |
206 This is line 49 | |
207 This is line 50 | |
208 This is line 51 | |
209 This is line 52 | |
210 This is line 53 | |
211 This is line 54 | |
212 This is line 55 | |
213 This is line 56 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
214 This is line 57 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
215 This is line 58 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
216 This is line 59 |
25839 | 217 @end format |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
218 |
25839 | 219 If you have managed to get here, go back to the beginning with |
37355
981fa38deecf
(Help-Small-Screen): Mention Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37344
diff
changeset
|
220 @kbd{DEL} (or Backspace), and come back here again, then you |
981fa38deecf
(Help-Small-Screen): Mention Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37344
diff
changeset
|
221 understand Space and DEL. So now type an @kbd{n} ---just one |
981fa38deecf
(Help-Small-Screen): Mention Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37344
diff
changeset
|
222 character; don't type the quotes and don't type the Return key |
981fa38deecf
(Help-Small-Screen): Mention Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37344
diff
changeset
|
223 afterward--- to get to the normal start of the course. |
25839 | 224 @end ifinfo |
225 | |
226 @node Help, Help-P, Help-Small-Screen, Getting Started | |
227 @comment node-name, next, previous, up | |
228 @section How to use Info | |
229 | |
230 You are talking to the program Info, for reading documentation. | |
231 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
232 @cindex node, in Info documents |
25839 | 233 Right now you are looking at one @dfn{Node} of Information. |
234 A node contains text describing a specific topic at a specific | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
235 level of detail. This node's topic is ``how to use Info''. The mode |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
236 line says that this is node @samp{Help} in the file @file{info}. |
25839 | 237 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
238 @cindex header of Info node |
25839 | 239 The top line of a node is its @dfn{header}. This node's header (look at |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
240 it now) says that the @samp{Next} node after this one is the node |
25839 | 241 called @samp{Help-P}. An advanced Info command lets you go to any node |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
242 whose name you know. In the stand-alone Info reader program, the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
243 header line shows the names of this node and the info file as well. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
244 In Emacs, the header line is displayed in a special typeface, and it |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
245 doesn't scroll off the screen when you scroll the display. The names |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
246 of this node and of its Info file are omitted by Emacs from the header |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
247 line. |
25839 | 248 |
249 Besides a @samp{Next}, a node can have a @samp{Previous} or an | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
250 @samp{Up} links, or both. As you can see, this node has all of these |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
251 links. |
25839 | 252 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
253 @kindex n @r{(Info mode)} |
25839 | 254 Now it is time to move on to the @samp{Next} node, named @samp{Help-P}. |
255 | |
256 @format | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
257 >> Type @kbd{n} to move there. Type just one character; |
25839 | 258 do not type the quotes and do not type a @key{RET} afterward. |
259 @end format | |
260 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
261 @noindent |
25839 | 262 @samp{>>} in the margin means it is really time to try a command. |
263 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
264 @format |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
265 >> If you have a mouse, and if you already practiced typing @kbd{n} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
266 to get to the next node, click now with the right mouse button on |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
267 the @samp{Next} link to do the same ``the mouse way''. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
268 @end format |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
269 |
25839 | 270 @node Help-P, Help-^L, Help, Getting Started |
271 @comment node-name, next, previous, up | |
272 @section Returning to the Previous node | |
273 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
274 @kindex p @r{(Info mode)} |
25839 | 275 This node is called @samp{Help-P}. The @samp{Previous} node, as you see, |
276 is @samp{Help}, which is the one you just came from using the @kbd{n} | |
277 command. Another @kbd{n} command now would take you to the next | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
278 node, @samp{Help-^L}. In Emacs, @kbd{n} runs the Emacs command |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
279 @code{Info-next}, and @kbd{p} runs @code{Info-prev}. |
25839 | 280 |
281 @format | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
282 >> But do not do that yet. First, try the @kbd{p} command, or click |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
283 the mouse on the @samp{Prev} link, which takes you to the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
284 @samp{Previous} node. When you get there, you can do an @kbd{n} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
285 again to return here. |
25839 | 286 @end format |
287 | |
288 This all probably seems insultingly simple so far, but @emph{do not} be | |
289 led into skimming. Things will get more complicated soon. Also, | |
290 do not try a new command until you are told it is time to. Otherwise, | |
291 you may make Info skip past an important warning that was coming up. | |
292 | |
293 @format | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
294 >> Now do an @kbd{n}, or click the mouse on the @samp{Next} link, to |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
295 get to the node @samp{Help-^L} and learn more. |
25839 | 296 @end format |
297 | |
298 @node Help-^L, Help-M, Help-P, Getting Started | |
299 @comment node-name, next, previous, up | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
300 @section The Space, DEL, B and ^L commands. |
25839 | 301 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
302 This node's mode line tells you that you are now at node @samp{Help-^L}, |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
303 and the header line tells you that @kbd{p} would get you back to |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
304 @samp{Help-P}. The node's title is underlined; it says what the node |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
305 is about (most nodes have titles). |
25839 | 306 |
307 This is a big node and it does not all fit on your display screen. | |
308 You can tell that there is more that is not visible because you | |
309 can see the string @samp{--Top-----} rather than @samp{--All----} near | |
310 the bottom right corner of the screen. | |
311 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
312 @kindex SPC @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
313 @kindex DEL @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
314 @kindex BACKSPACE @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
315 @findex Info-scroll-up |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
316 @findex Info-scroll-down |
37355
981fa38deecf
(Help-Small-Screen): Mention Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37344
diff
changeset
|
317 The Space, Backspace (or DEL)@footnote{The key which we call |
981fa38deecf
(Help-Small-Screen): Mention Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37344
diff
changeset
|
318 ``Backspace or DEL'' in this manual is labeled differently on |
981fa38deecf
(Help-Small-Screen): Mention Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37344
diff
changeset
|
319 different keyboards. Look for a key which is a little ways above the |
981fa38deecf
(Help-Small-Screen): Mention Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37344
diff
changeset
|
320 @key{ENTER} or @key{RET} key and which you normally use outside Emacs |
981fa38deecf
(Help-Small-Screen): Mention Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37344
diff
changeset
|
321 to erase the character before the cursor, i.e.@: the character you |
981fa38deecf
(Help-Small-Screen): Mention Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37344
diff
changeset
|
322 typed last. It might be labeled @samp{Backspace} or @samp{<-} or |
981fa38deecf
(Help-Small-Screen): Mention Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37344
diff
changeset
|
323 @samp{DEL}, or sometimes @samp{Delete}.} and @kbd{b} commands exist to |
981fa38deecf
(Help-Small-Screen): Mention Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37344
diff
changeset
|
324 allow you to ``move around'' in a node that does not all fit on the |
981fa38deecf
(Help-Small-Screen): Mention Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37344
diff
changeset
|
325 screen at once. Space moves forward, to show what was below the |
981fa38deecf
(Help-Small-Screen): Mention Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37344
diff
changeset
|
326 bottom of the screen. DEL or Backspace moves backward, to show what |
981fa38deecf
(Help-Small-Screen): Mention Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37344
diff
changeset
|
327 was above the top of the screen (there is not anything above the top |
981fa38deecf
(Help-Small-Screen): Mention Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37344
diff
changeset
|
328 until you have typed some spaces). In Emacs, Space runs the command |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
329 @code{Info-scroll-up}, while Backspace runs @code{Info-scroll-down}. |
25839 | 330 |
331 @format | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
332 >> Now try typing a Space (afterward, type a Backspace to return here). |
25839 | 333 @end format |
334 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
335 When you type the Space, the two lines that were at the bottom of |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
336 the screen appear at the top, followed by more lines. DEL or |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
337 Backspace takes the two lines from the top and moves them to the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
338 bottom, @emph{usually}, but if there are not a full screen's worth of |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
339 lines above them they may not make it all the way to the bottom. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
340 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
341 If you are reading this in Emacs, note that the header line is |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
342 always visible, never scrolling off the display. That way, you can |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
343 always see the @samp{Next}, @samp{Prev}, and @samp{Up} links, and you |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
344 can conveniently go to one of these links from anywhere in the node by |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
345 clicking the mouse on one of these links. |
25839 | 346 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
347 @cindex reading Info documents top to bottom |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
348 @cindex Info documents as tutorials |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
349 Space and DEL not only move forward and backward through the current |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
350 node. When these keys hit the beginning or the end of the current |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
351 node, they move to preceding or subsequent nodes. Specifically, they |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
352 scroll through all the nodes in an Info file as a single logical |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
353 sequence. In this sequence, a node's subnodes appear following their |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
354 parent. If a node has a menu, Space takes you into the subnodes |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
355 listed in the menu, one by one. Once you reach the end of a node, and |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
356 have seen all of its subnodes, Space takes you to the next node or to |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
357 the parent's next node. This is so you could read the entire manual |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
358 top to bottom by just typing Space. |
25839 | 359 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
360 @kindex PAGEUP @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
361 @kindex PAGEDOWN @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
362 Many keyboards nowadays have two scroll keys labeled @samp{PageUp} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
363 and @samp{PageDown} (or maybe @samp{Prior} and @samp{Next}). If your |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
364 keyboard has these keys, you can use them to move forward and backward |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
365 through the text, like with Space and Backspace. However, unlike |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
366 Space and Backspace, PageUp and PageDown keys will never scroll beyond |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
367 the beginning or the end of the current node. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
368 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
369 @kindex C-l @r{(Info mode)} |
25839 | 370 If your screen is ever garbaged, you can tell Info to print it out |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
371 again by typing @kbd{C-l} (@kbd{Control-L}, that is---hold down |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
372 ``Control'' and type an @key{L} or @kbd{l}). |
25839 | 373 |
374 @format | |
375 >> Type @kbd{C-l} now. | |
376 @end format | |
377 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
378 @kindex b @r{(Info mode)} |
25839 | 379 To move back to the beginning of the node you are on, you can type |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
380 a lot of Backspaces. You can also type simply @kbd{b} for beginning. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
381 |
25839 | 382 @format |
383 >> Try that now. (We have put in enough verbiage to push this past | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
384 the first screenful, but screens are so big nowadays that perhaps it |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
385 isn't enough. You may need to shrink your Emacs or Info window.) |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
386 Then come back, with Spaces. |
25839 | 387 @end format |
388 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
389 If your screen is very tall, all of this node might fit at once. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
390 In that case, @kbd{b} won't do anything. Sorry; what can we do? |
25839 | 391 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
392 @kindex ? @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
393 @findex Info-summary |
25839 | 394 You have just learned a considerable number of commands. If you |
395 want to use one but have trouble remembering which, you should type | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
396 a @key{?} (in Emacs it runs the @code{Info-summary} command) which |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
397 prints out a brief list of commands. When you are finished looking at |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
398 the list, make it go away by typing a Space repeatedly. |
25839 | 399 |
400 @format | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
401 >> Type a @key{?} now. Press @key{SPC} to see consecutive screenfuls of |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
402 the list until finished. Then type @key{SPC} several times, until |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
403 it goes away. |
25839 | 404 @end format |
405 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
406 (If you are using the stand-alone Info reader, type @kbd{C-x 0} to |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
407 return here, that is---press and hold ``Control'', type an @kbd{x}, |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
408 then release ``Control'' and @kbd{x}, and press @kbd{0}---a zero, not |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
409 the letter ``o''.) |
25839 | 410 |
411 From now on, you will encounter large nodes without warning, and | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
412 will be expected to know how to use Space and Backspace to move |
25839 | 413 around in them without being told. Since not all terminals have |
414 the same size screen, it would be impossible to warn you anyway. | |
415 | |
416 @format | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
417 >> Now type @kbd{n}, or click the mouse on the @samp{Next} link, to |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
418 see the description of the @kbd{m} command. |
25839 | 419 @end format |
420 | |
421 @node Help-M, Help-Adv, Help-^L, Getting Started | |
422 @comment node-name, next, previous, up | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
423 @section Menus and the @kbd{m} command |
25839 | 424 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
425 @cindex menus in an Info document |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
426 @cindex Info menus |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
427 With only the @kbd{n} (next) and @kbd{p} (previous) commands for |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
428 moving between nodes, nodes are restricted to a linear sequence. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
429 Menus allow a branching structure. A menu is a list of other nodes |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
430 you can move to. It is actually just part of the text of the node |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
431 formatted specially so that Info can interpret it. The beginning of a |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
432 menu is always identified by a line which starts with @samp{* Menu:}. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
433 A node contains a menu if and only if it has a line in it which starts |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
434 that way. The only menu you can use at any moment is the one in the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
435 node you are in. To use a menu in any other node, you must move to |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
436 that node first. |
25839 | 437 |
438 After the start of the menu, each line that starts with a @samp{*} | |
439 identifies one subtopic. The line usually contains a brief name | |
440 for the subtopic (followed by a @samp{:}), the name of the node that talks | |
441 about that subtopic, and optionally some further description of the | |
442 subtopic. Lines in the menu that do not start with a @samp{*} have no | |
443 special meaning---they are only for the human reader's benefit and do | |
444 not define additional subtopics. Here is an example: | |
445 | |
446 @example | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
447 * Foo: Node about FOO This tells about FOO |
25839 | 448 @end example |
449 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
450 The subtopic name is Foo, and the node describing it is @samp{Node |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
451 about FOO}. The rest of the line is just for the reader's |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
452 Information. [[ But this line is not a real menu item, simply because |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
453 there is no line above it which starts with @samp{* Menu:}.]] |
25839 | 454 |
455 When you use a menu to go to another node (in a way that will be | |
456 described soon), what you specify is the subtopic name, the first | |
457 thing in the menu line. Info uses it to find the menu line, extracts | |
458 the node name from it, and goes to that node. The reason that there | |
459 is both a subtopic name and a node name is that the node name must be | |
460 meaningful to the computer and may therefore have to be ugly looking. | |
461 The subtopic name can be chosen just to be convenient for the user to | |
462 specify. Often the node name is convenient for the user to specify | |
463 and so both it and the subtopic name are the same. There is an | |
464 abbreviation for this: | |
465 | |
466 @example | |
467 * Foo:: This tells about FOO | |
468 @end example | |
469 | |
470 @noindent | |
471 This means that the subtopic name and node name are the same; they are | |
472 both @samp{Foo}. | |
473 | |
474 @format | |
475 >> Now use Spaces to find the menu in this node, then come back to | |
476 the front with a @kbd{b} and some Spaces. As you see, a menu is | |
477 actually visible in its node. If you cannot find a menu in a node | |
478 by looking at it, then the node does not have a menu and the | |
479 @kbd{m} command is not available. | |
480 @end format | |
481 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
482 @kindex m @r{(Info mode)} |
25839 | 483 The command to go to one of the subnodes is @kbd{m}---but @emph{do |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
484 not do it yet!} Before you use @kbd{m}, you need to learn about |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
485 commands which prompt you for more input. So far, you have learned |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
486 several commands that do not need additional input; when you typed |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
487 one, Info processed it and was instantly ready for another command. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
488 The @kbd{m} command is different: it is incomplete without the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
489 @dfn{name of the subtopic}. Once you have typed @kbd{m}, Info tries |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
490 to read the subtopic name. |
25839 | 491 |
492 Now look for the line containing many dashes near the bottom of the | |
493 screen. There is one more line beneath that one, but usually it is | |
494 blank. If it is empty, Info is ready for a command, such as @kbd{n} | |
495 or @kbd{b} or Space or @kbd{m}. If that line contains text ending | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
496 in a colon, it means Info is trying to read more input for the last |
25839 | 497 command. At such times, commands do not work, because Info tries to |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
498 use them as the input it needs. You must either type your response and |
25839 | 499 finish the command you started, or type @kbd{Control-g} to cancel the |
500 command. When you have done one of those things, the line becomes | |
501 blank again. | |
502 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
503 @findex Info-menu |
25839 | 504 The command to go to a subnode via a menu is @kbd{m}. After you type |
505 the @kbd{m}, the line at the bottom of the screen says @samp{Menu item: }. | |
506 You must then type the name of the subtopic you want, and end it with | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
507 a @key{RET}. In Emacs, @kbd{m} runs the command @code{Info-menu}. |
25839 | 508 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
509 @cindex abbreviating Info subnodes |
25839 | 510 You can abbreviate the subtopic name. If the abbreviation is not |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
511 unique, the first matching subtopic is chosen. Some menus put |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
512 the shortest possible abbreviation for each subtopic name in capital |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
513 letters, so you can see how much you need to type. It does not |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
514 matter whether you use upper case or lower case when you type the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
515 subtopic. You should not put any spaces at the end, or inside of the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
516 item name, except for one space where a space appears in the item in |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
517 the menu. |
25839 | 518 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
519 @cindex completion of Info node names |
25839 | 520 You can also use the @dfn{completion} feature to help enter the subtopic |
521 name. If you type the Tab key after entering part of a name, it will | |
522 magically fill in more of the name---as much as follows uniquely from | |
523 what you have entered. | |
524 | |
525 If you move the cursor to one of the menu subtopic lines, then you do | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
526 not need to type the argument: you just type a @key{RET}, and it |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
527 stands for the subtopic of the line you are on. |
25839 | 528 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
529 Here is a menu to give you a chance to practice. This menu gives you |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
530 three ways of going to one place, Help-FOO: |
25839 | 531 |
532 @menu | |
533 * Foo: Help-FOO. A node you can visit for fun. | |
534 * Bar: Help-FOO. Strange! two ways to get to the same place. | |
535 * Help-FOO:: And yet another! | |
536 @end menu | |
537 | |
538 @format | |
539 >> Now type just an @kbd{m} and see what happens: | |
540 @end format | |
541 | |
542 Now you are ``inside'' an @kbd{m} command. Commands cannot be used | |
543 now; the next thing you will type must be the name of a subtopic. | |
544 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
545 You can change your mind about doing the @kbd{m} by typing |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
546 @kbd{Control-g}. |
25839 | 547 |
548 @format | |
549 >> Try that now; notice the bottom line clear. | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
550 @end format |
25839 | 551 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
552 @format |
25839 | 553 >> Then type another @kbd{m}. |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
554 @end format |
25839 | 555 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
556 @format |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
557 >> Now type @kbd{BAR}, the item name. Do not type @key{RET} yet. |
25839 | 558 @end format |
559 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
560 While you are typing the item name, you can use the @key{DEL} (or |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
561 Backspace) key to cancel one character at a time if you make a |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
562 mistake. |
25839 | 563 |
564 @format | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
565 >> Press @key{DEL} to cancel the @samp{R}. You could type another @kbd{R} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
566 to replace it. But you do not have to, since @samp{BA} is a valid |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
567 abbreviation. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
568 @end format |
25839 | 569 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
570 @format |
25839 | 571 >> Now you are ready to go. Type a @key{RET}. |
572 @end format | |
573 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
574 After visiting @samp{Help-FOO}, you should return here. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
575 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
576 Another way to move to the menu subtopic lines and between them is |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
577 to type @key{TAB}. Each time you type a @key{TAB}, you move to the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
578 next subtopic line. To move to a previous subtopic line, type |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
579 @kbd{M-@key{TAB}}---that is, press and hold the Meta key and then |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
580 press @key{TAB}. (On some keyboards, the Meta key might be known as |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
581 ``Alt''.) |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
582 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
583 Once you move cursor to a subtopic line, press @key{RET} to go to |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
584 that subtopic's node. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
585 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
586 @cindex mouse support in Info mode |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
587 @kindex Mouse-2 @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
588 If your terminal supports a mouse, you have yet another way of going |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
589 to a subtopic. Move your mouse pointer to the subtopic line, |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
590 somewhere between the beginning @samp{*} and the colon @samp{:} which |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
591 ends the subtopic's brief name. You will see the subtopic's name |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
592 change its appearance (usually, its background color will change), and |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
593 the shape of the mouse pointer will change if your platform supports |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
594 that. After a while, if you leave the mouse on that spot, a tooltip |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
595 will pop up saying ``Mouse-2: go to that node''. (If the tooltips are |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
596 turned off or unavailable, this message is printed in the @dfn{echo |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
597 area}, the last screen line where you typed the menu subtopics in |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
598 response to the prompt.) @kbd{Mouse-2} is the second button of your |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
599 mouse---normally the rightmost button. So pressing @kbd{Mouse-2} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
600 while the mouse pointer is on a menu subtopic goes to that subtopic. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
601 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
602 @findex Info-mouse-follow-nearest-node |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
603 More generally, @kbd{Mouse-2} in an Info buffer runs the Emacs |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
604 command @code{Info-mouse-follow-nearest-node}, which finds the nearest |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
605 link to another node and goes there. For example, near a cross |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
606 reference it acts like @kbd{f}, in a menu it acts like @kbd{m}, on the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
607 node's header line it acts like @kbd{n}, @kbd{p}, or @kbd{u}, etc. At |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
608 end of the node's text @kbd{Mouse-2} moves to the next node, or up if |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
609 there's no next node. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
610 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
611 Here is another way to get to Help-FOO, a menu. You can ignore this |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
612 if you want, or else try it by typing @key{TAB} and then @key{RET}, or |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
613 clicking @kbd{Mouse-2} on it (but then please come back to here). |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
614 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
615 @menu |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
616 * Help-FOO:: |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
617 @end menu |
25839 | 618 |
619 @format | |
620 >> Type @kbd{n} to see more commands. | |
621 @end format | |
622 | |
623 @node Help-FOO, , , Help-M | |
624 @subsection The @kbd{u} command | |
625 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
626 Congratulations! This is the node @samp{Help-FOO}. It has an @samp{Up} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
627 pointer @samp{Help-M}, the node you just came from via the @kbd{m} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
628 command. This is the usual convention---the nodes you reach from a menu |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
629 have @samp{Up} nodes that lead back to the menu. Menus move Down in the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
630 tree, and @samp{Up} moves Up. @samp{Previous}, on the other hand, is |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
631 usually used to ``stay on the same level but go backwards''. |
25839 | 632 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
633 @kindex u @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
634 @findex Info-up |
25839 | 635 You can go back to the node @samp{Help-M} by typing the command |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
636 @kbd{u} for ``Up'' (the Emacs command ruin by @kbd{u} is |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
637 @code{Info-up}). That puts you at the @emph{front} of the node---to |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
638 get back to where you were reading you have to type some @key{SPC}s. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
639 (Some Info readers, such as the one built into Emacs, put you at the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
640 same place where you were reading in @samp{Help-M}.) |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
641 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
642 Another way to go Up is to click on the @samp{Up} pointer shown in |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
643 the header line (provided that you have a mouse). |
25839 | 644 |
645 @format | |
646 >> Now type @kbd{u} to move back up to @samp{Help-M}. | |
647 @end format | |
648 | |
649 @node Help-Adv, Help-Q, Help-M, Getting Started | |
650 @comment node-name, next, previous, up | |
651 @section Some advanced Info commands | |
652 | |
653 The course is almost over, so please stick with it to the end. | |
654 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
655 @kindex l @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
656 @findex Info-last |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
657 @cindex going back in Info mode |
25839 | 658 If you have been moving around to different nodes and wish to |
659 retrace your steps, the @kbd{l} command (@kbd{l} for @dfn{last}) will | |
660 do that, one node-step at a time. As you move from node to node, Info | |
661 records the nodes where you have been in a special history list. The | |
662 @kbd{l} command revisits nodes in the history list; each successive | |
663 @kbd{l} command moves one step back through the history. | |
664 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
665 If you have been following directions, ad @kbd{l} command now will get |
25839 | 666 you back to @samp{Help-M}. Another @kbd{l} command would undo the |
667 @kbd{u} and get you back to @samp{Help-FOO}. Another @kbd{l} would undo | |
668 the @kbd{m} and get you back to @samp{Help-M}. | |
669 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
670 In Emacs, @kbd{l} runs the command @code{Info-last}. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
671 |
25839 | 672 @format |
673 >> Try typing three @kbd{l}'s, pausing in between to see what each | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
674 @kbd{l} does. Then follow directions again and you will end up |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
675 back here. |
25839 | 676 @end format |
677 | |
678 Note the difference between @kbd{l} and @kbd{p}: @kbd{l} moves to | |
679 where @emph{you} last were, whereas @kbd{p} always moves to the node | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
680 which the header says is the @samp{Previous} node (from this node, the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
681 @samp{Prev} link leads to @samp{Help-M}). |
25839 | 682 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
683 @kindex d @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
684 @findex Info-directory |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
685 @cindex go to Directory node |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
686 The @kbd{d} command (@code{Info-directory} in Emacs) gets you |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
687 instantly to the Directory node. This node, which is the first one |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
688 you saw when you entered Info, has a menu which leads (directly, or |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
689 indirectly through other menus), to all the nodes that exist. The |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
690 Directory node lists all the manuals and other Info documents that |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
691 are, or could be, installed on your system. |
25839 | 692 |
693 @format | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
694 >> Try doing a @kbd{d}, then do an @kbd{l} to return here (yes, |
25839 | 695 @emph{do} return). |
696 @end format | |
697 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
698 @kindex t @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
699 @findex Info-top-node |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
700 @cindex go to Top node |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
701 The @kbd{t} command moves to the @samp{Top} node of the manual. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
702 This is useful if you want to browse the manual's main menu, or select |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
703 some specific top-level menu item. The Emacs command run by @kbd{t} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
704 is @code{Info-top-node}. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
705 |
25839 | 706 Sometimes, in Info documentation, you will see a cross reference. |
707 Cross references look like this: @xref{Help-Cross, Cross}. That is a | |
708 real, live cross reference which is named @samp{Cross} and points at | |
709 the node named @samp{Help-Cross}. | |
710 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
711 @kindex f @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
712 @findex Info-follow-reference |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
713 @cindex cross references in Info documents |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
714 If you wish to follow a cross reference, you must use the @kbd{f} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
715 command. The @kbd{f} must be followed by the cross reference name |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
716 (in this case, @samp{Cross}). If the cursor is on or near the cross |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
717 reference, Info suggests the name if the nearest reference in |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
718 parentheses; typing @key{RET} will follow that reference. You can |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
719 also type a different name, if the default is not what you want. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
720 While you enter the name, you can use the DEL (or Backspace) key to |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
721 edit your input. If you change your mind about following any |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
722 reference, you can use @kbd{Control-g} to cancel the command. |
25839 | 723 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
724 Completion is available in the @kbd{f} command; you can complete among |
25839 | 725 all the cross reference names in the current node by typing a Tab. |
726 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
727 @kbd{f} runs @code{Info-follow-reference} in Emacs. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
728 |
25839 | 729 @format |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
730 >> Type @kbd{f}, followed by @kbd{Cross}, and a @key{RET}. |
25839 | 731 @end format |
732 | |
733 To get a list of all the cross references in the current node, you can | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
734 type @kbd{?} after an @kbd{f}. The @kbd{f} continues to await a |
25839 | 735 cross reference name even after printing the list, so if you don't |
736 actually want to follow a reference, you should type a @kbd{Control-g} | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
737 to cancel the @kbd{f}. |
25839 | 738 |
739 @format | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
740 >> Type @kbd{f?} to get a list of the cross references in this node. Then |
25839 | 741 type a @kbd{Control-g} and see how the @samp{f} gives up. |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
742 @end format |
25839 | 743 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
744 The @key{TAB} and @kbd{M-@key{TAB}} key, which move between |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
745 subtopics in a menu can move between cross references as well. Once |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
746 the cursor is on a cross reference, you can press @key{RET} to follow |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
747 that reference, just like you do in a menu. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
748 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
749 Clicking @kbd{Mouse-2} on or near a cross reference also follows the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
750 reference. You can see that the cross reference is mouse-sensitive by |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
751 moving the mouse pointer to the reference and watching how the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
752 underlying text and the mouse pointer change in response. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
753 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
754 @format |
25839 | 755 >> Now type @kbd{n} to see the last node of the course. |
756 @end format | |
757 | |
758 @c If a menu appears at the end of this node, remove it. | |
759 @c It is an accident of the menu updating command. | |
760 | |
761 @node Help-Cross, , , Help-Adv | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
762 @subsection The node reached by the cross reference in Info |
25839 | 763 |
764 This is the node reached by the cross reference named @samp{Cross}. | |
765 | |
766 While this node is specifically intended to be reached by a cross | |
767 reference, most cross references lead to nodes that ``belong'' | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
768 someplace else far away in the structure of an Info document. So you |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
769 cannot expect this node to have a @samp{Next}, @samp{Previous} or |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
770 @samp{Up} links pointing back to where you came from. In general, the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
771 @kbd{l} (el) command is the only way to get back there. |
25839 | 772 |
773 @format | |
774 >> Type @kbd{l} to return to the node where the cross reference was. | |
775 @end format | |
776 | |
777 @node Help-Q, , Help-Adv, Getting Started | |
778 @comment node-name, next, previous, up | |
779 @section Quitting Info | |
780 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
781 @kindex q @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
782 @findex Info-exit |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
783 @cindex quitting Info mode |
25839 | 784 To get out of Info, back to what you were doing before, type @kbd{q} |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
785 for @dfn{Quit}. This runs @code{Info-exit} in Emacs. |
25839 | 786 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
787 This is the end of the basic course on using Info. You have learned |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
788 how to move in an Info document, and how to follow menus and cross |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
789 references. This makes you ready for reading manuals top to bottom, |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
790 as new users should do when they learn a new package. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
791 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
792 Another set of Info commands is useful when you need to find |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
793 something quickly in a manual---that is, when you need to use a manual |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
794 as a reference rather than as a tutorial. We urge you to make learn |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
795 these search commands as well. If you want to do that now, follow this |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
796 cross reference to @ref{Info Search}. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
797 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
798 Yet another set of commands are meant for experienced users; you can |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
799 find them by looking in the Directory node for documentation on Info. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
800 Finding them will be a good exercise in using Info in the usual |
25839 | 801 manner. |
802 | |
803 @format | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
804 >> Type @kbd{d} to go to the Info directory node; then type |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
805 @kbd{mInfo} and Return, to get to the node about Info and |
25839 | 806 see what other help is available. |
807 @end format | |
808 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
809 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
810 @node Advanced Info |
25839 | 811 @chapter Info for Experts |
812 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
813 This chapter describes various advanced Info commands. (If you are |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
814 using a stand-alone Info reader, there are additional commands |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
815 specific to it, which are documented in several chapters of @ref{Top,, |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
816 GNU Info, info-stnd, GNU Info}.) |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
817 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
818 This chapter also explains how to write an Info as distinct from a |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
819 Texinfo file. (However, in most cases, writing a Texinfo file is |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
820 better, since you can use it @emph{both} to generate an Info file and |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
821 to make a printed manual. @xref{Top,, Overview of Texinfo, texinfo, |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
822 Texinfo: The GNU Documentation Format}.) |
25839 | 823 |
824 @menu | |
825 * Expert:: Advanced Info commands: g, s, e, and 1 - 5. | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
826 * Info Search:: How to search Info documents for specific subjects. |
25839 | 827 * Add:: Describes how to add new nodes to the hierarchy. |
828 Also tells what nodes look like. | |
829 * Menus:: How to add to or create menus in Info nodes. | |
830 * Cross-refs:: How to add cross-references to Info nodes. | |
831 * Tags:: How to make tags tables for Info files. | |
832 * Checking:: Checking an Info File | |
833 * Emacs Info Variables:: Variables modifying the behavior of Emacs Info. | |
834 @end menu | |
835 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
836 @node Expert, Info Search, , Advanced Info |
25839 | 837 @comment node-name, next, previous, up |
838 @section Advanced Info Commands | |
839 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
840 Here are some more Info commands that make it easier to move around. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
841 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
842 @unnumberedsubsec @kbd{g} goes to a node by name |
25839 | 843 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
844 @kindex g @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
845 @findex Info-goto-node |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
846 @cindex go to a node by name |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
847 If you know a node's name, you can go there by typing @kbd{g}, the |
25839 | 848 name, and @key{RET}. Thus, @kbd{gTop@key{RET}} would go to the node |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
849 called @samp{Top} in this file. (This is equivalent to @kbd{t}, see |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
850 @ref{Help-Adv}.) @kbd{gExpert@key{RET}} would come back here. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
851 @kbd{g} in Emacs runs the command @code{Info-goto-node}. |
25839 | 852 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
853 Unlike @kbd{m}, @kbd{g} does not allow the use of abbreviations. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
854 But it does allow completion, so you can type @key{TAB} to complete a |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
855 partial node name. |
25839 | 856 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
857 @cindex go to another Info file |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
858 To go to a node in another file, you can include the file name in the |
25839 | 859 node name by putting it at the front, in parentheses. Thus, |
860 @kbd{g(dir)Top@key{RET}} would go to the Info Directory node, which is | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
861 the node @samp{Top} in the Info file @file{dir}. Likewise, |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
862 @kbd{g(emacs)Top@key{RET}} goes to the top node of the Emacs manual. |
25839 | 863 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
864 The node name @samp{*} specifies the whole file. So you can look at |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
865 all of the current file by typing @kbd{g*@key{RET}} or all of any |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
866 other file with @kbd{g(@var{filename})@key{RET}}. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
867 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
868 @unnumberedsubsec @kbd{1} -- @kbd{9} choose a menu subtopic by its number |
25839 | 869 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
870 @kindex 1 @r{through} 9 @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
871 @findex Info-nth-menu-item |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
872 @cindex select @var{n}'th menu item |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
873 If you begrudge each character of type-in which your system requires, |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
874 you might like to use the commands @kbd{1}, @kbd{2}, @kbd{3}, @kbd{4}, |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
875 @dots{}, @kbd{9}. They are short for the @kbd{m} command together |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
876 with a name of a menu subtopic. @kbd{1} goes through the first item |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
877 in the current node's menu; @kbd{2} goes through the second item, etc. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
878 In the stand-alone reader, @kbd{0} goes through the last menu item; |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
879 this is so you need not count how many entries are there. In Emacs, |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
880 the digit keys run the command @code{Info-nth-menu-item}. |
25839 | 881 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
882 If your display supports multiple fonts, and you are using Emacs' |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
883 Info mode to read Info files, the @samp{*} for the fifth menu item |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
884 stands out, either in color or in some other attribute, such as |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
885 underline, and so is the @samp{*} for the ninth item; this makes it |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
886 easy to see at a glance which number to use for an item. |
25839 | 887 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
888 Some terminals don't support colors or underlining. If you need to |
25839 | 889 actually count items, it is better to use @kbd{m} instead, and specify |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
890 the name, or use @key{TAB} to quickly move between menu items. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
891 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
892 @unnumberedsubsec @kbd{e} makes Info document editable |
25839 | 893 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
894 @kindex e @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
895 @findex Info-edit |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
896 @cindex edit Info document |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
897 The Info command @kbd{e} changes from Info mode to an ordinary |
25839 | 898 Emacs editing mode, so that you can edit the text of the current node. |
899 Type @kbd{C-c C-c} to switch back to Info. The @kbd{e} command is allowed | |
900 only if the variable @code{Info-enable-edit} is non-@code{nil}. | |
901 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
902 The @kbd{e} command only works in Emacs, where it runs the command |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
903 @code{Info-edit}. The stand-alone Info reader doesn't allow you to |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
904 edit the Info file, so typing @kbd{e} there goes to the end of the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
905 current node. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
906 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
907 @node Info Search, Add, Expert, Advanced Info |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
908 @comment node-name, next, previous, up |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
909 @section How to search Info documents for specific subjects |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
910 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
911 @cindex searching Info documents |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
912 @cindex Info document as a reference |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
913 The commands which move between and inside nodes allow you to read |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
914 the entire manual or its large portions. But what if you need to find |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
915 some information in the manual as fast as you can, and you don't know |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
916 or don't remember in what node to look for it? This need arises when |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
917 you use a manual as a @dfn{reference}, or when it is impractical to |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
918 read the entire manual before you start using the programs it |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
919 describes. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
920 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
921 Info has powerful searching facilities that let you find things |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
922 quickly. You can search either the manual indices or its text. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
923 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
924 @kindex i @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
925 @findex Info-index |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
926 Since most subjects related to what the manual describes should be |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
927 indexed, you should try the index search first. The @kbd{i} command |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
928 prompts you for a subject and then looks up that subject in the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
929 indices. If it finds an index entry with the subject you typed, it |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
930 goes to the node to which that index entry points. You should browse |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
931 through that node to see whether the issue you are looking for is |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
932 described there. If it isn't, type @kbd{,} one or more times to go |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
933 through additional index entries which match your subject. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
934 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
935 The @kbd{i} command finds all index entries which include the string |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
936 you typed @emph{as a substring}. For each match, Info shows in the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
937 echo area the full index entry it found. Often, the text of the full |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
938 index entry already gives you enough information to decide whether it |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
939 is relevant to what you are looking for, so we recommend that you read |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
940 what Emacs shows in the echo are before looking at the node it |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
941 displays. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
942 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
943 Since @kbd{i} looks for a substring, you can search for subjects even |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
944 if you are not sure how they are spelled in the index. For example, |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
945 suppose you want to find something that is pertinent to commands which |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
946 complete partial input (e.g., when you type @key{TAB}). If you want |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
947 to catch index entries that refer to ``complete'', ``completion'', and |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
948 ``completing'', you could type @kbd{icomplet@key{RET}}. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
949 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
950 Info documents which describe programs should index the commands, |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
951 options, and key sequences that the program provides. If you are |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
952 looking for a description of a command, an option, or a key, just type |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
953 their names when @kbd{i} prompts you for a topic. For example, if you |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
954 want to read the description of what the @kbd{C-f} key does, type |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
955 @kbd{iC-f@key{RET}}. Here @kbd{C-f} are 3 literal characters |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
956 @samp{C}, @samp{-}, and @samp{f}, not the ``Control-f'' command key |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
957 you type inside Emacs to run the command bound to @kbd{C-f}. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
958 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
959 In Emacs, @kbd{i} runs the command @code{Info-index}. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
960 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
961 @kindex s @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
962 @findex Info-search |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
963 The @kbd{s} command allows you to search a whole file for a string. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
964 It switches to the next node if and when that is necessary. You |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
965 type @kbd{s} followed by the string to search for, terminated by |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
966 @key{RET}. To search for the same string again, just @kbd{s} followed |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
967 by @key{RET} will do. The file's nodes are scanned in the order |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
968 they are in in the file, which has no necessary relationship to the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
969 order that they may be in the tree structure of menus and @samp{next} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
970 pointers. But normally the two orders are not very different. In any |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
971 case, you can always do a @kbd{b} to find out what node you have |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
972 reached, if the header is not visible (this can happen, because @kbd{s} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
973 puts your cursor at the occurrence of the string, not at the beginning |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
974 of the node). |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
975 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
976 @kindex M-s @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
977 In Emacs, @kbd{Meta-s} is equivalent to @kbd{s}. That is for |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
978 compatibility with other GNU packages that use @kbd{M-s} for a similar |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
979 kind of search command. Both @kbd{s} and @kbd{M-s} run in Emacs the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
980 command @code{Info-search}. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
981 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
982 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
983 @node Add, Menus, Info Search, Advanced Info |
25839 | 984 @comment node-name, next, previous, up |
985 @section Adding a new node to Info | |
986 | |
987 To add a new topic to the list in the Info directory, you must: | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
988 |
25839 | 989 @enumerate |
990 @item | |
991 Create some nodes, in some file, to document that topic. | |
992 @item | |
993 Put that topic in the menu in the directory. @xref{Menus, Menu}. | |
994 @end enumerate | |
995 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
996 Usually, the way to create the nodes is with Texinfo (@pxref{Top,, |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
997 Overview of Texinfo, texinfo, Texinfo: The GNU Documentation Format}); |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
998 this has the advantage that you can also make a printed manual from |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
999 them. However, if you want to edit an Info file, here is how. |
25839 | 1000 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1001 @cindex node delimiters |
25839 | 1002 The new node can live in an existing documentation file, or in a new |
1003 one. It must have a @key{^_} character before it (invisible to the | |
1004 user; this node has one but you cannot see it), and it ends with either | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1005 a @key{^_}, a @key{^L}, or the end of file.@footnote{If you put in a |
25839 | 1006 @key{^L} to end a new node, be sure that there is a @key{^_} after it |
1007 to start the next one, since @key{^L} cannot @emph{start} a node. | |
1008 Also, a nicer way to make a node boundary be a page boundary as well | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1009 is to put a @key{^L} @emph{right after} the @key{^_}.} |
25839 | 1010 |
1011 The @key{^_} starting a node must be followed by a newline or a | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1012 @key{^L} newline, after which comes the node's header line. The header |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1013 line must give the node's name (by which Info finds it), and state the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1014 names of the @samp{Next}, @samp{Previous}, and @samp{Up} nodes (if there |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1015 are any). As you can see, this node's @samp{Up} node is the node |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1016 @samp{Top}, which points at all the documentation for Info. The |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1017 @samp{Next} node is @samp{Menus}. |
25839 | 1018 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1019 @cindex node header line format |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1020 @cindex format of node headers |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1021 The keywords @dfn{Node}, @dfn{Next}, @dfn{Previous}, and @dfn{Up} |
25839 | 1022 may appear in any order, anywhere in the header line, but the |
1023 recommended order is the one in this sentence. Each keyword must be | |
1024 followed by a colon, spaces and tabs, and then the appropriate name. | |
1025 The name may be terminated with a tab, a comma, or a newline. A space | |
1026 does not end it; node names may contain spaces. The case of letters | |
1027 in the names is insignificant. | |
1028 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1029 @cindex node name format |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1030 @cindex Directory node |
25839 | 1031 A node name has two forms. A node in the current file is named by |
1032 what appears after the @samp{Node: } in that node's first line. For | |
1033 example, this node's name is @samp{Add}. A node in another file is | |
1034 named by @samp{(@var{filename})@var{node-within-file}}, as in | |
1035 @samp{(info)Add} for this node. If the file name starts with ``./'', | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1036 then it is relative to the current directory; otherwise, it is |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1037 relative starting from the standard directory for Info files of your |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1038 site. The name @samp{(@var{filename})Top} can be abbreviated to just |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1039 @samp{(@var{filename})}. By convention, the name @samp{Top} is used |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1040 for the ``highest'' node in any single file---the node whose @samp{Up} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1041 points out of the file. The @samp{Directory} node is @file{(dir)}, it |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1042 points to a file @file{dir} which holds a large menu listing all the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1043 Info documents installed on your site. The @samp{Top} node of a |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1044 document file listed in the @samp{Directory} should have an @samp{Up: |
25839 | 1045 (dir)} in it. |
1046 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1047 @cindex unstructured documents |
25839 | 1048 The node name @kbd{*} is special: it refers to the entire file. |
1049 Thus, @kbd{g*} shows you the whole current file. The use of the | |
1050 node @kbd{*} is to make it possible to make old-fashioned, | |
1051 unstructured files into nodes of the tree. | |
1052 | |
1053 The @samp{Node:} name, in which a node states its own name, must not | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1054 contain a file name, since when Info searches for a node, it does not |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1055 expect a file name to be there. The @samp{Next}, @samp{Previous} and |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1056 @samp{Up} names may contain them. In this node, since the @samp{Up} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1057 node is in the same file, it was not necessary to use one. |
25839 | 1058 |
1059 Note that the nodes in this file have a file name in the header | |
1060 line. The file names are ignored by Info, but they serve as comments | |
1061 to help identify the node for the user. | |
1062 | |
1063 @node Menus, Cross-refs, Add, Advanced Info | |
1064 @comment node-name, next, previous, up | |
1065 @section How to Create Menus | |
1066 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1067 Any node in the Info hierarchy may have a @dfn{menu}---a list of subnodes. |
25839 | 1068 The @kbd{m} command searches the current node's menu for the topic which it |
1069 reads from the terminal. | |
1070 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1071 @cindex menu and menu entry format |
25839 | 1072 A menu begins with a line starting with @samp{* Menu:}. The rest of the |
1073 line is a comment. After the starting line, every line that begins | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1074 with a @samp{* } lists a single topic. The name of the topic--what |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1075 the user must type at the @kbd{m}'s command prompt to select this |
25839 | 1076 topic---comes right after the star and space, and is followed by a |
1077 colon, spaces and tabs, and the name of the node which discusses that | |
1078 topic. The node name, like node names following @samp{Next}, @samp{Previous} | |
1079 and @samp{Up}, may be terminated with a tab, comma, or newline; it may also | |
1080 be terminated with a period. | |
1081 | |
1082 If the node name and topic name are the same, then rather than | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1083 giving the name twice, the abbreviation @samp{* @var{name}::} may be |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1084 used (and should be used, whenever possible, as it reduces the visual |
25839 | 1085 clutter in the menu). |
1086 | |
1087 It is considerate to choose the topic names so that they differ | |
1088 from each other very near the beginning---this allows the user to type | |
1089 short abbreviations. In a long menu, it is a good idea to capitalize | |
1090 the beginning of each item name which is the minimum acceptable | |
1091 abbreviation for it (a long menu is more than 5 or so entries). | |
1092 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1093 The nodes listed in a node's menu are called its ``subnodes'', and it |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1094 is their ``superior''. They should each have an @samp{Up:} pointing at |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1095 the superior. It is often useful to arrange all or most of the subnodes |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1096 in a sequence of @samp{Next} and @samp{Previous} pointers so that |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1097 someone who wants to see them all need not keep revisiting the Menu. |
25839 | 1098 |
1099 The Info Directory is simply the menu of the node @samp{(dir)Top}---that | |
1100 is, node @samp{Top} in file @file{.../info/dir}. You can put new entries | |
1101 in that menu just like any other menu. The Info Directory is @emph{not} the | |
1102 same as the file directory called @file{info}. It happens that many of | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1103 Info's files live in that file directory, but they do not have to; and |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1104 files in that directory are not automatically listed in the Info |
25839 | 1105 Directory node. |
1106 | |
1107 Also, although the Info node graph is claimed to be a ``hierarchy'', | |
1108 in fact it can be @emph{any} directed graph. Shared structures and | |
1109 pointer cycles are perfectly possible, and can be used if they are | |
1110 appropriate to the meaning to be expressed. There is no need for all | |
1111 the nodes in a file to form a connected structure. In fact, this file | |
1112 has two connected components. You are in one of them, which is under | |
1113 the node @samp{Top}; the other contains the node @samp{Help} which the | |
1114 @kbd{h} command goes to. In fact, since there is no garbage | |
1115 collector, nothing terrible happens if a substructure is not pointed | |
1116 to, but such a substructure is rather useless since nobody can | |
1117 ever find out that it exists. | |
1118 | |
1119 @node Cross-refs, Tags, Menus, Advanced Info | |
1120 @comment node-name, next, previous, up | |
1121 @section Creating Cross References | |
1122 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1123 @cindex cross reference format |
25839 | 1124 A cross reference can be placed anywhere in the text, unlike a menu |
1125 item which must go at the front of a line. A cross reference looks | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1126 like a menu item except that it has @samp{*note} instead of @samp{*}. |
25839 | 1127 It @emph{cannot} be terminated by a @samp{)}, because @samp{)}'s are |
1128 so often part of node names. If you wish to enclose a cross reference | |
1129 in parentheses, terminate it with a period first. Here are two | |
1130 examples of cross references pointers: | |
1131 | |
1132 @example | |
1133 *Note details: commands. (See *note 3: Full Proof.) | |
1134 @end example | |
1135 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1136 @noindent |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1137 @emph{These are just examples.} The places they ``lead to'' do not |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1138 really exist! |
25839 | 1139 |
1140 @node Tags, Checking, Cross-refs, Advanced Info | |
1141 @comment node-name, next, previous, up | |
1142 @section Tags Tables for Info Files | |
1143 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1144 @cindex tags tables in info files |
25839 | 1145 You can speed up the access to nodes of a large Info file by giving |
1146 it a tags table. Unlike the tags table for a program, the tags table for | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1147 an Info file lives inside the file itself and is used |
25839 | 1148 automatically whenever Info reads in the file. |
1149 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1150 @findex Info-tagify |
25839 | 1151 To make a tags table, go to a node in the file using Emacs Info mode and type |
1152 @kbd{M-x Info-tagify}. Then you must use @kbd{C-x C-s} to save the | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1153 file. Info files produced by the @code{makeinfo} command that is part |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1154 of the Texinfo package always have tags tables to begin with. |
25839 | 1155 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1156 @cindex stale tags tables |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1157 @cindex update Info tags table |
25839 | 1158 Once the Info file has a tags table, you must make certain it is up |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1159 to date. If you edit an Info file directly (as opposed to editing its |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1160 Texinfo source), and, as a result of deletion of text, any node moves back |
25839 | 1161 more than a thousand characters in the file from the position |
1162 recorded in the tags table, Info will no longer be able to find that | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1163 node. To update the tags table, use the @code{Info-tagify} command |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1164 again. |
25839 | 1165 |
1166 An Info file tags table appears at the end of the file and looks like | |
1167 this: | |
1168 | |
1169 @example | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1170 ^_^L |
25839 | 1171 Tag Table: |
1172 File: info, Node: Cross-refs^?21419 | |
1173 File: info, Node: Tags^?22145 | |
1174 ^_ | |
1175 End Tag Table | |
1176 @end example | |
1177 | |
1178 @noindent | |
1179 Note that it contains one line per node, and this line contains | |
1180 the beginning of the node's header (ending just after the node name), | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1181 a DEL character, and the character position in the file of the |
25839 | 1182 beginning of the node. |
1183 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1184 |
25839 | 1185 @node Checking, Emacs Info Variables, Tags, Advanced Info |
1186 @section Checking an Info File | |
1187 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1188 When creating an Info file, it is easy to forget the name of a node when |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1189 you are making a pointer to it from another node. If you put in the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1190 wrong name for a node, this is not detected until someone tries to go |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1191 through the pointer using Info. Verification of the Info file is an |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1192 automatic process which checks all pointers to nodes and reports any |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1193 pointers which are invalid. Every @samp{Next}, @samp{Previous}, and |
25839 | 1194 @samp{Up} is checked, as is every menu item and every cross reference. In |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1195 addition, any @samp{Next} which does not have a @samp{Previous} pointing |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1196 back is reported. Only pointers within the file are checked, because |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1197 checking pointers to other files would be terribly slow. But those are |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1198 usually few. |
25839 | 1199 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1200 @findex Info-validate |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1201 To check an Info file, do @kbd{M-x Info-validate} while looking at any |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1202 node of the file with Emacs Info mode. |
25839 | 1203 |
1204 @node Emacs Info Variables, , Checking, Advanced Info | |
1205 @section Emacs Info-mode Variables | |
1206 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1207 The following variables may modify the behavior of Info-mode in Emacs; |
25839 | 1208 you may wish to set one or several of these variables interactively, or |
1209 in your @file{~/.emacs} init file. @xref{Examining, Examining and Setting | |
1210 Variables, Examining and Setting Variables, emacs, The GNU Emacs | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1211 Manual}. The stand-alone Info reader program has its own set of |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1212 variables, described in @ref{Variables,, Manipulating Variables, |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1213 info-stnd, GNU Info}. |
25839 | 1214 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1215 @vtable @code |
25839 | 1216 @item Info-directory-list |
1217 The list of directories to search for Info files. Each element is a | |
29307 | 1218 string (directory name) or @code{nil} (try default directory). If not |
1219 initialized Info uses the environment variable @env{INFOPATH} to | |
1220 initialize it, or @code{Info-default-directory-list} if there is no | |
1221 @env{INFOPATH} variable in the environment. | |
1222 | |
1223 @item Info-additional-directory-list | |
1224 A list of additional directories to search for Info documentation files. | |
1225 These directories are not searched for merging the @file{dir} file. | |
25839 | 1226 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1227 @item Info-fontify |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1228 When set to a non-@code{nil} value, enables highlighting of Info |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1229 files. The default is @code{t}. You can change how the highlighting |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1230 looks by customizing the faces @code{info-node}, @code{info-menu-5}, |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1231 @code{info-xref}, @code{info-header-xref}, @code{info-header-node}, |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1232 @code{info-title-@var{n}-face} (where @var{n} is the level of the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1233 section, a number between 1 and 4), and @code{info-menu-header}. To |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1234 customize a face, type @kbd{M-x customize-face @key{RET} @var{face} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1235 @key{RET}}, where @var{face} is one of the face names listed here. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1236 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1237 @item Info-use-header-line |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1238 If non-@code{nil}, Emacs puts in the Info buffer a header line showing |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1239 the @samp{Next}, @samp{Prev}, and @samp{Up} links. A header line does |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1240 not scroll with the rest of the buffer, making these links always |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1241 visible. |
29307 | 1242 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1243 @item Info-scroll-prefer-subnodes |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1244 If set to a non-@code{nil} value, Space and Backspace (or DEL) keys in |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1245 a menu visit subnodes of the current node before scrolling to its end |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1246 or beginning, respectively. For example, if the node's menu appears |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1247 on the screen, the next Space moves to a subnode indicated by the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1248 following menu item. Setting this option to @code{nil} results in |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1249 behavior similar to the stand-alone Info reader program, which visits |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1250 the first subnode from the menu only when you hit the end of the |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1251 current node. The default is @code{t}. |
25839 | 1252 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1253 @item Info-enable-active-nodes |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1254 When set to a non-@code{nil} value, allows Info to execute Lisp code |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1255 associated with nodes. The Lisp code is executed when the node is |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1256 selected. The Lisp code to be executed should follow the node |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1257 delimiter (the DEL character) and an @samp{execute: } tag, like this: |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1258 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1259 @example |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1260 ^_execute: (message "This is an active node!") |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1261 @end example |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1262 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1263 @item Info-enable-edit |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1264 Set to @code{nil}, disables the @samp{e} (@code{Info-edit}) command. A |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1265 non-@code{nil} value enables it. @xref{Add, Edit}. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1266 @end vtable |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1267 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1268 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1269 @node Creating an Info File |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1270 @chapter Creating an Info File from a Texinfo File |
25839 | 1271 |
1272 @code{makeinfo} is a utility that converts a Texinfo file into an Info | |
1273 file; @code{texinfo-format-region} and @code{texinfo-format-buffer} are | |
1274 GNU Emacs functions that do the same. | |
1275 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1276 @xref{Top,, Overview of Texinfo, texinfo, Texinfo: The GNU |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1277 Documentation Format}, to learn how to write a Texinfo file. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1278 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1279 @xref{Creating an Info File,,, texinfo, Texinfo: The GNU Documentation |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1280 Format}, to learn how to create an Info file from a Texinfo file. |
25839 | 1281 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1282 @xref{Installing an Info File,,, texinfo, Texinfo: The GNU |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1283 Documentation Format}, to learn how to install an Info file after you |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1284 have created one. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1285 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1286 @node Index |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1287 @unnumbered Index |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1288 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1289 This is an alphabetical listing of all the commands, variables, and |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1290 topics discussed in this document. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1291 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1292 @printindex cp |
25839 | 1293 |
1294 @bye |