annotate man/info.texi @ 51336:c1252b2b2582

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