aboutsummaryrefslogtreecommitdiffstats
path: root/doc/misc
diff options
context:
space:
mode:
authorGlenn Morris2014-06-28 19:33:50 -0700
committerGlenn Morris2014-06-28 19:33:50 -0700
commita27e8c78c03a911db68885f0beffb69250fc75fe (patch)
tree5242904a7d105a39a33eba2dad8c093da390929b /doc/misc
parent64de2916ca9a68bed19ea24115231b7c457760ec (diff)
downloademacs-a27e8c78c03a911db68885f0beffb69250fc75fe.tar.gz
emacs-a27e8c78c03a911db68885f0beffb69250fc75fe.zip
Doc and comment fixes re "online" help
* doc/emacs/help.texi (Misc Help): * doc/emacs/trouble.texi (Checklist): * doc/lispintro/emacs-lisp-intro.texi (Note for Novices, Finding More) (Conclusion): * doc/lispref/help.texi (Help Functions): * doc/misc/info.texi, doc/misc/mh-e.texi: * etc/refcards/calccard.tex (section{Getting Help}): * lisp/cus-edit.el (help): * lisp/finder.el (finder-known-keywords): * lisp/help.el (help-for-help-internal): * lisp/vc/ediff-mult.el (ediff-meta-buffer-verbose-message) (ediff-redraw-registry-buffer): * lisp/vc/ediff-ptch.el (ediff-patch-file-internal): Doc fixes re "online" help. Fixes: debbugs:17803
Diffstat (limited to 'doc/misc')
-rw-r--r--doc/misc/ChangeLog3
-rw-r--r--doc/misc/info.texi6
-rw-r--r--doc/misc/mh-e.texi22
3 files changed, 17 insertions, 14 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index d26d3a85b03..8547299aafc 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,5 +1,8 @@
12014-06-29 Glenn Morris <rgm@gnu.org> 12014-06-29 Glenn Morris <rgm@gnu.org>
2 2
3 * info.texi, mh-e.texi: "Online help" doesn't mean what it
4 used to any more.
5
3 * idlwave.texi (Introduction): Comment out dead http screenshot links. 6 * idlwave.texi (Introduction): Comment out dead http screenshot links.
4 7
52014-06-23 Leo Liu <sdl.web@gmail.com> 82014-06-23 Leo Liu <sdl.web@gmail.com>
diff --git a/doc/misc/info.texi b/doc/misc/info.texi
index 87e7794c61e..a3a14a35b80 100644
--- a/doc/misc/info.texi
+++ b/doc/misc/info.texi
@@ -12,7 +12,7 @@
12@comment %**end of header 12@comment %**end of header
13 13
14@copying 14@copying
15This file describes how to use Info, the on-line, menu-driven GNU 15This file describes how to use Info, the menu-driven GNU
16documentation system. 16documentation system.
17 17
18Copyright @copyright{} 1989, 1992, 1996--2014 Free Software Foundation, Inc. 18Copyright @copyright{} 1989, 1992, 1996--2014 Free Software Foundation, Inc.
@@ -51,7 +51,7 @@ modify this GNU manual.''
51@node Top 51@node Top
52@top Info: An Introduction 52@top Info: An Introduction
53 53
54The GNU Project distributes most of its on-line manuals in the 54The GNU Project distributes most of its manuals in the
55@dfn{Info format}, which you read using an @dfn{Info reader}. You are 55@dfn{Info format}, which you read using an @dfn{Info reader}. You are
56probably using an Info reader to read this now. 56probably using an Info reader to read this now.
57 57
@@ -98,7 +98,7 @@ program on a computer, so that you can try Info commands while reading
98about them. Reading it on paper or with an HTML browser is less 98about them. Reading it on paper or with an HTML browser is less
99effective, since you must take it on faith that the commands described 99effective, since you must take it on faith that the commands described
100really do what the manual says. By all means go through this manual 100really do what the manual says. By all means go through this manual
101now that you have it; but please try going through the on-line version 101now that you have it; but please try going through the Info version
102as well. 102as well.
103 103
104@cindex Info reader, how to invoke 104@cindex Info reader, how to invoke
diff --git a/doc/misc/mh-e.texi b/doc/misc/mh-e.texi
index a5766e346e3..b4538f89db5 100644
--- a/doc/misc/mh-e.texi
+++ b/doc/misc/mh-e.texi
@@ -227,7 +227,7 @@ have, see @ref{Getting Started}.
227@kindex C-h t 227@kindex C-h t
228 228
229If you don't already use GNU Emacs but want to learn more, you can 229If you don't already use GNU Emacs but want to learn more, you can
230read an online tutorial by starting GNU Emacs and typing @kbd{C-h t} 230read a built-in tutorial by starting GNU Emacs and typing @kbd{C-h t}
231(@code{help-with-tutorial}). (To learn about this notation, see 231(@code{help-with-tutorial}). (To learn about this notation, see
232@ref{Conventions}.) If you want to take the plunge, consult the 232@ref{Conventions}.) If you want to take the plunge, consult the
233@iftex 233@iftex
@@ -1066,9 +1066,9 @@ This chapter begins the meat of the manual which goes into more detail
1066about every MH-E command and option. 1066about every MH-E command and option.
1067 1067
1068@cindex Emacs, info 1068@cindex Emacs, info
1069@cindex Emacs, online help 1069@cindex Emacs, built-in help
1070@cindex info 1070@cindex info
1071@cindex online help 1071@cindex built-in help
1072@findex describe-mode 1072@findex describe-mode
1073@findex mh-help 1073@findex mh-help
1074@kindex ? 1074@kindex ?
@@ -1083,12 +1083,12 @@ summaries at the beginning of each chapter. In case you have or would
1083like to rebind the keys, the command summaries also list the 1083like to rebind the keys, the command summaries also list the
1084associated Emacs Lisp function. Furthermore, even if you're stranded 1084associated Emacs Lisp function. Furthermore, even if you're stranded
1085on a desert island with a laptop and are without your manuals, you can 1085on a desert island with a laptop and are without your manuals, you can
1086get a summary of all these commands with GNU Emacs online help: use 1086get a summary of all these commands with GNU Emacs built-in help: use
1087@kbd{C-h m} (@code{describe-mode}) for a brief summary of commands, 1087@kbd{C-h m} (@code{describe-mode}) for a brief summary of commands,
1088@kbd{?} (@code{mh-help}) for an even briefer summary@footnote{This 1088@kbd{?} (@code{mh-help}) for an even briefer summary@footnote{This
1089help appears in a buffer called @file{*MH-E Help*} 1089help appears in a buffer called @file{*MH-E Help*}
1090(@pxref{Miscellaneous}).} (@kbd{C-c ?} in MH-Letter mode), or @kbd{C-h 1090(@pxref{Miscellaneous}).} (@kbd{C-c ?} in MH-Letter mode), or @kbd{C-h
1091i} to read this manual via Info. The online help is quite good; try 1091i} to read this manual via Info. The built-in help is quite good; try
1092running @kbd{C-h C-h}. This brings up a list of available help topics, 1092running @kbd{C-h C-h}. This brings up a list of available help topics,
1093one of which displays the documentation for a given key (like @kbd{C-h 1093one of which displays the documentation for a given key (like @kbd{C-h
1094k C-n}). Another useful help feature is to view the manual section 1094k C-n}). Another useful help feature is to view the manual section
@@ -1120,21 +1120,21 @@ exist,
1120@c Yes, some of the stuff in the following sections is redundant, but 1120@c Yes, some of the stuff in the following sections is redundant, but
1121@c TeX barfs if the @ifs are inside the @footnote. 1121@c TeX barfs if the @ifs are inside the @footnote.
1122@iftex 1122@iftex
1123@footnote{The @cite{GNU Emacs Lisp Reference Manual} may be available 1123@footnote{The @cite{GNU Emacs Lisp Reference Manual} should be available
1124online in the Info system by typing @kbd{C-h i m Emacs Lisp 1124via the Info system by typing @kbd{C-h i m Emacs Lisp
1125@key{RET}}. It is also available online at @* 1125@key{RET}}. It is also available online at @*
1126@uref{http://www.gnu.org/software/emacs/manual/elisp.html}.} 1126@uref{http://www.gnu.org/software/emacs/manual/elisp.html}.}
1127@end iftex 1127@end iftex
1128@ifinfo 1128@ifinfo
1129@footnote{@xref{Top, The GNU Emacs Lisp Reference Manual, , elisp, GNU 1129@footnote{@xref{Top, The GNU Emacs Lisp Reference Manual, , elisp, GNU
1130Emacs Lisp Reference Manual}, which may be available online in the 1130Emacs Lisp Reference Manual}, which should be available via the
1131Info system. It is also available online at 1131Info system. It is also available online at
1132@uref{http://www.gnu.org/software/emacs/manual/elisp.html}.} 1132@uref{http://www.gnu.org/software/emacs/manual/elisp.html}.}
1133@end ifinfo 1133@end ifinfo
1134@ifhtml 1134@ifhtml
1135@footnote{The 1135@footnote{The
1136@uref{http://www.gnu.org/software/emacs/manual/elisp.html, 1136@uref{http://www.gnu.org/software/emacs/manual/elisp.html,
1137The GNU Emacs Lisp Reference Manual} may also be available online in 1137The GNU Emacs Lisp Reference Manual} should be available via
1138the Info system by typing @kbd{C-h i m Emacs Lisp @key{RET}}.} 1138the Info system by typing @kbd{C-h i m Emacs Lisp @key{RET}}.}
1139@end ifhtml 1139@end ifhtml
1140and you can look at the code itself for examples. Look in the Emacs 1140and you can look at the code itself for examples. Look in the Emacs
@@ -1142,7 +1142,7 @@ Lisp directory on your system (such as
1142@file{/usr/local/share/emacs/lisp/mh-e}) and find all the @file{mh-*.el} 1142@file{/usr/local/share/emacs/lisp/mh-e}) and find all the @file{mh-*.el}
1143files there. When calling MH-E and other Emacs Lisp functions directly 1143files there. When calling MH-E and other Emacs Lisp functions directly
1144from Emacs Lisp code, you'll need to know the correct arguments. Use 1144from Emacs Lisp code, you'll need to know the correct arguments. Use
1145the online help for this. For example, try @kbd{C-h f 1145the built-in help for this. For example, try @kbd{C-h f
1146mh-execute-commands @key{RET}}. If you write your own functions, 1146mh-execute-commands @key{RET}}. If you write your own functions,
1147please do not prefix your symbols (variables and functions) with 1147please do not prefix your symbols (variables and functions) with
1148@samp{mh-}. This prefix is reserved for the MH-E package. To avoid 1148@samp{mh-}. This prefix is reserved for the MH-E package. To avoid
@@ -6405,7 +6405,7 @@ see the section
6405The Menu Bar} in @cite{The GNU Emacs Manual}. 6405The Menu Bar} in @cite{The GNU Emacs Manual}.
6406@end ifhtml 6406@end ifhtml
6407 6407
6408The Emacs manual describes how to get online help for a particular 6408The Emacs manual describes how to get help for a particular
6409menu item. You can also look up a menu item in the index of this 6409menu item. You can also look up a menu item in the index of this
6410manual in two ways: all of the menu items are listed alphabetically, 6410manual in two ways: all of the menu items are listed alphabetically,
6411and you can also browse all of the items under the index entry 6411and you can also browse all of the items under the index entry