diff options
| author | Glenn Morris | 2014-06-28 19:33:50 -0700 |
|---|---|---|
| committer | Glenn Morris | 2014-06-28 19:33:50 -0700 |
| commit | a27e8c78c03a911db68885f0beffb69250fc75fe (patch) | |
| tree | 5242904a7d105a39a33eba2dad8c093da390929b /doc | |
| parent | 64de2916ca9a68bed19ea24115231b7c457760ec (diff) | |
| download | emacs-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')
| -rw-r--r-- | doc/emacs/ChangeLog | 6 | ||||
| -rw-r--r-- | doc/emacs/help.texi | 3 | ||||
| -rw-r--r-- | doc/emacs/trouble.texi | 2 | ||||
| -rw-r--r-- | doc/lispintro/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/lispintro/emacs-lisp-intro.texi | 8 | ||||
| -rw-r--r-- | doc/lispref/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/lispref/help.texi | 2 | ||||
| -rw-r--r-- | doc/misc/ChangeLog | 3 | ||||
| -rw-r--r-- | doc/misc/info.texi | 6 | ||||
| -rw-r--r-- | doc/misc/mh-e.texi | 22 |
10 files changed, 40 insertions, 22 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index 7c85d3a617e..5457f2d1f42 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog | |||
| @@ -1,3 +1,9 @@ | |||
| 1 | 2014-06-29 Glenn Morris <rgm@gnu.org> | ||
| 2 | |||
| 3 | * help.texi (Misc Help): | ||
| 4 | * trouble.texi (Checklist): "Online" help doesn't mean what it | ||
| 5 | used to any more. | ||
| 6 | |||
| 1 | 2014-06-08 Glenn Morris <rgm@gnu.org> | 7 | 2014-06-08 Glenn Morris <rgm@gnu.org> |
| 2 | 8 | ||
| 3 | * entering.texi (Entering Emacs): Small fix re initial-buffer-choice. | 9 | * entering.texi (Entering Emacs): Small fix re initial-buffer-choice. |
diff --git a/doc/emacs/help.texi b/doc/emacs/help.texi index db5448692f9..da831d76124 100644 --- a/doc/emacs/help.texi +++ b/doc/emacs/help.texi | |||
| @@ -490,8 +490,7 @@ currently in use. @xref{Coding Systems}. | |||
| 490 | @kindex C-h i | 490 | @kindex C-h i |
| 491 | @findex info | 491 | @findex info |
| 492 | @cindex Info | 492 | @cindex Info |
| 493 | @cindex manuals, on-line | 493 | @cindex manuals, included |
| 494 | @cindex on-line manuals | ||
| 495 | @kbd{C-h i} (@code{info}) runs the Info program, which browses | 494 | @kbd{C-h i} (@code{info}) runs the Info program, which browses |
| 496 | structured documentation files. The entire Emacs manual is available | 495 | structured documentation files. The entire Emacs manual is available |
| 497 | within Info, along with many other manuals for the GNU system. Type | 496 | within Info, along with many other manuals for the GNU system. Type |
diff --git a/doc/emacs/trouble.texi b/doc/emacs/trouble.texi index f0cbbcc5721..09260a1e5a9 100644 --- a/doc/emacs/trouble.texi +++ b/doc/emacs/trouble.texi | |||
| @@ -847,7 +847,7 @@ conclusion from our observations. | |||
| 847 | @item | 847 | @item |
| 848 | If the bug is that the Emacs Manual or the Emacs Lisp Reference Manual | 848 | If the bug is that the Emacs Manual or the Emacs Lisp Reference Manual |
| 849 | fails to describe the actual behavior of Emacs, or that the text is | 849 | fails to describe the actual behavior of Emacs, or that the text is |
| 850 | confusing, copy in the text from the online manual which you think is | 850 | confusing, copy in the text from the manual which you think is |
| 851 | at fault. If the section is small, just the section name is enough. | 851 | at fault. If the section is small, just the section name is enough. |
| 852 | 852 | ||
| 853 | @item | 853 | @item |
diff --git a/doc/lispintro/ChangeLog b/doc/lispintro/ChangeLog index 6ca9eb4c93f..ee3af3ff3d1 100644 --- a/doc/lispintro/ChangeLog +++ b/doc/lispintro/ChangeLog | |||
| @@ -1,3 +1,8 @@ | |||
| 1 | 2014-06-29 Glenn Morris <rgm@gnu.org> | ||
| 2 | |||
| 3 | * emacs-lisp-intro.texi (Note for Novices, Finding More, Conclusion): | ||
| 4 | "Online" help doesn't mean what it used to any more. | ||
| 5 | |||
| 1 | 2014-02-25 Glenn Morris <rgm@gnu.org> | 6 | 2014-02-25 Glenn Morris <rgm@gnu.org> |
| 2 | 7 | ||
| 3 | * emacs-lisp-intro.texi (X11 Colors): Don't use setq with hooks. | 8 | * emacs-lisp-intro.texi (X11 Colors): Don't use setq with hooks. |
diff --git a/doc/lispintro/emacs-lisp-intro.texi b/doc/lispintro/emacs-lisp-intro.texi index f181569ca75..4c85e67f7f3 100644 --- a/doc/lispintro/emacs-lisp-intro.texi +++ b/doc/lispintro/emacs-lisp-intro.texi | |||
| @@ -903,7 +903,7 @@ file, @file{cl.el}, that adds many Common Lisp features to Emacs Lisp.) | |||
| 903 | If you don't know GNU Emacs, you can still read this document | 903 | If you don't know GNU Emacs, you can still read this document |
| 904 | profitably. However, I recommend you learn Emacs, if only to learn to | 904 | profitably. However, I recommend you learn Emacs, if only to learn to |
| 905 | move around your computer screen. You can teach yourself how to use | 905 | move around your computer screen. You can teach yourself how to use |
| 906 | Emacs with the on-line tutorial. To use it, type @kbd{C-h t}. (This | 906 | Emacs with the built-in tutorial. To use it, type @kbd{C-h t}. (This |
| 907 | means you press and release the @key{CTRL} key and the @kbd{h} at the | 907 | means you press and release the @key{CTRL} key and the @kbd{h} at the |
| 908 | same time, and then press and release @kbd{t}.) | 908 | same time, and then press and release @kbd{t}.) |
| 909 | 909 | ||
| @@ -4657,7 +4657,7 @@ specialized library, such as a law library or an engineering library, | |||
| 4657 | rather than a general library. Each library, or file, contains | 4657 | rather than a general library. Each library, or file, contains |
| 4658 | functions that relate to a particular topic or activity, such as | 4658 | functions that relate to a particular topic or activity, such as |
| 4659 | @file{abbrev.el} for handling abbreviations and other typing | 4659 | @file{abbrev.el} for handling abbreviations and other typing |
| 4660 | shortcuts, and @file{help.el} for on-line help. (Sometimes several | 4660 | shortcuts, and @file{help.el} for help. (Sometimes several |
| 4661 | libraries provide code for a single activity, as the various | 4661 | libraries provide code for a single activity, as the various |
| 4662 | @file{rmail@dots{}} files provide code for reading electronic mail.) | 4662 | @file{rmail@dots{}} files provide code for reading electronic mail.) |
| 4663 | In @cite{The GNU Emacs Manual}, you will see sentences such as ``The | 4663 | In @cite{The GNU Emacs Manual}, you will see sentences such as ``The |
| @@ -18685,9 +18685,9 @@ easy-to-read description of Emacs Lisp. It is written not only for | |||
| 18685 | experts, but for people who know what you know. (The @cite{Reference | 18685 | experts, but for people who know what you know. (The @cite{Reference |
| 18686 | Manual} comes with the standard GNU Emacs distribution. Like this | 18686 | Manual} comes with the standard GNU Emacs distribution. Like this |
| 18687 | introduction, it comes as a Texinfo source file, so you can read it | 18687 | introduction, it comes as a Texinfo source file, so you can read it |
| 18688 | on-line and as a typeset, printed book.) | 18688 | on your computer and as a typeset, printed book.) |
| 18689 | 18689 | ||
| 18690 | Go to the other on-line help that is part of GNU Emacs: the on-line | 18690 | Go to the other built-in help that is part of GNU Emacs: the built-in |
| 18691 | documentation for all functions and variables, and @code{find-tag}, | 18691 | documentation for all functions and variables, and @code{find-tag}, |
| 18692 | the program that takes you to sources. | 18692 | the program that takes you to sources. |
| 18693 | 18693 | ||
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 6b673e7f329..2464eda28cb 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,8 @@ | |||
| 1 | 2014-06-29 Glenn Morris <rgm@gnu.org> | ||
| 2 | |||
| 3 | * help.texi (Help Functions): "Online" help doesn't mean what it | ||
| 4 | used to any more. | ||
| 5 | |||
| 1 | 2014-06-26 Glenn Morris <rgm@gnu.org> | 6 | 2014-06-26 Glenn Morris <rgm@gnu.org> |
| 2 | 7 | ||
| 3 | * minibuf.texi (Intro to Minibuffers): Batch mode is basic. | 8 | * minibuf.texi (Intro to Minibuffers): Batch mode is basic. |
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index 9a763b60938..20fb0e651f9 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi | |||
| @@ -508,7 +508,7 @@ non-@code{nil}, the return value is always a vector. | |||
| 508 | @node Help Functions | 508 | @node Help Functions |
| 509 | @section Help Functions | 509 | @section Help Functions |
| 510 | 510 | ||
| 511 | Emacs provides a variety of on-line help functions, all accessible to | 511 | Emacs provides a variety of built-in help functions, all accessible to |
| 512 | the user as subcommands of the prefix @kbd{C-h}. For more information | 512 | the user as subcommands of the prefix @kbd{C-h}. For more information |
| 513 | about them, see @ref{Help, , Help, emacs, The GNU Emacs Manual}. Here | 513 | about them, see @ref{Help, , Help, emacs, The GNU Emacs Manual}. Here |
| 514 | we describe some program-level interfaces to the same information. | 514 | we describe some program-level interfaces to the same information. |
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 @@ | |||
| 1 | 2014-06-29 Glenn Morris <rgm@gnu.org> | 1 | 2014-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 | ||
| 5 | 2014-06-23 Leo Liu <sdl.web@gmail.com> | 8 | 2014-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 |
| 15 | This file describes how to use Info, the on-line, menu-driven GNU | 15 | This file describes how to use Info, the menu-driven GNU |
| 16 | documentation system. | 16 | documentation system. |
| 17 | 17 | ||
| 18 | Copyright @copyright{} 1989, 1992, 1996--2014 Free Software Foundation, Inc. | 18 | Copyright @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 | ||
| 54 | The GNU Project distributes most of its on-line manuals in the | 54 | The 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 |
| 56 | probably using an Info reader to read this now. | 56 | probably 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 | |||
| 98 | about them. Reading it on paper or with an HTML browser is less | 98 | about them. Reading it on paper or with an HTML browser is less |
| 99 | effective, since you must take it on faith that the commands described | 99 | effective, since you must take it on faith that the commands described |
| 100 | really do what the manual says. By all means go through this manual | 100 | really do what the manual says. By all means go through this manual |
| 101 | now that you have it; but please try going through the on-line version | 101 | now that you have it; but please try going through the Info version |
| 102 | as well. | 102 | as 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 | ||
| 229 | If you don't already use GNU Emacs but want to learn more, you can | 229 | If you don't already use GNU Emacs but want to learn more, you can |
| 230 | read an online tutorial by starting GNU Emacs and typing @kbd{C-h t} | 230 | read 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 | |||
| 1066 | about every MH-E command and option. | 1066 | about 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 | |||
| 1083 | like to rebind the keys, the command summaries also list the | 1083 | like to rebind the keys, the command summaries also list the |
| 1084 | associated Emacs Lisp function. Furthermore, even if you're stranded | 1084 | associated Emacs Lisp function. Furthermore, even if you're stranded |
| 1085 | on a desert island with a laptop and are without your manuals, you can | 1085 | on a desert island with a laptop and are without your manuals, you can |
| 1086 | get a summary of all these commands with GNU Emacs online help: use | 1086 | get 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 |
| 1089 | help appears in a buffer called @file{*MH-E Help*} | 1089 | help 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 |
| 1091 | i} to read this manual via Info. The online help is quite good; try | 1091 | i} to read this manual via Info. The built-in help is quite good; try |
| 1092 | running @kbd{C-h C-h}. This brings up a list of available help topics, | 1092 | running @kbd{C-h C-h}. This brings up a list of available help topics, |
| 1093 | one of which displays the documentation for a given key (like @kbd{C-h | 1093 | one of which displays the documentation for a given key (like @kbd{C-h |
| 1094 | k C-n}). Another useful help feature is to view the manual section | 1094 | k 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 |
| 1124 | online in the Info system by typing @kbd{C-h i m Emacs Lisp | 1124 | via 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 |
| 1130 | Emacs Lisp Reference Manual}, which may be available online in the | 1130 | Emacs Lisp Reference Manual}, which should be available via the |
| 1131 | Info system. It is also available online at | 1131 | Info 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, |
| 1137 | The GNU Emacs Lisp Reference Manual} may also be available online in | 1137 | The GNU Emacs Lisp Reference Manual} should be available via |
| 1138 | the Info system by typing @kbd{C-h i m Emacs Lisp @key{RET}}.} | 1138 | the Info system by typing @kbd{C-h i m Emacs Lisp @key{RET}}.} |
| 1139 | @end ifhtml | 1139 | @end ifhtml |
| 1140 | and you can look at the code itself for examples. Look in the Emacs | 1140 | and 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} |
| 1143 | files there. When calling MH-E and other Emacs Lisp functions directly | 1143 | files there. When calling MH-E and other Emacs Lisp functions directly |
| 1144 | from Emacs Lisp code, you'll need to know the correct arguments. Use | 1144 | from Emacs Lisp code, you'll need to know the correct arguments. Use |
| 1145 | the online help for this. For example, try @kbd{C-h f | 1145 | the built-in help for this. For example, try @kbd{C-h f |
| 1146 | mh-execute-commands @key{RET}}. If you write your own functions, | 1146 | mh-execute-commands @key{RET}}. If you write your own functions, |
| 1147 | please do not prefix your symbols (variables and functions) with | 1147 | please 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 | |||
| 6405 | The Menu Bar} in @cite{The GNU Emacs Manual}. | 6405 | The Menu Bar} in @cite{The GNU Emacs Manual}. |
| 6406 | @end ifhtml | 6406 | @end ifhtml |
| 6407 | 6407 | ||
| 6408 | The Emacs manual describes how to get online help for a particular | 6408 | The Emacs manual describes how to get help for a particular |
| 6409 | menu item. You can also look up a menu item in the index of this | 6409 | menu item. You can also look up a menu item in the index of this |
| 6410 | manual in two ways: all of the menu items are listed alphabetically, | 6410 | manual in two ways: all of the menu items are listed alphabetically, |
| 6411 | and you can also browse all of the items under the index entry | 6411 | and you can also browse all of the items under the index entry |