* man.el (man): Revise docstring a bit to show -a and -l as

examples.  Add -k description since support for it has otherwise
been a secret.  (Further to bug#3717.)

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index a2710d59b7e5513a45bbf67a2ab93813f256ab62..28b4f29836c1812d728593b4c75d0c07178e8c7d 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -3,6 +3,10 @@
        * info-look.el (sh-mode): Look for coreutils new "Concept Index"
        node.  Keep previous "Index" name to work with past coreutils too.
 
+       * man.el (man): Revise docstring a bit to show -a and -l as
+       examples.  Add -k description since support for it has otherwise
+       been a secret.  (Further to bug#3717.)
+
 2009-12-26  Michael Albinus  <michael.albinus@gmx.de>
 
        * net/tramp.el (tramp-handle-insert-directory): Quote "'" in the

diff --git a/lisp/man.el b/lisp/man.el
index de827d89ef6a2fba836523ab6901fd0d92542044..c39621449f6787ba058b1ba194bf1bd8abab5af4 100644 (file)
--- a/lisp/man.el
+++ b/lisp/man.el
@@ -808,16 +808,39 @@ POS defaults to `point'."
 ;;;###autoload
 (defun man (man-args)
   "Get a Un*x manual page and put it in a buffer.
-This command is the top-level command in the man package.  It runs a Un*x
-command to retrieve and clean a manpage in the background and places the
-results in a Man mode (manpage browsing) buffer.  See variable
-`Man-notify-method' for what happens when the buffer is ready.
-If a buffer already exists for this man page, it will display immediately.
-
-To specify a man page from a certain section, type SUBJECT(SECTION) or
-SECTION SUBJECT when prompted for a manual entry.  To see manpages from
-all sections related to a subject, put something appropriate into the
-`Man-switches' variable, which see."
+This command is the top-level command in the man package.  It
+runs a Un*x command to retrieve and clean a manpage in the
+background and places the results in a `Man-mode' browsing
+buffer.  See variable `Man-notify-method' for what happens when
+the buffer is ready.  If a buffer already exists for this man
+page, it will display immediately.
+
+For a manpage from a particular section, use either of the
+following.  \"cat(1)\" is how cross-references appear and is
+passed to man as \"1 cat\".
+
+    cat(1)
+    1 cat
+
+To see manpages from all sections related to a subject, use an
+\"all pages\" option (which might be \"-a\" if it's not the
+default), then step through with `Man-next-manpage' (\\<Man-mode-map>\\[Man-next-manpage]) etc.
+Add to `Man-switches' to make this option permanent.
+
+    -a chmod
+
+An explicit filename can be given too.  Use -l if it might
+otherwise look like a page name.
+
+    /my/file/name.1.gz
+    -l somefile.1
+
+An \"apropos\" query with -k gives a buffer of matching page
+names or descriptions.  The pattern argument is usually an
+\"egrep\" style regexp.
+
+    -k pattern"
+
   (interactive
    (list (let* ((default-entry (Man-default-man-entry))
                ;; ignore case because that's friendly for bizarre