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