annotate man/info.texi @ 5440:24c67faf4be6

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