annotate man/info.texi @ 5661:6e5a7278f9bf

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