diff options
author | Michael Albinus <michael.albinus@gmx.de> | 2023-11-02 12:14:13 +0100 |
---|---|---|
committer | Michael Albinus <michael.albinus@gmx.de> | 2023-11-02 12:14:13 +0100 |
commit | f5b2d23fff6e77ab71e028c84e73b3a792c430bd (patch) | |
tree | 06d94f09770ba0e84bb3b89cd9c94b24800a96a7 /lisp/man.el | |
parent | cb92eb404d73feca21666d2de1dd54b41fe34c53 (diff) | |
download | emacs-f5b2d23fff6e77ab71e028c84e73b3a792c430bd.tar.gz |
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.
Diffstat (limited to 'lisp/man.el')
-rw-r--r-- | lisp/man.el | 15 |
1 files changed, 7 insertions, 8 deletions
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 "/bin/sh")) (defun Man-header-file-path () - "C Header file search path used in Man. -In the local case, it is the value of `Man-header-file-path'. -Otherwise, it will be checked on the remote system." + "Return the C header file search path that Man uses. +Normally, this is the value of the user option `Man-header-file-path', +but when the man page is retrieved from a remote system this +function tries to find the C header path on that system." (let ((remote-id (file-remote-p default-directory))) (if (null remote-id) ;; The local case. @@ -1088,11 +1089,9 @@ SPC character in the above examples, because this command attempts to auto-complete your input based on the installed manual pages. If `default-directory' is remote, and `Man-support-remote-systems' -is non-nil, the man page will be formatted on the corresponding -remote system. - -If `man' is called interactively with a prefix argument, the -value of `Man-support-remote-systems' is reverted." +is non-nil, this command formats the man page on the remote system. +A prefix argument reverses the value of `Man-support-remote-systems' +for the current call." (interactive (list (let* ((default-entry (Man-default-man-entry)) |