diff options
author | Stefan Kangas <stefankangas@gmail.com> | 2023-10-07 18:29:07 +0200 |
---|---|---|
committer | Stefan Kangas <stefankangas@gmail.com> | 2023-10-07 18:54:35 +0200 |
commit | 0590e3e69a9431b7ec024a61882f912c6083eb0c (patch) | |
tree | 2e50c8fed821d2cf73776b88aca8eda0b5baf1c1 | |
parent | 809da7fc9a1ca112ae7179112a5cec8dd557510e (diff) | |
download | emacs-0590e3e69a9431b7ec024a61882f912c6083eb0c.tar.gz |
Recommend `M-x man` in woman.el docs
* lisp/woman.el (Commentary, woman): Recommend using 'M-x man' where
available. The added sentence is copied from the emacs manual.
Ref: https://lists.gnu.org/r/emacs-devel/2023-10/msg00090.html
-rw-r--r-- | lisp/woman.el | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/lisp/woman.el b/lisp/woman.el index 92cd425d32f..2a71b8c1119 100644 --- a/lisp/woman.el +++ b/lisp/woman.el @@ -34,6 +34,10 @@ ;; the emulation is modified to include the reformatting done by the ;; Emacs `man' command. No hyphenation is performed. +;; Note that `M-x woman' doesn’t yet support the latest features of +;; modern man pages, so we recommend using `M-x man' if that is +;; available on your system. + ;; Advantages ;; Much more direct, does not require any external programs. @@ -1149,7 +1153,11 @@ speed. With a prefix argument, force the caches to be updated (e.g. to re-interpret the current directory). Used non-interactively, arguments are optional: if given then TOPIC -should be a topic string and non-nil RE-CACHE forces re-caching." +should be a topic string and non-nil RE-CACHE forces re-caching. + +Note that `M-x woman' doesn’t yet support the latest features of +modern man pages, so we recommend using `M-x man' if that is +available on your system." (interactive (list nil current-prefix-arg)) ;; The following test is for non-interactive calls via emacsclient, etc. (if (or (not (stringp topic)) (string-match-p "\\S " topic)) |