« back to all changes in this revision
Viewing changes to doc/info.texi
- browse files at revision 1.1.1
- compare with another revision
- download diff
- download tarball
- view history from revision 1.1.1
- Committer: Bazaar Package Importer
- Author(s): Norbert Preining
- Date: 2005-10-28 15:10:30 UTC
- mto: (2.1.1 dapper) (3.1.4 hardy)
- mto: This revision was merged to the branch mainline in revision 3.
- Revision ID: james.westby@ubuntu.com-20051028151030-9nsf2s2k2z3fktjt
Tags: upstream-4.8
Import upstream version 4.8
- files added:
- ChangeLog.46
- files removed:
- COPYING.DOC
- files modified:
- ABOUT-NLS
- depcomp *
- missing *
added
removed
doc/info.texi
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
5
@comment %**start of header
3
6
@setfilename info.info
4
7
@settitle Info
6
9
@syncodeindex vr cp
7
10
@syncodeindex ky cp
8
11
@comment %**end of header
9
@comment $Id: info.texi,v 1.22 2002/02/09 00:54:34 karl Exp $
12
13
@copying
14
This file describes how to use Info, the on-line, menu-driven GNU
15
documentation system.
16
17
Copyright (C) 1989, 1992, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
18
Free Software Foundation, Inc.
19
20
@quotation
21
Permission is granted to copy, distribute and/or modify this document
22
under the terms of the GNU Free Documentation License, Version 1.1 or
23
any later version published by the Free Software Foundation; with no
24
Invariant Sections, with the Front-Cover texts being ``A GNU
25
Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
26
license is included in the section entitled ``GNU Free Documentation
27
License'' in the Emacs manual.
28
29
(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
30
this GNU Manual, like GNU software. Copies published by the Free
31
Software Foundation raise funds for GNU development.''
32
33
This document is part of a collection distributed under the GNU Free
34
Documentation License. If you want to distribute this document
35
separately from the collection, you can do so by adding a copy of the
36
license to the document, as described in section 6 of the license.
37
@end quotation
38
@end copying
10
39
11
40
@dircategory Texinfo documentation system
12
41
@direntry
13
* Info: (info). Documentation browsing system.
42
* Info: (info). How to use the documentation browsing system.
14
43
@end direntry
15
44
16
@ifinfo
17
This file describes how to use Info, the on-line, menu-driven GNU
18
documentation system.
19
20
Copyright (C) 1989, 92, 96, 97, 98, 99, 2000, 2001
21
Free Software Foundation, Inc.
22
23
24
Permission is granted to copy, distribute and/or modify this document
25
under the terms of the GNU Free Documentation License, Version 1.1 or
26
any later version published by the Free Software Foundation; with no
27
Invariant Sections, with the Front-Cover texts being ``A GNU
28
Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
29
license is included in the section entitled ``GNU Free Documentation
30
License'' in the Emacs manual.
31
32
(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
33
this GNU Manual, like GNU software. Copies published by the Free
34
Software Foundation raise funds for GNU development.''
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 ifinfo
41
42
45
@titlepage
43
46
@title Info
44
47
@subtitle The online, hyper-text GNU documentation system
46
49
@author and the GNU Texinfo community
47
50
@page
48
51
@vskip 0pt plus 1filll
49
Copyright @copyright{} 1989, 92, 93, 96, 97, 98, 99, 2000, 2001
50
Free Software Foundation, Inc.
51
@sp 2
52
Published by the Free Software Foundation @*
53
59 Temple Place - Suite 330 @*
54
Boston, MA 02111-1307, USA.
55
56
Permission is granted to copy, distribute and/or modify this document
57
under the terms of the GNU Free Documentation License, Version 1.1 or
58
any later version published by the Free Software Foundation; with no
59
Invariant Sections, with the Front-Cover texts being ``A GNU
60
Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
61
license is included in the section entitled ``GNU Free Documentation
62
License'' in the Emacs manual.
63
64
(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
65
this GNU Manual, like GNU software. Copies published by the Free
66
Software Foundation raise funds for GNU development.''
67
68
This document is part of a collection distributed under the GNU Free
69
Documentation License. If you want to distribute this document
70
separately from the collection, you can do so by adding a copy of the
71
license to the document, as described in section 6 of the license.
52
@insertcopying
72
53
@end titlepage
73
54
55
@contents
56
74
57
@ifnottex
75
58
@node Top
76
59
@top Info: An Introduction
77
60
78
Info is a program, which you are using now, for reading documentation of
79
computer programs. The GNU Project distributes most of its on-line
80
manuals in the Info format, so you need a program called @dfn{Info
81
reader} to read the manuals. One of such programs you are using now.
61
The GNU Project distributes most of its on-line manuals in the
62
@dfn{Info format}, which you read using an @dfn{Info reader}. You are
63
probably using an Info reader to read this now.
64
65
There are two primary Info readers: @code{info}, a stand-alone program
66
designed just to read Info files, and the @code{info} package in GNU
67
Emacs, a general-purpose editor. At present, only the Emacs reader
68
supports using a mouse.
82
69
83
70
@ifinfo
84
If you are new to Info and want to learn how to use it, type the
85
command @kbd{h} now. It brings you to a programmed instruction
86
sequence.
71
If you are new to the Info reader and want to learn how to use it,
72
type the command @kbd{h} now. It brings you to a programmed
73
instruction sequence.
87
74
88
To learn advanced Info commands, type @kbd{n} twice. This brings you to
89
@cite{Info for Experts}, skipping over the `Getting Started' chapter.
75
To read about expert-level Info commands, type @kbd{n} twice. This
76
brings you to @cite{Info for Experts}, skipping over the `Getting
77
Started' chapter.
90
78
@end ifinfo
91
79
@end ifnottex
92
80
93
81
@menu
94
82
* Getting Started:: Getting started using an Info reader.
95
* Advanced Info:: Advanced commands within Info.
83
* Expert Info:: Info commands for experts.
96
84
* Creating an Info File:: How to make your own Info file.
97
85
* Index:: An index of topics, commands, and variables.
98
86
@end menu
99
87
100
@node Getting Started, Advanced Info, Top, Top
88
@node Getting Started, Expert Info, Top, Top
101
89
@comment node-name, next, previous, up
102
90
@chapter Getting Started
103
91
104
This first part of the Info manual describes how to get around inside
92
This first part of this Info manual describes how to get around inside
105
93
of Info. The second part of the manual describes various advanced
106
94
Info commands, and how to write an Info as distinct from a Texinfo
107
95
file. The third part briefly explains how to generate Info files from
128
116
@item
129
117
Type @code{emacs} at the command line; then type @kbd{C-h i}
130
118
(@kbd{Control-h}, followed by @kbd{i}). This approach uses the Info
131
mode of the Emacs program, an editor with many other capabilities.
119
mode of the Emacs editor.
132
120
@end enumerate
133
121
134
122
In either case, then type @kbd{mInfo} (just the letters), followed by
142
130
@end ifnotinfo
143
131
144
132
@menu
145
* Help-Small-Screen:: Starting Info on a Small Screen
146
* Help:: How to use Info
147
* Help-P:: Returning to the Previous node
133
* Help-Small-Screen:: Starting Info on a Small Screen.
134
* Help:: How to use Info.
135
* Help-P:: Returning to the Previous node.
148
136
* Help-^L:: The Space, DEL, B and ^L commands.
149
* Help-M:: Menus
150
* Help-Xref:: Following cross-references
151
* Help-Int:: Some intermediate Info commands
152
* Help-Q:: Quitting Info
137
* Help-Inv:: Invisible text in Emacs Info.
138
* Help-M:: Menus.
139
* Help-Xref:: Following cross-references.
140
* Help-Int:: Some intermediate Info commands.
141
* Help-Q:: Quitting Info.
153
142
@end menu
154
143
155
144
@node Help-Small-Screen
223
212
If you have managed to get here, go back to the beginning with
224
213
@kbd{DEL} (or @key{BACKSPACE}), and come back here again, then you
225
214
understand the about the @samp{Space} and @samp{Backspace} keys. So
226
now type an @kbd{n} ---just one character; don't type the quotes and
227
don't type the Return key afterward--- to get to the normal start of
215
now type an @kbd{n}---just one character; don't type the quotes and
216
don't type the Return key afterward---to get to the normal start of
228
217
the course.
229
218
@end ifinfo
230
219
234
223
235
224
You are talking to the program Info, for reading documentation.
236
225
226
There are two ways to use Info: from within Emacs or as a
227
stand-alone reader that you can invoke from a shell using the command
228
@command{info}.
229
237
230
@cindex node, in Info documents
238
231
Right now you are looking at one @dfn{Node} of Information.
239
232
A node contains text describing a specific topic at a specific
241
234
line says that this is node @samp{Help} in the file @file{info}.
242
235
243
236
@cindex header of Info node
244
The top line of a node is its @dfn{header}. This node's header (look at
245
it now) says that the @samp{Next} node after this one is the node
246
called @samp{Help-P}. An advanced Info command lets you go to any node
247
whose name you know. In the stand-alone Info reader program, the
248
header line shows the names of this node and the info file as well.
249
In Emacs, the header line is displayed in a special typeface, and it
250
doesn't scroll off the screen when you scroll the display. The names
251
of this node and of its Info file are omitted by Emacs from the header
252
line.
237
The top line of a node is its @dfn{header}. This node's header
238
(look at it now) says that the @samp{Next} node after this one is the
239
node called @samp{Help-P}. An advanced Info command lets you go to
240
any node whose name you know. In the stand-alone Info reader program,
241
the header line shows the names of this node and the info file as
242
well. In Emacs, the header line is duplicated in a special typeface,
243
and the duplicate remains at the top of the window all the time even
244
if you scroll through the node.
253
245
254
Besides a @samp{Next}, a node can have a @samp{Previous} or an
255
@samp{Up} links, or both. As you can see, this node has all of these
246
Besides a @samp{Next}, a node can have a @samp{Previous} link, or an
247
@samp{Up} link, or both. As you can see, this node has all of these
256
248
links.
257
249
258
250
@kindex n @r{(Info mode)}
267
259
@samp{>>} in the margin means it is really time to try a command.
268
260
269
261
@format
270
>> If you have a mouse, and if you already practiced typing @kbd{n}
271
to get to the next node, click now with the right mouse button on
272
the @samp{Next} link to do the same ``the mouse way''.
262
>> If you are in Emacs and have a mouse, and if you already practiced
263
typing @kbd{n} to get to the next node, click now with the middle
264
mouse button on the @samp{Next} link to do the same ``the mouse way''.
273
265
@end format
274
266
275
267
@node Help-P, Help-^L, Help, Getting Started
280
272
This node is called @samp{Help-P}. The @samp{Previous} node, as you see,
281
273
is @samp{Help}, which is the one you just came from using the @kbd{n}
282
274
command. Another @kbd{n} command now would take you to the next
283
node, @samp{Help-^L}. In Emacs, @kbd{n} runs the Emacs command
284
@code{Info-next}, and @kbd{p} runs @code{Info-prev}.
275
node, @samp{Help-^L}.
285
276
286
277
@format
287
>> But do not type @kbd{n} yet. First, try the @kbd{p} command,
288
or click the mouse on the @samp{Prev} link, which takes you to the
289
@samp{Previous} node. When you get there, you can do an @kbd{n}
290
again to return here.
278
>> But do not type @kbd{n} yet. First, try the @kbd{p} command, or
279
(in Emacs) click the middle mouse button on the @samp{Prev} link.
280
That takes you to the @samp{Previous} node. Then use @kbd{n} to
281
return here.
291
282
@end format
292
283
293
284
If you read this in Emacs, you will see an @samp{Info} item in the
294
menu bar, close to its right edge. Clicking your mouse on the
285
menu bar, close to its right edge. Clicking the mouse on the
295
286
@samp{Info} menu-bar item opens a menu of commands which include
296
287
@samp{Next} and @samp{Prev} (and also some others which you didn't yet
297
288
learn about).
298
289
299
This all probably seems insultingly simple so far, but @emph{do not} be
300
led into skimming. Things will get more complicated soon. Also,
301
do not try a new command until you are told it is time to. Otherwise,
302
you may make Info skip past an important warning that was coming up.
290
This all probably seems insultingly simple so far, but @emph{please
291
don't} start skimming. Things will get complicated soon enough!
292
Also, please do not try a new command until you are told it is time
293
to. You could make Info skip past an important warning that was
294
coming up.
303
295
304
296
@format
305
>> Now do an @kbd{n}, or click the mouse on the @samp{Next} link, to
306
get to the node @samp{Help-^L} and learn more.
297
>> Now do an @kbd{n}, or (in Emacs) click the middle mouse button on
298
the @samp{Next} link, to get to the node @samp{Help-^L} and learn more.
307
299
@end format
308
300
309
@node Help-^L, Help-M, Help-P, Getting Started
301
@node Help-^L, Help-Inv, Help-P, Getting Started
310
302
@comment node-name, next, previous, up
311
@section The Space, DEL, B and ^L commands.
303
@section The Space, DEL, B and ^L commands
312
304
313
This node's mode line tells you that you are now at node @samp{Help-^L},
314
and the header line tells you that @kbd{p} would get you back to
315
@samp{Help-P}. The node's title is underlined; it says what the node
316
is about (most nodes have titles).
305
This node's mode line tells you that you are now at node
306
@samp{Help-^L}, and the header line tells you that @kbd{p} would get
307
you back to @samp{Help-P}. The node's title is highlighted and may be
308
underlined as well; it says what the node is about.
317
309
318
310
This is a big node and it does not all fit on your display screen.
319
311
You can tell that there is more that is not visible because you
336
328
screen at once. @key{SPC} moves forward, to show what was below the
337
329
bottom of the screen. @key{DEL} or @key{BACKSPACE} moves backward, to
338
330
show what was above the top of the screen (there is not anything above
339
the top until you have typed some spaces). In Emacs, @key{SPC} runs
340
the command @code{Info-scroll-up}, while @key{BACKSPACE} runs
341
@code{Info-scroll-down}.
331
the top until you have typed some spaces).
342
332
343
333
@format
344
334
>> Now try typing a @key{SPC} (afterward, type a @key{BACKSPACE} to
354
344
If you are reading this in Emacs, note that the header line is
355
345
always visible, never scrolling off the display. That way, you can
356
346
always see the @samp{Next}, @samp{Prev}, and @samp{Up} links, and you
357
can conveniently go to one of these links from anywhere in the node by
358
clicking the mouse on one of these links.
347
can conveniently go to one of these links at any time by
348
clicking the middle mouse button on the link.
359
349
360
350
@cindex reading Info documents top to bottom
361
351
@cindex Info documents as tutorials
362
352
@key{SPC} and @key{DEL} not only move forward and backward through
363
the current node. When these keys hit the beginning or the end of the
364
current node, they move to preceding or subsequent nodes.
365
Specifically, they scroll through all the nodes in an Info file as a
366
single logical sequence. In this sequence, a node's subnodes appear
367
following their parent. If a node has a menu, @key{SPC} takes you
368
into the subnodes listed in the menu, one by one. Once you reach the
369
end of a node, and have seen all of its subnodes, @key{SPC} takes you
370
to the next node or to the parent's next node. This is so you could
371
read the entire manual top to bottom by just typing @key{SPC}.
353
the current node. They also move between nodes. @key{SPC} at the end
354
of a node moves to the next node; @key{DEL} (or @key{BACKSPACE}) at
355
the beginning of a node moves to the previous node. In effect, these
356
commands scroll through all the nodes in an Info file as a single
357
logical sequence. You can read an entire manual top to bottom by just
358
typing @key{SPC}, and move backward through the entire manual from
359
bottom to top by typing @key{DEL} (or @key{BACKSPACE}).
360
361
In this sequence, a node's subnodes appear following their parent.
362
If a node has a menu, @key{SPC} takes you into the subnodes listed in
363
the menu, one by one. Once you reach the end of a node, and have seen
364
all of its subnodes, @key{SPC} takes you to the next node or to the
365
parent's next node.
372
366
373
367
@kindex PAGEUP @r{(Info mode)}
374
368
@kindex PAGEDOWN @r{(Info mode)}
375
369
Many keyboards nowadays have two scroll keys labeled @samp{PageUp}
376
370
and @samp{PageDown} (or maybe @samp{Prior} and @samp{Next}). If your
377
371
keyboard has these keys, you can use them to move forward and backward
378
through the text, like with @key{SPC} and @key{BACKSPACE}. However,
379
unlike @key{SPC} and @key{BACKSPACE}, @key{PAGEUP} and @key{PAGEDOWN}
380
keys will never scroll beyond the beginning or the end of the current
381
node.
372
through the text of one node, like @key{SPC} and @key{BACKSPACE} (or
373
@key{DEL}). However, @key{PAGEUP} and @key{PAGEDOWN} keys never
374
scroll beyond the beginning or the end of the current node.
382
375
383
376
@kindex C-l @r{(Info mode)}
384
377
If your screen is ever garbaged, you can tell Info to display it
385
again by typing @kbd{C-l} (@kbd{Control-L}, that is---hold down
378
again by typing @kbd{C-l} (@kbd{Control-L}---that is, hold down
386
379
@key{CTRL} and type @kbd{L} or @kbd{l}).
387
380
388
381
@format
391
384
392
385
@kindex b @r{(Info mode)}
393
386
To move back to the beginning of the node you are on, you can type
394
a lot of @key{BACKSPACE} keys. You can also type simply @kbd{b} for
395
beginning.
387
the @key{BACKSPACE} key (or @key{DEL}) many times. You can also type
388
@kbd{b} just once. @kbd{b} stands for ``beginning.''
396
389
397
390
@format
398
391
>> Try that now. (We have put in enough verbiage to push this past
399
392
the first screenful, but screens are so big nowadays that perhaps it
400
393
isn't enough. You may need to shrink your Emacs or Info window.)
401
Then come back, with @key{SPS}s.
394
Then come back, by typing @key{SPC} one or more times.
402
395
@end format
403
396
404
If your screen is very tall, all of this node might fit at once.
405
In that case, @kbd{b} won't do anything. Sorry; what can we do?
397
If your screen is very tall, all of this node might fit at once. In
398
that case, @kbd{b} won't do anything. But you could observe the
399
effect of the @kbd{b} key if you use a smaller window.
406
400
407
401
@kindex ? @r{(Info mode)}
408
402
@findex Info-summary
414
408
415
409
@format
416
410
>> Type a @key{?} now. Press @key{SPC} to see consecutive screenfuls of
417
the list until finished. Then type @key{SPC} several times, until
418
it goes away.
411
the list until finished. Then type @key{SPC} several times. If
412
you are using Emacs, the help will then go away automatically.
419
413
@end format
420
414
421
415
(If you are using the stand-alone Info reader, type @kbd{C-x 0} to
422
416
return here, that is---press and hold @key{CTRL}, type an @kbd{x},
423
then release @key{CTRL} and @kbd{x}, and press @kbd{0}---a zero, not
424
the letter ``o''.)
417
then release @key{CTRL} and @kbd{x}, and press @kbd{0}; that's a zero,
418
not the letter ``o''.)
425
419
426
420
From now on, you will encounter large nodes without warning, and
427
421
will be expected to know how to use @key{SPC} and @key{BACKSPACE} to
429
423
the same size screen, it would be impossible to warn you anyway.
430
424
431
425
@format
432
>> Now type @kbd{n}, or click the mouse on the @samp{Next} link, to
433
see the description of the @kbd{m} command.
426
>> Now type @kbd{n}, or click the middle mouse button on the @samp{Next} link,
427
to visit the next node.
434
428
@end format
435
429
436
@node Help-M, Help-Xref, Help-^L, Getting Started
430
@node Help-Inv, Help-M, Help-^L, Getting Started
431
@comment node-name, next, previous, up
432
@section Invisible text in Emacs Info
433
434
Before discussing menus, we need to make some remarks that are only
435
relevant to users reading Info using Emacs. Users of the stand-alone
436
version can skip this node by typing @kbd{]} now.
437
438
@cindex invisible text in Emacs
439
In Emacs, certain text that appears in the stand-alone version is
440
normally hidden, technically because it has the @samp{invisibility}
441
property. Invisible text is really a part of the text. It becomes
442
visible (by default) after killing and yanking, it appears in printed
443
output, it gets saved to file just like any other text, and so on.
444
Thus it is useful to know it is there.
445
446
@findex visible-mode
447
You can make invisible text visible by using the command @kbd{M-x
448
visible-mode}. Visible mode is a minor mode, so using the command a
449
second time will make the text invisible again. Watch the effects of
450
the command on the ``menu'' below and the top line of this node.
451
452
If you prefer to @emph{always} see the invisible text, you can set
453
@code{Info-hide-note-references} to @code{nil}. Enabling Visible mode
454
permanently is not a real alternative, because Emacs Info also uses
455
(although less extensively) another text property that can change the
456
text being displayed, the @samp{display} property. Only the
457
invisibility property is affected by Visible mode. When, in this
458
tutorial, we refer to the @samp{Emacs} behavior, we mean the
459
@emph{default} Emacs behavior.
460
461
Now type @kbd{]}, to learn about the @kbd{]} and @kbd{[} commands.
462
463
@menu
464
* ]: Help-]. Node telling about ].
465
* stuff: Help-]. Same node.
466
* Help-]:: Yet again, same node.
467
@end menu
468
469
@node Help-], , , Help-Inv
470
@subsection The @kbd{]} and @kbd{[} commands
471
472
If you type @kbd{n} now, you get an error message saying that this
473
node has no next node. Similarly, if you type @kbd{p}, the error
474
message tells you that there is no previous node. (The exact message
475
depends on the Info reader you use.) This is because @kbd{n} and
476
@kbd{p} carry you to the next and previous node @emph{at the same
477
level}. The present node is contained in a menu (see next) of the
478
node you came from, and hence is considered to be at a lower level.
479
It is the only node in the previous node's menu (even though it was
480
listed three times). Hence it has no next or previous node that
481
@kbd{n} or @kbd{p} could move to.
482
483
If you systematically move through a manual by typing @kbd{n}, you run
484
the risk of skipping many nodes. You do not run this risk if you
485
systematically use @kbd{@key{SPC}}, because, when you scroll to the
486
bottom of a node and type another @kbd{@key{SPC}}, then this carries
487
you to the following node in the manual @emph{regardless of level}.
488
If you immediately want to go to that node, without having to scroll
489
to the bottom of the screen first, you can type @kbd{]}.
490
491
Similarly, @kbd{@key{BACKSPACE}} carries you to the preceding node
492
regardless of level, after you scrolled to the beginning of the
493
present node. If you want to go to the preceding node immediately,
494
you can type @kbd{[}.
495
496
For instance, typing this sequence will come back here in three steps:
497
@kbd{[ n [}. To do the same backward, type @kbd{] p ]}.
498
499
Now type @kbd{]} to go to the next node and learn about menus.
500
501
@node Help-M, Help-Xref, Help-Inv, Getting Started
437
502
@comment node-name, next, previous, up
438
503
@section Menus and the @kbd{m} command
439
504
440
505
@cindex menus in an Info document
441
506
@cindex Info menus
442
With only the @kbd{n} (next) and @kbd{p} (previous) commands for
443
moving between nodes, nodes are restricted to a linear sequence.
444
Menus allow a branching structure. A menu is a list of other nodes
445
you can move to. It is actually just part of the text of the node
446
formatted specially so that Info can interpret it. The beginning of a
447
menu is always identified by a line which starts with @samp{* Menu:}.
448
A node contains a menu if and only if it has a line in it which starts
449
that way. The only menu you can use at any moment is the one in the
450
node you are in. To use a menu in any other node, you must move to
451
that node first.
507
With only the @kbd{n} (next), @kbd{p} (previous), @kbd{@key{SPC}},
508
@kbd{@key{BACKSPACE}}, @kbd{]} and @kbd{[} commands for moving between
509
nodes, nodes are restricted to a linear sequence. Menus allow a
510
branching structure. A menu is a list of other nodes you can move to.
511
It is actually just part of the text of the node formatted specially
512
so that Info can interpret it. The beginning of a menu is always
513
identified by a line which starts with @w{@samp{* Menu:}}. A node
514
contains a menu if and only if it has a line in it which starts that
515
way. The only menu you can use at any moment is the one in the node
516
you are in. To use a menu in any other node, you must move to that
517
node first.
452
518
453
519
After the start of the menu, each line that starts with a @samp{*}
454
identifies one subtopic. The line usually contains a brief name
455
for the subtopic (followed by a @samp{:}), the name of the node that talks
456
about that subtopic, and optionally some further description of the
520
identifies one subtopic. The line usually contains a brief name for
521
the subtopic (followed by a @samp{:}, normally hidden in Emacs), the
522
name of the node that talks about that subtopic (again, normally
523
hidden in Emacs), and optionally some further description of the
457
524
subtopic. Lines in the menu that do not start with a @samp{*} have no
458
525
special meaning---they are only for the human reader's benefit and do
459
526
not define additional subtopics. Here is an example:
460
527
461
528
@example
462
* Foo: Node about FOO This tells about FOO
529
* Foo: Node about FOO. This tells about FOO.
463
530
@end example
464
531
465
532
The subtopic name is Foo, and the node describing it is @samp{Node
466
533
about FOO}. The rest of the line is just for the reader's
467
534
Information. [[ But this line is not a real menu item, simply because
468
there is no line above it which starts with @samp{* Menu:}.]]
535
there is no line above it which starts with @w{@samp{* Menu:}}. Also,
536
in a real menu item, the @samp{*} would appear at the very start of
537
the line. This is why the ``normally hidden'' text in Emacs, namely
538
@samp{: Node about FOO.}, is actually visible in this example, even
539
when Visible mode is off.]]
469
540
470
541
When you use a menu to go to another node (in a way that will be
471
542
described soon), what you specify is the subtopic name, the first
479
550
abbreviation for this:
480
551
481
552
@example
482
* Foo:: This tells about FOO
553
* Foo:: This tells about FOO.
483
554
@end example
484
555
485
556
@noindent
486
557
This means that the subtopic name and node name are the same; they are
487
both @samp{Foo}.
558
both @samp{Foo}. (The @samp{::} is normally hidden in Emacs.)
488
559
489
560
@format
490
561
>> Now use @key{SPC} to find the menu in this node, then come back to
494
565
@kbd{m} command is not available.
495
566
@end format
496
567
568
If you keep typing @key{SPC} once the menu appears on the screen, it
569
will move to another node (the first one in the menu). If that
570
happens, type @key{BACKSPACE} to come back.
571
497
572
@kindex m @r{(Info mode)}
498
The command to go to one of the subnodes is @kbd{m}---but @emph{do
499
not do it yet!} Before you use @kbd{m}, you need to learn about
500
commands which prompt you for more input. So far, you have learned
501
several commands that do not need additional input; when you typed
502
one, Info processed it and was instantly ready for another command.
503
The @kbd{m} command is different: it is incomplete without the
504
@dfn{name of the subtopic}. Once you have typed @kbd{m}, Info tries
505
to read the subtopic name.
506
507
Now look for the line containing many dashes near the bottom of the
508
screen. There is one more line beneath that one, but usually it is
509
blank. If it is empty, Info is ready for a command, such as @kbd{n}
510
or @kbd{b} or @key{SPC} or @kbd{m}. If that line contains text ending
511
in a colon, it means Info is trying to read more input for the last
512
command. At such times, commands do not work, because Info tries to
513
use them as the input it needs. You must either type your response and
514
finish the command you started, or type @kbd{Control-g} to cancel the
515
command. When you have done one of those things, the line becomes
516
blank again.
573
The command to go to one of the subnodes is @kbd{m}. This is very
574
different from the commands you have used: it is a command that
575
prompts you for more input.
576
577
The Info commands you know do not need additional input; when you
578
type one of them, Info processes it instantly and then is ready for
579
another command. The @kbd{m} command is different: it needs to know
580
the @dfn{name of the subtopic}. Once you have typed @kbd{m}, Info
581
tries to read the subtopic name.
582
583
Now, in the stand-alone Info, look for the line containing many
584
dashes near the bottom of the screen. (This is the stand-alone
585
equivalent for the mode line in Emacs.) There is one more line
586
beneath that one, but usually it is blank. (In Emacs, this is the
587
echo area.) When it is blank, Info is ready for a command, such as
588
@kbd{n} or @kbd{b} or @key{SPC} or @kbd{m}. If that line contains
589
text ending in a colon, it means Info is reading more input for the
590
last command. You can't type an Info command then, because Info is
591
trying to read input, not commands. You must either give the input
592
and finish the command you started, or type @kbd{Control-g} to cancel
593
the command. When you have done one of those things, the input entry
594
line becomes blank again. Then you can type Info commands again.
517
595
518
596
@findex Info-menu
519
597
The command to go to a subnode via a menu is @kbd{m}. After you type
532
610
the menu.
533
611
534
612
@cindex completion of Info node names
535
You can also use the @dfn{completion} feature to help enter the subtopic
536
name. If you type the @key{TAB} key after entering part of a name, it will
537
magically fill in more of the name---as much as follows uniquely from
538
what you have entered.
613
You can also use the @dfn{completion} feature to help enter the
614
subtopic name. If you type the @key{TAB} key after entering part of a
615
name, it will fill in more of the name---as much as Info can deduce
616
from the part you have entered.
539
617
540
618
If you move the cursor to one of the menu subtopic lines, then you do
541
619
not need to type the argument: you just type a @key{RET}, and it
542
stands for the subtopic of the line you are on.
620
stands for the subtopic of the line you are on. You can also click
621
the middle mouse button directly on the subtopic line to go there.
543
622
544
623
Here is a menu to give you a chance to practice. This menu gives you
545
624
three ways of going to one place, Help-FOO:
546
625
547
626
@menu
548
627
* Foo: Help-FOO. A node you can visit for fun.
549
* Bar: Help-FOO. Strange! two ways to get to the same place.
628
* Bar: Help-FOO. We have made two ways to get to the same place.
550
629
* Help-FOO:: And yet another!
551
630
@end menu
552
631
632
(Turn Visible mode on if you are using Emacs.)
633
553
634
@format
554
635
>> Now type just an @kbd{m} and see what happens:
555
636
@end format
606
687
ends the subtopic's brief name. You will see the subtopic's name
607
688
change its appearance (usually, its background color will change), and
608
689
the shape of the mouse pointer will change if your platform supports
609
that. After a while, if you leave the mouse on that spot, a tooltip
610
will pop up saying ``Mouse-2: go to that node''. (If the tooltips are
611
turned off or unavailable, this message is displayed in the @dfn{echo
612
area}, the bottom screen line where you typed the menu subtopics in
613
response to the prompt.) @kbd{Mouse-2} is the second button of your
614
mouse counting from the left---the rightmost button for two-button
615
mice, the middle button for 3-button mice. So pressing @kbd{Mouse-2}
616
while the mouse pointer is on a menu subtopic goes to that subtopic.
690
that. After a while, if you leave the mouse on that spot, a small
691
window will pop up, saying ``Mouse-2: go to that node'', or the same
692
message may appear at the bottom of the screen.
693
694
@kbd{Mouse-2} is the second button of your mouse counting from the
695
left---the middle button on a 3-button mouse. (On a 2-button mouse,
696
you may have to press both buttons together to ``press the middle
697
button''.) The message tells you pressing @kbd{Mouse-2} with the
698
current position of the mouse pointer (on subtopic in the menu) will
699
go to that subtopic.
617
700
618
701
@findex Info-mouse-follow-nearest-node
619
More generally, @kbd{Mouse-2} in an Info buffer runs the Emacs
620
command @code{Info-mouse-follow-nearest-node}, which finds the nearest
702
More generally, @kbd{Mouse-2} in an Info buffer finds the nearest
621
703
link to another node and goes there. For example, near a cross
622
704
reference it acts like @kbd{f}, in a menu it acts like @kbd{m}, on the
623
705
node's header line it acts like @kbd{n}, @kbd{p}, or @kbd{u}, etc. At
624
706
end of the node's text @kbd{Mouse-2} moves to the next node, or up if
625
707
there's no next node.
626
708
627
Here is another way to get to Help-FOO, a menu. You can ignore this
628
if you want, or else try it by typing @key{TAB} and then @key{RET}, or
629
clicking @kbd{Mouse-2} on it (but then please come back to here).
630
631
@menu
632
* Help-FOO::
633
@end menu
634
635
709
@format
636
710
>> Type @kbd{n} to see more commands.
637
711
@end format
655
729
(Some Info readers, such as the one built into Emacs, put you at the
656
730
same place where you were reading in @samp{Help-M}.)
657
731
658
Another way to go Up is to click on the @samp{Up} pointer shown in
659
the header line (provided that you have a mouse).
732
Another way to go Up is to click @kbd{Mouse-2} on the @samp{Up}
733
pointer shown in the header line (provided that you have a mouse).
660
734
661
735
@format
662
736
>> Now type @kbd{u} to move back up to @samp{Help-M}.
670
744
In Info documentation, you will see many @dfn{cross references}.
671
745
Cross references look like this: @xref{Help-Cross, Cross}. That text
672
746
is a real, live cross reference, whose name is @samp{Cross} and which
673
points to the node named @samp{Help-Cross}.
747
points to the node named @samp{Help-Cross}. (The node name is hidden
748
in Emacs. Do @kbd{M-x visible-mode} to show or hide it.)
674
749
675
750
@kindex f @r{(Info mode)}
676
751
@findex Info-follow-reference
713
788
The @key{TAB} and @kbd{M-@key{TAB}} key, which move between menu
714
789
items in a menu, also move between cross references outside of menus.
715
790
791
Sometimes a cross reference (or a node) can lead to another file (in
792
other words another ``manual''), or, on occasion, even a file on a
793
remote machine (although Info files distributed with Emacs or the
794
stand-alone Info avoid using remote links). Such a cross reference
795
looks like this: @xref{Top,, Overview of Texinfo, texinfo, Texinfo:
796
The GNU Documentation Format}. (After following this link, type
797
@kbd{l} to get back to this node.) Here the name @samp{texinfo}
798
between parentheses (shown in the stand-alone version) refers to the
799
file name. This file name appears in cross references and node names
800
if it differs from the current file. In Emacs, the file name is
801
hidden (along with other text). (Use @kbd{M-x visible-mode} to show
802
or hide it.)
803
804
The remainder of this node applies only to the Emacs version. If
805
you use the stand-alone version, you can type @kbd{n} immediately.
806
807
To some users, switching manuals is a much bigger switch than
808
switching sections. These users like to know that they are going to
809
be switching to another manual (and which one) before actually doing
810
so, especially given that, if one does not notice, Info commands like
811
@kbd{t} (see the next node) can have confusing results.
812
813
If you put your mouse over the cross reference and if the cross
814
reference leads to a different manual, then the information appearing
815
in a separate box (tool tip) or in the echo area, will mention the
816
file the cross reference will carry you to (between parentheses).
817
This is also true for menu subtopic names. If you have a mouse, just
818
leave it over the @samp{Overview} cross reference above and watch what
819
happens.
820
821
If you always like to have that information available without having
822
to move your mouse over the cross reference, set
823
@code{Info-hide-note-references} to a value other than t (@pxref{Emacs
824
Info Variables}). You might also want to do that if you have a lot of
825
cross references to files on remote machines and have non-permanent or
826
slow access, since otherwise you might not be able to distinguish
827
between local and remote links.
828
829
@format
830
>> Now type @kbd{n} to learn more commands.
831
@end format
832
716
833
@node Help-Int, Help-Q, Help-Xref, Getting Started
717
834
@comment node-name, next, previous, up
718
835
@section Some intermediate Info commands
720
837
The introductory course is almost over; please continue
721
838
a little longer to learn some intermediate-level commands.
722
839
723
Most Info files have an index, which is actually a large node that
724
contains nothing but a menu. The menu has one menu item for each
725
topic listed in the index. You can find the index node from the main
726
menu of the file, with the @kbd{m} command; then you can use the
727
@kbd{m} command again in the index node to go to the node that
728
describes the topic.
840
Most Info files have an index, which is actually a large node
841
containing little but a menu. The menu has one menu item for each
842
topic listed in the index. (As a special feature, menus for indices
843
may also include the line number within the node of the index entry.
844
This allows Info readers to go to the exact line of an entry, not just
845
the start of the containing node.)
846
847
You can get to the index from the main menu of the file with the
848
@kbd{m} command; then you can use the @kbd{m} command again in the
849
index node to go to the node that describes the topic you want.
729
850
730
851
There is also a short-cut Info command, @kbd{i}, which does all of
731
852
that for you. It searches the index for a given topic (a string) and
742
863
@kbd{l} command revisits nodes in the history list; each successive
743
864
@kbd{l} command moves one step back through the history.
744
865
745
If you have been following directions, ad @kbd{l} command now will get
746
you back to @samp{Help-M}. Another @kbd{l} command would undo the
747
@kbd{u} and get you back to @samp{Help-FOO}. Another @kbd{l} would undo
748
the @kbd{m} and get you back to @samp{Help-M}.
749
750
866
In Emacs, @kbd{l} runs the command @code{Info-last}.
751
867
752
868
@format
753
>> Try typing three @kbd{l}'s, pausing in between to see what each
754
@kbd{l} does. Then follow directions again and you will end up
755
back here.
869
>> Try typing @kbd{p p n} and then three @kbd{l}'s, pausing in between
870
to see what each @kbd{l} does. You should wind up right back here.
756
871
@end format
757
872
758
873
Note the difference between @kbd{l} and @kbd{p}: @kbd{l} moves to
759
874
where @emph{you} last were, whereas @kbd{p} always moves to the node
760
875
which the header says is the @samp{Previous} node (from this node, the
761
@samp{Prev} link leads to @samp{Help-M}).
876
@samp{Prev} link leads to @samp{Help-Xref}).
762
877
763
878
@kindex d @r{(Info mode)}
764
879
@findex Info-directory
792
907
>> Now type @kbd{n} to see the last node of the course.
793
908
@end format
794
909
795
@xref{Advanced Info}, for more advanced Info features.
910
@xref{Expert Info}, for more advanced Info features.
796
911
797
912
@c If a menu appears at the end of this node, remove it.
798
913
@c It is an accident of the menu updating command.
799
914
800
@node Advanced Info
915
@node Expert Info
801
916
@chapter Info for Experts
802
917
803
This chapter describes various advanced Info commands. (If you are
804
using a stand-alone Info reader, there are additional commands
918
This chapter describes various Info commands for experts. (If you
919
are using a stand-alone Info reader, there are additional commands
805
920
specific to it, which are documented in several chapters of @ref{Top,,
806
921
GNU Info, info-stnd, GNU Info}.)
807
922
808
923
This chapter also explains how to write an Info as distinct from a
809
924
Texinfo file. (However, in most cases, writing a Texinfo file is
810
better, since you can use it @emph{both} to generate an Info file and
811
to make a printed manual. @xref{Top,, Overview of Texinfo, texinfo,
812
Texinfo: The GNU Documentation Format}.)
925
better, since you can use it to make a printed manual or produce other
926
formats, such as HTML and DocBook, as well as for generating Info
927
files.) @xref{Top,, Overview of Texinfo, texinfo, Texinfo: The GNU
928
Documentation Format}.
813
929
814
930
@menu
815
* Expert:: Advanced Info commands: g, s, e, and 1 - 5.
931
* Advanced:: Advanced Info commands: g, e, and 1 - 9.
816
932
* Info Search:: How to search Info documents for specific subjects.
817
933
* Add:: Describes how to add new nodes to the hierarchy.
818
934
Also tells what nodes look like.
823
939
* Emacs Info Variables:: Variables modifying the behavior of Emacs Info.
824
940
@end menu
825
941
826
@node Expert, Info Search, , Advanced Info
942
@node Advanced, Info Search, , Expert Info
827
943
@comment node-name, next, previous, up
828
944
@section Advanced Info Commands
829
945
830
946
Here are some more Info commands that make it easier to move around.
831
947
832
@unnumberedsubsec @kbd{g} goes to a node by name
948
@subheading @kbd{g} goes to a node by name
833
949
834
950
@kindex g @r{(Info mode)}
835
951
@findex Info-goto-node
837
953
If you know a node's name, you can go there by typing @kbd{g}, the
838
954
name, and @key{RET}. Thus, @kbd{gTop@key{RET}} would go to the node
839
955
called @samp{Top} in this file. (This is equivalent to @kbd{t}, see
840
@ref{Help-Int}.) @kbd{gExpert@key{RET}} would come back here.
956
@ref{Help-Int}.) @kbd{gAdvanced@key{RET}} would come back here.
841
957
@kbd{g} in Emacs runs the command @code{Info-goto-node}.
842
958
843
959
Unlike @kbd{m}, @kbd{g} does not allow the use of abbreviations.
855
971
all of the current file by typing @kbd{g*@key{RET}} or all of any
856
972
other file with @kbd{g(@var{filename})@key{RET}}.
857
973
858
@unnumberedsubsec @kbd{1} -- @kbd{9} choose a menu subtopic by its number
974
@subheading @kbd{1}--@kbd{9} choose a menu subtopic by its number
859
975
860
976
@kindex 1 @r{through} 9 @r{(Info mode)}
861
977
@findex Info-nth-menu-item
869
985
this is so you need not count how many entries are there. In Emacs,
870
986
the digit keys run the command @code{Info-nth-menu-item}.
871
987
872
If your display supports multiple fonts, and you are using Emacs'
873
Info mode to read Info files, the @samp{*} for the fifth menu item
874
stands out, either in color or in some other attribute, such as
875
underline, and so is the @samp{*} for the ninth item; this makes it
876
easy to see at a glance which number to use for an item.
877
878
Some terminals don't support colors or underlining. If you need to
879
actually count items, it is better to use @kbd{m} instead, and specify
880
the name, or use @key{TAB} to quickly move between menu items.
881
882
@unnumberedsubsec @kbd{e} makes Info document editable
988
If your display supports multiple fonts, colors or underlining, and
989
you are using Emacs' Info mode to read Info files, the third, sixth
990
and ninth menu items have a @samp{*} that stands out, either in color
991
or in some other attribute, such as underline; this makes it easy to
992
see at a glance which number to use for an item.
993
994
Some terminals don't support either multiple fonts, colors or
995
underlining. If you need to actually count items, it is better to use
996
@kbd{m} instead, and specify the name, or use @key{TAB} to quickly
997
move between menu items.
998
999
@subheading @kbd{e} makes Info document editable
883
1000
884
1001
@kindex e @r{(Info mode)}
885
1002
@findex Info-edit
894
1011
edit the Info file, so typing @kbd{e} there goes to the end of the
895
1012
current node.
896
1013
897
@node Info Search, Add, Expert, Advanced Info
1014
@subheading @kbd{M-n} creates a new independent Info buffer in Emacs
1015
1016
@kindex M-n @r{(Info mode)}
1017
@findex clone-buffer
1018
@cindex multiple Info buffers
1019
If you are reading Info in Emacs, you can select a new independent
1020
Info buffer in another window by typing @kbd{M-n}. The new buffer
1021
starts out as an exact copy of the old one, but you will be able to
1022
move independently between nodes in the two buffers. (In Info mode,
1023
@kbd{M-n} runs the Emacs command @code{clone-buffer}.)
1024
1025
In Emacs Info, you can also produce new Info buffers by giving a
1026
numeric prefix argument to the @kbd{m} and @kbd{g} commands. @kbd{C-u
1027
m} and @kbd{C-u g} go to a new node in exactly the same way that
1028
@kbd{m} and @kbd{g} do, but they do so in a new Info buffer which they
1029
select in another window.
1030
1031
@node Info Search, Add, Advanced, Expert Info
898
1032
@comment node-name, next, previous, up
899
1033
@section How to search Info documents for specific subjects
900
1034
927
1061
echo area the full index entry it found. Often, the text of the full
928
1062
index entry already gives you enough information to decide whether it
929
1063
is relevant to what you are looking for, so we recommend that you read
930
what Emacs shows in the echo are before looking at the node it
1064
what Info shows in the echo area before looking at the node it
931
1065
displays.
932
1066
933
1067
Since @kbd{i} looks for a substring, you can search for subjects even
942
1076
looking for a description of a command, an option, or a key, just type
943
1077
their names when @kbd{i} prompts you for a topic. For example, if you
944
1078
want to read the description of what the @kbd{C-f} key does, type
945
@kbd{iC-f@key{RET}}. Here @kbd{C-f} are 3 literal characters
1079
@kbd{i C - f @key{RET}}. Here @kbd{C-f} are 3 literal characters
946
1080
@samp{C}, @samp{-}, and @samp{f}, not the ``Control-f'' command key
947
1081
you type inside Emacs to run the command bound to @kbd{C-f}.
948
1082
949
1083
In Emacs, @kbd{i} runs the command @code{Info-index}.
950
1084
1085
@findex info-apropos
1086
If you don't know what manual documents something, try the @kbd{M-x
1087
info-apropos} command. It prompts for a string and then looks up that
1088
string in all the indices of all the Info documents installed on your
1089
system.
1090
951
1091
@kindex s @r{(Info mode)}
952
1092
@findex Info-search
953
1093
The @kbd{s} command allows you to search a whole file for a string.
970
1110
command @code{Info-search}.
971
1111
972
1112
973
@node Add, Menus, Info Search, Advanced Info
1113
@node Add, Menus, Info Search, Expert Info
974
1114
@comment node-name, next, previous, up
975
1115
@section Adding a new node to Info
976
1116
985
1125
986
1126
Usually, the way to create the nodes is with Texinfo (@pxref{Top,,
987
1127
Overview of Texinfo, texinfo, Texinfo: The GNU Documentation Format});
988
this has the advantage that you can also make a printed manual from
989
them. However, if you want to edit an Info file, here is how.
1128
this has the advantage that you can also make a printed manual or HTML
1129
from them. You would use the @samp{@@dircategory} and
1130
@samp{@@direntry} commands to put the manual into the Info directory.
1131
However, if you want to edit an Info file manually and install it
1132
manually, here is how.
990
1133
991
1134
@cindex node delimiters
992
1135
The new node can live in an existing documentation file, or in a new
1000
1143
@samp{^_}.}
1001
1144
1002
1145
The @samp{^_} starting a node must be followed by a newline or a
1003
@samp{^L} newline, after which comes the node's header line. The header
1004
line must give the node's name (by which Info finds it), and state the
1005
names of the @samp{Next}, @samp{Previous}, and @samp{Up} nodes (if there
1006
are any). As you can see, this node's @samp{Up} node is the node
1007
@samp{Top}, which points at all the documentation for Info. The
1008
@samp{Next} node is @samp{Menus}.
1146
@samp{^L} newline, after which comes the node's header line. The
1147
header line must give the node's name (by which Info finds it), and
1148
state the names of the @samp{Next}, @samp{Previous}, and @samp{Up}
1149
nodes (if there are any). As you can see, this node's @samp{Up} node
1150
is the node @samp{Expert Info}. The @samp{Next} node is @samp{Menus}.
1009
1151
1010
1152
@cindex node header line format
1011
1153
@cindex format of node headers
1051
1193
line. The file names are ignored by Info, but they serve as comments
1052
1194
to help identify the node for the user.
1053
1195
1054
@node Menus, Cross-refs, Add, Advanced Info
1196
@node Menus, Cross-refs, Add, Expert Info
1055
1197
@comment node-name, next, previous, up
1056
1198
@section How to Create Menus
1057
1199
1060
1202
reads from the terminal.
1061
1203
1062
1204
@cindex menu and menu entry format
1063
A menu begins with a line starting with @samp{* Menu:}. The rest of the
1064
line is a comment. After the starting line, every line that begins
1065
with a @samp{* } lists a single topic. The name of the topic--what
1066
the user must type at the @kbd{m}'s command prompt to select this
1067
topic---comes right after the star and space, and is followed by a
1068
colon, spaces and tabs, and the name of the node which discusses that
1069
topic. The node name, like node names following @samp{Next}, @samp{Previous}
1070
and @samp{Up}, may be terminated with a tab, comma, or newline; it may also
1071
be terminated with a period.
1205
A menu begins with a line starting with @w{@samp{* Menu:}}. The
1206
rest of the line is a comment. After the starting line, every line
1207
that begins with a @samp{* } lists a single topic. The name of the
1208
topic---what the user must type at the @kbd{m}'s command prompt to
1209
select this topic---comes right after the star and space, and is
1210
followed by a colon, spaces and tabs, and the name of the node which
1211
discusses that topic. The node name, like node names following
1212
@samp{Next}, @samp{Previous} and @samp{Up}, may be terminated with a
1213
tab, comma, or newline; it may also be terminated with a period.
1072
1214
1073
1215
If the node name and topic name are the same, then rather than
1074
1216
giving the name twice, the abbreviation @samp{* @var{name}::} may be
1107
1249
to, but such a substructure is rather useless since nobody can
1108
1250
ever find out that it exists.
1109
1251
1110
@node Cross-refs, Tags, Menus, Advanced Info
1252
@node Cross-refs, Tags, Menus, Expert Info
1111
1253
@comment node-name, next, previous, up
1112
1254
@section Creating Cross References
1113
1255
1166
1308
1167
1309
Another set of Info commands is useful when you need to find
1168
1310
something quickly in a manual---that is, when you need to use a manual
1169
as a reference rather than as a tutorial. We urge you to make learn
1311
as a reference rather than as a tutorial. We urge you to learn
1170
1312
these search commands as well. If you want to do that now, follow this
1171
1313
cross reference to @ref{Info Search}.
1172
1314
1182
1324
@end format
1183
1325
1184
1326
1185
@node Tags, Checking, Cross-refs, Advanced Info
1327
@node Tags, Checking, Cross-refs, Expert Info
1186
1328
@comment node-name, next, previous, up
1187
1329
@section Tags Tables for Info Files
1188
1330
1227
1369
beginning of the node.
1228
1370
1229
1371
1230
@node Checking, Emacs Info Variables, Tags, Advanced Info
1372
@node Checking, Emacs Info Variables, Tags, Expert Info
1231
1373
@section Checking an Info File
1232
1374
1233
1375
When creating an Info file, it is easy to forget the name of a node when
1246
1388
To check an Info file, do @kbd{M-x Info-validate} while looking at any
1247
1389
node of the file with Emacs Info mode.
1248
1390
1249
@node Emacs Info Variables, , Checking, Advanced Info
1391
@node Emacs Info Variables, , Checking, Expert Info
1250
1392
@section Emacs Info-mode Variables
1251
1393
1252
1394
The following variables may modify the behavior of Info-mode in Emacs;
1276
1418
@item Info-fontify
1277
1419
When set to a non-@code{nil} value, enables highlighting of Info
1278
1420
files. The default is @code{t}. You can change how the highlighting
1279
looks by customizing the faces @code{info-node}, @code{info-menu-5},
1280
@code{info-xref}, @code{info-header-xref}, @code{info-header-node},
1281
@code{info-title-@var{n}-face} (where @var{n} is the level of the
1282
section, a number between 1 and 4), and @code{info-menu-header}. To
1421
looks by customizing the faces @code{info-node}, @code{info-xref},
1422
@code{info-header-xref}, @code{info-header-node}, @code{info-menu-5},
1423
@code{info-menu-header}, and @code{info-title-@var{n}-face} (where
1424
@var{n} is the level of the section, a number between 1 and 4). To
1283
1425
customize a face, type @kbd{M-x customize-face @key{RET} @var{face}
1284
1426
@key{RET}}, where @var{face} is one of the face names listed here.
1285
1427
1289
1431
not scroll with the rest of the buffer, making these links always
1290
1432
visible.
1291
1433
1434
@item Info-hide-note-references
1435
As explained in earlier nodes, the Emacs version of Info normally
1436
hides some text in menus and cross-references. You can completely
1437
disable this feature, by setting this option to @code{nil}. Setting
1438
it to a value that is neither @code{nil} nor @code{t} produces an
1439
intermediate behavior, hiding a limited amount of text, but showing
1440
all text that could potentially be useful.
1441
1292
1442
@item Info-scroll-prefer-subnodes
1293
1443
If set to a non-@code{nil} value, @key{SPC} and @key{BACKSPACE} (or
1294
1444
@key{DEL}) keys in a menu visit subnodes of the current node before
1297
1447
subnode indicated by the following menu item. Setting this option to
1298
1448
@code{nil} results in behavior similar to the stand-alone Info reader
1299
1449
program, which visits the first subnode from the menu only when you
1300
hit the end of the current node. The default is @code{t}.
1450
hit the end of the current node. The default is @code{nil}.
1301
1451
1302
1452
@item Info-enable-active-nodes
1303
1453
When set to a non-@code{nil} value, allows Info to execute Lisp code
1342
1492
@printindex cp
1343
1493
1344
1494
@bye
1495
1496
@ignore
1497
arch-tag: 965c1638-01d6-4156-9227-b10418b9d8e8
1498
@end ignore
Loggerhead is a web-based interface for Breezy
Version: 2.0.1