diff options
| author | Chong Yidong | 2007-04-08 13:50:53 +0000 |
|---|---|---|
| committer | Chong Yidong | 2007-04-08 13:50:53 +0000 |
| commit | fcd47c3369e35554b13d4c931f34a0a018f59fbd (patch) | |
| tree | 4d91ded482be36e85b6fe831365e1f7bb4920da0 | |
| parent | 24cc3360319ece47da5a0fb0f7641a00b535cf68 (diff) | |
| download | emacs-fcd47c3369e35554b13d4c931f34a0a018f59fbd.tar.gz emacs-fcd47c3369e35554b13d4c931f34a0a018f59fbd.zip | |
(Word at point, Interface Options): woman-topic-at-point renamed to
woman-use-topic-at-point. Document new behavior.
| -rw-r--r-- | man/woman.texi | 54 |
1 files changed, 23 insertions, 31 deletions
diff --git a/man/woman.texi b/man/woman.texi index 86c73306892..575c90309ae 100644 --- a/man/woman.texi +++ b/man/woman.texi | |||
| @@ -480,24 +480,22 @@ time it is run in a new Emacs session. | |||
| 480 | @cindex point, word at | 480 | @cindex point, word at |
| 481 | 481 | ||
| 482 | By default, the @code{woman} command uses the word nearest to point in | 482 | By default, the @code{woman} command uses the word nearest to point in |
| 483 | the current buffer as a suggestion for the topic to look up. The topic | 483 | the current buffer as a suggestion for the topic to look up, if it |
| 484 | must be confirmed or edited in the minibuffer. This suggestion can be | 484 | exists as a valid topic. The topic can be confirmed or edited in the |
| 485 | turned off, or @code{woman} can use the suggested topic without | 485 | minibuffer. |
| 486 | confirmation if possible, which is controlled by customizing the user | 486 | |
| 487 | option @code{woman-topic-at-point} to @code{nil} or @code{t} | 487 | You can also bind the variable @code{woman-use-topic-at-point} locally |
| 488 | respectively. (Its default value is neither @code{nil} nor @code{t}, | 488 | to a non-@code{nil} value (using @code{let}), in which case |
| 489 | meaning ask for confirmation.) | 489 | @code{woman} will can use the suggested topic without confirmation if |
| 490 | 490 | possible. This may be useful to provide special private key bindings, | |
| 491 | The variable @code{woman-topic-at-point} can also be rebound locally | 491 | e.g.@: this key binding for @kbd{C-c w} runs WoMan on the topic at |
| 492 | (using @code{let}), which may be useful to provide special private key | 492 | point without seeking confirmation: |
| 493 | bindings, e.g.@: this key binding for @kbd{C-c w} runs WoMan on the topic | ||
| 494 | at point without seeking confirmation: | ||
| 495 | 493 | ||
| 496 | @lisp | 494 | @lisp |
| 497 | (global-set-key "\C-cw" | 495 | (global-set-key "\C-cw" |
| 498 | (lambda () | 496 | (lambda () |
| 499 | (interactive) | 497 | (interactive) |
| 500 | (let ((woman-topic-at-point t)) | 498 | (let ((woman-use-topic-at-point t)) |
| 501 | (woman)))) | 499 | (woman)))) |
| 502 | @end lisp | 500 | @end lisp |
| 503 | 501 | ||
| @@ -1091,24 +1089,18 @@ a Contents menu to the menubar by calling @code{imenu-add-to-menubar}. | |||
| 1091 | A string representing the title to use if WoMan adds a Contents menu to | 1089 | A string representing the title to use if WoMan adds a Contents menu to |
| 1092 | the menubar. Default is @code{"CONTENTS"}. | 1090 | the menubar. Default is @code{"CONTENTS"}. |
| 1093 | 1091 | ||
| 1094 | @item woman-topic-at-point | 1092 | @item woman-use-topic-at-point |
| 1095 | A symbol, which may be either @code{t}, @code{nil} or @code{confirm}, | 1093 | A boolean value that defaults to @code{nil}. If non-@code{nil} then |
| 1096 | that controls the use by @code{woman} of the ``word at point'' as a | 1094 | the @code{woman} command uses the word at point as the topic, |
| 1097 | topic suggestion. If it is non-@code{nil} then the @code{woman} command uses | 1095 | @emph{without interactive confirmation}, if it exists as a topic. |
| 1098 | the word at point as an initial topic suggestion when it reads a topic | 1096 | |
| 1099 | from the minibuffer; if it is @code{t} then @code{woman} uses the word | 1097 | @item woman-use-topic-at-point-default |
| 1100 | at point @emph{without interactive confirmation} if it exists as a | 1098 | A boolean value representing the default value for |
| 1101 | topic. The value @code{confirm} means suggest a topic and ask for | 1099 | @code{woman-use-topic-at-point}. The default value is @code{nil}. |
| 1102 | confirmation. The default value is that of | 1100 | [The variable @code{woman-use-topic-at-point} may be @code{let}-bound |
| 1103 | @code{woman-topic-at-point-default}. | 1101 | when @code{woman} is loaded, in which case its global value does not |
| 1104 | 1102 | get defined. The function @code{woman-file-name} sets it to this | |
| 1105 | @item woman-topic-at-point-default | 1103 | value if it is unbound.] |
| 1106 | A symbol, which may be either @code{t}, @code{nil} or @code{confirm}, | ||
| 1107 | representing the default value for @code{woman-topic-at-point}. The | ||
| 1108 | default value is @code{confirm}. [The variable | ||
| 1109 | @code{woman-topic-at-point} may be @code{let}-bound when @code{woman} is | ||
| 1110 | loaded, in which case its global value does not get defined. The | ||
| 1111 | function @code{woman-file-name} sets it to this value if it is unbound.] | ||
| 1112 | 1104 | ||
| 1113 | @item woman-uncompressed-file-regexp | 1105 | @item woman-uncompressed-file-regexp |
| 1114 | A regular match expression used to select man source files (ignoring any | 1106 | A regular match expression used to select man source files (ignoring any |