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