Mercurial > hg > xemacs-beta
annotate man/info.texi @ 5496:a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
author | Aidan Kehoe <kehoea@parhasard.net> |
---|---|
date | Mon, 02 May 2011 10:35:36 +0100 |
parents | e82f5b7010fe |
children | 64be8a494bdc |
rev | line source |
---|---|
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
1 \input texinfo @c -*-texinfo-*- |
428 | 2 @comment %**start of header |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
3 @setfilename ../info/info.info |
428 | 4 @settitle Info |
5 @comment %**end of header | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
6 @comment $Id: info.texi,v 1.9 2001/04/13 09:11:28 michaels Exp $ |
428 | 7 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
8 @dircategory Texinfo documentation system |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
9 @direntry |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
10 * Info: (info). Documentation browsing system. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
11 @end direntry |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
12 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
13 @ifinfo |
428 | 14 This file describes how to use Info, the on-line, menu-driven GNU |
15 documentation system. | |
16 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
17 Copyright (C) 1989, 92, 96, 97, 98, 99 Free Software Foundation, Inc. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
18 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
19 Permission is granted to make and distribute verbatim copies of |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
20 this manual provided the copyright notice and this permission notice |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
21 are preserved on all copies. |
428 | 22 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
23 @ignore |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
24 Permission is granted to process this file through TeX and print the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
25 results, provided the printed document carries copying permission |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
26 notice identical to this one except for the removal of this paragraph |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
27 (this paragraph not being relevant to the printed manual). |
428 | 28 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
29 @end ignore |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
30 Permission is granted to copy and distribute modified versions of this |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
31 manual under the conditions for verbatim copying, provided that the entire |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
32 resulting derived work is distributed under the terms of a permission |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
33 notice identical to this one. |
428 | 34 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
35 Permission is granted to copy and distribute translations of this manual |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
36 into another language, under the above conditions for modified versions, |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
37 except that this permission notice may be stated in a translation approved |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
38 by the Free Software Foundation. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
39 @end ifinfo |
428 | 40 |
41 @titlepage | |
42 @title Info | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
43 @subtitle The online, menu-driven GNU documentation system |
428 | 44 @author Brian Fox |
45 @page | |
46 @vskip 0pt plus 1filll | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
47 Copyright @copyright{} 1989, 92, 93, 96, 97, 98, 99 Free Software |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
48 Foundation, Inc. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
49 @sp 2 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
50 Published by the Free Software Foundation @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
51 59 Temple Place - Suite 330 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
52 Boston, MA 02111-1307, USA. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
53 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
54 Permission is granted to make and distribute verbatim copies of |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
55 this manual provided the copyright notice and this permission notice |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
56 are preserved on all copies. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
57 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
58 Permission is granted to copy and distribute modified versions of this |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
59 manual under the conditions for verbatim copying, provided that the entire |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
60 resulting derived work is distributed under the terms of a permission |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
61 notice identical to this one. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
62 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
63 Permission is granted to copy and distribute translations of this manual |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
64 into another language, under the above conditions for modified versions, |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
65 except that this permission notice may be stated in a translation approved |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
66 by the Free Software Foundation. |
428 | 67 @end titlepage |
68 | |
69 @node Top | |
70 @top Info: An Introduction | |
71 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
72 Info is a program for reading documentation, which you might be using |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
73 now to read this. |
428 | 74 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
75 To learn how to use Info, type the command @kbd{h} while using the Info |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
76 program. It brings you to a programmed instruction sequence. |
428 | 77 |
78 @menu | |
79 * Getting Started:: Getting started using an Info reader. | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
80 * Advanced Info:: Advanced commands within Info. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
81 * Creating an Info File:: How to make your own Info file. |
428 | 82 @end menu |
83 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
84 @node Getting Started, Advanced Info, Top, Top |
428 | 85 @comment node-name, next, previous, up |
86 @chapter Getting Started | |
87 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
88 This first part of the Info manual describes how to get around inside |
428 | 89 of Info. The second part of the manual describes various advanced |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
90 Info commands, and how to write an Info as distinct from a Texinfo |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
91 file. The third part is about how to generate Info files from |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
92 Texinfo files. |
428 | 93 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
94 @iftex |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
95 This manual is primarily designed for use on a computer, so that you can |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
96 try Info commands while reading about them. Reading it on paper is less |
428 | 97 effective, since you must take it on faith that the commands described |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
98 really do what the manual says. By all means go through this manual now |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
99 that you have it; but please try going through the on-line version as |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
100 well. |
428 | 101 |
102 There are two ways of looking at the online version of this manual: | |
103 | |
104 @enumerate | |
105 @item | |
106 Type @code{info} at your shell's command line. This approach uses a | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
107 small stand-alone program designed just to read Info files. |
428 | 108 |
109 @item | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
110 Type @code{emacs} at the command line; then type @kbd{C-h i} (Control |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
111 @kbd{h}, followed by @kbd{i}). This approach uses the Info mode of the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
112 Emacs program, an editor with many other capabilities. |
428 | 113 @end enumerate |
114 | |
115 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 | |
117 be ready to follow the instructions in this manual as you read them on | |
118 the screen. | |
119 @c FIXME! (pesch@cygnus.com, 14 dec 1992) | |
120 @c Is it worth worrying about what-if the beginner goes to somebody | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
121 @c else's Emacs session, which already has an Info running in the middle |
428 | 122 @c of something---in which case these simple instructions won't work? |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
123 @end iftex |
428 | 124 |
125 @menu | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
126 * Help-Small-Screen:: Starting Info on a Small Screen |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
127 * Help:: How to use Info |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
128 * Help-P:: Returning to the Previous node |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
129 * Help-^L:: The Space, Rubout, B and ^L commands. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
130 * Help-M:: Menus |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
131 * Help-Adv:: Some advanced Info commands |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
132 * Help-Q:: Quitting Info |
428 | 133 @end menu |
134 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
135 @node Help-Small-Screen, Help, , Getting Started |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
136 @comment node-name, next, previous, up |
428 | 137 @section Starting Info on a Small Screen |
138 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
139 @iftex |
428 | 140 (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.) | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
142 @end iftex |
428 | 143 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
144 Since your terminal has an unusually small number of lines on its |
428 | 145 screen, it is necessary to give you special advice at the beginning. |
146 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
147 If you see the text @samp{--All----} at near the bottom right corner |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
148 of the screen, it means the entire text you are looking at fits on the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
149 screen. If you see @samp{--Top----} instead, it means that there is |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
150 more text below that does not fit. To move forward through the text |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
151 and see another screen full, press the Space bar, @key{SPC}. To move |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
152 back up, press the key labeled @samp{Backspace} or @key{Delete}. |
428 | 153 |
154 @ifinfo | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
155 Here are 40 lines of junk, so you can try Spaces and Deletes and |
428 | 156 see what they do. At the end are instructions of what you should do |
157 next. | |
158 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
159 This is line 17 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
160 This is line 18 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
161 This is line 19 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
162 This is line 20 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
163 This is line 21 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
164 This is line 22 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
165 This is line 23 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
166 This is line 24 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
167 This is line 25 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
168 This is line 26 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
169 This is line 27 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
170 This is line 28 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
171 This is line 29 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
172 This is line 30 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
173 This is line 31 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
174 This is line 32 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
175 This is line 33 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
176 This is line 34 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
177 This is line 35 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
178 This is line 36 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
179 This is line 37 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
180 This is line 38 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
181 This is line 39 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
182 This is line 40 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
183 This is line 41 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
184 This is line 42 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
185 This is line 43 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
186 This is line 44 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
187 This is line 45 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
188 This is line 46 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
189 This is line 47 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
190 This is line 48 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
191 This is line 49 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
192 This is line 50 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
193 This is line 51 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
194 This is line 52 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
195 This is line 53 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
196 This is line 54 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
197 This is line 55 @* |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
198 This is line 56 @* |
428 | 199 |
200 If you have managed to get here, go back to the beginning with | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
201 Delete, and come back here again, then you understand Space and |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
202 Delete. So now type an @kbd{n} ---just one character; don't type |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
203 the quotes and don't type the Return key afterward--- to |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
204 get to the normal start of the course. |
428 | 205 @end ifinfo |
206 | |
207 @node Help, Help-P, Help-Small-Screen, Getting Started | |
208 @comment node-name, next, previous, up | |
209 @section How to use Info | |
210 | |
211 You are talking to the program Info, for reading documentation. | |
212 | |
213 Right now you are looking at one @dfn{Node} of Information. | |
214 A node contains text describing a specific topic at a specific | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
215 level of detail. This node's topic is ``how to use Info''. |
428 | 216 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
217 The top line of a node is its @dfn{header}. This node's header (look at |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
218 it now) says that it is the node named @samp{Help} in the file |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
219 @file{info}. It says that the @samp{Next} node after this one is the node |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
220 called @samp{Help-P}. An advanced Info command lets you go to any node |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
221 whose name you know. |
428 | 222 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
223 Besides a @samp{Next}, a node can have a @samp{Previous} or an @samp{Up}. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
224 This node has a @samp{Previous} but no @samp{Up}, as you can see. |
428 | 225 |
226 Now it is time to move on to the @samp{Next} node, named @samp{Help-P}. | |
227 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
228 >> Type @samp{n} to move there. Type just one character; |
428 | 229 do not type the quotes and do not type a @key{RET} afterward. |
230 | |
231 @samp{>>} in the margin means it is really time to try a command. | |
232 | |
233 @node Help-P, Help-^L, Help, Getting Started | |
234 @comment node-name, next, previous, up | |
235 @section Returning to the Previous node | |
236 | |
237 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} | |
239 command. Another @kbd{n} command now would take you to the next | |
240 node, @samp{Help-^L}. | |
241 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
242 >> But do not do that yet. First, try the @kbd{p} command, which takes |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
243 you to the @samp{Previous} node. When you get there, you can do an |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
244 @kbd{n} again to return here. |
428 | 245 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
246 This all probably seems insultingly simple so far, but @emph{do not} be |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
247 led into skimming. Things will get more complicated soon. Also, |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
248 do not try a new command until you are told it is time to. Otherwise, |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
249 you may make Info skip past an important warning that was coming up. |
428 | 250 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
251 >> Now do an @kbd{n} to get to the node @samp{Help-^L} and learn more. |
428 | 252 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
253 @node Help-^L, Help-M, Help-P, Getting Started |
428 | 254 @comment node-name, next, previous, up |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
255 @section The Space, Delete, B and ^L commands. |
428 | 256 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
257 This node's header tells you that you are now at node @samp{Help-^L}, and |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
258 that @kbd{p} would get you back to @samp{Help-P}. The node's title is |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
259 underlined; it says what the node is about (most nodes have titles). |
428 | 260 |
261 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 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
263 can see the string @samp{--Top-----} rather than @samp{--All----} near |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
264 the bottom right corner of the screen. |
428 | 265 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
266 The Space, Delete and @kbd{B} commands exist to allow you to ``move |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
267 around'' in a node that does not all fit on the screen at once. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
268 Space moves forward, to show what was below the bottom of the screen. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
269 Delete moves backward, to show what was above the top of the screen |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
270 (there is not anything above the top until you have typed some spaces). |
428 | 271 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
272 >> Now try typing a Space (afterward, type a Delete to return here). |
428 | 273 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
274 When you type the space, the two lines that were at the bottom of |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
275 the screen appear at the top, followed by more lines. Delete takes |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
276 the two lines from the top and moves them to the bottom, |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
277 @emph{usually}, but if there are not a full screen's worth of lines |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
278 above them they may not make it all the way to the bottom. |
428 | 279 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
280 If you type Space when there is no more to see, it rings the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
281 bell and otherwise does nothing. The same goes for Delete when |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
282 the header of the node is visible. |
428 | 283 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
284 If your screen is ever garbaged, you can tell Info to print it out |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
285 again by typing @kbd{C-l} (@kbd{Control-L}, that is---hold down ``Control'' and |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
286 type an @key{L} or @kbd{l}). |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
287 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
288 >> Type @kbd{C-l} now. |
428 | 289 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
290 To move back to the beginning of the node you are on, you can type |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
291 a lot of Deletes. You can also type simply @kbd{b} for beginning. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
292 >> Try that now. (We have put in enough verbiage to push this past |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
293 the first screenful, but screens are so big nowadays that perhaps it |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
294 isn't enough. You may need to shrink your Emacs or Info window.) |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
295 Then come back, with Spaces. |
5492
e82f5b7010fe
Merge some stuff in man, fix up Makefile
Ben Wing <ben@xemacs.org>
parents:
468
diff
changeset
|
296 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
297 If your screen is very tall, all of this node might fit at once. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
298 In that case, "b" won't do anything. Sorry; what can we do? |
5492
e82f5b7010fe
Merge some stuff in man, fix up Makefile
Ben Wing <ben@xemacs.org>
parents:
468
diff
changeset
|
299 |
428 | 300 You have just learned a considerable number of commands. If you |
301 want to use one but have trouble remembering which, you should type | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
302 a @key{?} which prints out a brief list of commands. When you are |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
303 finished looking at the list, make it go away by pressing @key{SPC} |
428 | 304 repeatedly. |
305 | |
306 >> Type a @key{?} now. Press @key{SPC} to see consecutive screenfuls of | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
307 >> the list until finished. |
428 | 308 |
309 From now on, you will encounter large nodes without warning, and | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
310 will be expected to know how to use Space and Delete to move |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
311 around in them without being told. Since not all terminals have |
428 | 312 the same size screen, it would be impossible to warn you anyway. |
313 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
314 >> Now type @kbd{n} to see the description of the @kbd{m} command. |
5492
e82f5b7010fe
Merge some stuff in man, fix up Makefile
Ben Wing <ben@xemacs.org>
parents:
468
diff
changeset
|
315 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
316 @node Help-M, Help-Adv, Help-^L, Getting Started |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
317 @comment node-name, next, previous, up |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
318 @section Menus |
428 | 319 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
320 Menus and the @kbd{m} command |
428 | 321 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
322 With only the @kbd{n} and @kbd{p} commands for moving between nodes, nodes |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
323 are restricted to a linear sequence. Menus allow a branching |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
324 structure. A menu is a list of other nodes you can move to. It is |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
325 actually just part of the text of the node formatted specially so that |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
326 Info can interpret it. The beginning of a menu is always identified |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
327 by a line which starts with @samp{* Menu:}. A node contains a menu if and |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
328 only if it has a line in it which starts that way. The only menu you |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
329 can use at any moment is the one in the node you are in. To use a |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
330 menu in any other node, you must move to that node first. |
428 | 331 |
332 After the start of the menu, each line that starts with a @samp{*} | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
333 identifies one subtopic. The line usually contains a brief name |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
334 for the subtopic (followed by a @samp{:}), the name of the node that talks |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
335 about that subtopic, and optionally some further description of the |
428 | 336 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 | |
338 not define additional subtopics. Here is an example: | |
339 | |
340 @example | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
341 * Foo: FOO's Node This tells about FOO |
428 | 342 @end example |
343 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
344 The subtopic name is Foo, and the node describing it is @samp{FOO's Node}. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
345 The rest of the line is just for the reader's Information. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
346 [[ But this line is not a real menu item, simply because there is |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
347 no line above it which starts with @samp{* Menu:}.]] |
428 | 348 |
349 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 | |
351 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 | |
353 is both a subtopic name and a node name is that the node name must be | |
354 meaningful to the computer and may therefore have to be ugly looking. | |
355 The subtopic name can be chosen just to be convenient for the user to | |
356 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 | |
358 abbreviation for this: | |
359 | |
360 @example | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
361 * Foo:: This tells about FOO |
428 | 362 @end example |
363 | |
364 @noindent | |
365 This means that the subtopic name and node name are the same; they are | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
366 both @samp{Foo}. |
428 | 367 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
368 >> Now use Spaces to find the menu in this node, then come back to |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
369 the front with a @kbd{b} and some Spaces. As you see, a menu is |
428 | 370 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 | |
372 @kbd{m} command is not available. | |
373 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
374 The command to go to one of the subnodes is @kbd{m}---but @emph{do |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
375 not do it yet!} Before you use @kbd{m}, you must understand the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
376 difference between commands and arguments. So far, you have learned |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
377 several commands that do not need arguments. When you type one, Info |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
378 processes it and is instantly ready for another command. The @kbd{m} |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
379 command is different: it is incomplete without the @dfn{name of the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
380 subtopic}. Once you have typed @kbd{m}, Info tries to read the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
381 subtopic name. |
428 | 382 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
383 Now look for the line containing many dashes near the bottom of the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
384 screen. There is one more line beneath that one, but usually it is |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
385 blank. If it is empty, Info is ready for a command, such as @kbd{n} |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
386 or @kbd{b} or Space or @kbd{m}. If that line contains text ending |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
387 in a colon, it means Info is trying to read the @dfn{argument} to a |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
388 command. At such times, commands do not work, because Info tries to |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
389 use them as the argument. You must either type the argument and |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
390 finish the command you started, or type @kbd{Control-g} to cancel the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
391 command. When you have done one of those things, the line becomes |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
392 blank again. |
428 | 393 |
394 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: }. | |
396 You must then type the name of the subtopic you want, and end it with | |
397 a @key{RET}. | |
398 | |
399 You can abbreviate the subtopic name. If the abbreviation is not | |
400 unique, the first matching subtopic is chosen. Some menus put | |
401 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 | |
403 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 | |
405 item name, except for one space where a space appears in the item in | |
406 the menu. | |
407 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
408 You can also use the @dfn{completion} feature to help enter the subtopic |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
409 name. If you type the Tab key after entering part of a name, it will |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
410 magically fill in more of the name---as much as follows uniquely from |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
411 what you have entered. |
428 | 412 |
413 If you move the cursor to one of the menu subtopic lines, then you do | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
414 not need to type the argument: you just type a Return, and it stands for |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
415 the subtopic of the line you are on. |
428 | 416 |
417 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: | |
419 | |
420 @menu | |
421 * Foo: Help-FOO. A node you can visit for fun. | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
422 * Bar: Help-FOO. Strange! two ways to get to the same place. |
428 | 423 * Help-FOO:: And yet another! |
424 @end menu | |
425 | |
426 >> Now type just an @kbd{m} and see what happens: | |
427 | |
428 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. | |
430 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
431 You can change your mind about doing the @kbd{m} by typing Control-g. |
428 | 432 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
433 >> Try that now; notice the bottom line clear. |
428 | 434 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
435 >> Then type another @kbd{m}. |
5492
e82f5b7010fe
Merge some stuff in man, fix up Makefile
Ben Wing <ben@xemacs.org>
parents:
468
diff
changeset
|
436 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
437 >> Now type @samp{BAR} item name. Do not type Return yet. |
428 | 438 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
439 While you are typing the item name, you can use the Delete key to |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
440 cancel one character at a time if you make a mistake. |
428 | 441 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
442 >> Type one to cancel the @samp{R}. You could type another @samp{R} to |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
443 replace it. You do not have to, since @samp{BA} is a valid abbreviation. |
428 | 444 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
445 >> Now you are ready to go. Type a @key{RET}. |
5492
e82f5b7010fe
Merge some stuff in man, fix up Makefile
Ben Wing <ben@xemacs.org>
parents:
468
diff
changeset
|
446 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
447 After visiting Help-FOO, you should return here. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
448 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
449 >> Type @kbd{n} to see more commands. |
428 | 450 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
451 @c If a menu appears at the end of this node, remove it. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
452 @c It is an accident of the menu updating command. |
428 | 453 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
454 Here is another way to get to Help-FOO, a menu. You can ignore this |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
455 if you want, or else try it (but then please come back to here). |
428 | 456 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
457 @menu |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
458 * Help-FOO:: |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
459 @end menu |
428 | 460 |
461 @node Help-FOO, , , Help-M | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
462 @comment node-name, next, previous, up |
428 | 463 @subsection The @kbd{u} command |
464 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
465 Congratulations! This is the node @samp{Help-FOO}. Unlike the other |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
466 nodes you have seen, this one has an @samp{Up}: @samp{Help-M}, the node you |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
467 just came from via the @kbd{m} command. This is the usual |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
468 convention---the nodes you reach from a menu have @samp{Up} nodes that lead |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
469 back to the menu. Menus move Down in the tree, and @samp{Up} moves Up. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
470 @samp{Previous}, on the other hand, is usually used to ``stay on the same |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
471 level but go backwards'' |
5492
e82f5b7010fe
Merge some stuff in man, fix up Makefile
Ben Wing <ben@xemacs.org>
parents:
468
diff
changeset
|
472 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
473 You can go back to the node @samp{Help-M} by typing the command |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
474 @kbd{u} for ``Up''. That puts you at the @emph{front} of the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
475 node---to get back to where you were reading you have to type |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
476 some @key{SPC}s. |
5492
e82f5b7010fe
Merge some stuff in man, fix up Makefile
Ben Wing <ben@xemacs.org>
parents:
468
diff
changeset
|
477 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
478 >> Now type @kbd{u} to move back up to @samp{Help-M}. |
5492
e82f5b7010fe
Merge some stuff in man, fix up Makefile
Ben Wing <ben@xemacs.org>
parents:
468
diff
changeset
|
479 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
480 @node Help-Adv, Help-Q, Help-M, Getting Started |
428 | 481 @comment node-name, next, previous, up |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
482 @section Some advanced Info commands |
5492
e82f5b7010fe
Merge some stuff in man, fix up Makefile
Ben Wing <ben@xemacs.org>
parents:
468
diff
changeset
|
483 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
484 The course is almost over, so please stick with it to the end. |
428 | 485 |
486 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 | |
488 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 | |
490 @kbd{l} command revisits nodes in the history list; each successive | |
491 @kbd{l} command moves one step back through the history. | |
492 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
493 If you have been following directions, ad @kbd{l} command now will get |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
494 you back to @samp{Help-M}. Another @kbd{l} command would undo the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
495 @kbd{u} and get you back to @samp{Help-FOO}. Another @kbd{l} would undo |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
496 the @kbd{m} and get you back to @samp{Help-M}. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
497 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
498 >> Try typing three @kbd{l}'s, pausing in between to see what each |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
499 @kbd{l} does. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
500 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
501 Then follow directions again and you will end up back here. |
428 | 502 |
503 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 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
505 which the header says is the @samp{Previous} node (from this node, to |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
506 @samp{Help-M}). |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
507 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
508 The @samp{d} command gets you instantly to the Directory node. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
509 This node, which is the first one you saw when you entered Info, |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
510 has a menu which leads (directly, or indirectly through other menus), |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
511 to all the nodes that exist. |
428 | 512 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
513 >> Try doing a @samp{d}, then do an @kbd{l} to return here (yes, |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
514 @emph{do} return). |
428 | 515 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
516 Sometimes, in Info documentation, you will see a cross reference. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
517 Cross references look like this: @xref{Help-Cross, Cross}. That is a |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
518 real, live cross reference which is named @samp{Cross} and points at |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
519 the node named @samp{Help-Cross}. |
428 | 520 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
521 If you wish to follow a cross reference, you must use the @samp{f} |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
522 command. The @samp{f} must be followed by the cross reference name |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
523 (in this case, @samp{Cross}). While you enter the name, you can use the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
524 Delete key to edit your input. If you change your mind about following |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
525 any reference, you can use @kbd{Control-g} to cancel the command. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
526 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
527 Completion is available in the @samp{f} command; you can complete among |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
528 all the cross reference names in the current node by typing a Tab. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
529 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
530 >> Type @samp{f}, followed by @samp{Cross}, and a @key{RET}. |
428 | 531 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
532 To get a list of all the cross references in the current node, you can |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
533 type @kbd{?} after an @samp{f}. The @samp{f} continues to await a |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
534 cross reference name even after printing the list, so if you don't |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
535 actually want to follow a reference, you should type a @kbd{Control-g} |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
536 to cancel the @samp{f}. |
428 | 537 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
538 >> Type "f?" to get a list of the cross references in this node. Then |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
539 type a @kbd{Control-g} and see how the @samp{f} gives up. |
428 | 540 |
541 >> Now type @kbd{n} to see the last node of the course. | |
542 | |
543 @c If a menu appears at the end of this node, remove it. | |
544 @c It is an accident of the menu updating command. | |
545 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
546 @node Help-Cross, , , Help-Adv |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
547 @subsection The node reached by the cross reference in Info |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
548 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
549 This is the node reached by the cross reference named @samp{Cross}. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
550 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
551 While this node is specifically intended to be reached by a cross |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
552 reference, most cross references lead to nodes that ``belong'' someplace |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
553 else far away in the structure of Info. So you cannot expect the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
554 footnote to have a @samp{Next}, @samp{Previous} or @samp{Up} pointing |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
555 back to where you came from. In general, the @kbd{l} (el) command is |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
556 the only way to get back there. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
557 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
558 >> Type @kbd{l} to return to the node where the cross reference was. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
559 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
560 @node Help-Q, , Help-Adv, Getting Started |
428 | 561 @comment node-name, next, previous, up |
562 @section Quitting Info | |
563 | |
564 To get out of Info, back to what you were doing before, type @kbd{q} | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
565 for @dfn{Quit}. |
428 | 566 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
567 This is the end of the course on using Info. There are some other |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
568 commands that are meant for experienced users; they are useful, and you |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
569 can find them by looking in the directory node for documentation on |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
570 Info. Finding them will be a good exercise in using Info in the usual |
428 | 571 manner. |
572 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
573 >> Type @samp{d} to go to the Info directory node; then type |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
574 @samp{mInfo} and Return, to get to the node about Info and |
428 | 575 see what other help is available. |
576 | |
577 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
578 @node Advanced Info |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
579 @chapter Info for Experts |
428 | 580 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
581 This chapter describes various advanced Info commands, and how to write |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
582 an Info as distinct from a Texinfo file. (However, in most cases, writing a |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
583 Texinfo file is better, since you can use it @emph{both} to generate an |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
584 Info file and to make a printed manual. @xref{Top,, Overview of |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
585 Texinfo, texinfo, Texinfo}.) |
428 | 586 |
587 @menu | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
588 * Expert:: Advanced Info commands: g, s, e, and 1 - 5. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
589 * Add:: Describes how to add new nodes to the hierarchy. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
590 Also tells what nodes look like. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
591 * Menus:: How to add to or create menus in Info nodes. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
592 * Cross-refs:: How to add cross-references to Info nodes. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
593 * Tags:: How to make tag tables for Info files. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
594 * Checking:: Checking an Info File |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
595 * Emacs Info Variables:: Variables modifying the behavior of Emacs Info. |
428 | 596 @end menu |
597 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
598 @node Expert, Add, , Advanced Info |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
599 @comment node-name, next, previous, up |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
600 @section Advanced Info Commands |
5492
e82f5b7010fe
Merge some stuff in man, fix up Makefile
Ben Wing <ben@xemacs.org>
parents:
468
diff
changeset
|
601 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
602 @kbd{g}, @kbd{s}, @kbd{1}, -- @kbd{9}, and @kbd{e} |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
603 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
604 If you know a node's name, you can go there by typing @kbd{g}, the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
605 name, and @key{RET}. Thus, @kbd{gTop@key{RET}} would go to the node |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
606 called @samp{Top} in this file (its directory node). |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
607 @kbd{gExpert@key{RET}} would come back here. |
428 | 608 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
609 Unlike @kbd{m}, @kbd{g} does not allow the use of abbreviations. |
428 | 610 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
611 To go to a node in another file, you can include the filename in the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
612 node name by putting it at the front, in parentheses. Thus, |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
613 @kbd{g(dir)Top@key{RET}} would go to the Info Directory node, which is |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
614 node @samp{Top} in the file @file{dir}. |
428 | 615 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
616 The node name @samp{*} specifies the whole file. So you can look at |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
617 all of the current file by typing @kbd{g*@key{RET}} or all of any |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
618 other file with @kbd{g(FILENAME)@key{RET}}. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
619 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
620 The @kbd{s} command allows you to search a whole file for a string. |
428 | 621 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 | |
623 @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 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
625 they are in in the file, which has no necessary relationship to the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
626 order that they may be in in the tree structure of menus and @samp{next} |
428 | 627 pointers. But normally the two orders are not very different. In any |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
628 case, you can always do a @kbd{b} to find out what node you have |
428 | 629 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 | |
631 of the node). | |
632 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
633 If you grudge the system each character of type-in it requires, you |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
634 might like to use the commands @kbd{1}, @kbd{2}, @kbd{3}, @kbd{4}, ... |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
635 @kbd{9}. They are short for the @kbd{m} command together with an |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
636 argument. @kbd{1} goes through the first item in the current node's |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
637 menu; @kbd{2} goes through the second item, etc. |
428 | 638 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
639 If your display supports multiple fonts, and you are using Emacs' Info |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
640 mode to read Info files, the @samp{*} for the fifth menu item is |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
641 underlined, and so is the @samp{*} for the ninth item; these underlines |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
642 make it easy to see at a glance which number to use for an item. |
428 | 643 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
644 On ordinary terminals, you won't have underlining. If you need to |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
645 actually count items, it is better to use @kbd{m} instead, and specify |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
646 the name. |
428 | 647 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
648 The Info command @kbd{e} changes from Info mode to an ordinary |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
649 Emacs editing mode, so that you can edit the text of the current node. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
650 Type @kbd{C-c C-c} to switch back to Info. The @kbd{e} command is allowed |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
651 only if the variable @code{Info-enable-edit} is non-@code{nil}. |
428 | 652 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
653 @node Add, Menus, Expert, Advanced Info |
428 | 654 @comment node-name, next, previous, up |
655 @section Adding a new node to Info | |
656 | |
657 To add a new topic to the list in the Info directory, you must: | |
658 @enumerate | |
659 @item | |
660 Create some nodes, in some file, to document that topic. | |
661 @item | |
662 Put that topic in the menu in the directory. @xref{Menus, Menu}. | |
663 @end enumerate | |
664 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
665 Usually, the way to create the nodes is with Texinfo (@pxref{Top,, |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
666 Overview of Texinfo, texinfo, Texinfo}); this has the advantage that you |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
667 can also make a printed manual from them. However, if you want to edit |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
668 an Info file, here is how. |
428 | 669 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
670 The new node can live in an existing documentation file, or in a new |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
671 one. It must have a @key{^_} character before it (invisible to the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
672 user; this node has one but you cannot see it), and it ends with either |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
673 a @key{^_}, a @key{^L}, or the end of file. Note: If you put in a |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
674 @key{^L} to end a new node, be sure that there is a @key{^_} after it |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
675 to start the next one, since @key{^L} cannot @emph{start} a node. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
676 Also, a nicer way to make a node boundary be a page boundary as well |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
677 is to put a @key{^L} @emph{right after} the @key{^_}. |
428 | 678 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
679 The @key{^_} starting a node must be followed by a newline or a |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
680 @key{^L} newline, after which comes the node's header line. The header |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
681 line must give the node's name (by which Info finds it), and state the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
682 names of the @samp{Next}, @samp{Previous}, and @samp{Up} nodes (if there |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
683 are any). As you can see, this node's @samp{Up} node is the node |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
684 @samp{Top}, which points at all the documentation for Info. The |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
685 @samp{Next} node is @samp{Menus}. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
686 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
687 The keywords @dfn{Node}, @dfn{Previous}, @dfn{Up}, and @dfn{Next}, |
428 | 688 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 | |
690 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 | |
692 does not end it; node names may contain spaces. The case of letters | |
693 in the names is insignificant. | |
694 | |
695 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 | |
697 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 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
699 @samp{(info)Add} for this node. If the file name starts with ``./'', |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
700 then it is relative to the current directory; otherwise, it is relative |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
701 starting from the standard Info file directory of your site. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
702 The name @samp{(@var{filename})Top} can be abbreviated to just |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
703 @samp{(@var{filename})}. By convention, the name @samp{Top} is used for |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
704 the ``highest'' node in any single file---the node whose @samp{Up} points |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
705 out of the file. The Directory node is @file{(dir)}. The @samp{Top} node |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
706 of a document file listed in the Directory should have an @samp{Up: |
428 | 707 (dir)} in it. |
708 | |
709 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 | |
711 node @kbd{*} is to make it possible to make old-fashioned, | |
712 unstructured files into nodes of the tree. | |
713 | |
714 The @samp{Node:} name, in which a node states its own name, must not | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
715 contain a filename, since Info when searching for a node does not expect |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
716 one to be there. The @samp{Next}, @samp{Previous} and @samp{Up} names |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
717 may contain them. In this node, since the @samp{Up} node is in the same |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
718 file, it was not necessary to use one. |
428 | 719 |
720 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 | |
722 to help identify the node for the user. | |
723 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
724 @node Menus, Cross-refs, Add, Advanced Info |
428 | 725 @comment node-name, next, previous, up |
726 @section How to Create Menus | |
727 | |
728 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 | |
730 reads from the terminal. | |
731 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
732 A menu begins with a line starting with @samp{* Menu:}. The rest of the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
733 line is a comment. After the starting line, every line that begins |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
734 with a @samp{* } lists a single topic. The name of the topic--the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
735 argument that the user must give to the @kbd{m} command to select this |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
736 topic---comes right after the star and space, and is followed by a |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
737 colon, spaces and tabs, and the name of the node which discusses that |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
738 topic. The node name, like node names following @samp{Next}, @samp{Previous} |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
739 and @samp{Up}, may be terminated with a tab, comma, or newline; it may also |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
740 be terminated with a period. |
428 | 741 |
742 If the node name and topic name are the same, then rather than | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
743 giving the name twice, the abbreviation @samp{* NAME::} may be used |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
744 (and should be used, whenever possible, as it reduces the visual |
428 | 745 clutter in the menu). |
746 | |
747 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 | |
749 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 | |
751 abbreviation for it (a long menu is more than 5 or so entries). | |
752 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
753 The nodes listed in a node's menu are called its ``subnodes'', and it |
428 | 754 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 | |
756 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. | |
758 | |
759 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 | |
761 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 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
763 Info's files live on that file directory, but they do not have to; and |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
764 files on that directory are not automatically listed in the Info |
428 | 765 Directory node. |
766 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
767 Also, although the Info node graph is claimed to be a ``hierarchy'', |
428 | 768 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 | |
770 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 | |
772 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 | |
774 @kbd{h} command goes to. In fact, since there is no garbage | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
775 collector, nothing terrible happens if a substructure is not pointed |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
776 to, but such a substructure is rather useless since nobody can |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
777 ever find out that it exists. |
428 | 778 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
779 @node Cross-refs, Tags, Menus, Advanced Info |
428 | 780 @comment node-name, next, previous, up |
781 @section Creating Cross References | |
782 | |
783 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 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
785 like a menu item except that it has @samp{*note} instead of @kbd{*}. |
428 | 786 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 | |
788 in parentheses, terminate it with a period first. Here are two | |
789 examples of cross references pointers: | |
790 | |
791 @example | |
792 *Note details: commands. (See *note 3: Full Proof.) | |
793 @end example | |
794 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
795 They are just examples. The places they ``lead to'' do not really exist! |
5492
e82f5b7010fe
Merge some stuff in man, fix up Makefile
Ben Wing <ben@xemacs.org>
parents:
468
diff
changeset
|
796 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
797 @node Tags, Checking, Cross-refs, Advanced Info |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
798 @comment node-name, next, previous, up |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
799 @section Tag Tables for Info Files |
5492
e82f5b7010fe
Merge some stuff in man, fix up Makefile
Ben Wing <ben@xemacs.org>
parents:
468
diff
changeset
|
800 |
428 | 801 You can speed up the access to nodes of a large Info file by giving |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
802 it a tag table. Unlike the tag table for a program, the tag table for |
428 | 803 an Info file lives inside the file itself and is used |
804 automatically whenever Info reads in the file. | |
805 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
806 To make a tag table, go to a node in the file using Emacs Info mode and type |
428 | 807 @kbd{M-x Info-tagify}. Then you must use @kbd{C-x C-s} to save the |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
808 file. |
428 | 809 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
810 Once the Info file has a tag table, you must make certain it is up |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
811 to date. If, as a result of deletion of text, any node moves back |
428 | 812 more than a thousand characters in the file from the position |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
813 recorded in the tag table, Info will no longer be able to find that |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
814 node. To update the tag table, use the @code{Info-tagify} command again. |
428 | 815 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
816 An Info file tag table appears at the end of the file and looks like |
428 | 817 this: |
818 | |
819 @example | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
820 ^_ |
428 | 821 Tag Table: |
822 File: info, Node: Cross-refs^?21419 | |
823 File: info, Node: Tags^?22145 | |
824 ^_ | |
825 End Tag Table | |
826 @end example | |
827 | |
828 @noindent | |
829 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), | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
831 a Delete character, and the character position in the file of the |
428 | 832 beginning of the node. |
833 | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
834 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
835 @node Checking, Emacs Info Variables, Tags, Advanced Info |
428 | 836 @section Checking an Info File |
837 | |
838 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 | |
840 wrong name for a node, this is not detected until someone tries to go | |
841 through the pointer using Info. Verification of the Info file is an | |
842 automatic process which checks all pointers to nodes and reports any | |
843 pointers which are invalid. Every @samp{Next}, @samp{Previous}, and | |
844 @samp{Up} is checked, as is every menu item and every cross reference. In | |
845 addition, any @samp{Next} which does not have a @samp{Previous} pointing | |
846 back is reported. Only pointers within the file are checked, because | |
847 checking pointers to other files would be terribly slow. But those are | |
848 usually few. | |
849 | |
850 To check an Info file, do @kbd{M-x Info-validate} while looking at any | |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
851 node of the file with Emacs Info mode. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
852 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
853 @node Emacs Info Variables, , Checking, Advanced Info |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
854 @section Emacs Info-mode Variables |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
855 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
856 The following variables may modify the behavior of Info-mode in Emacs; |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
857 you may wish to set one or several of these variables interactively, or |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
858 in your @file{~/.emacs} init file. @xref{Examining, Examining and |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
859 Setting Variables, Examining and Setting Variables, xemacs, XEmacs |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
860 User's Manual}. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
861 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
862 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
863 @vtable @code |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
864 @item Info-enable-edit |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
865 Set to @code{nil}, disables the @samp{e} (@code{Info-edit}) command. A |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
866 non-@code{nil} value enables it. @xref{Add, Edit}. |
428 | 867 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
868 @item Info-enable-active-nodes |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
869 When set to a non-@code{nil} value, allows Info to execute Lisp code |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
870 associated with nodes. The Lisp code is executed when the node is |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
871 selected. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
872 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
873 @item Info-directory-list |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
874 The list of directories to search for Info files. Each element is a |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
875 string (directory name) or @code{nil} (try default directory). |
428 | 876 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
877 @item Info-directory |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
878 The standard directory for Info documentation files. Only used when the |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
879 function @code{Info-directory} is called. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
880 @end vtable |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
881 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
882 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
883 @node Creating an Info File |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
884 @chapter Creating an Info File |
428 | 885 |
5496
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
886 @xref{Top,, Overview of Texinfo, texinfo, Texinfo}, to learn how to |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
887 write a Texinfo file. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
888 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
889 @xref{Create an Info File, , Creating an Info File, texinfo, Texinfo}, |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
890 to learn how to create an Info file from a Texinfo file. |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
891 |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
892 @xref{Install an Info File, , Installing an Info File, texinfo, Texinfo}, |
a7da359711ce
Backed out changeset e82f5b7010fe, incompatible with extant makeinfo.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5492
diff
changeset
|
893 to learn how to install an Info file after you have created one. |
428 | 894 |
895 @bye |