diff options
| author | Michael Albinus | 2023-11-02 12:14:13 +0100 |
|---|---|---|
| committer | Michael Albinus | 2023-11-02 12:14:13 +0100 |
| commit | f5b2d23fff6e77ab71e028c84e73b3a792c430bd (patch) | |
| tree | 06d94f09770ba0e84bb3b89cd9c94b24800a96a7 | |
| parent | cb92eb404d73feca21666d2de1dd54b41fe34c53 (diff) | |
| download | emacs-f5b2d23fff6e77ab71e028c84e73b3a792c430bd.tar.gz emacs-f5b2d23fff6e77ab71e028c84e73b3a792c430bd.zip | |
Adapt doc for man.el
* etc/NEWS: Rephrase 'Man-support-remote-systems' entry.
Fix typos.
* lisp/man.el (Man-header-file-path, man): Adapt docstrings.
| -rw-r--r-- | etc/NEWS | 13 | ||||
| -rw-r--r-- | lisp/man.el | 15 |
2 files changed, 13 insertions, 15 deletions
| @@ -688,16 +688,15 @@ bound to 'C-c C-d' in 'go-ts-mode'. | |||
| 688 | 688 | ||
| 689 | +++ | 689 | +++ |
| 690 | *** New user option 'Man-prefer-synchronous-call'. | 690 | *** New user option 'Man-prefer-synchronous-call'. |
| 691 | When this is non-nil, call the 'man' program synchronously rather than | 691 | When this is non-nil, run the 'man' command synchronously rather than |
| 692 | asynchronously (which is the default behavior). | 692 | asynchronously (which is the default behavior). |
| 693 | 693 | ||
| 694 | +++ | 694 | +++ |
| 695 | *** New user option 'Man-support-remote-systems'. | 695 | *** New user option 'Man-support-remote-systems'. |
| 696 | If the user option 'Man-support-remote-systems' is non-nil, and | 696 | This option controls whether the man page is taken from the remote |
| 697 | 'default-directory' indicates a remote system, the man page is taken | 697 | system when the current buffer is remote. You can invoke the 'man' |
| 698 | from the remote system. Calling the 'man' command with a prefix like | 698 | command with a prefix argument to reverse the value of this option |
| 699 | 'C-u M-x man' reverts the value of 'Man-support-remote-systems' for | 699 | only for the current invocation. |
| 700 | that call. | ||
| 701 | 700 | ||
| 702 | ** DocView | 701 | ** DocView |
| 703 | 702 | ||
| @@ -1011,7 +1010,7 @@ A major mode based on the tree-sitter library for editing Lua files. | |||
| 1011 | 1010 | ||
| 1012 | *** New commands 'previous-line-completion' and 'next-line-completion'. | 1011 | *** New commands 'previous-line-completion' and 'next-line-completion'. |
| 1013 | Bound to '<UP>' and '<DOWN>' arrow keys, respectively, they navigate | 1012 | Bound to '<UP>' and '<DOWN>' arrow keys, respectively, they navigate |
| 1014 | the *Completions* buffer vertically by lines, wrapping at the | 1013 | the "*Completions*" buffer vertically by lines, wrapping at the |
| 1015 | top/bottom when 'completion-auto-wrap' is non-nil. | 1014 | top/bottom when 'completion-auto-wrap' is non-nil. |
| 1016 | 1015 | ||
| 1017 | +++ | 1016 | +++ |
diff --git a/lisp/man.el b/lisp/man.el index d64a355e3d8..28c71ba1e06 100644 --- a/lisp/man.el +++ b/lisp/man.el | |||
| @@ -583,9 +583,10 @@ Otherwise, the value is whatever the function | |||
| 583 | "/bin/sh")) | 583 | "/bin/sh")) |
| 584 | 584 | ||
| 585 | (defun Man-header-file-path () | 585 | (defun Man-header-file-path () |
| 586 | "C Header file search path used in Man. | 586 | "Return the C header file search path that Man uses. |
| 587 | In the local case, it is the value of `Man-header-file-path'. | 587 | Normally, this is the value of the user option `Man-header-file-path', |
| 588 | Otherwise, it will be checked on the remote system." | 588 | but when the man page is retrieved from a remote system this |
| 589 | function tries to find the C header path on that system." | ||
| 589 | (let ((remote-id (file-remote-p default-directory))) | 590 | (let ((remote-id (file-remote-p default-directory))) |
| 590 | (if (null remote-id) | 591 | (if (null remote-id) |
| 591 | ;; The local case. | 592 | ;; The local case. |
| @@ -1088,11 +1089,9 @@ SPC character in the above examples, because this command attempts | |||
| 1088 | to auto-complete your input based on the installed manual pages. | 1089 | to auto-complete your input based on the installed manual pages. |
| 1089 | 1090 | ||
| 1090 | If `default-directory' is remote, and `Man-support-remote-systems' | 1091 | If `default-directory' is remote, and `Man-support-remote-systems' |
| 1091 | is non-nil, the man page will be formatted on the corresponding | 1092 | is non-nil, this command formats the man page on the remote system. |
| 1092 | remote system. | 1093 | A prefix argument reverses the value of `Man-support-remote-systems' |
| 1093 | 1094 | for the current call." | |
| 1094 | If `man' is called interactively with a prefix argument, the | ||
| 1095 | value of `Man-support-remote-systems' is reverted." | ||
| 1096 | 1095 | ||
| 1097 | (interactive | 1096 | (interactive |
| 1098 | (list (let* ((default-entry (Man-default-man-entry)) | 1097 | (list (let* ((default-entry (Man-default-man-entry)) |