aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard M. Stallman2001-02-17 17:28:52 +0000
committerRichard M. Stallman2001-02-17 17:28:52 +0000
commita83e87655f0db5e9c3b3633204b70f2fcdbdba34 (patch)
tree05ce94ca17ac0201d39af9325da4df57042c03f0
parent08d376e3198636d95ca241b03b7052ce77a8e900 (diff)
downloademacs-a83e87655f0db5e9c3b3633204b70f2fcdbdba34.tar.gz
emacs-a83e87655f0db5e9c3b3633204b70f2fcdbdba34.zip
Clean up and move index-searching recommendation.
Other minor changes.
-rw-r--r--man/help.texi42
1 files changed, 23 insertions, 19 deletions
diff --git a/man/help.texi b/man/help.texi
index 146e7ce36cb..2c4a0b24ac5 100644
--- a/man/help.texi
+++ b/man/help.texi
@@ -33,40 +33,42 @@ define other meanings for it, but they all support @key{F1}.)
33 33
34 Most help buffers use a special major mode, Help mode, which lets you 34 Most help buffers use a special major mode, Help mode, which lets you
35scroll conveniently with @key{SPC} and @key{DEL}. It also offers 35scroll conveniently with @key{SPC} and @key{DEL}. It also offers
36hyperlinks to more help on cross-referenced names, Info nodes, 36hyperlinks to further help regarding cross-referenced names, Info nodes,
37customization buffers and the like. @xref{Help Mode}. 37customization buffers and the like. @xref{Help Mode}.
38 38
39@cindex searching documentation efficiently 39@cindex searching documentation efficiently
40@cindex looking for a subject in documentation 40@cindex looking for a subject in documentation
41 If you are looking for a certain feature, but don't know where exactly 41 If you are looking for a certain feature, but don't know where exactly
42it is documented, and aren't even sure what is the name of the related 42it is documented, and aren't even sure what is the name of the related
43command or option, we recommend the following procedure: 43command or option, we recommend these commands:
44 44
45@table @kbd 45@table @kbd
46@item C-h a @var{topic} @key{RET} 46@item C-h a @var{topic} @key{RET}
47This searches for commands whose names match @var{topic}. @var{topic} 47This searches for commands whose names match @var{topic}, which should
48is a regular expression (@pxref{Regexps}). Browse the buffer popped up 48be a regular expression (@pxref{Regexps}). Browse the buffer popped
49by Emacs, to find what you are looking for. @xref{Apropos}. 49up by Emacs, to find what you are looking for. @xref{Apropos}.
50 50
51@item M-x apropos @var{topic} @key{RET} 51@item M-x apropos @var{topic} @key{RET}
52This works like @kbd{C-h a}, but it also searches for user options and 52This works like @kbd{C-h a}, but it also searches for user options and
53other variables, in case the feature you are looking for is controlled 53other variables, in case the feature you are looking for is controlled
54by an option, not a command. @xref{Apropos}. 54by an option, not a command. @xref{Apropos}.
55 55
56@item C-h i m emacs @key{RET} i @var{topic} @key{RET}
57This looks up @var{topic} in the indices of the Emacs on-line manual.
58Press @key{,} repetitively until you find what you are looking for.
59
60@item C-h i m emacs @key{RET} s @var{topic} @key{RET}
61This works like the previous command, but it searches for @var{topic}
62(which can be a regular expression) in the @emph{text} of the manual
63rather than in its indices.
64
65@item M-x apropos-documentation @var{topic} @key{RET} 56@item M-x apropos-documentation @var{topic} @key{RET}
66This searches the @emph{documentation strings} (the built-in short 57This searches the @emph{documentation strings} (the built-in short
67descriptions) of all variables and functions (not their names) for a 58descriptions) of all variables and functions (not their names) for a
68match for @var{topic}, a regular expression. @xref{Apropos}. 59match for @var{topic}, a regular expression. @xref{Apropos}.
69 60
61@item C-h i m emacs @key{RET} i @var{topic} @key{RET}
62This looks up @var{topic} in the indices of the Emacs on-line manual.
63There may be several matches, so displays the first one. You can then
64press @key{,} to move to other matches, until you find what you are
65looking for.
66
67@item C-h i m emacs @key{RET} s @var{topic} @key{RET}
68Similar, but searches for @var{topic} (which can be a regular
69expression) in the @emph{text} of the manual rather than in its
70indices.
71
70@item C-h F 72@item C-h F
71This brings up the Emacs FAQ, where you can use the usual search 73This brings up the Emacs FAQ, where you can use the usual search
72commands (@pxref{Search}) to find the information. 74commands (@pxref{Search}) to find the information.
@@ -252,11 +254,13 @@ Lisp variables instead of Lisp functions. Its default is the Lisp symbol
252around or before point, but only if that is the name of a known Lisp 254around or before point, but only if that is the name of a known Lisp
253variable. @xref{Variables}.@refill 255variable. @xref{Variables}.@refill
254 256
255Help buffers describing variables or functions defined in Lisp normally 257 Help buffers describing variables or functions defined in Lisp
256have hyperlinks to their definitions if you have the Lisp source files 258normally have hyperlinks to the Lisp definition, if you have the Lisp
257installed. If you can read Lisp, this provides the ultimate 259source files installed. If you know Lisp, this provides the ultimate
258documentation. 260documentation. If you don't know Lisp, you should learn it. If you
259 261are treating Emacs as an object file, then you are just @emph{using}
262Emacs. For real intimacy with Emacs, you must read the source code.
263
260@node Apropos 264@node Apropos
261@section Apropos 265@section Apropos
262 266