annotate man/info.texi @ 38509:59acf1c91dd2

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