Mercurial > emacs
annotate man/info.texi @ 46898:0b0448a9c183
(setup-ethiopic-environment-internal, exit-ethiopic-environment):
Use find-file-hook and write-file-functions instead of
find-file-hooks and write-file-hooks.
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Thu, 15 Aug 2002 00:46:09 +0000 |
parents | ba6de43c41d7 |
children | 0a70200bde27 |
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 |
46888
ba6de43c41d7
copyright years must be spelled out in full.
Karl Berry <karl@gnu.org>
parents:
46205
diff
changeset
|
9 @comment $Id: info.texi,v 1.24 2002/07/07 11:31:31 rms 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 |
43961
47a8aeb481fb
Synchronize DIR entries with text in @direntry in Texinfo sources.
Eli Zaretskii <eliz@gnu.org>
parents:
42914
diff
changeset
|
13 * Info: (info). How to use the 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 |
46888
ba6de43c41d7
copyright years must be spelled out in full.
Karl Berry <karl@gnu.org>
parents:
46205
diff
changeset
|
20 Copyright (C) 1989, 1992, 1996, 1997, 1998, 1999, 2000, 2001, 2002 |
37344
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 | |
46888
ba6de43c41d7
copyright years must be spelled out in full.
Karl Berry <karl@gnu.org>
parents:
46205
diff
changeset
|
49 Copyright @copyright{} 1989, 1992, 1993, 1996, 1997, 1998, 1999, 2000, |
ba6de43c41d7
copyright years must be spelled out in full.
Karl Berry <karl@gnu.org>
parents:
46205
diff
changeset
|
50 2001, 2002 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 | |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
78 The GNU Project distributes most of its on-line manuals in the |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
79 @dfn{Info format}, which you read using an @dfn{Info reader}. You are |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
80 probably using an Info reader to read this now. |
25839 | 81 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
82 @ifinfo |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
83 If you are new to the Info reader and want to learn how to use it, |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
84 type the command @kbd{h} now. It brings you to a programmed |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
85 instruction sequence. |
25839 | 86 |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
87 To read about expert-level Info commands, type @kbd{n} twice. This |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
88 brings you to @cite{Info for Experts}, skipping over the `Getting |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
89 Started' chapter. |
25839 | 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. | |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
95 * Expert Info:: Info commands for experts. |
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 | |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
100 @node Getting Started, Expert Info, Top, Top |
25839 | 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 |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
244 The top line of a node is its @dfn{header}. This node's header |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
245 (look at it now) says that the @samp{Next} node after this one is the |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
246 node called @samp{Help-P}. An advanced Info command lets you go to |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
247 any node whose name you know. In the stand-alone Info reader program, |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
248 the header line shows the names of this node and the info file as |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
249 well. In Emacs, the header line is duplicated in a special typeface, |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
250 and the duplicate remains at the top of the window all the time even |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
251 if you scroll through the node. |
25839 | 252 |
253 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
|
254 @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
|
255 links. |
25839 | 256 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
257 @kindex n @r{(Info mode)} |
25839 | 258 Now it is time to move on to the @samp{Next} node, named @samp{Help-P}. |
259 | |
260 @format | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
261 >> Type @kbd{n} to move there. Type just one character; |
25839 | 262 do not type the quotes and do not type a @key{RET} afterward. |
263 @end format | |
264 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
265 @noindent |
25839 | 266 @samp{>>} in the margin means it is really time to try a command. |
267 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
268 @format |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
269 >> If you have a mouse, and if you already practiced typing @kbd{n} |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
270 to get to the next node, click now with the middle mouse button on |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
271 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
|
272 @end format |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
273 |
25839 | 274 @node Help-P, Help-^L, Help, Getting Started |
275 @comment node-name, next, previous, up | |
276 @section Returning to the Previous node | |
277 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
278 @kindex p @r{(Info mode)} |
25839 | 279 This node is called @samp{Help-P}. The @samp{Previous} node, as you see, |
280 is @samp{Help}, which is the one you just came from using the @kbd{n} | |
281 command. Another @kbd{n} command now would take you to the next | |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
282 node, @samp{Help-^L}. |
25839 | 283 |
284 @format | |
37362
f3e3f00c30fc
Fix markup of keys such as Space and Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37355
diff
changeset
|
285 >> But do not type @kbd{n} yet. First, try the @kbd{p} command, |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
286 or click the middle mouse button on the @samp{Prev} link. That |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
287 takes you to the @samp{Previous} node. Then use @kbd{n} to return here. |
25839 | 288 @end format |
289 | |
37362
f3e3f00c30fc
Fix markup of keys such as Space and Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37355
diff
changeset
|
290 If you read this in Emacs, you will see an @samp{Info} item in the |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
291 menu bar, close to its right edge. Clicking the mouse on the |
37362
f3e3f00c30fc
Fix markup of keys such as Space and Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37355
diff
changeset
|
292 @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
|
293 @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
|
294 learn about). |
f3e3f00c30fc
Fix markup of keys such as Space and Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37355
diff
changeset
|
295 |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
296 This all probably seems insultingly simple so far, but @emph{please |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
297 don't} start skimming. Things will get complicated soon enough! |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
298 Also, please do not try a new command until you are told it is time |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
299 to. You could make Info skip past an important warning that was |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
300 coming up. |
25839 | 301 |
302 @format | |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
303 >> Now do an @kbd{n}, or click the middle mouse button on the @samp{Next} |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
304 link, to get to the node @samp{Help-^L} and learn more. |
25839 | 305 @end format |
306 | |
307 @node Help-^L, Help-M, Help-P, Getting Started | |
308 @comment node-name, next, previous, up | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
309 @section The Space, DEL, B and ^L commands. |
25839 | 310 |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
311 This node's mode line tells you that you are now at node |
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
312 @samp{Help-^L}, and the header line tells you that @kbd{p} would get |
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
313 you back to @samp{Help-P}. The node's title is highlighted and may be |
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
314 underlined as well; it says what the node is about. |
25839 | 315 |
316 This is a big node and it does not all fit on your display screen. | |
317 You can tell that there is more that is not visible because you | |
318 can see the string @samp{--Top-----} rather than @samp{--All----} near | |
319 the bottom right corner of the screen. | |
320 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
321 @kindex SPC @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
322 @kindex DEL @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
323 @kindex BACKSPACE @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
324 @findex Info-scroll-up |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
325 @findex Info-scroll-down |
37362
f3e3f00c30fc
Fix markup of keys such as Space and Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37355
diff
changeset
|
326 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
|
327 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
|
328 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
|
329 @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
|
330 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
|
331 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
|
332 @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
|
333 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
|
334 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
|
335 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
|
336 show what was above the top of the screen (there is not anything above |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
337 the top until you have typed some spaces). |
25839 | 338 |
339 @format | |
37362
f3e3f00c30fc
Fix markup of keys such as Space and Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37355
diff
changeset
|
340 >> 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
|
341 return here). |
25839 | 342 @end format |
343 | |
37362
f3e3f00c30fc
Fix markup of keys such as Space and Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37355
diff
changeset
|
344 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
|
345 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
|
346 @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
|
347 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
|
348 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
|
349 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
350 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
|
351 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
|
352 always see the @samp{Next}, @samp{Prev}, and @samp{Up} links, and you |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
353 can conveniently go to one of these links at any time by |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
354 clicking the middle mouse button on the link. |
25839 | 355 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
356 @cindex reading Info documents top to bottom |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
357 @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
|
358 @key{SPC} and @key{DEL} not only move forward and backward through |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
359 the current node. They also move between nodes. @key{SPC} at the end |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
360 of a node moves to the next node; @key{DEL} (or @key{BACKSPACE}) at |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
361 the beginning of a node moves to the previous node. In effect, these |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
362 commands scroll through all the nodes in an Info file as a single |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
363 logical sequence. You can read an entire manual top to bottom by just |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
364 typing @key{SPC}, and move backward through the entire manual from |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
365 bottom to top by typing @key{DEL} (or @key{BACKSPACE}). |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
366 |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
367 In this sequence, a node's subnodes appear following their parent. |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
368 If a node has a menu, @key{SPC} takes you into the subnodes listed in |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
369 the menu, one by one. Once you reach the end of a node, and have seen |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
370 all of its subnodes, @key{SPC} takes you to the next node or to the |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
371 parent's next node. |
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 |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
378 through the text of one node, like @key{SPC} and @key{BACKSPACE} (or |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
379 @key{DEL}). However, @key{PAGEUP} and @key{PAGEDOWN} keys never |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
380 scroll beyond the beginning or the end of the current node. |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
381 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
382 @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
|
383 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
|
384 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
|
385 @key{CTRL} and type @kbd{L} or @kbd{l}). |
25839 | 386 |
387 @format | |
388 >> Type @kbd{C-l} now. | |
389 @end format | |
390 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
391 @kindex b @r{(Info mode)} |
25839 | 392 To move back to the beginning of the node you are on, you can type |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
393 the @key{BACKSPACE} key (or @key{DEL}) many times. You can also type |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
394 @kbd{b} just once. @kbd{b} stands for ``beginning.'' |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
395 |
25839 | 396 @format |
397 >> 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
|
398 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
|
399 isn't enough. You may need to shrink your Emacs or Info window.) |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
400 Then come back, by typing @key{SPC} one or more times. |
25839 | 401 @end format |
402 | |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
403 If your screen is very tall, all of this node might fit at once. In |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
404 that case, @kbd{b} won't do anything. But you could observe the |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
405 effect of the @kbd{b} key if you use a smaller window. |
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 | |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
432 >> Now type @kbd{n}, or click the middle mouse button on the @samp{Next} link, |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
433 to 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 | |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
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 | |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
482 * Foo:: This tells about FOO. |
25839 | 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 | |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
497 If you keep typing @key{SPC} once the menu appears on the screen, it |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
498 will move to another node (the first one in the menu). If that |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
499 happens, type @key{BACKSPACE} to come back. |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
500 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
501 @kindex m @r{(Info mode)} |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
502 The command to go to one of the subnodes is @kbd{m}. This is very |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
503 different from the commands you have used: it is a command that |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
504 prompts you for more input. |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
505 |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
506 The Info commands you know do not need additional input; when you |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
507 type one of them, Info processes it instantly and then is ready for |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
508 another command. The @kbd{m} command is different: it needs to know |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
509 the @dfn{name of the subtopic}. Once you have typed @kbd{m}, Info |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
510 tries to read the subtopic name. |
25839 | 511 |
512 Now look for the line containing many dashes near the bottom of the | |
513 screen. There is one more line beneath that one, but usually it is | |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
514 blank. When it is blank, 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
|
515 or @kbd{b} or @key{SPC} or @kbd{m}. If that line contains text ending |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
516 in a colon, it means Info is reading more input for the last command. |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
517 You can't type an Info command then, because Info is trying to read |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
518 input, not commands. You must either give the input and finish the |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
519 command you started, or type @kbd{Control-g} to cancel the command. |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
520 When you have done one of those things, the input entry line becomes |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
521 blank again. Then you can type Info commands again. |
25839 | 522 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
523 @findex Info-menu |
25839 | 524 The command to go to a subnode via a menu is @kbd{m}. After you type |
525 the @kbd{m}, the line at the bottom of the screen says @samp{Menu item: }. | |
526 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
|
527 a @key{RET}. In Emacs, @kbd{m} runs the command @code{Info-menu}. |
25839 | 528 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
529 @cindex abbreviating Info subnodes |
25839 | 530 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
|
531 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
|
532 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
|
533 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
|
534 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
|
535 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
|
536 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
|
537 the menu. |
25839 | 538 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
539 @cindex completion of Info node names |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
540 You can also use the @dfn{completion} feature to help enter the |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
541 subtopic name. If you type the @key{TAB} key after entering part of a |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
542 name, it will fill in more of the name---as much as Info can deduce |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
543 from the part you have entered. |
25839 | 544 |
545 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
|
546 not need to type the argument: you just type a @key{RET}, and it |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
547 stands for the subtopic of the line you are on. You can also click |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
548 the middle mouse button directly on the subtopic line to go there. |
25839 | 549 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
550 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
|
551 three ways of going to one place, Help-FOO: |
25839 | 552 |
553 @menu | |
554 * Foo: Help-FOO. A node you can visit for fun. | |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
555 * Bar: Help-FOO. We have made two ways to get to the same place. |
25839 | 556 * Help-FOO:: And yet another! |
557 @end menu | |
558 | |
559 @format | |
560 >> Now type just an @kbd{m} and see what happens: | |
561 @end format | |
562 | |
563 Now you are ``inside'' an @kbd{m} command. Commands cannot be used | |
564 now; the next thing you will type must be the name of a subtopic. | |
565 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
566 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
|
567 @kbd{Control-g}. |
25839 | 568 |
569 @format | |
570 >> 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
|
571 @end format |
25839 | 572 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
573 @format |
25839 | 574 >> Then type another @kbd{m}. |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
575 @end format |
25839 | 576 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
577 @format |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
578 >> Now type @kbd{BAR}, the item name. Do not type @key{RET} yet. |
25839 | 579 @end format |
580 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
581 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
|
582 @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
|
583 mistake. |
25839 | 584 |
585 @format | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
586 >> 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
|
587 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
|
588 abbreviation. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
589 @end format |
25839 | 590 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
591 @format |
25839 | 592 >> Now you are ready to go. Type a @key{RET}. |
593 @end format | |
594 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
595 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
|
596 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
597 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
|
598 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
|
599 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
|
600 @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
|
601 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
|
602 @samp{Alt}.) |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
603 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
604 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
|
605 that subtopic's node. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
606 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
607 @cindex mouse support in Info mode |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
608 @kindex Mouse-2 @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
609 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
|
610 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
|
611 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
|
612 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
|
613 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
|
614 the shape of the mouse pointer will change if your platform supports |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
615 that. After a while, if you leave the mouse on that spot, a small |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
616 window will pop up, saying ``Mouse-2: go to that node'', or the same |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
617 message may appear at the bottom of the screen. |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
618 |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
619 @kbd{Mouse-2} is the second button of your mouse counting from the |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
620 left---the middle button on a 3-button mouse. (On a 2-button mouse, |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
621 you may have to press both buttons together to ``press the middle |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
622 button''.) The message tells you pressing @kbd{Mouse-2} with the |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
623 current position of the mouse pointer (on subtopic in the menu) will |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
624 go to that subtopic. |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
625 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
626 @findex Info-mouse-follow-nearest-node |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
627 More generally, @kbd{Mouse-2} in an Info buffer finds the nearest |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
628 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
|
629 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
|
630 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
|
631 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
|
632 there's no next node. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
633 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
634 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
|
635 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
|
636 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
|
637 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
638 @menu |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
639 * Help-FOO:: |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
640 @end menu |
25839 | 641 |
642 @format | |
643 >> Type @kbd{n} to see more commands. | |
644 @end format | |
645 | |
646 @node Help-FOO, , , Help-M | |
647 @subsection The @kbd{u} command | |
648 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
649 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
|
650 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
|
651 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
|
652 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
|
653 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
|
654 usually used to ``stay on the same level but go backwards''. |
25839 | 655 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
656 @kindex u @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
657 @findex Info-up |
25839 | 658 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
|
659 @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
|
660 @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
|
661 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
|
662 (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
|
663 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
|
664 |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
665 Another way to go Up is to click @kbd{Mouse-2} on the @samp{Up} |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
666 pointer shown in the header line (provided that you have a mouse). |
25839 | 667 |
668 @format | |
669 >> Now type @kbd{u} to move back up to @samp{Help-M}. | |
670 @end format | |
671 | |
39356
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
672 @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
|
673 @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
|
674 @section Following Cross-References |
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
675 |
39357
9012f11877c1
Major rewrite of Help-Xref. Don't use "print" except for paper.
Richard M. Stallman <rms@gnu.org>
parents:
39356
diff
changeset
|
676 @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
|
677 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
|
678 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
|
679 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
|
680 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
|
681 |
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
682 @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
|
683 @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
|
684 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
|
685 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
|
686 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
|
687 @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
|
688 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
|
689 @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
|
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 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
|
692 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
|
693 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
|
694 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
|
695 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
|
696 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
|
697 |
9012f11877c1
Major rewrite of Help-Xref. Don't use "print" except for paper.
Richard M. Stallman <rms@gnu.org>
parents:
39356
diff
changeset
|
698 @format |
9012f11877c1
Major rewrite of Help-Xref. Don't use "print" except for paper.
Richard M. Stallman <rms@gnu.org>
parents:
39356
diff
changeset
|
699 >> 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
|
700 @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
|
701 |
9012f11877c1
Major rewrite of Help-Xref. Don't use "print" except for paper.
Richard M. Stallman <rms@gnu.org>
parents:
39356
diff
changeset
|
702 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
|
703 @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
|
704 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
|
705 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
|
706 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
|
707 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
|
708 |
39357
9012f11877c1
Major rewrite of Help-Xref. Don't use "print" except for paper.
Richard M. Stallman <rms@gnu.org>
parents:
39356
diff
changeset
|
709 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
|
710 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
|
711 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
|
712 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
|
713 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
|
714 |
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
715 @format |
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
716 >> 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
|
717 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
|
718 @end format |
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
719 |
39357
9012f11877c1
Major rewrite of Help-Xref. Don't use "print" except for paper.
Richard M. Stallman <rms@gnu.org>
parents:
39356
diff
changeset
|
720 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
|
721 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
|
722 |
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
723 @node Help-Int, Help-Q, Help-Xref, Getting Started |
25839 | 724 @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
|
725 @section Some intermediate Info commands |
25839 | 726 |
39355
127d6dc34db9
Rename Help-Adv to Help-Int, for intermediate-level.
Richard M. Stallman <rms@gnu.org>
parents:
37552
diff
changeset
|
727 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
|
728 a little longer to learn some intermediate-level commands. |
25839 | 729 |
39356
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
730 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
|
731 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
|
732 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
|
733 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
|
734 @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
|
735 describes the topic. |
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
736 |
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
737 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
|
738 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
|
739 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
|
740 @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
|
741 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
742 @kindex l @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
743 @findex Info-last |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
744 @cindex going back in Info mode |
25839 | 745 If you have been moving around to different nodes and wish to |
746 retrace your steps, the @kbd{l} command (@kbd{l} for @dfn{last}) will | |
747 do that, one node-step at a time. As you move from node to node, Info | |
748 records the nodes where you have been in a special history list. The | |
749 @kbd{l} command revisits nodes in the history list; each successive | |
750 @kbd{l} command moves one step back through the history. | |
751 | |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
752 If you have been following directions, an @kbd{l} command now will get |
25839 | 753 you back to @samp{Help-M}. Another @kbd{l} command would undo the |
754 @kbd{u} and get you back to @samp{Help-FOO}. Another @kbd{l} would undo | |
755 the @kbd{m} and get you back to @samp{Help-M}. | |
756 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
757 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
|
758 |
25839 | 759 @format |
760 >> 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
|
761 @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
|
762 back here. |
25839 | 763 @end format |
764 | |
765 Note the difference between @kbd{l} and @kbd{p}: @kbd{l} moves to | |
766 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
|
767 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
|
768 @samp{Prev} link leads to @samp{Help-M}). |
25839 | 769 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
770 @kindex d @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
771 @findex Info-directory |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
772 @cindex go to Directory node |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
773 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
|
774 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
|
775 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
|
776 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
|
777 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
|
778 are, or could be, installed on your system. |
25839 | 779 |
780 @format | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
781 >> Try doing a @kbd{d}, then do an @kbd{l} to return here (yes, |
25839 | 782 @emph{do} return). |
783 @end format | |
784 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
785 @kindex t @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
786 @findex Info-top-node |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
787 @cindex go to Top node |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
788 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
|
789 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
|
790 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
|
791 is @code{Info-top-node}. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
792 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
793 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
|
794 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
|
795 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
|
796 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
|
797 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
798 @format |
25839 | 799 >> Now type @kbd{n} to see the last node of the course. |
800 @end format | |
801 | |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
802 @xref{Expert Info}, for more advanced Info features. |
39355
127d6dc34db9
Rename Help-Adv to Help-Int, for intermediate-level.
Richard M. Stallman <rms@gnu.org>
parents:
37552
diff
changeset
|
803 |
25839 | 804 @c If a menu appears at the end of this node, remove it. |
805 @c It is an accident of the menu updating command. | |
806 | |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
807 @node Expert Info |
25839 | 808 @chapter Info for Experts |
809 | |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
810 This chapter describes various Info commands for experts. (If you |
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
811 are using a stand-alone Info reader, there are additional commands |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
812 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
|
813 GNU Info, info-stnd, GNU Info}.) |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
814 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
815 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
|
816 Texinfo file. (However, in most cases, writing a Texinfo file is |
44877 | 817 better, since you can use it to make a printed manual or produce other |
818 formats, such as HTML and DocBook, as well as for generating Info | |
819 files.) @xref{Top,, Overview of Texinfo, texinfo, Texinfo: The GNU | |
820 Documentation Format}.) | |
25839 | 821 |
822 @menu | |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
823 * Advanced:: 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
|
824 * Info Search:: How to search Info documents for specific subjects. |
25839 | 825 * Add:: Describes how to add new nodes to the hierarchy. |
826 Also tells what nodes look like. | |
827 * Menus:: How to add to or create menus in Info nodes. | |
828 * Cross-refs:: How to add cross-references to Info nodes. | |
829 * Tags:: How to make tags tables for Info files. | |
830 * Checking:: Checking an Info File | |
831 * Emacs Info Variables:: Variables modifying the behavior of Emacs Info. | |
832 @end menu | |
833 | |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
834 @node Advanced, Info Search, , Expert Info |
25839 | 835 @comment node-name, next, previous, up |
836 @section Advanced Info Commands | |
837 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
838 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
|
839 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
840 @unnumberedsubsec @kbd{g} goes to a node by name |
25839 | 841 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
842 @kindex g @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
843 @findex Info-goto-node |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
844 @cindex go to a node by name |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
845 If you know a node's name, you can go there by typing @kbd{g}, the |
25839 | 846 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
|
847 called @samp{Top} in this file. (This is equivalent to @kbd{t}, see |
44801
b986daa6d686
Re-add accidentally deleted `@key'.
Miles Bader <miles@gnu.org>
parents:
44785
diff
changeset
|
848 @ref{Help-Int}.) @kbd{gAdvanced@key{RET}} would come back here. |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
849 @kbd{g} in Emacs runs the command @code{Info-goto-node}. |
25839 | 850 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
851 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
|
852 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
|
853 partial node name. |
25839 | 854 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
855 @cindex go to another Info file |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
856 To go to a node in another file, you can include the file name in the |
25839 | 857 node name by putting it at the front, in parentheses. Thus, |
858 @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
|
859 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
|
860 @kbd{g(emacs)Top@key{RET}} goes to the top node of the Emacs manual. |
25839 | 861 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
862 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
|
863 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
|
864 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
|
865 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
866 @unnumberedsubsec @kbd{1} -- @kbd{9} choose a menu subtopic by its number |
25839 | 867 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
868 @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
|
869 @findex Info-nth-menu-item |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
870 @cindex select @var{n}'th menu item |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
871 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
|
872 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
|
873 @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
|
874 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
|
875 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
|
876 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
|
877 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
|
878 the digit keys run the command @code{Info-nth-menu-item}. |
25839 | 879 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
880 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
|
881 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
|
882 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
|
883 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
|
884 easy to see at a glance which number to use for an item. |
25839 | 885 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
886 Some terminals don't support colors or underlining. If you need to |
25839 | 887 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
|
888 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
|
889 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
890 @unnumberedsubsec @kbd{e} makes Info document editable |
25839 | 891 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
892 @kindex e @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
893 @findex Info-edit |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
894 @cindex edit Info document |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
895 The Info command @kbd{e} changes from Info mode to an ordinary |
25839 | 896 Emacs editing mode, so that you can edit the text of the current node. |
897 Type @kbd{C-c C-c} to switch back to Info. The @kbd{e} command is allowed | |
898 only if the variable @code{Info-enable-edit} is non-@code{nil}. | |
899 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
900 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
|
901 @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
|
902 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
|
903 current node. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
904 |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
905 @node Info Search, Add, Advanced, Expert Info |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
906 @comment node-name, next, previous, up |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
907 @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
|
908 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
909 @cindex searching Info documents |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
910 @cindex Info document as a reference |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
911 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
|
912 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
|
913 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
|
914 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
|
915 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
|
916 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
|
917 describes. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
918 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
919 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
|
920 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
|
921 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
922 @kindex i @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
923 @findex Info-index |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
924 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
|
925 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
|
926 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
|
927 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
|
928 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
|
929 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
|
930 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
|
931 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
|
932 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
933 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
|
934 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
|
935 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
|
936 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
|
937 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
|
938 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
|
939 displays. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
940 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
941 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
|
942 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
|
943 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
|
944 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
|
945 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
|
946 ``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
|
947 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
948 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
|
949 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
|
950 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
|
951 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
|
952 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
|
953 @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
|
954 @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
|
955 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
|
956 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
957 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
|
958 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
959 @kindex s @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
960 @findex Info-search |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
961 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
|
962 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
|
963 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
|
964 @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
|
965 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
|
966 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
|
967 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
|
968 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
|
969 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
|
970 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
|
971 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
|
972 of the node). |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
973 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
974 @kindex M-s @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
975 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
|
976 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
|
977 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
|
978 command @code{Info-search}. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
979 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
980 |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
981 @node Add, Menus, Info Search, Expert Info |
25839 | 982 @comment node-name, next, previous, up |
983 @section Adding a new node to Info | |
984 | |
985 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
|
986 |
25839 | 987 @enumerate |
988 @item | |
989 Create some nodes, in some file, to document that topic. | |
990 @item | |
991 Put that topic in the menu in the directory. @xref{Menus, Menu}. | |
992 @end enumerate | |
993 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
994 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
|
995 Overview of Texinfo, texinfo, Texinfo: The GNU Documentation Format}); |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
996 this has the advantage that you can also make a printed manual or HTML |
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
997 from them. You would use the @samp{@@dircategory} and |
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
998 @samp{@@direntry} commands to put the manual into the Info directory. |
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
999 However, if you want to edit an Info file manually and install it |
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
1000 manually, here is how. |
25839 | 1001 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1002 @cindex node delimiters |
25839 | 1003 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
|
1004 one. It must have a @samp{^_} character before it (invisible to the |
25839 | 1005 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
|
1006 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
|
1007 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
|
1008 @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
|
1009 @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
|
1010 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
|
1011 @samp{^_}.} |
25839 | 1012 |
37392
18abdfdd5585
Fix markup of control characters.
Eli Zaretskii <eliz@gnu.org>
parents:
37362
diff
changeset
|
1013 The @samp{^_} starting a node must be followed by a newline or a |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
1014 @samp{^L} newline, after which comes the node's header line. The |
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
1015 header line must give the node's name (by which Info finds it), and |
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
1016 state the names of the @samp{Next}, @samp{Previous}, and @samp{Up} |
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
1017 nodes (if there are any). As you can see, this node's @samp{Up} node |
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
1018 is the node @samp{Expert Info}. The @samp{Next} node is @samp{Menus}. |
25839 | 1019 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1020 @cindex node header line format |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1021 @cindex format of node headers |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1022 The keywords @dfn{Node}, @dfn{Next}, @dfn{Previous}, and @dfn{Up} |
25839 | 1023 may appear in any order, anywhere in the header line, but the |
1024 recommended order is the one in this sentence. Each keyword must be | |
1025 followed by a colon, spaces and tabs, and then the appropriate name. | |
1026 The name may be terminated with a tab, a comma, or a newline. A space | |
1027 does not end it; node names may contain spaces. The case of letters | |
1028 in the names is insignificant. | |
1029 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1030 @cindex node name format |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1031 @cindex Directory node |
25839 | 1032 A node name has two forms. A node in the current file is named by |
1033 what appears after the @samp{Node: } in that node's first line. For | |
1034 example, this node's name is @samp{Add}. A node in another file is | |
1035 named by @samp{(@var{filename})@var{node-within-file}}, as in | |
1036 @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
|
1037 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
|
1038 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
|
1039 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
|
1040 @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
|
1041 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
|
1042 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
|
1043 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
|
1044 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
|
1045 document file listed in the @samp{Directory} should have an @samp{Up: |
25839 | 1046 (dir)} in it. |
1047 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1048 @cindex unstructured documents |
25839 | 1049 The node name @kbd{*} is special: it refers to the entire file. |
1050 Thus, @kbd{g*} shows you the whole current file. The use of the | |
1051 node @kbd{*} is to make it possible to make old-fashioned, | |
1052 unstructured files into nodes of the tree. | |
1053 | |
1054 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
|
1055 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
|
1056 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
|
1057 @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
|
1058 node is in the same file, it was not necessary to use one. |
25839 | 1059 |
1060 Note that the nodes in this file have a file name in the header | |
1061 line. The file names are ignored by Info, but they serve as comments | |
1062 to help identify the node for the user. | |
1063 | |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
1064 @node Menus, Cross-refs, Add, Expert Info |
25839 | 1065 @comment node-name, next, previous, up |
1066 @section How to Create Menus | |
1067 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1068 Any node in the Info hierarchy may have a @dfn{menu}---a list of subnodes. |
25839 | 1069 The @kbd{m} command searches the current node's menu for the topic which it |
1070 reads from the terminal. | |
1071 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1072 @cindex menu and menu entry format |
25839 | 1073 A menu begins with a line starting with @samp{* Menu:}. The rest of the |
1074 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
|
1075 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
|
1076 the user must type at the @kbd{m}'s command prompt to select this |
25839 | 1077 topic---comes right after the star and space, and is followed by a |
1078 colon, spaces and tabs, and the name of the node which discusses that | |
1079 topic. The node name, like node names following @samp{Next}, @samp{Previous} | |
1080 and @samp{Up}, may be terminated with a tab, comma, or newline; it may also | |
1081 be terminated with a period. | |
1082 | |
1083 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
|
1084 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
|
1085 used (and should be used, whenever possible, as it reduces the visual |
25839 | 1086 clutter in the menu). |
1087 | |
1088 It is considerate to choose the topic names so that they differ | |
1089 from each other very near the beginning---this allows the user to type | |
1090 short abbreviations. In a long menu, it is a good idea to capitalize | |
1091 the beginning of each item name which is the minimum acceptable | |
1092 abbreviation for it (a long menu is more than 5 or so entries). | |
1093 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1094 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
|
1095 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
|
1096 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
|
1097 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
|
1098 someone who wants to see them all need not keep revisiting the Menu. |
25839 | 1099 |
1100 The Info Directory is simply the menu of the node @samp{(dir)Top}---that | |
1101 is, node @samp{Top} in file @file{.../info/dir}. You can put new entries | |
1102 in that menu just like any other menu. The Info Directory is @emph{not} the | |
1103 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
|
1104 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
|
1105 files in that directory are not automatically listed in the Info |
25839 | 1106 Directory node. |
1107 | |
1108 Also, although the Info node graph is claimed to be a ``hierarchy'', | |
1109 in fact it can be @emph{any} directed graph. Shared structures and | |
1110 pointer cycles are perfectly possible, and can be used if they are | |
1111 appropriate to the meaning to be expressed. There is no need for all | |
1112 the nodes in a file to form a connected structure. In fact, this file | |
1113 has two connected components. You are in one of them, which is under | |
1114 the node @samp{Top}; the other contains the node @samp{Help} which the | |
1115 @kbd{h} command goes to. In fact, since there is no garbage | |
1116 collector, nothing terrible happens if a substructure is not pointed | |
1117 to, but such a substructure is rather useless since nobody can | |
1118 ever find out that it exists. | |
1119 | |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
1120 @node Cross-refs, Tags, Menus, Expert Info |
25839 | 1121 @comment node-name, next, previous, up |
1122 @section Creating Cross References | |
1123 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1124 @cindex cross reference format |
25839 | 1125 A cross reference can be placed anywhere in the text, unlike a menu |
1126 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
|
1127 like a menu item except that it has @samp{*note} instead of @samp{*}. |
25839 | 1128 It @emph{cannot} be terminated by a @samp{)}, because @samp{)}'s are |
1129 so often part of node names. If you wish to enclose a cross reference | |
1130 in parentheses, terminate it with a period first. Here are two | |
1131 examples of cross references pointers: | |
1132 | |
1133 @example | |
1134 *Note details: commands. (See *note 3: Full Proof.) | |
1135 @end example | |
1136 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1137 @noindent |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1138 @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
|
1139 really exist! |
25839 | 1140 |
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
|
1141 @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
|
1142 * 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
|
1143 @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
|
1144 |
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 |
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 @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
|
1147 @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
|
1148 |
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 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
|
1150 |
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 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
|
1152 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
|
1153 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
|
1154 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
|
1155 @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
|
1156 @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
|
1157 |
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 @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
|
1159 >> 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
|
1160 @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
|
1161 |
39355
127d6dc34db9
Rename Help-Adv to Help-Int, for intermediate-level.
Richard M. Stallman <rms@gnu.org>
parents:
37552
diff
changeset
|
1162 @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
|
1163 @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
|
1164 @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
|
1165 |
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 @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
|
1167 @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
|
1168 @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
|
1169 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
|
1170 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
|
1171 |
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 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
|
1173 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
|
1174 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
|
1175 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
|
1176 |
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 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
|
1178 something quickly in a manual---that is, when you need to use a manual |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
1179 as a reference rather than as a tutorial. We urge you to learn |
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
|
1180 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
|
1181 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
|
1182 |
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 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
|
1184 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
|
1185 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
|
1186 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
|
1187 |
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
|
1188 @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
|
1189 >> 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
|
1190 @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
|
1191 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
|
1192 @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
|
1193 |
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
|
1194 |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
1195 @node Tags, Checking, Cross-refs, Expert Info |
25839 | 1196 @comment node-name, next, previous, up |
1197 @section Tags Tables for Info Files | |
1198 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1199 @cindex tags tables in info files |
25839 | 1200 You can speed up the access to nodes of a large Info file by giving |
1201 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
|
1202 an Info file lives inside the file itself and is used |
25839 | 1203 automatically whenever Info reads in the file. |
1204 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1205 @findex Info-tagify |
25839 | 1206 To make a tags table, go to a node in the file using Emacs Info mode and type |
1207 @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
|
1208 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
|
1209 of the Texinfo package always have tags tables to begin with. |
25839 | 1210 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1211 @cindex stale tags tables |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1212 @cindex update Info tags table |
25839 | 1213 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
|
1214 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
|
1215 Texinfo source), and, as a result of deletion of text, any node moves back |
25839 | 1216 more than a thousand characters in the file from the position |
1217 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
|
1218 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
|
1219 again. |
25839 | 1220 |
1221 An Info file tags table appears at the end of the file and looks like | |
1222 this: | |
1223 | |
1224 @example | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1225 ^_^L |
25839 | 1226 Tag Table: |
1227 File: info, Node: Cross-refs^?21419 | |
1228 File: info, Node: Tags^?22145 | |
1229 ^_ | |
1230 End Tag Table | |
1231 @end example | |
1232 | |
1233 @noindent | |
1234 Note that it contains one line per node, and this line contains | |
1235 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
|
1236 a @samp{DEL} character, and the character position in the file of the |
25839 | 1237 beginning of the node. |
1238 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1239 |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
1240 @node Checking, Emacs Info Variables, Tags, Expert Info |
25839 | 1241 @section Checking an Info File |
1242 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1243 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
|
1244 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
|
1245 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
|
1246 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
|
1247 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
|
1248 pointers which are invalid. Every @samp{Next}, @samp{Previous}, and |
25839 | 1249 @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
|
1250 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
|
1251 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
|
1252 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
|
1253 usually few. |
25839 | 1254 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1255 @findex Info-validate |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1256 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
|
1257 node of the file with Emacs Info mode. |
25839 | 1258 |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
1259 @node Emacs Info Variables, , Checking, Expert Info |
25839 | 1260 @section Emacs Info-mode Variables |
1261 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1262 The following variables may modify the behavior of Info-mode in Emacs; |
25839 | 1263 you may wish to set one or several of these variables interactively, or |
1264 in your @file{~/.emacs} init file. @xref{Examining, Examining and Setting | |
1265 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
|
1266 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
|
1267 variables, described in @ref{Variables,, Manipulating Variables, |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1268 info-stnd, GNU Info}. |
25839 | 1269 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1270 @vtable @code |
25839 | 1271 @item Info-directory-list |
1272 The list of directories to search for Info files. Each element is a | |
29307 | 1273 string (directory name) or @code{nil} (try default directory). If not |
1274 initialized Info uses the environment variable @env{INFOPATH} to | |
1275 initialize it, or @code{Info-default-directory-list} if there is no | |
1276 @env{INFOPATH} variable in the environment. | |
1277 | |
42914 | 1278 If you wish to customize the Info directory search list for both Emacs |
1279 info and stand-alone Info, it is best to set the @env{INFOPATH} | |
1280 environment variable, since that applies to both programs. | |
1281 | |
29307 | 1282 @item Info-additional-directory-list |
1283 A list of additional directories to search for Info documentation files. | |
1284 These directories are not searched for merging the @file{dir} file. | |
25839 | 1285 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1286 @item Info-fontify |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1287 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
|
1288 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
|
1289 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
|
1290 @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
|
1291 @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
|
1292 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
|
1293 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
|
1294 @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
|
1295 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1296 @item Info-use-header-line |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1297 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
|
1298 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
|
1299 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
|
1300 visible. |
29307 | 1301 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1302 @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
|
1303 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
|
1304 @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
|
1305 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
|
1306 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
|
1307 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
|
1308 @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
|
1309 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
|
1310 hit the end of the current node. The default is @code{t}. |
25839 | 1311 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1312 @item Info-enable-active-nodes |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1313 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
|
1314 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
|
1315 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
|
1316 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
|
1317 this: |
37344
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 @example |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1320 ^_execute: (message "This is an active node!") |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1321 @end example |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1322 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1323 @item Info-enable-edit |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1324 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
|
1325 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
|
1326 @end vtable |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1327 |
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 @node Creating an Info File |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1330 @chapter Creating an Info File from a Texinfo File |
25839 | 1331 |
1332 @code{makeinfo} is a utility that converts a Texinfo file into an Info | |
1333 file; @code{texinfo-format-region} and @code{texinfo-format-buffer} are | |
1334 GNU Emacs functions that do the same. | |
1335 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1336 @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
|
1337 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
|
1338 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1339 @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
|
1340 Format}, to learn how to create an Info file from a Texinfo file. |
25839 | 1341 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1342 @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
|
1343 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
|
1344 have created one. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1345 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1346 @node Index |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1347 @unnumbered Index |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1348 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1349 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
|
1350 topics discussed in this document. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1351 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1352 @printindex cp |
25839 | 1353 |
1354 @bye |