annotate man/xemacs/help.texi @ 1633:baca156a450b

[xemacs-hg @ 2003-08-19 02:11:46 by james] Make modules build and run on Cygwin and MinGW. This is the second commit to get the toplevel files that were not committed the first time.
author james
date Tue, 19 Aug 2003 02:11:49 +0000
parents abe6d1db359e
children 5b25cf17bd61
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2 @node Help, Mark, M-x, Top
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3 @chapter Help
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
4 @kindex Help
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5 @cindex help
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6 @cindex self-documentation
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
7 @findex help-command
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
8 @kindex C-h
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
9 @kindex F1
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
11 XEmacs provides extensive help features accessible through a single
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12 character, @kbd{C-h}. @kbd{C-h} is a prefix key that is used only for
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
13 documentation-printing commands. The characters that you can type after
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 @kbd{C-h} are called @dfn{help options}. One help option is @kbd{C-h};
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
15 that is how you ask for help about using @kbd{C-h}. To cancel, type
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
16 @kbd{C-g}. The function key @key{F1} is equivalent to @kbd{C-h}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
18 @kindex C-h C-h
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
19 @findex help-for-help
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
20 @kbd{C-h C-h} (@code{help-for-help}) displays a list of the possible
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
21 help options, and then asks you to type the desired option. It prompts
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
22 with the string:
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 @smallexample
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
25 A B C F I K L M N P S T V W C-c C-d C-f C-i C-k C-n C-w; ? for more help:
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 @end smallexample
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 @noindent
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 You should type one of those characters.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31 Typing a third @kbd{C-h} displays a description of what the options mean;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 Emacs still waits for you to type an option. To cancel, type @kbd{C-g}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
34 Most help buffers use a special major mode, Help mode, which lets you
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
35 scroll conveniently with @key{SPC} and @key{DEL} or @key{BS}.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
36
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
37 @menu
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
38 * Help Summary:: Brief list of all Help commands.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
39 * Key Help:: Asking what a key does in XEmacs.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
40 * Name Help:: Asking about a command, variable or function name.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
41 * Apropos:: Asking what pertains to a given topic.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
42 * Library Keywords:: Finding Lisp libraries by keywords (topics).
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
43 * Help Mode:: Special features of Help mode and Help buffers.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
44 * Misc Help:: Other help commands.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
45 @end menu
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
46
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
47 @iftex
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
48 @node Help Summary, Help Summary, Help, Help
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
49 @end iftex
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
50 @ifinfo
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
51 @node Help Summary, Key Help, Help, Help
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
52 @section Help Summary
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
53 @end ifinfo
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
54
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 Here is a summary of the defined help commands.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57 @table @kbd
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
58 @item C-h a @var{regexp} @key{RET}
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
59 Display a list of functions and variables whose names match @var{regexp}
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
60 (@code{hyper-apropos}).
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
61 @item C-h A @var{regexp}
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
62 Show all commands whose names contain matches for @var{regexp}
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
63 (@code{command-apropos}).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64 @item C-h b
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
65 Display a table of all key bindings currently in effect, with local
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
66 bindings of the current major mode first, followed by all global
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
67 bindings (@code{describe-bindings}).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68 @item C-h c @var{key}
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
69 Print the name of the command that @var{key} runs
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
70 (@code{describe-key-briefly}). Here @kbd{c} stands for `character'. For more
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
71 extensive information on @var{key}, use @kbd{C-h k}.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
72 @item C-h d @var{function} @key{RET}
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
73 @itemx C-h f @var{function} @key{RET}
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
74 Display documentation on the Lisp function named @var{function}
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
75 (@code{describe-function}). Since commands are Lisp functions,
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76 a command name may be used.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
77 @item C-h i
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
78 Run Info, the program for browsing documentation files (@code{info}).
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
79 The complete XEmacs manual is available online in Info.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
80 @item C-h k @var{key}
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
81 Display the name and documentation of the command that @var{key} runs
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
82 (@code{describe-key}).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
83 @item C-h l
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
84 Display a description of the last 100 characters you typed
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
85 (@code{view-lossage}).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
86 @item C-h m
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
87 Display documentation of the current major mode (@code{describe-mode}).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
88 @item C-h n
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
89 @itemx C-h C-n
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
90 Display documentation of XEmacs changes, most recent first
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
91 (@code{view-emacs-news}).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
92 @item C-h p
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
93 Find packages by topic keyword (@code{finder-by-keyword}).
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
94 @item C-h C-p
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
95 Display a table of all mouse bindings currently in effect now, with
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
96 local bindings of the current major mode first, followed by all global
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
97 bindings (@code{describe-pointer}).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
98 @item C-h s
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
99 Display current contents of the syntax table, plus an explanation of
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
100 what they mean (@code{describe-syntax}). @xref{Syntax}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
101 @item C-h t
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
102 Enter the XEmacs interactive tutorial (@code{help-with-tutorial}).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
103 @item C-h v @var{var} @key{RET}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
104 Display the documentation of the Lisp variable @var{var}
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
105 (@code{describe-variable}).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
106 @item C-h w @var{command} @key{RET}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
107 Print which keys run the command named @var{command} (@code{where-is}).
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
108 @item C-h B @key{RET}
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
109 Display info on how to deal with Beta versions of XEmacs
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
110 (@code{describe-beta}).
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
111 @item C-h C @var{group} @key{RET}
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
112 Select customization buffer for @var{group} (@code{customize}).
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
113 @item C-h F @key{RET}
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
114 View the local copy of the XEmacs FAQ (@code{xemacs-local-faq}).
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
115 @item C-h C-i @var{file} @key{RET}
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
116 Read Info file @var{file} with Info browser (@code{Info-query}).
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
117 @item C-h C-c @var{command} @key{RET}
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
118 Look up an Emacs command @var{command} in the Emacs manual in the Info
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
119 system (@code{Info-goto-emacs-command-node}).
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
120 @item C-h C-f @var{function} @key{RET}
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
121 Look up an Emacs Lisp function @var{function} in the Elisp manual in the
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
122 Info system (@code{Info-elisp-ref}).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
123 @end table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
124
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
125 @node Key Help, Name Help, Help Summary, Help
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
126 @section Documentation for a Key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
127
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
128 @kindex C-h c
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
129 @findex describe-key-briefly
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
130 The most basic @kbd{C-h} options are @kbd{C-h c}
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
131 (@code{describe-key-briefly}) and @w{@kbd{C-h k}} (@code{describe-key}).
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
132 @kbd{C-h c @var{key}} prints in the echo area the name of the command
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
133 that @var{key} is bound to. For example, @kbd{C-h c C-f} prints
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
134 @samp{forward-char}. Since command names are chosen to describe what
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
135 the commands do, this is a good way to get a very brief description of
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
136 what @var{key} does.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
137
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
138 @kindex C-h k
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
139 @findex describe-key
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
140 @kbd{C-h k @var{key}} is similar to @kbd{C-h c} but gives more
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
141 information. It displays the documentation string of the function
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
142 @var{key} is bound to as well as its name. @var{key} is a string or
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
143 vector of events. When called interactively, @var{key} may also be a menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
144 selection. This information does not usually fit into the echo area, so a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
145 window is used for the display.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
146
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
147 @kbd{C-h c} and @kbd{C-h k} work for any sort of key sequences,
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
148 including function keys and mouse events.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
149
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
150 @node Name Help, Apropos, Key Help, Help
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
151 @section Help by Command or Variable Name
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
152
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
153 @kindex C-h f
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
154 @findex describe-function
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
155 @vindex describe-function-show-arglist
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
156 @kbd{C-h f} (@code{describe-function}) reads the name of a Lisp
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
157 function using the minibuffer, then displays that function's
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
158 documentation string in a window. Since commands are Lisp functions,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
159 you can use the argument @var{function} to get the documentation of a
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
160 command that you know by name. For example,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
161
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
162 @example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
163 C-h f auto-fill-mode @key{RET}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
164 @end example
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
165
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
166 @noindent
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
167 displays the documentation for @code{auto-fill-mode}. Using @kbd{C-h f}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
168 is the only way to see the documentation of a command that is not bound
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
169 to any key, that is, a command you would normally call using @kbd{M-x}.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
170 If the variable @code{describe-function-show-arglist} is @code{t},
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
171 @code{describe-function} shows its arglist if the @var{function} is not
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
172 an autoload function.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
173
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
174 @kbd{C-h f} is also useful for Lisp functions that you are planning to
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
175 use in a Lisp program. For example, if you have just written the
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
176 expression @code{(make-vector len)} and want to make sure you are using
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
177 @code{make-vector} properly, type @kbd{C-h f make-vector @key{RET}}.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
178 Because @kbd{C-h f} allows all function names, not just command names,
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
179 you may find that some of your favorite abbreviations that work in
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
180 @kbd{M-x} don't work in @kbd{C-h f}. An abbreviation may be unique
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
181 among command names, yet fail to be unique when other function names are
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
182 allowed.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
183
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
184 The function name for @kbd{C-h f} to describe has a default which is
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
185 used if you type @key{RET} leaving the minibuffer empty. The default is
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
186 the function called by the innermost Lisp expression in the buffer
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
187 around point, @emph{provided} that is a valid, defined Lisp function
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
188 name. For example, if point is located following the text
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
189 @samp{(make-vector (car x)}, the innermost list containing point is the
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
190 one that starts with @samp{(make-vector}, so the default is to describe the
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
191 function @code{make-vector}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
192
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
193 @kbd{C-h f} is often useful just to verify that you have the right
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
194 spelling for the function name. If @kbd{C-h f} mentions a name from the
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
195 buffer as the default, that name must be defined as a Lisp function. If
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
196 that is all you want to know, just type @kbd{C-g} to cancel the @kbd{C-h
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
197 f} command, then go on editing.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
198
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
199 @kindex C-h w
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
200 @findex where-is
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
201 @kbd{C-h w @var{command} @key{RET}} (@code{where-is}) tells you what
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
202 keys are bound to @var{command}. It prints a list of the keys in the
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
203 echo area. Alternatively, it informs you that a command is not bound to
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
204 any keys, which implies that you must use @kbd{M-x} to call the
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
205 command.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
206
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
207 @kindex C-h v
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
208 @findex describe-variable
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
209 @kbd{C-h v} (@code{describe-variable}) is like @kbd{C-h f} but
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
210 describes Lisp variables instead of Lisp functions. Its default is the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
211 Lisp symbol around or before point, if that is the name of a known Lisp
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
212 variable. @xref{Variables}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
213
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
214 @node Apropos, Library Keywords, Name Help, Help
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
215 @section Apropos
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
216
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
217 @kindex C-h A
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
218 @findex command-apropos
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
219 @cindex apropos
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
220
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
221 @table @kbd
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
222 @item C-h A
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
223 Show only symbols that are names of commands
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
224 (@code{command-apropos}).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
225
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
226 @item M-x apropos @var{regexp}
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
227 Show all symbols whose names contain matches for @var{regexp}.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
228 @end table
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
229
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
230 A more sophisticated sort of question to ask is, ``What are the
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
231 commands for working with files?'' To ask this question, type @kbd{C-h
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
232 a file @key{RET}}, which displays a list of all command names that
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
233 contain @samp{file}, including @code{copy-file}, @code{find-file}, and
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
234 so on. With each command name appears a brief description of how to use
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
235 the command, and what keys you can currently invoke it with. For
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
236 example, it would say that you can invoke @code{find-file} by typing
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
237 @kbd{C-x C-f}. The @kbd{A} in @kbd{C-h A} stands for `Apropos';
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
238 @kbd{C-h A} runs the command @code{command-apropos}. This command
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
239 normally checks only commands (interactive functions); if you specify a
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
240 prefix argument, it checks noninteractive functions as well.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
241
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
242 Because @kbd{C-h A} looks only for functions whose names contain the
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
243 string you specify, you must use ingenuity in choosing the string. If
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
244 you are looking for commands for killing backwards and @kbd{C-h a
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
245 kill-backwards @key{RET}} doesn't reveal any, don't give up. Try just
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
246 @kbd{kill}, or just @kbd{backwards}, or just @kbd{back}. Be persistent.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
247 Pretend you are playing Adventure. Also note that you can use a regular
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
248 expression as the argument, for more flexibility (@pxref{Regexps}).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
249
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
250 Here is a set of arguments to give to @kbd{C-h a} that covers many
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
251 classes of XEmacs commands, since there are strong conventions for
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
252 naming the standard XEmacs commands. By giving you a feel for the
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
253 naming conventions, this set should also serve to aid you in developing
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
254 a technique for picking @code{apropos} strings.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
255
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
256 @quotation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
257 char, line, word, sentence, paragraph, region, page, sexp, list, defun,
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
258 rect, buffer, frame, window, face, file, dir, register, mode, beginning,
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
259 end, forward, backward, next, previous, up, down, search, goto, kill,
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
260 delete, mark, insert, yank, fill, indent, case, change, set, what, list,
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
261 find, view, describe, default.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
262 @end quotation
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
263
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
264 @findex apropos
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
265 To list all Lisp symbols that contain a match for a regexp, not just
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
266 the ones that are defined as commands, use the command @kbd{M-x apropos}
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
267 instead of @kbd{C-h A}. This command does not check key bindings by
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
268 default; specify a numeric argument if you want it to check them.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
269
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
270 @findex apropos-documentation
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
271 The @code{apropos-documentation} command is like @code{apropos} except
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
272 that it searches documentation strings for matches for the specified
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
273 regular expression.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
274
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
275 @findex apropos-value
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
276 The @code{apropos-value} command is like @code{apropos} except that it
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
277 searches symbols' values for matches for the specified regular
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
278 expression. This command does not check function definitions or
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
279 property lists by default; specify a numeric argument if you want it to
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
280 check them.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
281
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
282 @vindex apropos-do-all
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
283 If the variable @code{apropos-do-all} is non-@code{nil}, the commands
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
284 above all behave as if they had been given a prefix argument.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
285
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
286 If you want more information about a function definition, variable or
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
287 symbol property listed in the Apropos buffer, you can click on it with
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
288 @kbd{Mouse-2} or move there and type @key{RET}.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
289
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
290 @node Library Keywords, Help Mode, Apropos, Help
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
291 @section Keyword Search for Lisp Libraries
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
292
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
293 @kindex C-h p
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
294 @findex finder-by-keyword
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
295 The @kbd{C-h p} command lets you search the standard Emacs Lisp
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
296 libraries by topic keywords. Here is a partial list of keywords you can
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
297 use:
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
298
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
299 @display
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
300 abbrev abbreviation handling, typing shortcuts, macros
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
301 bib code related to the `bib' bibliography processor
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
302 c C, C++, and Objective-C language support
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
303 calendar calendar and time management support
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
304 comm communications, networking, remote access to files
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
305 data support for editing files of data
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
306 docs support for Emacs documentation
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
307 dumped files preloaded into Emacs
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
308 emulations emulations of other editors
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
309 extensions Emacs Lisp language extensions
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
310 faces support for multiple fonts
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
311 frames support for Emacs frames and window systems
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
312 games games, jokes and amusements
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
313 hardware support for interfacing with exotic hardware
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
314 help support for on-line help systems
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
315 hypermedia support for links between text or other media types
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
316 i18n internationalization and alternate character-set support
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
317 internal code for Emacs internals, build process, defaults
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
318 languages specialized modes for editing programming languages
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
319 lisp Lisp support, including Emacs Lisp
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
320 local code local to your site
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
321 maint maintenance aids for the Emacs development group
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
322 mail modes for electronic-mail handling
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
323 matching various sorts of searching and matching
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
324 mouse mouse support
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
325 mule multi-language extensions
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
326 news support for netnews reading and posting
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
327 oop support for object-oriented programming
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
328 outlines support for hierarchical outlining
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
329 processes process, subshell, compilation, and job control support
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
330 terminals support for terminal types
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
331 tex code related to the TeX formatter
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
332 tools programming tools
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
333 unix front-ends/assistants for, or emulators of, UNIX features
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
334 vms support code for vms
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
335 wp word processing
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
336 @end display
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
337
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
338 @node Help Mode, Misc Help, Library Keywords, Help
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
339 @section Help Mode Commands
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
340
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
341 Help buffers provide the commands of View mode (@pxref{Misc File
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
342 Ops}), plus a few special commands of their own.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
343
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
344 @table @kbd
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
345 @item @key{SPC}
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
346 Scroll forward.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
347 @item @key{DEL}
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
348 @itemx @key{BS}
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
349 Scroll backward.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
350 @c @item @key{RET}
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
351 @c Follow a cross reference at point.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
352 @c @item @key{TAB}
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
353 @c Move point forward to the next cross reference.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
354 @c @item S-@key{TAB}
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
355 @c Move point back to the previous cross reference.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
356 @c @item Mouse-2
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
357 @c Follow a cross reference that you click on.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
358 @end table
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
359
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
360 When a command name (@pxref{M-x,, Running Commands by Name}) or
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
361 variable name (@pxref{Variables}) appears in the documentation, it
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
362 normally appears inside paired single-quotes.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
363
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
364 @node Misc Help, , Help Mode, Help
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
365 @section Other Help Commands
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
366
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
367 @kindex C-h i
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
368 @findex info
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
369 @cindex Info
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
370 @cindex manuals, on-line
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
371 @cindex on-line manuals
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
372 @kbd{C-h i} (@code{info}) runs the Info program, which is used for
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
373 browsing through structured documentation files. The entire XEmacs manual
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
374 is available within Info. Eventually all the documentation of the GNU
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
375 system will be available. Type @kbd{h} after entering Info to run
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
376 a tutorial on using Info.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
377
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
378 If you specify a numeric argument, @kbd{C-h i} prompts for the name of
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
379 a documentation file. This way, you can browse a file which doesn't
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
380 have an entry in the top-level Info menu. It is also handy when you
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
381 need to get to the documentation quickly, and you know the exact name of
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
382 the file.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
383
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
384 @kindex C-h C-f
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
385 @kindex C-h C-k
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
386 @findex Info-elisp-ref
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
387 @findex Info-goto-emacs-command-node
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
388 There are two special help commands for accessing XEmacs documentation
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
389 through Info. @kbd{C-h C-f @var{function} @key{RET}} enters Info and
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
390 goes straight to the documentation of the XEmacs function
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
391 @var{function}. @kbd{C-h C-k @var{key}} enters Info and goes straight
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
392 to the documentation of the key @var{key}. These two keys run the
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
393 commands @code{Info-elisp-ref} and
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
394 @code{Info-goto-emacs-key-command-node}.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
395
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
396 @kindex C-h l
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
397 @findex view-lossage
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
398 If something surprising happens, and you are not sure what commands you
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
399 typed, use @kbd{C-h l} (@code{view-lossage}). @kbd{C-h l} prints the last
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
400 100 command characters you typed in. If you see commands that you don't
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
401 know, you can use @kbd{C-h c} to find out what they do.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
402
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
403 @kindex C-h m
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
404 @findex describe-mode
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
405 XEmacs has several major modes. Each mode redefines a few keys and
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
406 makes a few other changes in how editing works. @kbd{C-h m}
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
407 (@code{describe-mode}) prints documentation on the current major mode,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
408 which normally describes all the commands that are changed in this mode.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
409
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
410 @kindex C-h b
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
411 @findex describe-bindings
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
412 @kbd{C-h b} (@code{describe-bindings}) and @kbd{C-h s}
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
413 (@code{describe-syntax}) present information about the current XEmacs
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
414 mode that is not covered by @kbd{C-h m}. @kbd{C-h b} displays a list of
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
415 all the key bindings currently in effect, with the local bindings of the
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
416 current major mode first, followed by the global bindings (@pxref{Key
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
417 Bindings}). @kbd{C-h s} displays the contents of the syntax table with
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
418 explanations of each character's syntax (@pxref{Syntax}).
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
419
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
420 You can get a similar list for a particular prefix key by typing
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
421 @kbd{C-h} after the prefix key. (There are a few prefix keys for which
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
422 this does not work---those that provide their own bindings for
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
423 @kbd{C-h}. One of these is @key{ESC}, because @kbd{@key{ESC} C-h} is
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
424 actually @kbd{C-M-h}, which marks a defun.)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
425
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
426 @kindex C-h F
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
427 @findex xemacs-local-faq
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
428 @kindex C-h n
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
429 @findex view-emacs-news
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
430 @kindex C-h t
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
431 @findex help-with-tutorial
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
432 @kindex C-h C-c
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
433 @findex describe-copying
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
434 @kindex C-h C-d
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
435 @findex describe-distribution
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
436 @kindex C-h C-w
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
437 @findex describe-no-warranty
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
438 The other @kbd{C-h} options display various files of useful
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
439 information. @kbd{C-h C-w} (@code{describe-no-warranty}) displays the
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
440 full details on the complete absence of warranty for XEmacs. @kbd{C-h
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
441 n} (@code{view-emacs-news}) displays the file @file{xemacs/etc/NEWS},
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
442 which contains documentation on XEmacs changes arranged chronologically.
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
443 @kbd{C-h F} (@code{xemacs-local-faq}) displays local version of the
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
444 XEmacs frequently-answered-questions-list. @kbd{C-h t}
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
445 (@code{help-with-tutorial}) displays the learn-by-doing XEmacs
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
446 tutorial. @kbd{C-h C-c} (@code{describe-copying}) displays the file
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
447 @file{xemacs/etc/COPYING}, which tells you the conditions you must obey
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
448 in distributing copies of XEmacs. @kbd{C-h C-d}
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
449 (@code{describe-distribution}) displays another file named
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
450 @file{xemacs/etc/DISTRIB}, which tells you how you can order a copy of
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 0
diff changeset
451 the latest version of XEmacs.