lisp/man.el

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