Mercurial > emacs
annotate man/info.texi @ 82182:78ee45af2b61
(mode-line-remote): Use updated %@ construct.
author | Nick Roberts <nickrob@snap.net.nz> |
---|---|
date | Sat, 28 Jul 2007 01:24:33 +0000 |
parents | bed4242b228c |
children | a1be62cbd32a |
rev | line source |
---|---|
54317
5bb4ac4ec8d7
\input texinfo.tex instead of just texinfo, to
Karl Berry <karl@gnu.org>
parents:
54057
diff
changeset
|
1 \input texinfo.tex @c -*-texinfo-*- |
5bb4ac4ec8d7
\input texinfo.tex instead of just texinfo, to
Karl Berry <karl@gnu.org>
parents:
54057
diff
changeset
|
2 @c We must \input texinfo.tex instead of texinfo, otherwise make |
5bb4ac4ec8d7
\input texinfo.tex instead of just texinfo, to
Karl Berry <karl@gnu.org>
parents:
54057
diff
changeset
|
3 @c distcheck in the Texinfo distribution fails, because the texinfo Info |
5bb4ac4ec8d7
\input texinfo.tex instead of just texinfo, to
Karl Berry <karl@gnu.org>
parents:
54057
diff
changeset
|
4 @c file is made first, and texi2dvi must include . first in the path. |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
5 @comment %**start of header |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
6 @setfilename info.info |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
7 @settitle Info |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
8 @syncodeindex fn cp |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
9 @syncodeindex vr cp |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
10 @syncodeindex ky cp |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
11 @comment %**end of header |
25839 | 12 |
47737
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46888
diff
changeset
|
13 @copying |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
14 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
|
15 documentation system. |
25839 | 16 |
69681
11b616eddda4
@copyright{}, no indentation in @copying{}
Karl Berry <karl@gnu.org>
parents:
68639
diff
changeset
|
17 Copyright @copyright{} 1989, 1992, 1996, 1997, 1998, 1999, 2000, 2001, |
75348 | 18 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. |
25839 | 19 |
47737
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46888
diff
changeset
|
20 @quotation |
32315 | 21 Permission is granted to copy, distribute and/or modify this document |
65555
69b3598a61c5
Update all manuals to specify GFDL version 1.2.
Romain Francoise <romain@orebokech.com>
parents:
64890
diff
changeset
|
22 under the terms of the GNU Free Documentation License, Version 1.2 or |
32315 | 23 any later version published by the Free Software Foundation; with no |
24 Invariant Sections, with the Front-Cover texts being ``A GNU | |
72101
c7e4f78b81a6
Move periods and commas inside quotes.
Richard M. Stallman <rms@gnu.org>
parents:
71496
diff
changeset
|
25 Manual,'' and with the Back-Cover Texts as in (a) below. A copy of the |
32315 | 26 license is included in the section entitled ``GNU Free Documentation |
27 License'' in the Emacs manual. | |
25839 | 28 |
81889
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
29 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
30 modify this GNU Manual, like GNU software. Buying copies from GNU |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
31 Press supports the FSF in developing GNU and promoting software |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
32 freedom.'' |
25839 | 33 |
32315 | 34 This document is part of a collection distributed under the GNU Free |
35 Documentation License. If you want to distribute this document | |
36 separately from the collection, you can do so by adding a copy of the | |
37 license to the document, as described in section 6 of the license. | |
47737
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46888
diff
changeset
|
38 @end quotation |
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46888
diff
changeset
|
39 @end copying |
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46888
diff
changeset
|
40 |
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46888
diff
changeset
|
41 @dircategory Texinfo documentation system |
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46888
diff
changeset
|
42 @direntry |
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46888
diff
changeset
|
43 * Info: (info). How to use the documentation browsing system. |
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46888
diff
changeset
|
44 @end direntry |
25839 | 45 |
46 @titlepage | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
47 @title Info |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
48 @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
|
49 @author Brian Fox |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
50 @author and the GNU Texinfo community |
25839 | 51 @page |
52 @vskip 0pt plus 1filll | |
47737
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
46888
diff
changeset
|
53 @insertcopying |
25839 | 54 @end titlepage |
55 | |
52122 | 56 @contents |
57 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
58 @ifnottex |
51729
4ee4b130c3cb
(Top, Help-Small-Screen): Remove accidentally added next, prev and up
Luc Teirlinck <teirllm@auburn.edu>
parents:
51713
diff
changeset
|
59 @node Top |
25839 | 60 @top Info: An Introduction |
61 | |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
62 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
|
63 @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
|
64 probably using an Info reader to read this now. |
25839 | 65 |
56180
8e90bf0fe781
(Top): mention that only Emacs has mouse support.
Karl Berry <karl@gnu.org>
parents:
54720
diff
changeset
|
66 There are two primary Info readers: @code{info}, a stand-alone program |
8e90bf0fe781
(Top): mention that only Emacs has mouse support.
Karl Berry <karl@gnu.org>
parents:
54720
diff
changeset
|
67 designed just to read Info files, and the @code{info} package in GNU |
8e90bf0fe781
(Top): mention that only Emacs has mouse support.
Karl Berry <karl@gnu.org>
parents:
54720
diff
changeset
|
68 Emacs, a general-purpose editor. At present, only the Emacs reader |
8e90bf0fe781
(Top): mention that only Emacs has mouse support.
Karl Berry <karl@gnu.org>
parents:
54720
diff
changeset
|
69 supports using a mouse. |
8e90bf0fe781
(Top): mention that only Emacs has mouse support.
Karl Berry <karl@gnu.org>
parents:
54720
diff
changeset
|
70 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
71 @ifinfo |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
72 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
|
73 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
|
74 instruction sequence. |
25839 | 75 |
66009 | 76 To read about advanced Info commands, type @kbd{n} twice. This |
77 brings you to @cite{Advanced Info Commands}, skipping over the `Getting | |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
78 Started' chapter. |
25839 | 79 @end ifinfo |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
80 @end ifnottex |
25839 | 81 |
82 @menu | |
83 * Getting Started:: Getting started using an Info reader. | |
66009 | 84 * Advanced:: Advanced Info commands. |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
85 * Expert Info:: Info commands for experts. |
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
|
86 * Index:: An index of topics, commands, and variables. |
25839 | 87 @end menu |
88 | |
66009 | 89 @node Getting Started, Advanced, Top, Top |
25839 | 90 @comment node-name, next, previous, up |
91 @chapter Getting Started | |
92 | |
56180
8e90bf0fe781
(Top): mention that only Emacs has mouse support.
Karl Berry <karl@gnu.org>
parents:
54720
diff
changeset
|
93 This first part of this Info manual describes how to get around inside |
25839 | 94 of Info. The second part of the manual describes various advanced |
66009 | 95 Info commands. The third part briefly explains how to generate Info |
66137
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
96 files from Texinfo files, and describes how to write an Info file |
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
97 by hand. |
25839 | 98 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
99 @ifnotinfo |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
100 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
|
101 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
|
102 about them. Reading it on paper or with an HTML browser is less |
25839 | 103 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
|
104 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
|
105 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
|
106 as well. |
25839 | 107 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
108 @cindex Info reader, how to invoke |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
109 @cindex entering Info |
25839 | 110 There are two ways of looking at the online version of this manual: |
111 | |
112 @enumerate | |
113 @item | |
114 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
|
115 stand-alone program designed just to read Info files. |
25839 | 116 |
117 @item | |
37362
f3e3f00c30fc
Fix markup of keys such as Space and Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37355
diff
changeset
|
118 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
|
119 (@kbd{Control-h}, followed by @kbd{i}). This approach uses the Info |
56180
8e90bf0fe781
(Top): mention that only Emacs has mouse support.
Karl Berry <karl@gnu.org>
parents:
54720
diff
changeset
|
120 mode of the Emacs editor. |
25839 | 121 @end enumerate |
122 | |
123 In either case, then type @kbd{mInfo} (just the letters), followed by | |
124 @key{RET}---the ``Return'' or ``Enter'' key. At this point, you should | |
125 be ready to follow the instructions in this manual as you read them on | |
126 the screen. | |
127 @c FIXME! (pesch@cygnus.com, 14 dec 1992) | |
128 @c Is it worth worrying about what-if the beginner goes to somebody | |
129 @c else's Emacs session, which already has an Info running in the middle | |
130 @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
|
131 @end ifnotinfo |
25839 | 132 |
133 @menu | |
57342 | 134 * Help-Small-Screen:: Starting Info on a Small Screen. |
135 * Help:: How to use Info. | |
136 * 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
|
137 * Help-^L:: The Space, DEL, B and ^L commands. |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
138 * Help-Inv:: Invisible text in Emacs Info. |
57342 | 139 * Help-M:: Menus. |
140 * Help-Xref:: Following cross-references. | |
141 * Help-Int:: Some intermediate Info commands. | |
142 * Help-Q:: Quitting Info. | |
25839 | 143 @end menu |
144 | |
51729
4ee4b130c3cb
(Top, Help-Small-Screen): Remove accidentally added next, prev and up
Luc Teirlinck <teirllm@auburn.edu>
parents:
51713
diff
changeset
|
145 @node Help-Small-Screen |
25839 | 146 @section Starting Info on a Small Screen |
147 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
148 @ifnotinfo |
25839 | 149 (In Info, you only see this section if your terminal has a small |
150 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
|
151 @end ifnotinfo |
25839 | 152 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
153 @cindex small screen, moving around |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
154 Since your terminal has a relatively small number of lines on its |
25839 | 155 screen, it is necessary to give you special advice at the beginning. |
156 | |
71496
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
157 If the entire text you are looking at fits on the screen, the text |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
158 @samp{All} will be displayed at the bottom of the screen. In the |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
159 stand-alone Info reader, it is displayed at the bottom right corner of |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
160 the screen; in Emacs, it is displayed on the modeline. If you see the |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
161 text @samp{Top} instead, it means that there is more text below that |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
162 does not fit. To move forward through the text and see another screen |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
163 full, press @key{SPC}, the Space bar. To move back up, press the key |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
164 labeled @samp{Backspace} or @samp{DEL} (on some keyboards, this key |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
165 might be labeled @samp{Delete}). |
25839 | 166 |
167 @ifinfo | |
37362
f3e3f00c30fc
Fix markup of keys such as Space and Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37355
diff
changeset
|
168 Here are 40 lines of junk, so you can try @key{SPC} and @key{DEL} and |
25839 | 169 see what they do. At the end are instructions of what you should do |
170 next. | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
171 |
25839 | 172 @format |
173 This is line 20 | |
174 This is line 21 | |
175 This is line 22 | |
176 This is line 23 | |
177 This is line 24 | |
178 This is line 25 | |
179 This is line 26 | |
180 This is line 27 | |
181 This is line 28 | |
182 This is line 29 | |
183 This is line 30 | |
184 This is line 31 | |
185 This is line 32 | |
186 This is line 33 | |
187 This is line 34 | |
188 This is line 35 | |
189 This is line 36 | |
190 This is line 37 | |
191 This is line 38 | |
192 This is line 39 | |
193 This is line 40 | |
194 This is line 41 | |
195 This is line 42 | |
196 This is line 43 | |
197 This is line 44 | |
198 This is line 45 | |
199 This is line 46 | |
200 This is line 47 | |
201 This is line 48 | |
202 This is line 49 | |
203 This is line 50 | |
204 This is line 51 | |
205 This is line 52 | |
206 This is line 53 | |
207 This is line 54 | |
208 This is line 55 | |
209 This is line 56 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
210 This is line 57 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
211 This is line 58 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
212 This is line 59 |
25839 | 213 @end format |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
214 |
25839 | 215 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
|
216 @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
|
217 understand the about the @samp{Space} and @samp{Backspace} keys. So |
57342 | 218 now type an @kbd{n}---just one character; don't type the quotes and |
219 don't type the Return key afterward---to get to the normal start of | |
37362
f3e3f00c30fc
Fix markup of keys such as Space and Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37355
diff
changeset
|
220 the course. |
25839 | 221 @end ifinfo |
222 | |
223 @node Help, Help-P, Help-Small-Screen, Getting Started | |
224 @comment node-name, next, previous, up | |
225 @section How to use Info | |
226 | |
227 You are talking to the program Info, for reading documentation. | |
228 | |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
229 There are two ways to use Info: from within Emacs or as a |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
230 stand-alone reader that you can invoke from a shell using the command |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
231 @command{info}. |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
232 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
233 @cindex node, in Info documents |
25839 | 234 Right now you are looking at one @dfn{Node} of Information. |
235 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
|
236 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
|
237 line says that this is node @samp{Help} in the file @file{info}. |
25839 | 238 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
239 @cindex header of Info node |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
240 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
|
241 (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
|
242 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
|
243 any node whose name you know. In the stand-alone Info reader program, |
64813
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
244 the header line shows the names of this node and the Info file as |
71496
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
245 well. In Emacs, the header line is displayed with a special typeface, |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
246 and remains at the top of the window all the time even if you scroll |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
247 through the node. |
25839 | 248 |
57342 | 249 Besides a @samp{Next}, a node can have a @samp{Previous} link, or an |
250 @samp{Up} link, or both. As you can see, this node has all of these | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
251 links. |
25839 | 252 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
253 @kindex n @r{(Info mode)} |
25839 | 254 Now it is time to move on to the @samp{Next} node, named @samp{Help-P}. |
255 | |
256 @format | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
257 >> Type @kbd{n} to move there. Type just one character; |
25839 | 258 do not type the quotes and do not type a @key{RET} afterward. |
259 @end format | |
260 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
261 @noindent |
25839 | 262 @samp{>>} in the margin means it is really time to try a command. |
263 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
264 @format |
48162
4260c3b0397c
(Info-fontify): reorder face list to avoid bad
Karl Berry <karl@gnu.org>
parents:
47737
diff
changeset
|
265 >> If you are in Emacs and have a mouse, and if you already practiced |
71496
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
266 typing @kbd{n} to get to the next node, click now with the left |
48162
4260c3b0397c
(Info-fontify): reorder face list to avoid bad
Karl Berry <karl@gnu.org>
parents:
47737
diff
changeset
|
267 mouse button on the @samp{Next} link to do the same ``the mouse way''. |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
268 @end format |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
269 |
25839 | 270 @node Help-P, Help-^L, Help, Getting Started |
271 @comment node-name, next, previous, up | |
272 @section Returning to the Previous node | |
273 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
274 @kindex p @r{(Info mode)} |
25839 | 275 This node is called @samp{Help-P}. The @samp{Previous} node, as you see, |
276 is @samp{Help}, which is the one you just came from using the @kbd{n} | |
277 command. Another @kbd{n} command now would take you to the next | |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
278 node, @samp{Help-^L}. |
25839 | 279 |
280 @format | |
56180
8e90bf0fe781
(Top): mention that only Emacs has mouse support.
Karl Berry <karl@gnu.org>
parents:
54720
diff
changeset
|
281 >> But do not type @kbd{n} yet. First, try the @kbd{p} command, or |
71496
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
282 (in Emacs) click on the @samp{Prev} link. That takes you to |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
283 the @samp{Previous} node. Then use @kbd{n} to return here. |
25839 | 284 @end format |
285 | |
37362
f3e3f00c30fc
Fix markup of keys such as Space and Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37355
diff
changeset
|
286 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
|
287 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
|
288 @samp{Info} menu-bar item opens a menu of commands which include |
64813
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
289 @samp{Next} and @samp{Previous} (and also some others which you didn't yet |
37362
f3e3f00c30fc
Fix markup of keys such as Space and Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37355
diff
changeset
|
290 learn about). |
f3e3f00c30fc
Fix markup of keys such as Space and Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37355
diff
changeset
|
291 |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
292 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
|
293 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
|
294 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
|
295 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
|
296 coming up. |
25839 | 297 |
298 @format | |
56180
8e90bf0fe781
(Top): mention that only Emacs has mouse support.
Karl Berry <karl@gnu.org>
parents:
54720
diff
changeset
|
299 >> Now do an @kbd{n}, or (in Emacs) click the middle mouse button on |
8e90bf0fe781
(Top): mention that only Emacs has mouse support.
Karl Berry <karl@gnu.org>
parents:
54720
diff
changeset
|
300 the @samp{Next} link, to get to the node @samp{Help-^L} and learn more. |
25839 | 301 @end format |
302 | |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
303 @node Help-^L, Help-Inv, Help-P, Getting Started |
25839 | 304 @comment node-name, next, previous, up |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
305 @section The Space, DEL, B and ^L commands |
25839 | 306 |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
307 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
|
308 @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
|
309 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
|
310 underlined as well; it says what the node is about. |
25839 | 311 |
312 This is a big node and it does not all fit on your display screen. | |
313 You can tell that there is more that is not visible because you | |
71496
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
314 can see the text @samp{Top} rather than @samp{All} near the bottom of |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
315 the screen. |
25839 | 316 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
317 @kindex SPC @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
318 @kindex DEL @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
319 @kindex BACKSPACE @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
320 @findex Info-scroll-up |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
321 @findex Info-scroll-down |
37362
f3e3f00c30fc
Fix markup of keys such as Space and Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37355
diff
changeset
|
322 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
|
323 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
|
324 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
|
325 @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
|
326 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
|
327 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
|
328 @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
|
329 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
|
330 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
|
331 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
|
332 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
|
333 the top until you have typed some spaces). |
25839 | 334 |
335 @format | |
37362
f3e3f00c30fc
Fix markup of keys such as Space and Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37355
diff
changeset
|
336 >> 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
|
337 return here). |
25839 | 338 @end format |
339 | |
37362
f3e3f00c30fc
Fix markup of keys such as Space and Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37355
diff
changeset
|
340 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
|
341 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
|
342 @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
|
343 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
|
344 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
|
345 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
346 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
|
347 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
|
348 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
|
349 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
|
350 clicking the middle mouse button on the link. |
25839 | 351 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
352 @cindex reading Info documents top to bottom |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
353 @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
|
354 @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
|
355 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
|
356 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
|
357 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
|
358 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
|
359 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
|
360 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
|
361 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
|
362 |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
363 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
|
364 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
|
365 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
|
366 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
|
367 parent's next node. |
25839 | 368 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
369 @kindex PAGEUP @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
370 @kindex PAGEDOWN @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
371 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
|
372 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
|
373 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
|
374 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
|
375 @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
|
376 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
|
377 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
378 @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
|
379 If your screen is ever garbaged, you can tell Info to display it |
57342 | 380 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
|
381 @key{CTRL} and type @kbd{L} or @kbd{l}). |
25839 | 382 |
383 @format | |
384 >> Type @kbd{C-l} now. | |
385 @end format | |
386 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
387 @kindex b @r{(Info mode)} |
25839 | 388 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
|
389 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
|
390 @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
|
391 |
25839 | 392 @format |
393 >> 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
|
394 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
|
395 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
|
396 Then come back, by typing @key{SPC} one or more times. |
25839 | 397 @end format |
398 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
399 @kindex ? @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
400 @findex Info-summary |
25839 | 401 You have just learned a considerable number of commands. If you |
402 want to use one but have trouble remembering which, you should type | |
71496
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
403 @kbd{?}, which displays a brief list of commands. When you are |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
404 finished looking at the list, make it go away by typing @key{SPC} |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
405 repeatedly. |
25839 | 406 |
407 @format | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
408 >> Type a @key{?} now. Press @key{SPC} to see consecutive screenfuls of |
48162
4260c3b0397c
(Info-fontify): reorder face list to avoid bad
Karl Berry <karl@gnu.org>
parents:
47737
diff
changeset
|
409 the list until finished. Then type @key{SPC} several times. If |
4260c3b0397c
(Info-fontify): reorder face list to avoid bad
Karl Berry <karl@gnu.org>
parents:
47737
diff
changeset
|
410 you are using Emacs, the help will then go away automatically. |
25839 | 411 @end format |
412 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
413 (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
|
414 return here, that is---press and hold @key{CTRL}, type an @kbd{x}, |
57342 | 415 then release @key{CTRL} and @kbd{x}, and press @kbd{0}; that's a zero, |
416 not the letter ``o''.) | |
25839 | 417 |
418 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
|
419 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
|
420 move around in them without being told. Since not all terminals have |
25839 | 421 the same size screen, it would be impossible to warn you anyway. |
422 | |
423 @format | |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
424 >> Now type @kbd{n}, or click the middle mouse button on the @samp{Next} link, |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
425 to visit the next node. |
25839 | 426 @end format |
427 | |
51812
e45f9b4a6497
(Help-Inv, Help-M, Help-Xref): Update following renaming of `vis-mode'
Luc Teirlinck <teirllm@auburn.edu>
parents:
51729
diff
changeset
|
428 @node Help-Inv, Help-M, Help-^L, Getting Started |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
429 @comment node-name, next, previous, up |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
430 @section Invisible text in Emacs Info |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
431 |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
432 Before discussing menus, we need to make some remarks that are only |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
433 relevant to users reading Info using Emacs. Users of the stand-alone |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
434 version can skip this node by typing @kbd{]} now. |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
435 |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
436 @cindex invisible text in Emacs |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
437 In Emacs, certain text that appears in the stand-alone version is |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
438 normally hidden, technically because it has the @samp{invisibility} |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
439 property. Invisible text is really a part of the text. It becomes |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
440 visible (by default) after killing and yanking, it appears in printed |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
441 output, it gets saved to file just like any other text, and so on. |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
442 Thus it is useful to know it is there. |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
443 |
51812
e45f9b4a6497
(Help-Inv, Help-M, Help-Xref): Update following renaming of `vis-mode'
Luc Teirlinck <teirllm@auburn.edu>
parents:
51729
diff
changeset
|
444 @findex visible-mode |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
445 You can make invisible text visible by using the command @kbd{M-x |
51814
4dbb30eefc67
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
51813
diff
changeset
|
446 visible-mode}. Visible mode is a minor mode, so using the command a |
4dbb30eefc67
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
51813
diff
changeset
|
447 second time will make the text invisible again. Watch the effects of |
4dbb30eefc67
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
51813
diff
changeset
|
448 the command on the ``menu'' below and the top line of this node. |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
449 |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
450 If you prefer to @emph{always} see the invisible text, you can set |
51813
d82cd7a68702
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
51812
diff
changeset
|
451 @code{Info-hide-note-references} to @code{nil}. Enabling Visible mode |
d82cd7a68702
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
51812
diff
changeset
|
452 permanently is not a real alternative, because Emacs Info also uses |
d82cd7a68702
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
51812
diff
changeset
|
453 (although less extensively) another text property that can change the |
d82cd7a68702
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
51812
diff
changeset
|
454 text being displayed, the @samp{display} property. Only the |
d82cd7a68702
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
51812
diff
changeset
|
455 invisibility property is affected by Visible mode. When, in this |
d82cd7a68702
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
51812
diff
changeset
|
456 tutorial, we refer to the @samp{Emacs} behavior, we mean the |
d82cd7a68702
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
51812
diff
changeset
|
457 @emph{default} Emacs behavior. |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
458 |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
459 Now type @kbd{]}, to learn about the @kbd{]} and @kbd{[} commands. |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
460 |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
461 @menu |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
462 * ]: Help-]. Node telling about ]. |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
463 * stuff: Help-]. Same node. |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
464 * Help-]:: Yet again, same node. |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
465 @end menu |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
466 |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
467 @node Help-], , , Help-Inv |
52561
d4cddd3d3be2
(] and [ commands): no period at end of section title.
Karl Berry <karl@gnu.org>
parents:
52401
diff
changeset
|
468 @subsection The @kbd{]} and @kbd{[} commands |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
469 |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
470 If you type @kbd{n} now, you get an error message saying that this |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
471 node has no next node. Similarly, if you type @kbd{p}, the error |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
472 message tells you that there is no previous node. (The exact message |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
473 depends on the Info reader you use.) This is because @kbd{n} and |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
474 @kbd{p} carry you to the next and previous node @emph{at the same |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
475 level}. The present node is contained in a menu (see next) of the |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
476 node you came from, and hence is considered to be at a lower level. |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
477 It is the only node in the previous node's menu (even though it was |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
478 listed three times). Hence it has no next or previous node that |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
479 @kbd{n} or @kbd{p} could move to. |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
480 |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
481 If you systematically move through a manual by typing @kbd{n}, you run |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
482 the risk of skipping many nodes. You do not run this risk if you |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
483 systematically use @kbd{@key{SPC}}, because, when you scroll to the |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
484 bottom of a node and type another @kbd{@key{SPC}}, then this carries |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
485 you to the following node in the manual @emph{regardless of level}. |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
486 If you immediately want to go to that node, without having to scroll |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
487 to the bottom of the screen first, you can type @kbd{]}. |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
488 |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
489 Similarly, @kbd{@key{BACKSPACE}} carries you to the preceding node |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
490 regardless of level, after you scrolled to the beginning of the |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
491 present node. If you want to go to the preceding node immediately, |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
492 you can type @kbd{[}. |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
493 |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
494 For instance, typing this sequence will come back here in three steps: |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
495 @kbd{[ n [}. To do the same backward, type @kbd{] p ]}. |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
496 |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
497 Now type @kbd{]} to go to the next node and learn about menus. |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
498 |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
499 @node Help-M, Help-Xref, Help-Inv, Getting Started |
25839 | 500 @comment node-name, next, previous, up |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
501 @section Menus and the @kbd{m} command |
25839 | 502 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
503 @cindex menus in an Info document |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
504 @cindex Info menus |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
505 With only the @kbd{n} (next), @kbd{p} (previous), @kbd{@key{SPC}}, |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
506 @kbd{@key{BACKSPACE}}, @kbd{]} and @kbd{[} commands for moving between |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
507 nodes, nodes are restricted to a linear sequence. Menus allow a |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
508 branching structure. A menu is a list of other nodes you can move to. |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
509 It is actually just part of the text of the node formatted specially |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
510 so that Info can interpret it. The beginning of a menu is always |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
511 identified by a line which starts with @w{@samp{* Menu:}}. A node |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
512 contains a menu if and only if it has a line in it which starts that |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
513 way. The only menu you can use at any moment is the one in the node |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
514 you are in. To use a menu in any other node, you must move to that |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
515 node first. |
25839 | 516 |
517 After the start of the menu, each line that starts with a @samp{*} | |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
518 identifies one subtopic. The line usually contains a brief name for |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
519 the subtopic (followed by a @samp{:}, normally hidden in Emacs), the |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
520 name of the node that talks about that subtopic (again, normally |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
521 hidden in Emacs), and optionally some further description of the |
25839 | 522 subtopic. Lines in the menu that do not start with a @samp{*} have no |
523 special meaning---they are only for the human reader's benefit and do | |
524 not define additional subtopics. Here is an example: | |
525 | |
526 @example | |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
527 * Foo: Node about FOO. This tells about FOO. |
25839 | 528 @end example |
529 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
530 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
|
531 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
|
532 Information. [[ But this line is not a real menu item, simply because |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
533 there is no line above it which starts with @w{@samp{* Menu:}}. Also, |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
534 in a real menu item, the @samp{*} would appear at the very start of |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
535 the line. This is why the ``normally hidden'' text in Emacs, namely |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
536 @samp{: Node about FOO.}, is actually visible in this example, even |
51813
d82cd7a68702
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
51812
diff
changeset
|
537 when Visible mode is off.]] |
25839 | 538 |
539 When you use a menu to go to another node (in a way that will be | |
540 described soon), what you specify is the subtopic name, the first | |
541 thing in the menu line. Info uses it to find the menu line, extracts | |
542 the node name from it, and goes to that node. The reason that there | |
543 is both a subtopic name and a node name is that the node name must be | |
544 meaningful to the computer and may therefore have to be ugly looking. | |
545 The subtopic name can be chosen just to be convenient for the user to | |
546 specify. Often the node name is convenient for the user to specify | |
547 and so both it and the subtopic name are the same. There is an | |
548 abbreviation for this: | |
549 | |
550 @example | |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
551 * Foo:: This tells about FOO. |
25839 | 552 @end example |
553 | |
554 @noindent | |
555 This means that the subtopic name and node name are the same; they are | |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
556 both @samp{Foo}. (The @samp{::} is normally hidden in Emacs.) |
25839 | 557 |
558 @format | |
37362
f3e3f00c30fc
Fix markup of keys such as Space and Backspace.
Eli Zaretskii <eliz@gnu.org>
parents:
37355
diff
changeset
|
559 >> 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
|
560 the front with a @kbd{b} and some @key{SPC}s. As you see, a menu is |
25839 | 561 actually visible in its node. If you cannot find a menu in a node |
562 by looking at it, then the node does not have a menu and the | |
563 @kbd{m} command is not available. | |
564 @end format | |
565 | |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
566 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
|
567 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
|
568 happens, type @key{BACKSPACE} to come back. |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
569 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
570 @kindex m @r{(Info mode)} |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
571 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
|
572 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
|
573 prompts you for more input. |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
574 |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
575 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
|
576 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
|
577 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
|
578 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
|
579 tries to read the subtopic name. |
25839 | 580 |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
581 Now, in the stand-alone Info, look for the line containing many |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
582 dashes near the bottom of the screen. (This is the stand-alone |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
583 equivalent for the mode line in Emacs.) There is one more line |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
584 beneath that one, but usually it is blank. (In Emacs, this is the |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
585 echo area.) When it is blank, Info is ready for a command, such as |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
586 @kbd{n} or @kbd{b} or @key{SPC} or @kbd{m}. If that line contains |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
587 text ending in a colon, it means Info is reading more input for the |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
588 last command. You can't type an Info command then, because Info is |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
589 trying to read input, not commands. You must either give the input |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
590 and finish the command you started, or type @kbd{Control-g} to cancel |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
591 the command. When you have done one of those things, the input entry |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
592 line becomes blank again. Then you can type Info commands again. |
25839 | 593 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
594 @findex Info-menu |
25839 | 595 The command to go to a subnode via a menu is @kbd{m}. After you type |
596 the @kbd{m}, the line at the bottom of the screen says @samp{Menu item: }. | |
597 You must then type the name of the subtopic you want, and end it with | |
71496
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
598 a @key{RET}. |
25839 | 599 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
600 @cindex abbreviating Info subnodes |
25839 | 601 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
|
602 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
|
603 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
|
604 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
|
605 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
|
606 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
|
607 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
|
608 the menu. |
25839 | 609 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
610 @cindex completion of Info node names |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
611 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
|
612 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
|
613 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
|
614 from the part you have entered. |
25839 | 615 |
616 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
|
617 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
|
618 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
|
619 the middle mouse button directly on the subtopic line to go there. |
25839 | 620 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
621 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
|
622 three ways of going to one place, Help-FOO: |
25839 | 623 |
624 @menu | |
625 * 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
|
626 * Bar: Help-FOO. We have made two ways to get to the same place. |
25839 | 627 * Help-FOO:: And yet another! |
628 @end menu | |
629 | |
51813
d82cd7a68702
*** empty log message ***
Luc Teirlinck <teirllm@auburn.edu>
parents:
51812
diff
changeset
|
630 (Turn Visible mode on if you are using Emacs.) |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
631 |
25839 | 632 @format |
633 >> Now type just an @kbd{m} and see what happens: | |
634 @end format | |
635 | |
636 Now you are ``inside'' an @kbd{m} command. Commands cannot be used | |
637 now; the next thing you will type must be the name of a subtopic. | |
638 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
639 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
|
640 @kbd{Control-g}. |
25839 | 641 |
642 @format | |
643 >> 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
|
644 @end format |
25839 | 645 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
646 @format |
25839 | 647 >> Then type another @kbd{m}. |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
648 @end format |
25839 | 649 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
650 @format |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
651 >> Now type @kbd{BAR}, the item name. Do not type @key{RET} yet. |
25839 | 652 @end format |
653 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
654 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
|
655 @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
|
656 mistake. |
25839 | 657 |
658 @format | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
659 >> 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
|
660 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
|
661 abbreviation. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
662 @end format |
25839 | 663 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
664 @format |
25839 | 665 >> Now you are ready to go. Type a @key{RET}. |
666 @end format | |
667 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
668 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
|
669 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
670 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
|
671 to type @key{TAB}. Each time you type a @key{TAB}, you move to the |
64813
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
672 next subtopic line. To move to a previous subtopic line in the |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
673 stand-alone reader, type @kbd{M-@key{TAB}}---that is, press and hold |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
674 the @key{META} key and then press @key{TAB}. (On some keyboards, the |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
675 @key{META} key might be labeled @samp{Alt}.) In Emacs Info, type |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
676 @kbd{S-@key{TAB}} to move to a previous subtopic line (press and hold |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
677 the @key{Shift} key and then press @key{TAB}). |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
678 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
679 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
|
680 that subtopic's node. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
681 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
682 @cindex mouse support in Info mode |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
683 @kindex Mouse-2 @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
684 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
|
685 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
|
686 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
|
687 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
|
688 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
|
689 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
|
690 that. After a while, if you leave the mouse on that spot, a small |
72101
c7e4f78b81a6
Move periods and commas inside quotes.
Richard M. Stallman <rms@gnu.org>
parents:
71496
diff
changeset
|
691 window will pop up, saying ``Mouse-2: go to that node,'' or the same |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
692 message may appear at the bottom of the screen. |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
693 |
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
694 @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
|
695 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
|
696 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
|
697 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
|
698 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
|
699 go to that subtopic. |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
700 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
701 @findex Info-mouse-follow-nearest-node |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
702 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
|
703 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
|
704 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
|
705 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
|
706 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
|
707 there's no next node. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
708 |
25839 | 709 @format |
710 >> Type @kbd{n} to see more commands. | |
711 @end format | |
712 | |
713 @node Help-FOO, , , Help-M | |
714 @subsection The @kbd{u} command | |
715 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
716 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
|
717 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
|
718 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
|
719 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
|
720 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
|
721 usually used to ``stay on the same level but go backwards''. |
25839 | 722 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
723 @kindex u @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
724 @findex Info-up |
25839 | 725 You can go back to the node @samp{Help-M} by typing the command |
71496
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
726 @kbd{u} for ``Up''. This puts you at the menu subtopic line pointing |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
727 to the subnode that the @kbd{u} command brought you from. (Some Info |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
728 readers may put you at the @emph{front} of the node instead---to get |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
729 back to where you were reading, you have to type some @key{SPC}s.) |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
730 |
46205
6676ac71682b
Update mouse button info.
Richard M. Stallman <rms@gnu.org>
parents:
44877
diff
changeset
|
731 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
|
732 pointer shown in the header line (provided that you have a mouse). |
25839 | 733 |
734 @format | |
735 >> Now type @kbd{u} to move back up to @samp{Help-M}. | |
736 @end format | |
737 | |
39356
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
738 @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
|
739 @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
|
740 @section Following Cross-References |
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
741 |
39357
9012f11877c1
Major rewrite of Help-Xref. Don't use "print" except for paper.
Richard M. Stallman <rms@gnu.org>
parents:
39356
diff
changeset
|
742 @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
|
743 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
|
744 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
|
745 is a real, live cross reference, whose name is @samp{Cross} and which |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
746 points to the node named @samp{Help-Cross}. (The node name is hidden |
51812
e45f9b4a6497
(Help-Inv, Help-M, Help-Xref): Update following renaming of `vis-mode'
Luc Teirlinck <teirllm@auburn.edu>
parents:
51729
diff
changeset
|
747 in Emacs. Do @kbd{M-x visible-mode} to show or hide it.) |
39356
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
748 |
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
749 @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
|
750 @findex Info-follow-reference |
71496
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
751 You can follow a cross reference by moving the cursor to it and |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
752 press @key{RET}, just as in a menu. In Emacs, you can also click |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
753 @kbd{Mouse-1} on a cross reference to follow it; you can see that the |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
754 cross reference is mouse-sensitive by moving the mouse pointer to the |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
755 reference and watching how the underlying text and the mouse pointer |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
756 change in response. |
39357
9012f11877c1
Major rewrite of Help-Xref. Don't use "print" except for paper.
Richard M. Stallman <rms@gnu.org>
parents:
39356
diff
changeset
|
757 |
71496
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
758 Another way to follow a cross reference is to type @kbd{f} and then |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
759 specify the name of the cross reference (in this case, @samp{Cross}) |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
760 as an argument. For this command, it does not matter where the cursor |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
761 was. If the cursor is on or near a cross reference, @kbd{f} suggests |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
762 that reference name in parentheses as the default; typing @key{RET} |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
763 will follow that reference. However, if you type a different |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
764 reference name, @kbd{f} will follow the other reference which has that |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
765 name. |
39357
9012f11877c1
Major rewrite of Help-Xref. Don't use "print" except for paper.
Richard M. Stallman <rms@gnu.org>
parents:
39356
diff
changeset
|
766 |
9012f11877c1
Major rewrite of Help-Xref. Don't use "print" except for paper.
Richard M. Stallman <rms@gnu.org>
parents:
39356
diff
changeset
|
767 @format |
9012f11877c1
Major rewrite of Help-Xref. Don't use "print" except for paper.
Richard M. Stallman <rms@gnu.org>
parents:
39356
diff
changeset
|
768 >> 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
|
769 @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
|
770 |
9012f11877c1
Major rewrite of Help-Xref. Don't use "print" except for paper.
Richard M. Stallman <rms@gnu.org>
parents:
39356
diff
changeset
|
771 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
|
772 @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
|
773 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
|
774 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
|
775 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
|
776 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
|
777 |
39357
9012f11877c1
Major rewrite of Help-Xref. Don't use "print" except for paper.
Richard M. Stallman <rms@gnu.org>
parents:
39356
diff
changeset
|
778 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
|
779 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
|
780 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
|
781 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
|
782 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
|
783 |
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
784 @format |
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
785 >> 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
|
786 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
|
787 @end format |
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
788 |
64813
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
789 The @key{TAB}, @kbd{M-@key{TAB}} and @kbd{S-@key{TAB}} keys, |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
790 which move between menu items in a menu, also move between cross |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
791 references outside of menus. |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
792 |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
793 Sometimes a cross reference (or a node) can lead to another file (in |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
794 other words another ``manual''), or, on occasion, even a file on a |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
795 remote machine (although Info files distributed with Emacs or the |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
796 stand-alone Info avoid using remote links). Such a cross reference |
51952
b011595889f7
(Help-Xref): missing , in @xref.
Karl Berry <karl@gnu.org>
parents:
51814
diff
changeset
|
797 looks like this: @xref{Top,, Overview of Texinfo, texinfo, Texinfo: |
b011595889f7
(Help-Xref): missing , in @xref.
Karl Berry <karl@gnu.org>
parents:
51814
diff
changeset
|
798 The GNU Documentation Format}. (After following this link, type |
b011595889f7
(Help-Xref): missing , in @xref.
Karl Berry <karl@gnu.org>
parents:
51814
diff
changeset
|
799 @kbd{l} to get back to this node.) Here the name @samp{texinfo} |
64813
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
800 between parentheses refers to the file name. This file name appears |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
801 in cross references and node names if it differs from the current |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
802 file, so you can always know that you are going to be switching to |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
803 another manual and which one. |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
804 |
64813
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
805 However, Emacs normally hides some other text in cross-references. |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
806 If you put your mouse over the cross reference, then the information |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
807 appearing in a separate box (tool tip) or in the echo area will show |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
808 the full cross-reference including the file name and the node name of |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
809 the cross reference. If you have a mouse, just leave it over the |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
810 cross reference @xref{Top,, Overview of Texinfo, texinfo, Texinfo: |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
811 The GNU Documentation Format}, and watch what happens. If you |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
812 always like to have that information visible without having to move |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
813 your mouse over the cross reference, use @kbd{M-x visible-mode}, or |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
814 set @code{Info-hide-note-references} to a value other than @code{t} |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
815 (@pxref{Emacs Info Variables}). |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
816 |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
817 @format |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
818 >> Now type @kbd{n} to learn more commands. |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
819 @end format |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
820 |
39356
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
821 @node Help-Int, Help-Q, Help-Xref, Getting Started |
25839 | 822 @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
|
823 @section Some intermediate Info commands |
25839 | 824 |
39355
127d6dc34db9
Rename Help-Adv to Help-Int, for intermediate-level.
Richard M. Stallman <rms@gnu.org>
parents:
37552
diff
changeset
|
825 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
|
826 a little longer to learn some intermediate-level commands. |
25839 | 827 |
54057
c92801a25b2f
(Help-Int): mention the new line number feature.
Karl Berry <karl@gnu.org>
parents:
52942
diff
changeset
|
828 Most Info files have an index, which is actually a large node |
c92801a25b2f
(Help-Int): mention the new line number feature.
Karl Berry <karl@gnu.org>
parents:
52942
diff
changeset
|
829 containing little but a menu. The menu has one menu item for each |
c92801a25b2f
(Help-Int): mention the new line number feature.
Karl Berry <karl@gnu.org>
parents:
52942
diff
changeset
|
830 topic listed in the index. (As a special feature, menus for indices |
c92801a25b2f
(Help-Int): mention the new line number feature.
Karl Berry <karl@gnu.org>
parents:
52942
diff
changeset
|
831 may also include the line number within the node of the index entry. |
c92801a25b2f
(Help-Int): mention the new line number feature.
Karl Berry <karl@gnu.org>
parents:
52942
diff
changeset
|
832 This allows Info readers to go to the exact line of an entry, not just |
c92801a25b2f
(Help-Int): mention the new line number feature.
Karl Berry <karl@gnu.org>
parents:
52942
diff
changeset
|
833 the start of the containing node.) |
c92801a25b2f
(Help-Int): mention the new line number feature.
Karl Berry <karl@gnu.org>
parents:
52942
diff
changeset
|
834 |
c92801a25b2f
(Help-Int): mention the new line number feature.
Karl Berry <karl@gnu.org>
parents:
52942
diff
changeset
|
835 You can get to the index from the main menu of the file with the |
64813
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
836 @kbd{m} command and the name of the index node; then you can use the |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
837 @kbd{m} command again in the index node to go to the node that |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
838 describes the topic you want. |
39356
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
839 |
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
840 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
|
841 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
|
842 goes to the node which is listed in the index for that topic. |
66009 | 843 @xref{Search Index}, for a full explanation. |
39356
81362552baba
New node Help-Xref broken out from Help-Int.
Richard M. Stallman <rms@gnu.org>
parents:
39355
diff
changeset
|
844 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
845 @kindex l @r{(Info mode)} |
64813
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
846 @findex Info-history-back |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
847 @cindex going back in Info history |
25839 | 848 If you have been moving around to different nodes and wish to |
849 retrace your steps, the @kbd{l} command (@kbd{l} for @dfn{last}) will | |
850 do that, one node-step at a time. As you move from node to node, Info | |
851 records the nodes where you have been in a special history list. The | |
852 @kbd{l} command revisits nodes in the history list; each successive | |
853 @kbd{l} command moves one step back through the history. | |
854 | |
855 @format | |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
856 >> Try typing @kbd{p p n} and then three @kbd{l}'s, pausing in between |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
857 to see what each @kbd{l} does. You should wind up right back here. |
25839 | 858 @end format |
859 | |
860 Note the difference between @kbd{l} and @kbd{p}: @kbd{l} moves to | |
861 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
|
862 which the header says is the @samp{Previous} node (from this node, the |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
863 @samp{Prev} link leads to @samp{Help-Xref}). |
25839 | 864 |
64813
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
865 @kindex r @r{(Info mode)} |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
866 @findex Info-history-forward |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
867 @cindex going forward in Info history |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
868 You can use the @kbd{r} command (@code{Info-history-forward} in Emacs) |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
869 to revisit nodes in the history list in the forward direction, so that |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
870 @kbd{r} will return you to the node you came from by typing @kbd{l}. |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
871 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
872 @kindex d @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
873 @findex Info-directory |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
874 @cindex go to Directory node |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
875 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
|
876 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
|
877 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
|
878 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
|
879 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
|
880 are, or could be, installed on your system. |
25839 | 881 |
882 @format | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
883 >> Try doing a @kbd{d}, then do an @kbd{l} to return here (yes, |
25839 | 884 @emph{do} return). |
885 @end format | |
886 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
887 @kindex t @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
888 @findex Info-top-node |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
889 @cindex go to Top node |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
890 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
|
891 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
|
892 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
|
893 is @code{Info-top-node}. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
894 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
895 @format |
25839 | 896 >> Now type @kbd{n} to see the last node of the course. |
897 @end format | |
898 | |
66009 | 899 @xref{Advanced}, 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
|
900 |
25839 | 901 @c If a menu appears at the end of this node, remove it. |
902 @c It is an accident of the menu updating command. | |
903 | |
81889
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
904 @node Help-Q, , Help-Int, Getting Started |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
905 @comment node-name, next, previous, up |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
906 @section Quitting Info |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
907 |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
908 @kindex q @r{(Info mode)} |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
909 @findex Info-exit |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
910 @cindex quitting Info mode |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
911 To get out of Info, back to what you were doing before, type @kbd{q} |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
912 for @dfn{Quit}. This runs @code{Info-exit} in Emacs. |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
913 |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
914 This is the end of the basic course on using Info. You have learned |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
915 how to move in an Info document, and how to follow menus and cross |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
916 references. This makes you ready for reading manuals top to bottom, |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
917 as new users should do when they learn a new package. |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
918 |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
919 Another set of Info commands is useful when you need to find |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
920 something quickly in a manual---that is, when you need to use a manual |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
921 as a reference rather than as a tutorial. We urge you to learn |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
922 these search commands as well. If you want to do that now, follow this |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
923 cross reference to @ref{Advanced}. |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
924 |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
925 Yet another set of commands are meant for experienced users; you can |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
926 find them by looking in the Directory node for documentation on Info. |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
927 Finding them will be a good exercise in using Info in the usual |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
928 manner. |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
929 |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
930 @format |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
931 >> Type @kbd{d} to go to the Info directory node; then type |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
932 @kbd{mInfo} and Return, to get to the node about Info and |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
933 see what other help is available. |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
934 @end format |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
935 |
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
936 |
66009 | 937 @node Advanced |
938 @chapter Advanced Info Commands | |
25839 | 939 |
66009 | 940 This chapter describes various advanced Info commands. (If you |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
941 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
|
942 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
|
943 GNU Info, info-stnd, GNU Info}.) |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
944 |
71389 | 945 @kindex C-q @r{(Info mode)} |
946 One advanced command useful with most of the others described here | |
947 is @kbd{C-q}, which ``quotes'' the next character so that it is | |
948 entered literally (@pxref{Inserting Text,,,emacs,The GNU Emacs | |
949 Manual}). For example, pressing @kbd{?} ordinarily brings up a list | |
950 of completion possibilities. If you want to (for example) search for | |
951 an actual @samp{?} character, the simplest way is to insert it using | |
952 @kbd{C-q ?}. This works the same in Emacs and stand-alone Info. | |
953 | |
25839 | 954 @menu |
66009 | 955 * Search Text:: How to search Info documents. |
956 * Search Index:: How to search the indices for specific subjects. | |
957 * Go to node:: How to go to a node by name. | |
958 * Choose menu subtopic:: How to choose a menu subtopic by its number. | |
959 * Create Info buffer:: How to create a new Info buffer in Emacs. | |
25839 | 960 * Emacs Info Variables:: Variables modifying the behavior of Emacs Info. |
961 @end menu | |
962 | |
81889
bed4242b228c
move Quitting Info node; update Back-Cover Text
Karl Berry <karl@gnu.org>
parents:
75348
diff
changeset
|
963 |
66009 | 964 @node Search Text, Search Index, , Advanced |
25839 | 965 @comment node-name, next, previous, up |
66009 | 966 @section How to search Info documents |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
967 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
968 @cindex searching Info documents |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
969 @cindex Info document as a reference |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
970 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
|
971 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
|
972 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
|
973 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
|
974 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
|
975 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
|
976 describes. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
977 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
978 Info has powerful searching facilities that let you find things |
66009 | 979 quickly. You can search either the manual text or its indices. |
980 | |
981 @kindex s @r{(Info mode)} | |
982 @findex Info-search | |
983 The @kbd{s} command allows you to search a whole Info file for a string. | |
984 It switches to the next node if and when that is necessary. You | |
985 type @kbd{s} followed by the string to search for, terminated by | |
986 @key{RET}. To search for the same string again, just @kbd{s} followed | |
987 by @key{RET} will do. The file's nodes are scanned in the order | |
988 they are in the file, which has no necessary relationship to the | |
989 order that they may be in the tree structure of menus and @samp{next} | |
990 pointers. But normally the two orders are not very different. In any | |
66137
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
991 case, you can always look at the mode line to find out what node you have |
66009 | 992 reached, if the header is not visible (this can happen, because @kbd{s} |
993 puts your cursor at the occurrence of the string, not at the beginning | |
994 of the node). | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
995 |
66009 | 996 @kindex M-s @r{(Info mode)} |
997 In Emacs, @kbd{Meta-s} is equivalent to @kbd{s}. That is for | |
998 compatibility with other GNU packages that use @kbd{M-s} for a similar | |
999 kind of search command. Both @kbd{s} and @kbd{M-s} run in Emacs the | |
1000 command @code{Info-search}. | |
1001 | |
1002 @kindex C-s @r{(Info mode)} | |
1003 @kindex C-r @r{(Info mode)} | |
1004 @findex isearch | |
1005 Instead of using @kbd{s} in Emacs Info and in the stand-alone Info, | |
1006 you can use an incremental search started with @kbd{C-s} or @kbd{C-r}. | |
1007 It can search through multiple Info nodes. @xref{Incremental Search,,, | |
71496
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
1008 emacs, The GNU Emacs Manual}. In Emacs, you can disable this behavior |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
1009 by setting the variable @code{Info-isearch-search} to @code{nil} |
66009 | 1010 (@pxref{Emacs Info Variables}). |
1011 | |
1012 @node Search Index, Go to node, Search Text, Advanced | |
1013 @comment node-name, next, previous, up | |
1014 @section How to search the indices for specific subjects | |
1015 | |
1016 @cindex searching Info indices | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1017 @kindex i @r{(Info mode)} |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1018 @findex Info-index |
66137
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1019 Since most topics in the manual should be indexed, you should try |
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1020 the index search first before the text search. The @kbd{i} command |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1021 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
|
1022 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
|
1023 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
|
1024 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
|
1025 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
|
1026 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
|
1027 |
66137
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1028 The @kbd{i} command and subsequent @kbd{,} commands find all index |
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1029 entries which include the string you typed @emph{as a substring}. |
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1030 For each match, Info shows in the echo area the full index entry it |
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1031 found. Often, the text of the full index entry already gives you |
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1032 enough information to decide whether it is relevant to what you are |
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1033 looking for, so we recommend that you read what Info shows in the echo |
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1034 area before looking at the node it displays. |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1035 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1036 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
|
1037 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
|
1038 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
|
1039 complete partial input (e.g., when you type @key{TAB}). If you want |
72101
c7e4f78b81a6
Move periods and commas inside quotes.
Richard M. Stallman <rms@gnu.org>
parents:
71496
diff
changeset
|
1040 to catch index entries that refer to ``complete,'' ``completion,'' and |
c7e4f78b81a6
Move periods and commas inside quotes.
Richard M. Stallman <rms@gnu.org>
parents:
71496
diff
changeset
|
1041 ``completing,'' you could type @kbd{icomplet@key{RET}}. |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1042 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1043 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
|
1044 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
|
1045 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
|
1046 their names when @kbd{i} prompts you for a topic. For example, if you |
66137
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1047 want to read the description of what the @kbd{C-l} key does, type |
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1048 @kbd{iC-l@key{RET}} literally. |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1049 |
54720
4b458413e987
(Info Search): Add info-apropos.
Jesper Harder <harder@ifa.au.dk>
parents:
54416
diff
changeset
|
1050 @findex info-apropos |
64813
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
1051 @findex index-apropos |
66137
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1052 If you aren't sure which manual documents the topic you are looking |
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1053 for, try the @kbd{M-x info-apropos} command in Emacs, or the @kbd{M-x |
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1054 index-apropos} command in the stand-alone reader. It prompts for |
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1055 a string and then looks up that string in all the indices of all the |
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1056 Info documents installed on your system. |
54720
4b458413e987
(Info Search): Add info-apropos.
Jesper Harder <harder@ifa.au.dk>
parents:
54416
diff
changeset
|
1057 |
66009 | 1058 @node Go to node, Choose menu subtopic, Search Index, Advanced |
1059 @comment node-name, next, previous, up | |
1060 @section @kbd{g} goes to a node by name | |
1061 | |
1062 @kindex g @r{(Info mode)} | |
1063 @findex Info-goto-node | |
1064 @cindex go to a node by name | |
1065 If you know a node's name, you can go there by typing @kbd{g}, the | |
1066 name, and @key{RET}. Thus, @kbd{gTop@key{RET}} would go to the node | |
1067 called @samp{Top} in this file. (This is equivalent to @kbd{t}, see | |
1068 @ref{Help-Int}.) @kbd{gGo to node@key{RET}} would come back here. | |
1069 | |
1070 Unlike @kbd{m}, @kbd{g} does not allow the use of abbreviations. | |
1071 But it does allow completion, so you can type @key{TAB} to complete a | |
1072 partial node name. | |
1073 | |
1074 @cindex go to another Info file | |
1075 To go to a node in another file, you can include the file name in the | |
1076 node name by putting it at the front, in parentheses. Thus, | |
1077 @kbd{g(dir)Top@key{RET}} would go to the Info Directory node, which is | |
1078 the node @samp{Top} in the Info file @file{dir}. Likewise, | |
1079 @kbd{g(emacs)Top@key{RET}} goes to the top node of the Emacs manual. | |
1080 | |
1081 The node name @samp{*} specifies the whole file. So you can look at | |
1082 all of the current file by typing @kbd{g*@key{RET}} or all of any | |
1083 other file with @kbd{g(@var{filename})*@key{RET}}. | |
1084 | |
1085 @node Choose menu subtopic, Create Info buffer, Go to node, Advanced | |
1086 @comment node-name, next, previous, up | |
1087 @section @kbd{1}--@kbd{9} choose a menu subtopic by its number | |
1088 | |
1089 @kindex 1 @r{through} 9 @r{(Info mode)} | |
1090 @findex Info-nth-menu-item | |
1091 @cindex select @var{n}'th menu item | |
1092 If you begrudge each character of type-in which your system requires, | |
1093 you might like to use the commands @kbd{1}, @kbd{2}, @kbd{3}, @kbd{4}, | |
1094 @dots{}, @kbd{9}. They are short for the @kbd{m} command together | |
1095 with a name of a menu subtopic. @kbd{1} goes through the first item | |
1096 in the current node's menu; @kbd{2} goes through the second item, etc. | |
1097 In the stand-alone reader, @kbd{0} goes through the last menu item; | |
71496
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
1098 this is so you need not count how many entries are there. |
66009 | 1099 |
1100 If your display supports multiple fonts, colors or underlining, and | |
1101 you are using Emacs' Info mode to read Info files, the third, sixth | |
1102 and ninth menu items have a @samp{*} that stands out, either in color | |
1103 or in some other attribute, such as underline; this makes it easy to | |
1104 see at a glance which number to use for an item. | |
1105 | |
1106 Some terminals don't support either multiple fonts, colors or | |
1107 underlining. If you need to actually count items, it is better to use | |
1108 @kbd{m} instead, and specify the name, or use @key{TAB} to quickly | |
1109 move between menu items. | |
1110 | |
1111 @node Create Info buffer, Emacs Info Variables, Choose menu subtopic, Advanced | |
1112 @comment node-name, next, previous, up | |
1113 @section @kbd{M-n} creates a new independent Info buffer in Emacs | |
1114 | |
1115 @kindex M-n @r{(Info mode)} | |
1116 @findex clone-buffer | |
1117 @cindex multiple Info buffers | |
1118 If you are reading Info in Emacs, you can select a new independent | |
71496
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
1119 Info buffer in a new Emacs window by typing @kbd{M-n}. The new buffer |
66009 | 1120 starts out as an exact copy of the old one, but you will be able to |
1121 move independently between nodes in the two buffers. (In Info mode, | |
1122 @kbd{M-n} runs the Emacs command @code{clone-buffer}.) | |
1123 | |
1124 In Emacs Info, you can also produce new Info buffers by giving a | |
1125 numeric prefix argument to the @kbd{m} and @kbd{g} commands. @kbd{C-u | |
1126 m} and @kbd{C-u g} go to a new node in exactly the same way that | |
1127 @kbd{m} and @kbd{g} do, but they do so in a new Info buffer which they | |
1128 select in another window. | |
1129 | |
1130 Another way to produce new Info buffers in Emacs is to use a numeric | |
1131 prefix argument for the @kbd{C-h i} command (@code{info}) which | |
1132 switches to the Info buffer with that number. Thus, @kbd{C-u 2 C-h i} | |
1133 switches to the buffer @samp{*info*<2>}, creating it if necessary. | |
1134 | |
1135 @node Emacs Info Variables, , Create Info buffer, Advanced | |
1136 @comment node-name, next, previous, up | |
1137 @section Emacs Info-mode Variables | |
1138 | |
1139 The following variables may modify the behavior of Info-mode in Emacs; | |
71496
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
1140 you may wish to set one or several of these variables interactively, |
d6f6fe603bad
* info.texi (Help-Small-Screen): Clarify placement of "All" and "Top"
Chong Yidong <cyd@stupidchicken.com>
parents:
71389
diff
changeset
|
1141 or in your init file. @xref{Examining, Examining and Setting |
66009 | 1142 Variables, Examining and Setting Variables, emacs, The GNU Emacs |
1143 Manual}. The stand-alone Info reader program has its own set of | |
1144 variables, described in @ref{Variables,, Manipulating Variables, | |
1145 info-stnd, GNU Info}. | |
1146 | |
1147 @vtable @code | |
1148 @item Info-directory-list | |
1149 The list of directories to search for Info files. Each element is a | |
1150 string (directory name) or @code{nil} (try default directory). If not | |
1151 initialized Info uses the environment variable @env{INFOPATH} to | |
1152 initialize it, or @code{Info-default-directory-list} if there is no | |
1153 @env{INFOPATH} variable in the environment. | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1154 |
66009 | 1155 If you wish to customize the Info directory search list for both Emacs |
1156 Info and stand-alone Info, it is best to set the @env{INFOPATH} | |
1157 environment variable, since that applies to both programs. | |
1158 | |
1159 @item Info-additional-directory-list | |
1160 A list of additional directories to search for Info documentation files. | |
1161 These directories are not searched for merging the @file{dir} file. | |
1162 | |
1163 @item Info-mode-hook | |
1164 Hooks run when @code{Info-mode} is called. By default, it contains | |
1165 the hook @code{turn-on-font-lock} which enables highlighting of Info | |
1166 files. You can change how the highlighting looks by customizing the | |
1167 faces @code{info-node}, @code{info-xref}, @code{info-xref-visited}, | |
1168 @code{info-header-xref}, @code{info-header-node}, @code{info-menu-header}, | |
1169 @code{info-menu-star}, and @code{info-title-@var{n}} (where @var{n} | |
1170 is the level of the section, a number between 1 and 4). To customize | |
1171 a face, type @kbd{M-x customize-face @key{RET} @var{face} @key{RET}}, | |
1172 where @var{face} is one of the face names listed here. | |
1173 | |
1174 @item Info-fontify-maximum-menu-size | |
1175 Maximum size of menu to fontify if @code{font-lock-mode} is non-@code{nil}. | |
1176 | |
1177 @item Info-fontify-visited-nodes | |
1178 If non-@code{nil}, menu items and cross-references pointing to visited | |
1179 nodes are displayed in the @code{info-xref-visited} face. | |
1180 | |
1181 @item Info-use-header-line | |
1182 If non-@code{nil}, Emacs puts in the Info buffer a header line showing | |
1183 the @samp{Next}, @samp{Prev}, and @samp{Up} links. A header line does | |
1184 not scroll with the rest of the buffer, making these links always | |
1185 visible. | |
1186 | |
1187 @item Info-hide-note-references | |
1188 As explained in earlier nodes, the Emacs version of Info normally | |
1189 hides some text in menus and cross-references. You can completely | |
1190 disable this feature, by setting this option to @code{nil}. Setting | |
1191 it to a value that is neither @code{nil} nor @code{t} produces an | |
1192 intermediate behavior, hiding a limited amount of text, but showing | |
1193 all text that could potentially be useful. | |
1194 | |
1195 @item Info-scroll-prefer-subnodes | |
1196 If set to a non-@code{nil} value, @key{SPC} and @key{BACKSPACE} (or | |
1197 @key{DEL}) keys in a menu visit subnodes of the current node before | |
1198 scrolling to its end or beginning, respectively. For example, if the | |
1199 node's menu appears on the screen, the next @key{SPC} moves to a | |
1200 subnode indicated by the following menu item. Setting this option to | |
1201 @code{nil} results in behavior similar to the stand-alone Info reader | |
1202 program, which visits the first subnode from the menu only when you | |
1203 hit the end of the current node. The default is @code{nil}. | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1204 |
66009 | 1205 @item Info-isearch-search |
1206 If non-@code{nil}, isearch in Info searches through multiple nodes. | |
1207 | |
1208 @item Info-enable-active-nodes | |
1209 When set to a non-@code{nil} value, allows Info to execute Lisp code | |
1210 associated with nodes. The Lisp code is executed when the node is | |
1211 selected. The Lisp code to be executed should follow the node | |
1212 delimiter (the @samp{DEL} character) and an @samp{execute: } tag, like | |
1213 this: | |
1214 | |
1215 @example | |
1216 ^_execute: (message "This is an active node!") | |
1217 @end example | |
1218 @end vtable | |
1219 | |
1220 | |
1221 @node Expert Info | |
1222 @chapter Info for Experts | |
1223 | |
66137
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1224 This chapter explains how to write an Info file by hand. However, |
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1225 in most cases, writing a Texinfo file is better, since you can use it |
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1226 to make a printed manual or produce other formats, such as HTML and |
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1227 DocBook, as well as for generating Info files. |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1228 |
66137
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1229 The @code{makeinfo} command converts a Texinfo file into an Info file; |
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1230 @code{texinfo-format-region} and @code{texinfo-format-buffer} are GNU |
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1231 Emacs functions that do the same. |
66009 | 1232 |
1233 @xref{Top,, Overview of Texinfo, texinfo, Texinfo: The GNU | |
66137
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1234 Documentation Format}, for how to write a Texinfo file. |
66009 | 1235 |
1236 @xref{Creating an Info File,,, texinfo, Texinfo: The GNU Documentation | |
66137
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1237 Format}, for how to create an Info file from a Texinfo file. |
66009 | 1238 |
1239 @xref{Installing an Info File,,, texinfo, Texinfo: The GNU | |
66137
8e90ee28ad1a
(Getting Started, Search Index, Expert Info): Fix wording.
Juri Linkov <juri@jurta.org>
parents:
66009
diff
changeset
|
1240 Documentation Format}, for how to install an Info file after you |
66009 | 1241 have created one. |
1242 | |
1243 However, if you want to edit an Info file manually and install it manually, | |
1244 here is how. | |
1245 | |
1246 @menu | |
1247 * Add:: Describes how to add new nodes to the hierarchy. | |
1248 Also tells what nodes look like. | |
1249 * Menus:: How to add to or create menus in Info nodes. | |
1250 * Cross-refs:: How to add cross-references to Info nodes. | |
1251 * Tags:: How to make tags tables for Info files. | |
1252 * Checking:: Checking an Info File. | |
1253 @end menu | |
1254 | |
1255 @node Add, Menus, , Expert Info | |
25839 | 1256 @comment node-name, next, previous, up |
1257 @section Adding a new node to Info | |
1258 | |
1259 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
|
1260 |
25839 | 1261 @enumerate |
1262 @item | |
1263 Create some nodes, in some file, to document that topic. | |
1264 @item | |
1265 Put that topic in the menu in the directory. @xref{Menus, Menu}. | |
1266 @end enumerate | |
1267 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1268 @cindex node delimiters |
25839 | 1269 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
|
1270 one. It must have a @samp{^_} character before it (invisible to the |
25839 | 1271 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
|
1272 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
|
1273 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
|
1274 @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
|
1275 @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
|
1276 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
|
1277 @samp{^_}.} |
25839 | 1278 |
37392
18abdfdd5585
Fix markup of control characters.
Eli Zaretskii <eliz@gnu.org>
parents:
37362
diff
changeset
|
1279 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
|
1280 @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
|
1281 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
|
1282 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
|
1283 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
|
1284 is the node @samp{Expert Info}. The @samp{Next} node is @samp{Menus}. |
25839 | 1285 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1286 @cindex node header line format |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1287 @cindex format of node headers |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1288 The keywords @dfn{Node}, @dfn{Next}, @dfn{Previous}, and @dfn{Up} |
25839 | 1289 may appear in any order, anywhere in the header line, but the |
1290 recommended order is the one in this sentence. Each keyword must be | |
1291 followed by a colon, spaces and tabs, and then the appropriate name. | |
1292 The name may be terminated with a tab, a comma, or a newline. A space | |
1293 does not end it; node names may contain spaces. The case of letters | |
1294 in the names is insignificant. | |
1295 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1296 @cindex node name format |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1297 @cindex Directory node |
25839 | 1298 A node name has two forms. A node in the current file is named by |
1299 what appears after the @samp{Node: } in that node's first line. For | |
1300 example, this node's name is @samp{Add}. A node in another file is | |
1301 named by @samp{(@var{filename})@var{node-within-file}}, as in | |
72101
c7e4f78b81a6
Move periods and commas inside quotes.
Richard M. Stallman <rms@gnu.org>
parents:
71496
diff
changeset
|
1302 @samp{(info)Add} for this node. If the file name starts with @samp{./}, |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1303 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
|
1304 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
|
1305 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
|
1306 @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
|
1307 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
|
1308 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
|
1309 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
|
1310 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
|
1311 document file listed in the @samp{Directory} should have an @samp{Up: |
25839 | 1312 (dir)} in it. |
1313 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1314 @cindex unstructured documents |
25839 | 1315 The node name @kbd{*} is special: it refers to the entire file. |
1316 Thus, @kbd{g*} shows you the whole current file. The use of the | |
1317 node @kbd{*} is to make it possible to make old-fashioned, | |
1318 unstructured files into nodes of the tree. | |
1319 | |
1320 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
|
1321 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
|
1322 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
|
1323 @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
|
1324 node is in the same file, it was not necessary to use one. |
25839 | 1325 |
1326 Note that the nodes in this file have a file name in the header | |
1327 line. The file names are ignored by Info, but they serve as comments | |
1328 to help identify the node for the user. | |
1329 | |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
1330 @node Menus, Cross-refs, Add, Expert Info |
25839 | 1331 @comment node-name, next, previous, up |
1332 @section How to Create Menus | |
1333 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1334 Any node in the Info hierarchy may have a @dfn{menu}---a list of subnodes. |
25839 | 1335 The @kbd{m} command searches the current node's menu for the topic which it |
1336 reads from the terminal. | |
1337 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1338 @cindex menu and menu entry format |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
1339 A menu begins with a line starting with @w{@samp{* Menu:}}. The |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
1340 rest of the line is a comment. After the starting line, every line |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
1341 that begins with a @samp{* } lists a single topic. The name of the |
57342 | 1342 topic---what the user must type at the @kbd{m}'s command prompt to |
51713
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
1343 select this topic---comes right after the star and space, and is |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
1344 followed by a colon, spaces and tabs, and the name of the node which |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
1345 discusses that topic. The node name, like node names following |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
1346 @samp{Next}, @samp{Previous} and @samp{Up}, may be terminated with a |
205602055b5f
(Help): Mention existence of Emacs and stand-alone Info at the very
Luc Teirlinck <teirllm@auburn.edu>
parents:
48162
diff
changeset
|
1347 tab, comma, or newline; it may also be terminated with a period. |
25839 | 1348 |
1349 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
|
1350 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
|
1351 used (and should be used, whenever possible, as it reduces the visual |
25839 | 1352 clutter in the menu). |
1353 | |
1354 It is considerate to choose the topic names so that they differ | |
1355 from each other very near the beginning---this allows the user to type | |
1356 short abbreviations. In a long menu, it is a good idea to capitalize | |
1357 the beginning of each item name which is the minimum acceptable | |
1358 abbreviation for it (a long menu is more than 5 or so entries). | |
1359 | |
72101
c7e4f78b81a6
Move periods and commas inside quotes.
Richard M. Stallman <rms@gnu.org>
parents:
71496
diff
changeset
|
1360 The nodes listed in a node's menu are called its ``subnodes,'' and it |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1361 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
|
1362 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
|
1363 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
|
1364 someone who wants to see them all need not keep revisiting the Menu. |
25839 | 1365 |
1366 The Info Directory is simply the menu of the node @samp{(dir)Top}---that | |
1367 is, node @samp{Top} in file @file{.../info/dir}. You can put new entries | |
1368 in that menu just like any other menu. The Info Directory is @emph{not} the | |
1369 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
|
1370 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
|
1371 files in that directory are not automatically listed in the Info |
25839 | 1372 Directory node. |
1373 | |
72101
c7e4f78b81a6
Move periods and commas inside quotes.
Richard M. Stallman <rms@gnu.org>
parents:
71496
diff
changeset
|
1374 Also, although the Info node graph is claimed to be a ``hierarchy,'' |
25839 | 1375 in fact it can be @emph{any} directed graph. Shared structures and |
1376 pointer cycles are perfectly possible, and can be used if they are | |
1377 appropriate to the meaning to be expressed. There is no need for all | |
1378 the nodes in a file to form a connected structure. In fact, this file | |
1379 has two connected components. You are in one of them, which is under | |
1380 the node @samp{Top}; the other contains the node @samp{Help} which the | |
1381 @kbd{h} command goes to. In fact, since there is no garbage | |
64813
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
1382 collector on the node graph, nothing terrible happens if a substructure |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
1383 is not pointed to, but such a substructure is rather useless since nobody |
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
1384 can ever find out that it exists. |
25839 | 1385 |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
1386 @node Cross-refs, Tags, Menus, Expert Info |
25839 | 1387 @comment node-name, next, previous, up |
1388 @section Creating Cross References | |
1389 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1390 @cindex cross reference format |
25839 | 1391 A cross reference can be placed anywhere in the text, unlike a menu |
1392 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
|
1393 like a menu item except that it has @samp{*note} instead of @samp{*}. |
25839 | 1394 It @emph{cannot} be terminated by a @samp{)}, because @samp{)}'s are |
1395 so often part of node names. If you wish to enclose a cross reference | |
1396 in parentheses, terminate it with a period first. Here are two | |
1397 examples of cross references pointers: | |
1398 | |
1399 @example | |
1400 *Note details: commands. (See *note 3: Full Proof.) | |
1401 @end example | |
1402 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1403 @noindent |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1404 @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
|
1405 really exist! |
25839 | 1406 |
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
|
1407 @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
|
1408 * 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
|
1409 @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
|
1410 |
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
|
1411 |
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
|
1412 @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
|
1413 @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
|
1414 |
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
|
1415 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
|
1416 |
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
|
1417 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
|
1418 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
|
1419 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
|
1420 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
|
1421 @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
|
1422 @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
|
1423 |
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
|
1424 @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
|
1425 >> 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
|
1426 @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
|
1427 |
44785
a59fec4b6783
Rename Advanced Info to Expert Info.
Richard M. Stallman <rms@gnu.org>
parents:
43992
diff
changeset
|
1428 @node Tags, Checking, Cross-refs, Expert Info |
25839 | 1429 @comment node-name, next, previous, up |
1430 @section Tags Tables for Info Files | |
1431 | |
64813
06fa0e2abb19
(Help-P): Replace `Prev' with `Previous'.
Juri Linkov <juri@jurta.org>
parents:
63674
diff
changeset
|
1432 @cindex tags tables in Info files |
25839 | 1433 You can speed up the access to nodes of a large Info file by giving |
1434 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
|
1435 an Info file lives inside the file itself and is used |
25839 | 1436 automatically whenever Info reads in the file. |
1437 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1438 @findex Info-tagify |
25839 | 1439 To make a tags table, go to a node in the file using Emacs Info mode and type |
1440 @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
|
1441 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
|
1442 of the Texinfo package always have tags tables to begin with. |
25839 | 1443 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1444 @cindex stale tags tables |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1445 @cindex update Info tags table |
25839 | 1446 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
|
1447 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
|
1448 Texinfo source), and, as a result of deletion of text, any node moves back |
25839 | 1449 more than a thousand characters in the file from the position |
1450 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
|
1451 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
|
1452 again. |
25839 | 1453 |
1454 An Info file tags table appears at the end of the file and looks like | |
1455 this: | |
1456 | |
1457 @example | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1458 ^_^L |
25839 | 1459 Tag Table: |
1460 File: info, Node: Cross-refs^?21419 | |
1461 File: info, Node: Tags^?22145 | |
1462 ^_ | |
1463 End Tag Table | |
1464 @end example | |
1465 | |
1466 @noindent | |
1467 Note that it contains one line per node, and this line contains | |
1468 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
|
1469 a @samp{DEL} character, and the character position in the file of the |
25839 | 1470 beginning of the node. |
1471 | |
66009 | 1472 @node Checking, , Tags, Expert Info |
25839 | 1473 @section Checking an Info File |
1474 | |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1475 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
|
1476 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
|
1477 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
|
1478 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
|
1479 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
|
1480 pointers which are invalid. Every @samp{Next}, @samp{Previous}, and |
25839 | 1481 @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
|
1482 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
|
1483 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
|
1484 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
|
1485 usually few. |
25839 | 1486 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1487 @findex Info-validate |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1488 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
|
1489 node of the file with Emacs Info mode. |
25839 | 1490 |
37344
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1491 @node Index |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1492 @unnumbered Index |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1493 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1494 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
|
1495 topics discussed in this document. |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1496 |
7ebf3c6391d2
Update for Emacs 21. Add index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
1497 @printindex cp |
25839 | 1498 |
1499 @bye | |
52401 | 1500 |
1501 @ignore | |
1502 arch-tag: 965c1638-01d6-4156-9227-b10418b9d8e8 | |
1503 @end ignore |