lisp/man.el

   1 ;;; man.el --- browse UNIX manual pages -*- coding: iso-8859-1 -*-
   2
   3 ;; Copyright (C) 1993, 1994, 1996, 1997, 2001, 2002, 2003,
   4 ;;   2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
   5
   6 ;; Author: Barry A. Warsaw <bwarsaw@cen.com>
   7 ;; Maintainer: FSF
   8 ;; Keywords: help
   9 ;; Adapted-By: ESR, pot
  10
  11 ;; This file is part of GNU Emacs.
  12
  13 ;; GNU Emacs is free software: you can redistribute it and/or modify
  14 ;; it under the terms of the GNU General Public License as published by
  15 ;; the Free Software Foundation, either version 3 of the License, or
  16 ;; (at your option) any later version.
  17
  18 ;; GNU Emacs is distributed in the hope that it will be useful,
  19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 ;; GNU General Public License for more details.
  22
  23 ;; You should have received a copy of the GNU General Public License
  24 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  25
  26 ;;; Commentary:
  27
  28 ;; This code provides a function, `man', with which you can browse
  29 ;; UNIX manual pages.  Formatting is done in background so that you
  30 ;; can continue to use your Emacs while processing is going on.
  31 ;;
  32 ;; The mode also supports hypertext-like following of manual page SEE
  33 ;; ALSO references, and other features.  See below or do `?' in a
  34 ;; manual page buffer for details.
  35
  36 ;; ========== Credits and History ==========
  37 ;; In mid 1991, several people posted some interesting improvements to
  38 ;; man.el from the standard Emacs 18.57 distribution.  I liked many of
  39 ;; these, but wanted everything in one single package, so I decided
  40 ;; to incorporate them into a single manual browsing mode.  While
  41 ;; much of the code here has been rewritten, and some features added,
  42 ;; these folks deserve lots of credit for providing the initial
  43 ;; excellent packages on which this one is based.
  44
  45 ;; Nick Duffek <duffek@chaos.cs.brandeis.edu>, posted a very nice
  46 ;; improvement which retrieved and cleaned the manpages in a
  47 ;; background process, and which correctly deciphered such options as
  48 ;; man -k.
  49
  50 ;; Eric Rose <erose@jessica.stanford.edu>, submitted manual.el which
  51 ;; provided a very nice manual browsing mode.
  52
  53 ;; This package was available as `superman.el' from the LCD package
  54 ;; for some time before it was accepted into Emacs 19.  The entry
  55 ;; point and some other names have been changed to make it a drop-in
  56 ;; replacement for the old man.el package.
  57
  58 ;; Francesco Potorti` <pot@cnuce.cnr.it> cleaned it up thoroughly,
  59 ;; making it faster, more robust and more tolerant of different
  60 ;; systems' man idiosyncrasies.
  61
  62 ;; ========== Features ==========
  63 ;; + Runs "man" in the background and pipes the results through a
  64 ;;   series of sed and awk scripts so that all retrieving and cleaning
  65 ;;   is done in the background.  The cleaning commands are configurable.
  66 ;; + Syntax is the same as Un*x man
  67 ;; + Functionality is the same as Un*x man, including "man -k" and
  68 ;;   "man <section>", etc.
  69 ;; + Provides a manual browsing mode with keybindings for traversing
  70 ;;   the sections of a manpage, following references in the SEE ALSO
  71 ;;   section, and more.
  72 ;; + Multiple manpages created with the same man command are put into
  73 ;;   a narrowed buffer circular list.
  74
  75 ;; ============= TODO ===========
  76 ;; - Add a command for printing.
  77 ;; - The awk script deletes multiple blank lines.  This behaviour does
  78 ;;   not allow to understand if there was indeed a blank line at the
  79 ;;   end or beginning of a page (after the header, or before the
  80 ;;   footer).  A different algorithm should be used.  It is easy to
  81 ;;   compute how many blank lines there are before and after the page
  82 ;;   headers, and after the page footer.  But it is possible to compute
  83 ;;   the number of blank lines before the page footer by heuristics
  84 ;;   only.  Is it worth doing?
  85 ;; - Allow a user option to mean that all the manpages should go in
  86 ;;   the same buffer, where they can be browsed with M-n and M-p.
  87 ;; - Allow completion on the manpage name when calling man.  This
  88 ;;   requires a reliable list of places where manpages can be found.  The
  89 ;;   drawback would be that if the list is not complete, the user might
  90 ;;   be led to believe that the manpages in the missing directories do
  91 ;;   not exist.
  92
  93 \f
  94 ;;; Code:
  95
  96 (eval-when-compile (require 'cl))
  97 (require 'assoc)
  98 (require 'button)
  99
 100 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
 101 ;; empty defvars (keep the compiler quiet)
 102
 103 (defgroup man nil
 104   "Browse UNIX manual pages."
 105   :prefix "Man-"
 106   :group 'help)
 107
 108
 109 (defvar Man-notify)
 110 (defcustom Man-filter-list nil
 111   "*Manpage cleaning filter command phrases.
 112 This variable contains a list of the following form:
 113
 114 '((command-string phrase-string*)*)
 115
 116 Each phrase-string is concatenated onto the command-string to form a
 117 command filter.  The (standard) output (and standard error) of the Un*x
 118 man command is piped through each command filter in the order the
 119 commands appear in the association list.  The final output is placed in
 120 the manpage buffer."
 121   :type '(repeat (list (string :tag "Command String")
 122                        (repeat :inline t
 123                                (string :tag "Phrase String"))))
 124   :group 'man)
 125
 126 (defvar Man-uses-untabify-flag t
 127   "Non-nil means use `untabify' instead of `Man-untabify-command'.")
 128 (defvar Man-sed-script nil
 129   "Script for sed to nuke backspaces and ANSI codes from manpages.")
 130
 131 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
 132 ;; user variables
 133
 134 (defcustom Man-fontify-manpage-flag t
 135   "Non-nil means make up the manpage with fonts."
 136   :type 'boolean
 137   :group 'man)
 138
 139 (defcustom Man-overstrike-face 'bold
 140   "Face to use when fontifying overstrike."
 141   :type 'face
 142   :group 'man)
 143
 144 (defcustom Man-underline-face 'underline
 145   "Face to use when fontifying underlining."
 146   :type 'face
 147   :group 'man)
 148
 149 (defcustom Man-reverse-face 'highlight
 150   "Face to use when fontifying reverse video."
 151   :type 'face
 152   :group 'man)
 153
 154 ;; Use the value of the obsolete user option Man-notify, if set.
 155 (defcustom Man-notify-method (if (boundp 'Man-notify) Man-notify 'friendly)
 156   "Selects the behavior when manpage is ready.
 157 This variable may have one of the following values, where (sf) means
 158 that the frames are switched, so the manpage is displayed in the frame
 159 where the man command was called from:
 160
 161 newframe   -- put the manpage in its own frame (see `Man-frame-parameters')
 162 pushy      -- make the manpage the current buffer in the current window
 163 bully      -- make the manpage the current buffer and only window (sf)
 164 aggressive -- make the manpage the current buffer in the other window (sf)
 165 friendly   -- display manpage in the other window but don't make current (sf)
 166 polite     -- don't display manpage, but prints message and beep when ready
 167 quiet      -- like `polite', but don't beep
 168 meek       -- make no indication that the manpage is ready
 169
 170 Any other value of `Man-notify-method' is equivalent to `meek'."
 171   :type '(radio (const newframe) (const pushy) (const bully)
 172                 (const aggressive) (const friendly)
 173                 (const polite) (const quiet) (const meek))
 174   :group 'man)
 175
 176 (defcustom Man-width nil
 177   "Number of columns for which manual pages should be formatted.
 178 If nil, the width of the window selected at the moment of man
 179 invocation is used.  If non-nil, the width of the frame selected
 180 at the moment of man invocation is used.  The value also can be a
 181 positive integer."
 182   :type '(choice (const :tag "Window width" nil)
 183                  (const :tag "Frame width" t)
 184                  (integer :tag "Specific width" :value 65))
 185   :group 'man)
 186
 187 (defcustom Man-frame-parameters nil
 188   "Frame parameter list for creating a new frame for a manual page."
 189   :type 'sexp
 190   :group 'man)
 191
 192 (defcustom Man-downcase-section-letters-flag t
 193   "Non-nil means letters in sections are converted to lower case.
 194 Some Un*x man commands can't handle uppercase letters in sections, for
 195 example \"man 2V chmod\", but they are often displayed in the manpage
 196 with the upper case letter.  When this variable is t, the section
 197 letter (e.g., \"2V\") is converted to lowercase (e.g., \"2v\") before
 198 being sent to the man background process."
 199   :type 'boolean
 200   :group 'man)
 201
 202 (defcustom Man-circular-pages-flag t
 203   "Non-nil means the manpage list is treated as circular for traversal."
 204   :type 'boolean
 205   :group 'man)
 206
 207 (defcustom Man-section-translations-alist
 208   (list
 209    '("3C++" . "3")
 210    ;; Some systems have a real 3x man section, so let's comment this.
 211    ;; '("3X" . "3")                        ; Xlib man pages
 212    '("3X11" . "3")
 213    '("1-UCB" . ""))
 214   "Association list of bogus sections to real section numbers.
 215 Some manpages (e.g. the Sun C++ 2.1 manpages) have section numbers in
 216 their references which Un*x `man' does not recognize.  This
 217 association list is used to translate those sections, when found, to
 218 the associated section number."
 219   :type '(repeat (cons (string :tag "Bogus Section")
 220                        (string :tag "Real Section")))
 221   :group 'man)
 222
 223 (defcustom Man-header-file-path
 224   '("/usr/include" "/usr/local/include")
 225   "C Header file search path used in Man."
 226   :type '(repeat string)
 227   :group 'man)
 228
 229 (defvar manual-program "man"
 230   "The name of the program that produces man pages.")
 231
 232 (defvar Man-untabify-command "pr"
 233   "Command used for untabifying.")
 234
 235 (defvar Man-untabify-command-args (list "-t" "-e")
 236   "List of arguments to be passed to `Man-untabify-command' (which see).")
 237
 238 (defvar Man-sed-command "sed"
 239   "Command used for processing sed scripts.")
 240
 241 (defvar Man-awk-command "awk"
 242   "Command used for processing awk scripts.")
 243
 244 (defvar Man-mode-hook nil
 245   "Hook run when Man mode is enabled.")
 246
 247 (defvar Man-cooked-hook nil
 248   "Hook run after removing backspaces but before `Man-mode' processing.")
 249
 250 (defvar Man-name-regexp "[-a-zA-Z0-9_+][-a-zA-Z0-9_.:+]*"
 251   "Regular expression describing the name of a manpage (without section).")
 252
 253 (defvar Man-section-regexp "[0-9][a-zA-Z0-9+]*\\|[LNln]"
 254   "Regular expression describing a manpage section within parentheses.")
 255
 256 (defvar Man-page-header-regexp
 257   (if (and (string-match "-solaris2\\." system-configuration)
 258            (not (string-match "-solaris2\\.[123435]$" system-configuration)))
 259       (concat "^[-A-Za-z0-9_].*[ \t]\\(" Man-name-regexp
 260               "(\\(" Man-section-regexp "\\))\\)$")
 261     (concat "^[ \t]*\\(" Man-name-regexp
 262             "(\\(" Man-section-regexp "\\))\\).*\\1"))
 263   "Regular expression describing the heading of a page.")
 264
 265 (defvar Man-heading-regexp "^\\([A-Z][A-Z0-9 /-]+\\)$"
 266   "Regular expression describing a manpage heading entry.")
 267
 268 (defvar Man-see-also-regexp "SEE ALSO"
 269   "Regular expression for SEE ALSO heading (or your equivalent).
 270 This regexp should not start with a `^' character.")
 271
 272 ;; This used to have leading space [ \t]*, but was removed because it
 273 ;; causes false page splits on an occasional NAME with leading space
 274 ;; inside a manpage.  And `Man-heading-regexp' doesn't have [ \t]* anyway.
 275 (defvar Man-first-heading-regexp "^NAME$\\|^[ \t]*No manual entry fo.*$"
 276   "Regular expression describing first heading on a manpage.
 277 This regular expression should start with a `^' character.")
 278
 279 (defvar Man-reference-regexp
 280   (concat "\\(" Man-name-regexp "\\)[ \t]*(\\(" Man-section-regexp "\\))")
 281   "Regular expression describing a reference to another manpage.")
 282
 283 (defvar Man-apropos-regexp
 284   (concat "\\\[\\(" Man-name-regexp "\\)\\\][ \t]*(\\(" Man-section-regexp "\\))")
 285   "Regular expression describing a reference to manpages in \"man -k output\".")
 286
 287 (defvar Man-synopsis-regexp "SYNOPSIS"
 288   "Regular expression for SYNOPSIS heading (or your equivalent).
 289 This regexp should not start with a `^' character.")
 290
 291 (defvar Man-files-regexp "FILES"
 292   "Regular expression for FILES heading (or your equivalent).
 293 This regexp should not start with a `^' character.")
 294
 295 (defvar Man-include-regexp "#[ \t]*include[ \t]*"
 296   "Regular expression describing the #include (directive of cpp).")
 297
 298 (defvar Man-file-name-regexp "[^<>\", \t\n]+"
 299   "Regular expression describing <> in #include line (directive of cpp).")
 300
 301 (defvar Man-normal-file-prefix-regexp "[/~$]"
 302   "Regular expression describing a file path appeared in FILES section.")
 303
 304 (defvar Man-header-regexp
 305   (concat "\\(" Man-include-regexp "\\)"
 306           "[<\"]"
 307           "\\(" Man-file-name-regexp "\\)"
 308           "[>\"]")
 309   "Regular expression describing references to header files.")
 310
 311 (defvar Man-normal-file-regexp
 312   (concat Man-normal-file-prefix-regexp Man-file-name-regexp)
 313   "Regular expression describing references to normal files.")
 314
 315 ;; This includes the section as an optional part to catch hyphenated
 316 ;; refernces to manpages.
 317 (defvar Man-hyphenated-reference-regexp
 318   (concat "\\(" Man-name-regexp "\\)\\((\\(" Man-section-regexp "\\))\\)?")
 319   "Regular expression describing a reference in the SEE ALSO section.")
 320
 321 (defvar Man-switches ""
 322   "Switches passed to the man command, as a single string.
 323
 324 If you want to be able to see all the manpages for a subject you type,
 325 make -a one of the switches, if your `man' program supports it.")
 326
 327 (defvar Man-specified-section-option
 328   (if (string-match "-solaris[0-9.]*$" system-configuration)
 329       "-s"
 330     "")
 331   "Option that indicates a specified a manual section name.")
 332
 333 (defvar Man-support-local-filenames 'auto-detect
 334   "Internal cache for the value of the function `Man-support-local-filenames'.
 335 `auto-detect' means the value is not yet determined.
 336 Otherwise, the value is whatever the function
 337 `Man-support-local-filenames' should return.")
 338
 339 ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 340 ;; end user variables
 341 \f
 342 ;; other variables and keymap initializations
 343 (defvar Man-original-frame)
 344 (make-variable-buffer-local 'Man-original-frame)
 345 (defvar Man-arguments)
 346 (make-variable-buffer-local 'Man-arguments)
 347 (put 'Man-arguments 'permanent-local t)
 348
 349 (defvar Man-sections-alist nil)
 350 (make-variable-buffer-local 'Man-sections-alist)
 351 (defvar Man-refpages-alist nil)
 352 (make-variable-buffer-local 'Man-refpages-alist)
 353 (defvar Man-page-list nil)
 354 (make-variable-buffer-local 'Man-page-list)
 355 (defvar Man-current-page 0)
 356 (make-variable-buffer-local 'Man-current-page)
 357 (defvar Man-page-mode-string "1 of 1")
 358 (make-variable-buffer-local 'Man-page-mode-string)
 359
 360 (defconst Man-sysv-sed-script "\
 361 /\b/ {  s/_\b//g
 362         s/\b_//g
 363         s/o\b+/o/g
 364         s/+\bo/o/g
 365         :ovstrk
 366         s/\\(.\\)\b\\1/\\1/g
 367         t ovstrk
 368         }
 369 /\e\\[[0-9][0-9]*m/ s///g"
 370   "Script for sysV-like sed to nuke backspaces and ANSI codes from manpages.")
 371
 372 (defconst Man-berkeley-sed-script "\
 373 /\b/ {  s/_\b//g\\
 374         s/\b_//g\\
 375         s/o\b+/o/g\\
 376         s/+\bo/o/g\\
 377         :ovstrk\\
 378         s/\\(.\\)\b\\1/\\1/g\\
 379         t ovstrk\\
 380         }\\
 381 /\e\\[[0-9][0-9]*m/ s///g"
 382   "Script for berkeley-like sed to nuke backspaces and ANSI codes from manpages.")
 383
 384 (defvar Man-topic-history nil "Topic read history.")
 385
 386 (defvar man-mode-syntax-table
 387   (let ((table (copy-syntax-table (standard-syntax-table))))
 388     (modify-syntax-entry ?. "w" table)
 389     (modify-syntax-entry ?_ "w" table)
 390     (modify-syntax-entry ?: "w" table)  ; for PDL::Primitive in Perl man pages
 391     table)
 392   "Syntax table used in Man mode buffers.")
 393
 394 (defvar Man-mode-map
 395   (let ((map (make-sparse-keymap)))
 396     (suppress-keymap map)
 397     (set-keymap-parent map button-buffer-map)
 398
 399     (define-key map " "    'scroll-up)
 400     (define-key map "\177" 'scroll-down)
 401     (define-key map "n"    'Man-next-section)
 402     (define-key map "p"    'Man-previous-section)
 403     (define-key map "\en"  'Man-next-manpage)
 404     (define-key map "\ep"  'Man-previous-manpage)
 405     (define-key map ">"    'end-of-buffer)
 406     (define-key map "<"    'beginning-of-buffer)
 407     (define-key map "."    'beginning-of-buffer)
 408     (define-key map "r"    'Man-follow-manual-reference)
 409     (define-key map "g"    'Man-goto-section)
 410     (define-key map "s"    'Man-goto-see-also-section)
 411     (define-key map "k"    'Man-kill)
 412     (define-key map "q"    'Man-quit)
 413     (define-key map "m"    'man)
 414     ;; Not all the man references get buttons currently.  The text in the
 415     ;; manual page can contain references to other man pages
 416     (define-key map "\r"   'man-follow)
 417     (define-key map "?"    'describe-mode)
 418     map)
 419   "Keymap for Man mode.")
 420
 421 ;; buttons
 422 (define-button-type 'Man-abstract-xref-man-page
 423   'follow-link t
 424   'help-echo "mouse-2, RET: display this man page"
 425   'func nil
 426   'action #'Man-xref-button-action)
 427
 428 (defun Man-xref-button-action (button)
 429   (let ((target (button-get button 'Man-target-string)))
 430     (funcall
 431      (button-get button 'func)
 432      (cond ((null target)
 433             (button-label button))
 434            ((functionp target)
 435             (funcall target (button-start button)))
 436            (t target)))))
 437
 438 (define-button-type 'Man-xref-man-page
 439   :supertype 'Man-abstract-xref-man-page
 440   'func 'man-follow)
 441
 442
 443 (define-button-type 'Man-xref-header-file
 444     'action (lambda (button)
 445               (let ((w (button-get button 'Man-target-string)))
 446                 (unless (Man-view-header-file w)
 447                   (error "Cannot find header file: %s" w))))
 448     'follow-link t
 449     'help-echo "mouse-2: display this header file")
 450
 451 (define-button-type 'Man-xref-normal-file
 452   'action (lambda (button)
 453             (let ((f (substitute-in-file-name
 454                       (button-get button 'Man-target-string))))
 455               (if (file-exists-p f)
 456                   (if (file-readable-p f)
 457                       (view-file f)
 458                     (error "Cannot read a file: %s" f))
 459                 (error "Cannot find a file: %s" f))))
 460   'follow-link t
 461   'help-echo "mouse-2: display this file")
 462
 463 \f
 464 ;; ======================================================================
 465 ;; utilities
 466
 467 (defun Man-init-defvars ()
 468   "Used for initializing variables based on display's color support.
 469 This is necessary if one wants to dump man.el with Emacs."
 470
 471   ;; Avoid possible error in call-process by using a directory that must exist.
 472   (let ((default-directory "/"))
 473     (setq Man-sed-script
 474           (cond
 475            (Man-fontify-manpage-flag
 476             nil)
 477            ((eq 0 (call-process Man-sed-command nil nil nil Man-sysv-sed-script))
 478             Man-sysv-sed-script)
 479            ((eq 0 (call-process Man-sed-command nil nil nil Man-berkeley-sed-script))
 480             Man-berkeley-sed-script)
 481            (t
 482             nil))))
 483
 484   (setq Man-filter-list
 485         ;; Avoid trailing nil which confuses customize.
 486         (apply 'list
 487          (cons
 488           Man-sed-command
 489           (list
 490            (if Man-sed-script
 491                (concat "-e '" Man-sed-script "'")
 492              "")
 493            "-e '/^[\001-\032][\001-\032]*$/d'"
 494            "-e '/\e[789]/s///g'"
 495            "-e '/Reformatting page.  Wait/d'"
 496            "-e '/Reformatting entry.  Wait/d'"
 497            "-e '/^[ \t]*Hewlett-Packard[ \t]Company[ \t]*-[ \t][0-9]*[ \t]-/d'"
 498            "-e '/^[ \t]*Hewlett-Packard[ \t]*-[ \t][0-9]*[ \t]-.*$/d'"
 499            "-e '/^[ \t][ \t]*-[ \t][0-9]*[ \t]-[ \t]*Formatted:.*[0-9]$/d'"
 500            "-e '/^[ \t]*Page[ \t][0-9]*.*(printed[ \t][0-9\\/]*)$/d'"
 501            "-e '/^Printed[ \t][0-9].*[0-9]$/d'"
 502            "-e '/^[ \t]*X[ \t]Version[ \t]1[01].*Release[ \t][0-9]/d'"
 503            "-e '/^[A-Za-z].*Last[ \t]change:/d'"
 504            "-e '/^Sun[ \t]Release[ \t][0-9].*[0-9]$/d'"
 505            "-e '/[ \t]*Copyright [0-9]* UNIX System Laboratories, Inc.$/d'"
 506            "-e '/^[ \t]*Rev\\..*Page [0-9][0-9]*$/d'"
 507            ))
 508          (cons
 509           Man-awk-command
 510           (list
 511            "'\n"
 512            "BEGIN { blankline=0; anonblank=0; }\n"
 513            "/^$/ { if (anonblank==0) next; }\n"
 514            "{ anonblank=1; }\n"
 515            "/^$/ { blankline++; next; }\n"
 516            "{ if (blankline>0) { print \"\"; blankline=0; } print $0; }\n"
 517            "'"
 518            ))
 519          (if (not Man-uses-untabify-flag)
 520              ;; The outer list will be stripped off by apply.
 521              (list (cons
 522                     Man-untabify-command
 523                     Man-untabify-command-args))
 524            )))
 525 )
 526
 527 (defsubst Man-make-page-mode-string ()
 528   "Formats part of the mode line for Man mode."
 529   (format "%s page %d of %d"
 530           (or (nth 2 (nth (1- Man-current-page) Man-page-list))
 531               "")
 532           Man-current-page
 533           (length Man-page-list)))
 534
 535 (defsubst Man-build-man-command ()
 536   "Builds the entire background manpage and cleaning command."
 537   (let ((command (concat manual-program " " Man-switches
 538                          (cond
 539                           ;; Already has %s
 540                           ((string-match "%s" manual-program) "")
 541                           ;; Stock MS-DOS shells cannot redirect stderr;
 542                           ;; `call-process' below sends it to /dev/null,
 543                           ;; so we don't need `2>' even with DOS shells
 544                           ;; which do support stderr redirection.
 545                           ((not (fboundp 'start-process)) " %s")
 546                           ((concat " %s 2>" null-device)))))
 547         (flist Man-filter-list))
 548     (while (and flist (car flist))
 549       (let ((pcom (car (car flist)))
 550             (pargs (cdr (car flist))))
 551         (setq command
 552               (concat command " | " pcom " "
 553                       (mapconcat (lambda (phrase)
 554                                    (if (not (stringp phrase))
 555                                        (error "Malformed Man-filter-list"))
 556                                    phrase)
 557                                  pargs " ")))
 558         (setq flist (cdr flist))))
 559     command))
 560
 561
 562 (defun Man-translate-cleanup (string)
 563   "Strip leading, trailing and middle spaces."
 564   (when (stringp string)
 565     ;;  Strip leading and trailing
 566     (if (string-match "^[ \t\f\r\n]*\\(.+[^ \t\f\r\n]\\)" string)
 567         (setq string (match-string 1 string)))
 568     ;; middle spaces
 569     (setq string (replace-regexp-in-string "[\t\r\n]" " " string))
 570     (setq string (replace-regexp-in-string "  +" " " string))
 571     string))
 572
 573 (defun Man-translate-references (ref)
 574   "Translates REF from \"chmod(2V)\" to \"2v chmod\" style.
 575 Leave it as is if already in that style.  Possibly downcase and
 576 translate the section (see the `Man-downcase-section-letters-flag'
 577 and the `Man-section-translations-alist' variables)."
 578   (let ((name "")
 579         (section "")
 580         (slist Man-section-translations-alist))
 581     (setq ref (Man-translate-cleanup ref))
 582     (cond
 583      ;; "chmod(2V)" case ?
 584      ((string-match (concat "^" Man-reference-regexp "$") ref)
 585       (setq name (match-string 1 ref)
 586             section (match-string 2 ref)))
 587      ;; "2v chmod" case ?
 588      ((string-match (concat "^\\(" Man-section-regexp
 589                             "\\) +\\(" Man-name-regexp "\\)$") ref)
 590       (setq name (match-string 2 ref)
 591             section (match-string 1 ref))))
 592     (if (string= name "")
 593         ref                             ; Return the reference as is
 594       (if Man-downcase-section-letters-flag
 595           (setq section (downcase section)))
 596       (while slist
 597         (let ((s1 (car (car slist)))
 598               (s2 (cdr (car slist))))
 599           (setq slist (cdr slist))
 600           (if Man-downcase-section-letters-flag
 601               (setq s1 (downcase s1)))
 602           (if (not (string= s1 section)) nil
 603             (setq section (if Man-downcase-section-letters-flag
 604                               (downcase s2)
 605                             s2)
 606                   slist nil))))
 607       (concat Man-specified-section-option section " " name))))
 608
 609 (defun Man-support-local-filenames ()
 610   "Check the availability of `-l' option of the man command.
 611 This option allows `man' to interpret command line arguments
 612 as local filenames.
 613 Return the value of the variable `Man-support-local-filenames'
 614 if it was set to nil or t before the call of this function.
 615 If t, the man command supports `-l' option.  If nil, it doesn't.
 616 Otherwise, if the value of `Man-support-local-filenames'
 617 is neither t nor nil, then determine a new value, set it
 618 to the variable `Man-support-local-filenames' and return
 619 a new value."
 620   (if (or (not Man-support-local-filenames)
 621           (eq Man-support-local-filenames t))
 622       Man-support-local-filenames
 623     (setq Man-support-local-filenames
 624           (with-temp-buffer
 625             (and (equal (condition-case nil
 626                             (let ((default-directory
 627                                     ;; Assure that `default-directory' exists
 628                                     ;; and is readable.
 629                                     (if (and (file-directory-p default-directory)
 630                                              (file-readable-p default-directory))
 631                                         default-directory
 632                                       (expand-file-name "~/"))))
 633                               (call-process manual-program nil t nil "--help"))
 634                           (error nil))
 635                         0)
 636                  (progn
 637                    (goto-char (point-min))
 638                    (search-forward "--local-file" nil t))
 639                  t)))))
 640
 641 \f
 642 ;; ======================================================================
 643 ;; default man entry: get word near point
 644
 645 (defun Man-default-man-entry (&optional pos)
 646   "Guess default manual entry based on the text near position POS.
 647 POS defaults to `point'."
 648   (let (word start pos column distance)
 649     (save-excursion
 650       (when pos (goto-char pos))
 651       (setq pos (point))
 652       ;; The default title is the nearest entry-like object before or
 653       ;; after POS.
 654       (if (and (skip-chars-backward " \ta-zA-Z0-9+")
 655                (not (zerop (skip-chars-backward "(")))
 656                ;; Try to handle the special case where POS is on a
 657                ;; section number.
 658                (looking-at
 659                 (concat "([ \t]*\\(" Man-section-regexp "\\)[ \t]*)"))
 660                ;; We skipped a valid section number backwards, look at
 661                ;; preceding text.
 662                (or (and (skip-chars-backward ",; \t")
 663                         (not (zerop (skip-chars-backward "-a-zA-Z0-9._+:"))))
 664                    ;; Not a valid entry, move POS after closing paren.
 665                    (not (setq pos (match-end 0)))))
 666           ;; We have a candidate, make `start' record its starting
 667           ;; position.
 668           (setq start (point))
 669         ;; Otherwise look at char before POS.
 670         (goto-char pos)
 671         (if (not (zerop (skip-chars-backward "-a-zA-Z0-9._+:")))
 672             ;; Our candidate is just before or around POS.
 673             (setq start (point))
 674           ;; Otherwise record the current column and look backwards.
 675           (setq column (current-column))
 676           (skip-chars-backward ",; \t")
 677           ;; Record the distance travelled.
 678           (setq distance (- column (current-column)))
 679           (when (looking-back
 680                  (concat "([ \t]*\\(?:" Man-section-regexp "\\)[ \t]*)"))
 681             ;; Skip section number backwards.
 682             (goto-char (match-beginning 0))
 683             (skip-chars-backward " \t"))
 684           (if (not (zerop (skip-chars-backward "-a-zA-Z0-9._+:")))
 685               (progn
 686                 ;; We have a candidate before POS ...
 687                 (setq start (point))
 688                 (goto-char pos)
 689                 (if (and (skip-chars-forward ",; \t")
 690                          (< (- (current-column) column) distance)
 691                          (looking-at "[-a-zA-Z0-9._+:]"))
 692                     ;; ... but the one after POS is better.
 693                     (setq start (point))
 694                   ;; ... and anything after POS is worse.
 695                   (goto-char start)))
 696             ;; No candidate before POS.
 697             (goto-char pos)
 698             (skip-chars-forward ",; \t")
 699             (setq start (point)))))
 700       ;; We have found a suitable starting point, try to skip at least
 701       ;; one character.
 702       (skip-chars-forward "-a-zA-Z0-9._+:")
 703       (setq word (buffer-substring-no-properties start (point)))
 704       ;; If there is a continuation at the end of line, check the
 705       ;; following line too, eg:
 706       ;;     see this-
 707       ;;     command-here(1)
 708       ;; Note: This code gets executed iff our entry is after POS.
 709       (when (looking-at "[ \t\r\n]+\\([-a-zA-Z0-9._+:]+\\)([0-9])")
 710         (setq word (concat word (match-string-no-properties 1)))
 711         ;; Make sure the section number gets included by the code below.
 712         (goto-char (match-end 1)))
 713       (when (string-match "[._]+$" word)
 714         (setq word (substring word 0 (match-beginning 0))))
 715       ;; The following was commented out since the preceding code
 716       ;; should not produce a leading "*" in the first place.
 717 ;;;       ;; If looking at something like *strcat(... , remove the '*'
 718 ;;;       (when (string-match "^*" word)
 719 ;;;     (setq word (substring word 1)))
 720         (concat
 721          word
 722          (and (not (string-equal word ""))
 723               ;; If looking at something like ioctl(2) or brc(1M),
 724               ;; include the section number in the returned value.
 725               (looking-at
 726                (concat "[ \t]*([ \t]*\\(" Man-section-regexp "\\)[ \t]*)"))
 727               (format "(%s)" (match-string-no-properties 1)))))))
 728
 729 \f
 730 ;; ======================================================================
 731 ;; Top level command and background process sentinel
 732
 733 ;; For compatibility with older versions.
 734 ;;;###autoload
 735 (defalias 'manual-entry 'man)
 736
 737
 738 ;;;###autoload
 739 (defun man (man-args)
 740   "Get a Un*x manual page and put it in a buffer.
 741 This command is the top-level command in the man package.  It runs a Un*x
 742 command to retrieve and clean a manpage in the background and places the
 743 results in a Man mode (manpage browsing) buffer.  See variable
 744 `Man-notify-method' for what happens when the buffer is ready.
 745 If a buffer already exists for this man page, it will display immediately.
 746
 747 To specify a man page from a certain section, type SUBJECT(SECTION) or
 748 SECTION SUBJECT when prompted for a manual entry.  To see manpages from
 749 all sections related to a subject, put something appropriate into the
 750 `Man-switches' variable, which see."
 751   (interactive
 752    (list (let* ((default-entry (Man-default-man-entry))
 753                 (input (read-string
 754                         (format "Manual entry%s"
 755                                 (if (string= default-entry "")
 756                                     ": "
 757                                   (format " (default %s): " default-entry)))
 758                         nil 'Man-topic-history default-entry)))
 759            (if (string= input "")
 760                (error "No man args given")
 761              input))))
 762
 763   ;; Possibly translate the "subject(section)" syntax into the
 764   ;; "section subject" syntax and possibly downcase the section.
 765   (setq man-args (Man-translate-references man-args))
 766
 767   (Man-getpage-in-background man-args))
 768
 769 ;;;###autoload
 770 (defun man-follow (man-args)
 771   "Get a Un*x manual page of the item under point and put it in a buffer."
 772   (interactive (list (Man-default-man-entry)))
 773   (if (or (not man-args)
 774           (string= man-args ""))
 775       (error "No item under point")
 776     (man man-args)))
 777
 778 (defun Man-getpage-in-background (topic)
 779   "Use TOPIC to build and fire off the manpage and cleaning command."
 780   (let* ((man-args topic)
 781          (bufname (concat "*Man " man-args "*"))
 782          (buffer  (get-buffer bufname)))
 783     (if buffer
 784         (Man-notify-when-ready buffer)
 785       (require 'env)
 786       (message "Invoking %s %s in the background" manual-program man-args)
 787       (setq buffer (generate-new-buffer bufname))
 788       (with-current-buffer buffer
 789         (setq buffer-undo-list t)
 790         (setq Man-original-frame (selected-frame))
 791         (setq Man-arguments man-args))
 792       (let ((process-environment (copy-sequence process-environment))
 793             ;; The following is so Awk script gets \n intact
 794             ;; But don't prevent decoding of the outside.
 795             (coding-system-for-write 'raw-text-unix)
 796             ;; We must decode the output by a coding system that the
 797             ;; system's locale suggests in multibyte mode.
 798             (coding-system-for-read
 799              (if default-enable-multibyte-characters
 800                  locale-coding-system 'raw-text-unix))
 801             ;; Avoid possible error by using a directory that always exists.
 802             (default-directory
 803               (if (and (file-directory-p default-directory)
 804                        (not (find-file-name-handler default-directory
 805                                                     'file-directory-p)))
 806                   default-directory
 807                 "/")))
 808         ;; Prevent any attempt to use display terminal fanciness.
 809         (setenv "TERM" "dumb")
 810         ;; In Debian Woody, at least, we get overlong lines under X
 811         ;; unless COLUMNS or MANWIDTH is set.  This isn't a problem on
 812         ;; a tty.  man(1) says:
 813         ;;        MANWIDTH
 814         ;;               If $MANWIDTH is set, its value is used as the  line
 815         ;;               length  for which manual pages should be formatted.
 816         ;;               If it is not set, manual pages  will  be  formatted
 817         ;;               with  a line length appropriate to the current ter-
 818         ;;               minal (using an ioctl(2) if available, the value of
 819         ;;               $COLUMNS,  or falling back to 80 characters if nei-
 820         ;;               ther is available).
 821         (unless (or (getenv "MANWIDTH") (getenv "COLUMNS"))
 822           ;; This isn't strictly correct, since we don't know how
 823           ;; the page will actually be displayed, but it seems
 824           ;; reasonable.
 825           (setenv "COLUMNS" (number-to-string
 826                              (cond
 827                               ((and (integerp Man-width) (> Man-width 0))
 828                                Man-width)
 829                               (Man-width (frame-width))
 830                               ((window-width))))))
 831         (setenv "GROFF_NO_SGR" "1")
 832         (if (fboundp 'start-process)
 833             (set-process-sentinel
 834              (start-process manual-program buffer
 835                             (if (memq system-type '(cygwin windows-nt))
 836                                 shell-file-name
 837                               "sh")
 838                             shell-command-switch
 839                             (format (Man-build-man-command) man-args))
 840              'Man-bgproc-sentinel)
 841           (let ((exit-status
 842                  (call-process shell-file-name nil (list buffer nil) nil
 843                                shell-command-switch
 844                                (format (Man-build-man-command) man-args)))
 845                 (msg ""))
 846             (or (and (numberp exit-status)
 847                      (= exit-status 0))
 848                 (and (numberp exit-status)
 849                      (setq msg
 850                            (format "exited abnormally with code %d"
 851                                    exit-status)))
 852                 (setq msg exit-status))
 853             (Man-bgproc-sentinel bufname msg)))))))
 854
 855 (defun Man-notify-when-ready (man-buffer)
 856   "Notify the user when MAN-BUFFER is ready.
 857 See the variable `Man-notify-method' for the different notification behaviors."
 858   (let ((saved-frame (with-current-buffer man-buffer
 859                        Man-original-frame)))
 860     (cond
 861      ((eq Man-notify-method 'newframe)
 862       ;; Since we run asynchronously, perhaps while Emacs is waiting
 863       ;; for input, we must not leave a different buffer current.  We
 864       ;; can't rely on the editor command loop to reselect the
 865       ;; selected window's buffer.
 866       (save-excursion
 867         (let ((frame (make-frame Man-frame-parameters)))
 868           (set-window-buffer (frame-selected-window frame) man-buffer)
 869           (set-window-dedicated-p (frame-selected-window frame) t)
 870           (or (display-multi-frame-p frame)
 871               (select-frame frame)))))
 872      ((eq Man-notify-method 'pushy)
 873       (switch-to-buffer man-buffer))
 874      ((eq Man-notify-method 'bully)
 875       (and (frame-live-p saved-frame)
 876            (select-frame saved-frame))
 877       (pop-to-buffer man-buffer)
 878       (delete-other-windows))
 879      ((eq Man-notify-method 'aggressive)
 880       (and (frame-live-p saved-frame)
 881            (select-frame saved-frame))
 882       (pop-to-buffer man-buffer))
 883      ((eq Man-notify-method 'friendly)
 884       (and (frame-live-p saved-frame)
 885            (select-frame saved-frame))
 886       (display-buffer man-buffer 'not-this-window))
 887      ((eq Man-notify-method 'polite)
 888       (beep)
 889       (message "Manual buffer %s is ready" (buffer-name man-buffer)))
 890      ((eq Man-notify-method 'quiet)
 891       (message "Manual buffer %s is ready" (buffer-name man-buffer)))
 892      ((or (eq Man-notify-method 'meek)
 893           t)
 894       (message ""))
 895      )))
 896
 897 (defun Man-softhyphen-to-minus ()
 898   ;; \255 is SOFT HYPHEN in Latin-N.  Versions of Debian man, at
 899   ;; least, emit it even when not in a Latin-N locale.
 900   (unless (eq t (compare-strings "latin-" 0 nil
 901                                  current-language-environment 0 6 t))
 902     (goto-char (point-min))
 903     (let ((str "\255"))
 904       (if enable-multibyte-characters
 905           (setq str (string-as-multibyte str)))
 906       (while (search-forward str nil t) (replace-match "-")))))
 907
 908 (defun Man-fontify-manpage ()
 909   "Convert overstriking and underlining to the correct fonts.
 910 Same for the ANSI bold and normal escape sequences."
 911   (interactive)
 912   (message "Please wait: formatting the %s man page..." Man-arguments)
 913   (goto-char (point-min))
 914   ;; Fontify ANSI escapes.
 915   (let ((faces nil)
 916         (buffer-undo-list t)
 917         (start (point)))
 918     ;; http://www.isthe.com/chongo/tech/comp/ansi_escapes.html
 919     ;; suggests many codes, but we only handle:
 920     ;; ESC [ 00 m       reset to normal display
 921     ;; ESC [ 01 m       bold
 922     ;; ESC [ 04 m       underline
 923     ;; ESC [ 07 m       reverse-video
 924     ;; ESC [ 22 m       no-bold
 925     ;; ESC [ 24 m       no-underline
 926     ;; ESC [ 27 m       no-reverse-video
 927     (while (re-search-forward "\e\\[0?\\([1470]\\|2\\([247]\\)\\)m" nil t)
 928       (if faces (put-text-property start (match-beginning 0) 'face
 929                                    (if (cdr faces) faces (car faces))))
 930       (setq faces
 931             (cond
 932              ((match-beginning 2)
 933               (delq (case (char-after (match-beginning 2))
 934                       (?2 Man-overstrike-face)
 935                       (?4 Man-underline-face)
 936                       (?7 Man-reverse-face))
 937                     faces))
 938              ((eq (char-after (match-beginning 1)) ?0) nil)
 939              (t
 940               (cons (case (char-after (match-beginning 1))
 941                       (?1 Man-overstrike-face)
 942                       (?4 Man-underline-face)
 943                       (?7 Man-reverse-face))
 944                     faces))))
 945       (delete-region (match-beginning 0) (match-end 0))
 946       (setq start (point))))
 947   ;; Other highlighting.
 948   (let ((buffer-undo-list t))
 949     (if (< (buffer-size) (position-bytes (point-max)))
 950         ;; Multibyte characters exist.
 951         (progn
 952           (goto-char (point-min))
 953           (while (search-forward "__\b\b" nil t)
 954             (backward-delete-char 4)
 955             (put-text-property (point) (1+ (point)) 'face Man-underline-face))
 956           (goto-char (point-min))
 957           (while (search-forward "\b\b__" nil t)
 958             (backward-delete-char 4)
 959             (put-text-property (1- (point)) (point) 'face Man-underline-face))))
 960     (goto-char (point-min))
 961     (while (search-forward "_\b" nil t)
 962       (backward-delete-char 2)
 963       (put-text-property (point) (1+ (point)) 'face Man-underline-face))
 964     (goto-char (point-min))
 965     (while (search-forward "\b_" nil t)
 966       (backward-delete-char 2)
 967       (put-text-property (1- (point)) (point) 'face Man-underline-face))
 968     (goto-char (point-min))
 969     (while (re-search-forward "\\(.\\)\\(\b+\\1\\)+" nil t)
 970       (replace-match "\\1")
 971       (put-text-property (1- (point)) (point) 'face Man-overstrike-face))
 972     (goto-char (point-min))
 973     (while (re-search-forward "o\b\\+\\|\\+\bo" nil t)
 974       (replace-match "o")
 975       (put-text-property (1- (point)) (point) 'face 'bold))
 976     (goto-char (point-min))
 977     (while (re-search-forward "[-|]\\(\b[-|]\\)+" nil t)
 978       (replace-match "+")
 979       (put-text-property (1- (point)) (point) 'face 'bold))
 980     (goto-char (point-min))
 981     ;; Try to recognize common forms of cross references.
 982     (Man-highlight-references)
 983     (Man-softhyphen-to-minus)
 984     (goto-char (point-min))
 985     (while (re-search-forward Man-heading-regexp nil t)
 986       (put-text-property (match-beginning 0)
 987                          (match-end 0)
 988                          'face Man-overstrike-face)))
 989   (message "%s man page formatted" Man-arguments))
 990
 991 (defun Man-highlight-references (&optional xref-man-type)
 992   "Highlight the references on mouse-over.
 993 References include items in the SEE ALSO section,
 994 header file (#include <foo.h>), and files in FILES.
 995 If optional argument XREF-MAN-TYPE is non-nil, it used as the
 996 button type for items in SEE ALSO section.  If it is nil, the
 997 default type, `Man-xref-man-page' is used for the buttons."
 998   ;; `Man-highlight-references' is used from woman.el, too.
 999   ;; woman.el doesn't set `Man-arguments'.
1000   (unless Man-arguments
1001     (setq Man-arguments ""))
1002   (if (string-match "-k " Man-arguments)
1003       (progn
1004         (Man-highlight-references0 nil Man-reference-regexp 1
1005                                    'Man-default-man-entry
1006                                    (or xref-man-type 'Man-xref-man-page))
1007         (Man-highlight-references0 nil Man-apropos-regexp 1
1008                                    'Man-default-man-entry
1009                                    (or xref-man-type 'Man-xref-man-page)))
1010     (Man-highlight-references0 Man-see-also-regexp Man-reference-regexp 1
1011                                'Man-default-man-entry
1012                                (or xref-man-type 'Man-xref-man-page))
1013     (Man-highlight-references0 Man-synopsis-regexp Man-header-regexp 0 2
1014                                'Man-xref-header-file)
1015     (Man-highlight-references0 Man-files-regexp Man-normal-file-regexp 0 0
1016                                'Man-xref-normal-file)))
1017
1018 (defun Man-highlight-references0 (start-section regexp button-pos target type)
1019   ;; Based on `Man-build-references-alist'
1020   (when (or (null start-section)
1021             (Man-find-section start-section))
1022     (let ((end (if start-section
1023                    (progn
1024                      (forward-line 1)
1025                      (back-to-indentation)
1026                      (save-excursion
1027                        (Man-next-section 1)
1028                        (point)))
1029                  (goto-char (point-min))
1030                  nil)))
1031       (while (re-search-forward regexp end t)
1032         (make-text-button
1033          (match-beginning button-pos)
1034          (match-end button-pos)
1035          'type type
1036          'Man-target-string (cond
1037                              ((numberp target)
1038                               (match-string target))
1039                              ((functionp target)
1040                               target)
1041                              (t nil)))))))
1042
1043 (defun Man-cleanup-manpage (&optional interactive)
1044   "Remove overstriking and underlining from the current buffer.
1045 Normally skip any jobs that should have been done by the sed script,
1046 but when called interactively, do those jobs even if the sed
1047 script would have done them."
1048   (interactive "p")
1049   (message "Please wait: cleaning up the %s man page..."
1050            Man-arguments)
1051   (if (or interactive (not Man-sed-script))
1052       (progn
1053         (goto-char (point-min))
1054         (while (search-forward "_\b" nil t) (backward-delete-char 2))
1055         (goto-char (point-min))
1056         (while (search-forward "\b_" nil t) (backward-delete-char 2))
1057         (goto-char (point-min))
1058         (while (re-search-forward "\\(.\\)\\(\b\\1\\)+" nil t)
1059           (replace-match "\\1"))
1060         (goto-char (point-min))
1061         (while (re-search-forward "\e\\[[0-9]+m" nil t) (replace-match ""))
1062         (goto-char (point-min))
1063         (while (re-search-forward "o\b\\+\\|\\+\bo" nil t) (replace-match "o"))
1064         ))
1065   (goto-char (point-min))
1066   (while (re-search-forward "[-|]\\(\b[-|]\\)+" nil t) (replace-match "+"))
1067   (Man-softhyphen-to-minus)
1068   (message "%s man page cleaned up" Man-arguments))
1069
1070 (defun Man-bgproc-sentinel (process msg)
1071   "Manpage background process sentinel.
1072 When manpage command is run asynchronously, PROCESS is the process
1073 object for the manpage command; when manpage command is run
1074 synchronously, PROCESS is the name of the buffer where the manpage
1075 command is run.  Second argument MSG is the exit message of the
1076 manpage command."
1077   (let ((Man-buffer (if (stringp process) (get-buffer process)
1078                       (process-buffer process)))
1079         (delete-buff nil)
1080         (err-mess nil))
1081
1082     (if (null (buffer-name Man-buffer)) ;; deleted buffer
1083         (or (stringp process)
1084             (set-process-buffer process nil))
1085
1086       (with-current-buffer Man-buffer
1087         (let ((case-fold-search nil))
1088           (goto-char (point-min))
1089           (cond ((or (looking-at "No \\(manual \\)*entry for")
1090                      (looking-at "[^\n]*: nothing appropriate$"))
1091                  (setq err-mess (buffer-substring (point)
1092                                                   (progn
1093                                                     (end-of-line) (point)))
1094                        delete-buff t))
1095                 ((or (stringp process)
1096                      (not (and (eq (process-status process) 'exit)
1097                                (= (process-exit-status process) 0))))
1098                  (or (zerop (length msg))
1099                      (progn
1100                        (setq err-mess
1101                              (concat (buffer-name Man-buffer)
1102                                      ": process "
1103                                      (let ((eos (1- (length msg))))
1104                                        (if (= (aref msg eos) ?\n)
1105                                            (substring msg 0 eos) msg))))
1106                        (goto-char (point-max))
1107                        (insert (format "\nprocess %s" msg))))
1108                  ))
1109         (if delete-buff
1110             (kill-buffer Man-buffer)
1111           (if Man-fontify-manpage-flag
1112               (Man-fontify-manpage)
1113             (Man-cleanup-manpage))
1114
1115           (run-hooks 'Man-cooked-hook)
1116           (Man-mode)
1117
1118           (if (not Man-page-list)
1119               (let ((args Man-arguments))
1120                 (kill-buffer (current-buffer))
1121                 (error "Can't find the %s manpage" args)))
1122
1123           (set-buffer-modified-p nil)
1124           ))
1125         ;; Restore case-fold-search before calling
1126         ;; Man-notify-when-ready because it may switch buffers.
1127
1128         (if (not delete-buff)
1129             (Man-notify-when-ready Man-buffer))
1130
1131         (if err-mess
1132             (error "%s" err-mess))
1133         ))))
1134
1135 \f
1136 ;; ======================================================================
1137 ;; set up manual mode in buffer and build alists
1138
1139 (put 'Man-mode 'mode-class 'special)
1140
1141 (defun Man-mode ()
1142   "A mode for browsing Un*x manual pages.
1143
1144 The following man commands are available in the buffer.  Try
1145 \"\\[describe-key] <key> RET\" for more information:
1146
1147 \\[man]       Prompt to retrieve a new manpage.
1148 \\[Man-follow-manual-reference]       Retrieve reference in SEE ALSO section.
1149 \\[Man-next-manpage]   Jump to next manpage in circular list.
1150 \\[Man-previous-manpage]   Jump to previous manpage in circular list.
1151 \\[Man-next-section]       Jump to next manpage section.
1152 \\[Man-previous-section]       Jump to previous manpage section.
1153 \\[Man-goto-section]       Go to a manpage section.
1154 \\[Man-goto-see-also-section]       Jumps to the SEE ALSO manpage section.
1155 \\[Man-quit]       Deletes the manpage window, bury its buffer.
1156 \\[Man-kill]       Deletes the manpage window, kill its buffer.
1157 \\[describe-mode]       Prints this help text.
1158
1159 The following variables may be of some use.  Try
1160 \"\\[describe-variable] <variable-name> RET\" for more information:
1161
1162 `Man-notify-method'             What happens when manpage formatting is done.
1163 `Man-downcase-section-letters-flag' Force section letters to lower case.
1164 `Man-circular-pages-flag'       Treat multiple manpage list as circular.
1165 `Man-section-translations-alist' List of section numbers and their Un*x equiv.
1166 `Man-filter-list'               Background manpage filter command.
1167 `Man-mode-map'                  Keymap bindings for Man mode buffers.
1168 `Man-mode-hook'                 Normal hook run on entry to Man mode.
1169 `Man-section-regexp'            Regexp describing manpage section letters.
1170 `Man-heading-regexp'            Regexp describing section headers.
1171 `Man-see-also-regexp'           Regexp for SEE ALSO section (or your equiv).
1172 `Man-first-heading-regexp'      Regexp for first heading on a manpage.
1173 `Man-reference-regexp'          Regexp matching a references in SEE ALSO.
1174 `Man-switches'                  Background `man' command switches.
1175
1176 The following key bindings are currently in effect in the buffer:
1177 \\{Man-mode-map}"
1178   (interactive)
1179   (kill-all-local-variables)
1180   (setq major-mode 'Man-mode
1181         mode-name "Man"
1182         buffer-auto-save-file-name nil
1183         mode-line-buffer-identification
1184         (list (default-value 'mode-line-buffer-identification)
1185               " {" 'Man-page-mode-string "}")
1186         truncate-lines t
1187         buffer-read-only t)
1188   (buffer-disable-undo)
1189   (auto-fill-mode -1)
1190   (use-local-map Man-mode-map)
1191   (set-syntax-table man-mode-syntax-table)
1192   (setq imenu-generic-expression (list (list nil Man-heading-regexp 0)))
1193   (set (make-local-variable 'outline-regexp) Man-heading-regexp)
1194   (set (make-local-variable 'outline-level) (lambda () 1))
1195   (Man-build-page-list)
1196   (Man-strip-page-headers)
1197   (Man-unindent)
1198   (Man-goto-page 1 t)
1199   (run-mode-hooks 'Man-mode-hook))
1200
1201 (defsubst Man-build-section-alist ()
1202   "Build the association list of manpage sections."
1203   (setq Man-sections-alist nil)
1204   (goto-char (point-min))
1205   (let ((case-fold-search nil))
1206     (while (re-search-forward Man-heading-regexp (point-max) t)
1207       (aput 'Man-sections-alist (match-string 1))
1208       (forward-line 1))))
1209
1210 (defsubst Man-build-references-alist ()
1211   "Build the association list of references (in the SEE ALSO section)."
1212   (setq Man-refpages-alist nil)
1213   (save-excursion
1214     (if (Man-find-section Man-see-also-regexp)
1215         (let ((start (progn (forward-line 1) (point)))
1216               (end (progn
1217                      (Man-next-section 1)
1218                      (point)))
1219               hyphenated
1220               (runningpoint -1))
1221           (save-restriction
1222             (narrow-to-region start end)
1223             (goto-char (point-min))
1224             (back-to-indentation)
1225             (while (and (not (eobp)) (/= (point) runningpoint))
1226               (setq runningpoint (point))
1227               (if (re-search-forward Man-hyphenated-reference-regexp end t)
1228                   (let* ((word (match-string 0))
1229                          (len (1- (length word))))
1230                     (if hyphenated
1231                         (setq word (concat hyphenated word)
1232                               hyphenated nil
1233                               ;; Update len, in case a reference spans
1234                               ;; more than two lines (paranoia).
1235                               len (1- (length word))))
1236                     (if (memq (aref word len) '(?- ?))
1237                         (setq hyphenated (substring word 0 len)))
1238                     (if (string-match Man-reference-regexp word)
1239                         (aput 'Man-refpages-alist word))))
1240               (skip-chars-forward " \t\n,"))))))
1241   (setq Man-refpages-alist (nreverse Man-refpages-alist)))
1242
1243 (defun Man-build-page-list ()
1244   "Build the list of separate manpages in the buffer."
1245   (setq Man-page-list nil)
1246   (let ((page-start (point-min))
1247         (page-end (point-max))
1248         (header ""))
1249     (goto-char page-start)
1250     ;; (switch-to-buffer (current-buffer))(debug)
1251     (while (not (eobp))
1252       (setq header
1253             (if (looking-at Man-page-header-regexp)
1254                 (match-string 1)
1255               nil))
1256       ;; Go past both the current and the next Man-first-heading-regexp
1257       (if (re-search-forward Man-first-heading-regexp nil 'move 2)
1258           (let ((p (progn (beginning-of-line) (point))))
1259             ;; We assume that the page header is delimited by blank
1260             ;; lines and that it contains at most one blank line.  So
1261             ;; if we back by three blank lines we will be sure to be
1262             ;; before the page header but not before the possible
1263             ;; previous page header.
1264             (search-backward "\n\n" nil t 3)
1265             (if (re-search-forward Man-page-header-regexp p 'move)
1266                 (beginning-of-line))))
1267       (setq page-end (point))
1268       (setq Man-page-list (append Man-page-list
1269                                   (list (list (copy-marker page-start)
1270                                               (copy-marker page-end)
1271                                               header))))
1272       (setq page-start page-end)
1273       )))
1274
1275 (defun Man-strip-page-headers ()
1276   "Strip all the page headers but the first from the manpage."
1277   (let ((inhibit-read-only t)
1278         (case-fold-search nil)
1279         (header ""))
1280     (dolist (page Man-page-list)
1281       (and (nth 2 page)
1282            (goto-char (car page))
1283            (re-search-forward Man-first-heading-regexp nil t)
1284            (setq header (buffer-substring (car page) (match-beginning 0)))
1285            ;; Since the awk script collapses all successive blank
1286            ;; lines into one, and since we don't want to get rid of
1287            ;; the fast awk script, one must choose between adding
1288            ;; spare blank lines between pages when there were none and
1289            ;; deleting blank lines at page boundaries when there were
1290            ;; some.  We choose the first, so we comment the following
1291            ;; line.
1292            ;; (setq header (concat "\n" header)))
1293            (while (search-forward header (nth 1 page) t)
1294              (replace-match ""))))))
1295
1296 (defun Man-unindent ()
1297   "Delete the leading spaces that indent the manpage."
1298   (let ((inhibit-read-only t)
1299         (case-fold-search nil))
1300     (dolist (page Man-page-list)
1301       (let ((indent "")
1302             (nindent 0))
1303         (narrow-to-region (car page) (car (cdr page)))
1304         (if Man-uses-untabify-flag
1305             (untabify (point-min) (point-max)))
1306         (if (catch 'unindent
1307               (goto-char (point-min))
1308               (if (not (re-search-forward Man-first-heading-regexp nil t))
1309                   (throw 'unindent nil))
1310               (beginning-of-line)
1311               (setq indent (buffer-substring (point)
1312                                              (progn
1313                                                (skip-chars-forward " ")
1314                                                (point))))
1315               (setq nindent (length indent))
1316               (if (zerop nindent)
1317                   (throw 'unindent nil))
1318               (setq indent (concat indent "\\|$"))
1319               (goto-char (point-min))
1320               (while (not (eobp))
1321                 (if (looking-at indent)
1322                     (forward-line 1)
1323                   (throw 'unindent nil)))
1324               (goto-char (point-min)))
1325             (while (not (eobp))
1326               (or (eolp)
1327                   (delete-char nindent))
1328               (forward-line 1)))
1329         ))))
1330
1331 \f
1332 ;; ======================================================================
1333 ;; Man mode commands
1334
1335 (defun Man-next-section (n)
1336   "Move point to Nth next section (default 1)."
1337   (interactive "p")
1338   (let ((case-fold-search nil)
1339         (start (point)))
1340     (if (looking-at Man-heading-regexp)
1341         (forward-line 1))
1342     (if (re-search-forward Man-heading-regexp (point-max) t n)
1343         (beginning-of-line)
1344       (goto-char (point-max))
1345       ;; The last line doesn't belong to any section.
1346       (forward-line -1))
1347     ;; But don't move back from the starting point (can happen if `start'
1348     ;; is somewhere on the last line).
1349     (if (< (point) start) (goto-char start))))
1350
1351 (defun Man-previous-section (n)
1352   "Move point to Nth previous section (default 1)."
1353   (interactive "p")
1354   (let ((case-fold-search nil))
1355     (if (looking-at Man-heading-regexp)
1356         (forward-line -1))
1357     (if (re-search-backward Man-heading-regexp (point-min) t n)
1358         (beginning-of-line)
1359       (goto-char (point-min)))))
1360
1361 (defun Man-find-section (section)
1362   "Move point to SECTION if it exists, otherwise don't move point.
1363 Returns t if section is found, nil otherwise."
1364   (let ((curpos (point))
1365         (case-fold-search nil))
1366     (goto-char (point-min))
1367     (if (re-search-forward (concat "^" section) (point-max) t)
1368         (progn (beginning-of-line) t)
1369       (goto-char curpos)
1370       nil)
1371     ))
1372
1373 (defun Man-goto-section ()
1374   "Query for section to move point to."
1375   (interactive)
1376   (aput 'Man-sections-alist
1377         (let* ((default (aheadsym Man-sections-alist))
1378                (completion-ignore-case t)
1379                chosen
1380                (prompt (concat "Go to section (default " default "): ")))
1381           (setq chosen (completing-read prompt Man-sections-alist))
1382           (if (or (not chosen)
1383                   (string= chosen ""))
1384               default
1385             chosen)))
1386   (Man-find-section (aheadsym Man-sections-alist)))
1387
1388 (defun Man-goto-see-also-section ()
1389   "Move point to the \"SEE ALSO\" section.
1390 Actually the section moved to is described by `Man-see-also-regexp'."
1391   (interactive)
1392   (if (not (Man-find-section Man-see-also-regexp))
1393       (error "%s" (concat "No " Man-see-also-regexp
1394                      " section found in the current manpage"))))
1395
1396 (defun Man-possibly-hyphenated-word ()
1397   "Return a possibly hyphenated word at point.
1398 If the word starts at the first non-whitespace column, and the
1399 previous line ends with a hyphen, return the last word on the previous
1400 line instead.  Thus, if a reference to \"tcgetpgrp(3V)\" is hyphenated
1401 as \"tcgetp-grp(3V)\", and point is at \"grp(3V)\", we return
1402 \"tcgetp-\" instead of \"grp\"."
1403   (save-excursion
1404     (skip-syntax-backward "w()")
1405     (skip-chars-forward " \t")
1406     (let ((beg (point))
1407           (word (current-word)))
1408       (when (eq beg (save-excursion
1409                       (back-to-indentation)
1410                       (point)))
1411         (end-of-line 0)
1412         (if (eq (char-before) ?-)
1413             (setq word (current-word))))
1414       word)))
1415
1416 (defun Man-follow-manual-reference (reference)
1417   "Get one of the manpages referred to in the \"SEE ALSO\" section.
1418 Specify which REFERENCE to use; default is based on word at point."
1419   (interactive
1420    (if (not Man-refpages-alist)
1421        (error "There are no references in the current man page")
1422      (list
1423       (let* ((default (or
1424                        (car (all-completions
1425                              (let ((word
1426                                     (or (Man-possibly-hyphenated-word)
1427                                         "")))
1428                                ;; strip a trailing '-':
1429                                (if (string-match "-$" word)
1430                                    (substring word 0
1431                                               (match-beginning 0))
1432                                  word))
1433                              Man-refpages-alist))
1434                        (aheadsym Man-refpages-alist)))
1435              (defaults
1436                (mapcar 'substring-no-properties
1437                        (delete-dups
1438                         (delq nil (cons default
1439                                         (mapcar 'car Man-refpages-alist))))))
1440              chosen
1441              (prompt (concat "Refer to (default " default "): ")))
1442         (setq chosen (completing-read prompt Man-refpages-alist
1443                                       nil nil nil nil defaults))
1444         (if (or (not chosen)
1445                 (string= chosen ""))
1446             default
1447           chosen)))))
1448   (if (not Man-refpages-alist)
1449       (error "Can't find any references in the current manpage")
1450     (aput 'Man-refpages-alist reference)
1451     (Man-getpage-in-background
1452      (Man-translate-references (aheadsym Man-refpages-alist)))))
1453
1454 (defun Man-kill ()
1455   "Kill the buffer containing the manpage."
1456   (interactive)
1457   (quit-window t))
1458
1459 (defun Man-quit ()
1460   "Bury the buffer containing the manpage."
1461   (interactive)
1462   (quit-window))
1463
1464 (defun Man-goto-page (page &optional noerror)
1465   "Go to the manual page on page PAGE."
1466   (interactive
1467    (if (not Man-page-list)
1468        (error "Not a man page buffer")
1469      (if (= (length Man-page-list) 1)
1470          (error "You're looking at the only manpage in the buffer")
1471        (list (read-minibuffer (format "Go to manpage [1-%d]: "
1472                                       (length Man-page-list)))))))
1473   (if (and (not Man-page-list) (not noerror))
1474       (error "Not a man page buffer"))
1475   (when Man-page-list
1476     (if (or (< page 1)
1477             (> page (length Man-page-list)))
1478         (error "No manpage %d found" page))
1479     (let* ((page-range (nth (1- page) Man-page-list))
1480            (page-start (car page-range))
1481            (page-end (car (cdr page-range))))
1482       (setq Man-current-page page
1483             Man-page-mode-string (Man-make-page-mode-string))
1484       (widen)
1485       (goto-char page-start)
1486       (narrow-to-region page-start page-end)
1487       (Man-build-section-alist)
1488       (Man-build-references-alist)
1489       (goto-char (point-min)))))
1490
1491
1492 (defun Man-next-manpage ()
1493   "Find the next manpage entry in the buffer."
1494   (interactive)
1495   (if (= (length Man-page-list) 1)
1496       (error "This is the only manpage in the buffer"))
1497   (if (< Man-current-page (length Man-page-list))
1498       (Man-goto-page (1+ Man-current-page))
1499     (if Man-circular-pages-flag
1500         (Man-goto-page 1)
1501       (error "You're looking at the last manpage in the buffer"))))
1502
1503 (defun Man-previous-manpage ()
1504   "Find the previous manpage entry in the buffer."
1505   (interactive)
1506   (if (= (length Man-page-list) 1)
1507       (error "This is the only manpage in the buffer"))
1508   (if (> Man-current-page 1)
1509       (Man-goto-page (1- Man-current-page))
1510     (if Man-circular-pages-flag
1511         (Man-goto-page (length Man-page-list))
1512       (error "You're looking at the first manpage in the buffer"))))
1513
1514 ;; Header file support
1515 (defun Man-view-header-file (file)
1516   "View a header file specified by FILE from `Man-header-file-path'."
1517   (let ((path Man-header-file-path)
1518         complete-path)
1519     (while path
1520       (setq complete-path (expand-file-name file (car path))
1521             path (cdr path))
1522       (if (file-readable-p complete-path)
1523           (progn (view-file complete-path)
1524                  (setq path nil))
1525         (setq complete-path nil)))
1526     complete-path))
1527 \f
1528 ;; Init the man package variables, if not already done.
1529 (Man-init-defvars)
1530
1531 (add-to-list 'debug-ignored-errors "^No manpage [0-9]* found$")
1532 (add-to-list 'debug-ignored-errors "^Can't find the .* manpage$")
1533
1534 (provide 'man)
1535
1536 ;; arch-tag: 587cda76-8e23-4594-b1f3-89b6b09a0d47
1537 ;;; man.el ends here