comparison man/info.texi @ 5508:3fe8358ad59a

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