code.delx.au - gnu-emacs/blob - 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   'follow-link t
 419   'help-echo "mouse-2, RET: display this man page")
 420
 421 (define-button-type 'Man-xref-header-file
 422     'action (lambda (button)
 423               (let ((w (button-get button 'Man-target-string)))
 424                 (unless (Man-view-header-file w)
 425                   (error "Cannot find header file: %s" w))))
 426     'follow-link t
 427     'help-echo "mouse-2: display this header file")
 428
 429 (define-button-type 'Man-xref-normal-file
 430   'action (lambda (button)
 431             (let ((f (substitute-in-file-name
 432                       (button-get button 'Man-target-string))))
 433               (if (file-exists-p f)
 434                   (if (file-readable-p f)
 435                       (view-file f)
 436                     (error "Cannot read a file: %s" f))
 437                 (error "Cannot find a file: %s" f))))
 438   'follow-link t
 439   'help-echo "mouse-2: display this file")
 440
 441 \f
 442 ;; ======================================================================
 443 ;; utilities
 444
 445 (defun Man-init-defvars ()
 446   "Used for initialising variables based on display's color support.
 447 This is necessary if one wants to dump man.el with Emacs."
 448
 449   ;; Avoid possible error in call-process by using a directory that must exist.
 450   (let ((default-directory "/"))
 451     (setq Man-sed-script
 452           (cond
 453            (Man-fontify-manpage-flag
 454             nil)
 455            ((eq 0 (call-process Man-sed-command nil nil nil Man-sysv-sed-script))
 456             Man-sysv-sed-script)
 457            ((eq 0 (call-process Man-sed-command nil nil nil Man-berkeley-sed-script))
 458             Man-berkeley-sed-script)
 459            (t
 460             nil))))
 461
 462   (setq Man-filter-list
 463         ;; Avoid trailing nil which confuses customize.
 464         (apply 'list
 465          (cons
 466           Man-sed-command
 467           (list
 468            (if Man-sed-script
 469                (concat "-e '" Man-sed-script "'")
 470              "")
 471            "-e '/^[\001-\032][\001-\032]*$/d'"
 472            "-e '/\e[789]/s///g'"
 473            "-e '/Reformatting page.  Wait/d'"
 474            "-e '/Reformatting entry.  Wait/d'"
 475            "-e '/^[ \t]*Hewlett-Packard[ \t]Company[ \t]*-[ \t][0-9]*[ \t]-/d'"
 476            "-e '/^[ \t]*Hewlett-Packard[ \t]*-[ \t][0-9]*[ \t]-.*$/d'"
 477            "-e '/^[ \t][ \t]*-[ \t][0-9]*[ \t]-[ \t]*Formatted:.*[0-9]$/d'"
 478            "-e '/^[ \t]*Page[ \t][0-9]*.*(printed[ \t][0-9\\/]*)$/d'"
 479            "-e '/^Printed[ \t][0-9].*[0-9]$/d'"
 480            "-e '/^[ \t]*X[ \t]Version[ \t]1[01].*Release[ \t][0-9]/d'"
 481            "-e '/^[A-Za-z].*Last[ \t]change:/d'"
 482            "-e '/^Sun[ \t]Release[ \t][0-9].*[0-9]$/d'"
 483            "-e '/[ \t]*Copyright [0-9]* UNIX System Laboratories, Inc.$/d'"
 484            "-e '/^[ \t]*Rev\\..*Page [0-9][0-9]*$/d'"
 485            ))
 486          (cons
 487           Man-awk-command
 488           (list
 489            "'\n"
 490            "BEGIN { blankline=0; anonblank=0; }\n"
 491            "/^$/ { if (anonblank==0) next; }\n"
 492            "{ anonblank=1; }\n"
 493            "/^$/ { blankline++; next; }\n"
 494            "{ if (blankline>0) { print \"\"; blankline=0; } print $0; }\n"
 495            "'"
 496            ))
 497          (if (not Man-uses-untabify-flag)
 498              ;; The outer list will be stripped off by apply.
 499              (list (cons
 500                     Man-untabify-command
 501                     Man-untabify-command-args))
 502            )))
 503 )
 504
 505 (defsubst Man-make-page-mode-string ()
 506   "Formats part of the mode line for Man mode."
 507   (format "%s page %d of %d"
 508           (or (nth 2 (nth (1- Man-current-page) Man-page-list))
 509               "")
 510           Man-current-page
 511           (length Man-page-list)))
 512
 513 (defsubst Man-build-man-command ()
 514   "Builds the entire background manpage and cleaning command."
 515   (let ((command (concat manual-program " " Man-switches
 516                          (cond
 517                           ;; Already has %s
 518                           ((string-match "%s" manual-program) "")
 519                           ;; Stock MS-DOS shells cannot redirect stderr;
 520                           ;; `call-process' below sends it to /dev/null,
 521                           ;; so we don't need `2>' even with DOS shells
 522                           ;; which do support stderr redirection.
 523                           ((not (fboundp 'start-process)) " %s")
 524                           ((concat " %s 2>" null-device)))))
 525         (flist Man-filter-list))
 526     (while (and flist (car flist))
 527       (let ((pcom (car (car flist)))
 528             (pargs (cdr (car flist))))
 529         (setq command
 530               (concat command " | " pcom " "
 531                       (mapconcat (lambda (phrase)
 532                                    (if (not (stringp phrase))
 533                                        (error "Malformed Man-filter-list"))
 534                                    phrase)
 535                                  pargs " ")))
 536         (setq flist (cdr flist))))
 537     command))
 538
 539
 540 (defun Man-translate-cleanup (string)
 541   "Strip leading, trailing and middle spaces."
 542   (when (stringp string)
 543     ;;  Strip leading and trailing
 544     (if (string-match "^[ \t\f\r\n]*\\(.+[^ \t\f\r\n]\\)" string)
 545         (setq string (match-string 1 string)))
 546     ;; middle spaces
 547     (setq string (replace-regexp-in-string "[\t\r\n]" " " string))
 548     (setq string (replace-regexp-in-string "  +" " " string))
 549     string))
 550
 551 (defun Man-translate-references (ref)
 552   "Translates REF from \"chmod(2V)\" to \"2v chmod\" style.
 553 Leave it as is if already in that style.  Possibly downcase and
 554 translate the section (see the Man-downcase-section-letters-flag
 555 and the Man-section-translations-alist variables)."
 556   (let ((name "")
 557         (section "")
 558         (slist Man-section-translations-alist))
 559     (setq ref (Man-translate-cleanup ref))
 560     (cond
 561      ;; "chmod(2V)" case ?
 562      ((string-match (concat "^" Man-reference-regexp "$") ref)
 563       (setq name (match-string 1 ref)
 564             section (match-string 2 ref)))
 565      ;; "2v chmod" case ?
 566      ((string-match (concat "^\\(" Man-section-regexp
 567                             "\\) +\\(" Man-name-regexp "\\)$") ref)
 568       (setq name (match-string 2 ref)
 569             section (match-string 1 ref))))
 570     (if (string= name "")
 571         ref                             ; Return the reference as is
 572       (if Man-downcase-section-letters-flag
 573           (setq section (downcase section)))
 574       (while slist
 575         (let ((s1 (car (car slist)))
 576               (s2 (cdr (car slist))))
 577           (setq slist (cdr slist))
 578           (if Man-downcase-section-letters-flag
 579               (setq s1 (downcase s1)))
 580           (if (not (string= s1 section)) nil
 581             (setq section (if Man-downcase-section-letters-flag
 582                               (downcase s2)
 583                             s2)
 584                   slist nil))))
 585       (concat Man-specified-section-option section " " name))))
 586
 587 (defun Man-support-local-filenames ()
 588   "Check the availability of `-l' option of the man command.
 589 This option allows `man' to interpret command line arguments
 590 as local filenames.
 591 Return the value of the variable `Man-support-local-filenames'
 592 if it was set to nil or t before the call of this function.
 593 If t, the man command supports `-l' option.  If nil, it don't.
 594 Otherwise, if the value of `Man-support-local-filenames'
 595 is neither t nor nil, then determine a new value, set it
 596 to the variable `Man-support-local-filenames' and return
 597 a new value."
 598   (if (or (not Man-support-local-filenames)
 599           (eq Man-support-local-filenames t))
 600       Man-support-local-filenames
 601     (setq Man-support-local-filenames
 602           (with-temp-buffer
 603             (and (equal (condition-case nil
 604                             (call-process manual-program nil t nil "--help")
 605                           (error nil))
 606                         0)
 607                  (progn
 608                    (goto-char (point-min))
 609                    (search-forward "--local-file" nil t))
 610                  t)))))
 611
 612 \f
 613 ;; ======================================================================
 614 ;; default man entry: get word under point
 615
 616 (defsubst Man-default-man-entry ()
 617   "Make a guess at a default manual entry.
 618 This guess is based on the text surrounding the cursor."
 619   (let (word)
 620     (save-excursion
 621       ;; Default man entry title is any word the cursor is on, or if
 622       ;; cursor not on a word, then nearest preceding word.
 623       (skip-chars-backward "-a-zA-Z0-9._+:")
 624       (let ((start (point)))
 625         (skip-chars-forward "-a-zA-Z0-9._+:")
 626         (setq word (buffer-substring-no-properties start (point))))
 627       (if (string-match "[._]+$" word)
 628           (setq word (substring word 0 (match-beginning 0))))
 629       ;; If looking at something like *strcat(... , remove the '*'
 630       (if (string-match "^*" word)
 631           (setq word (substring word 1)))
 632       ;; If looking at something like ioctl(2) or brc(1M), include the
 633       ;; section number in the returned value.  Remove text properties.
 634       (concat word
 635               (if (looking-at
 636                    (concat "[ \t]*([ \t]*\\(" Man-section-regexp "\\)[ \t]*)"))
 637                   (format "(%s)" (match-string-no-properties 1)))))))
 638
 639 \f
 640 ;; ======================================================================
 641 ;; Top level command and background process sentinel
 642
 643 ;; For compatibility with older versions.
 644 ;;;###autoload
 645 (defalias 'manual-entry 'man)
 646
 647
 648 ;;;###autoload
 649 (defun man (man-args)
 650   "Get a Un*x manual page and put it in a buffer.
 651 This command is the top-level command in the man package.  It runs a Un*x
 652 command to retrieve and clean a manpage in the background and places the
 653 results in a Man mode (manpage browsing) buffer.  See variable
 654 `Man-notify-method' for what happens when the buffer is ready.
 655 If a buffer already exists for this man page, it will display immediately.
 656
 657 To specify a man page from a certain section, type SUBJECT(SECTION) or
 658 SECTION SUBJECT when prompted for a manual entry.  To see manpages from
 659 all sections related to a subject, put something appropriate into the
 660 `Man-switches' variable, which see."
 661   (interactive
 662    (list (let* ((default-entry (Man-default-man-entry))
 663                 (input (read-string
 664                         (format "Manual entry%s: "
 665                                 (if (string= default-entry "")
 666                                     ""
 667                                   (format " (default %s)" default-entry)))
 668                         nil nil default-entry)))
 669            (if (string= input "")
 670                (error "No man args given")
 671              input))))
 672
 673   ;; Possibly translate the "subject(section)" syntax into the
 674   ;; "section subject" syntax and possibly downcase the section.
 675   (setq man-args (Man-translate-references man-args))
 676
 677   (Man-getpage-in-background man-args))
 678
 679 ;;;###autoload
 680 (defun man-follow (man-args)
 681   "Get a Un*x manual page of the item under point and put it in a buffer."
 682   (interactive (list (Man-default-man-entry)))
 683   (if (or (not man-args)
 684           (string= man-args ""))
 685       (error "No item under point")
 686     (man man-args)))
 687
 688 (defun Man-getpage-in-background (topic)
 689   "Use TOPIC to build and fire off the manpage and cleaning command."
 690   (let* ((man-args topic)
 691          (bufname (concat "*Man " man-args "*"))
 692          (buffer  (get-buffer bufname)))
 693     (if buffer
 694         (Man-notify-when-ready buffer)
 695       (require 'env)
 696       (message "Invoking %s %s in the background" manual-program man-args)
 697       (setq buffer (generate-new-buffer bufname))
 698       (save-excursion
 699         (set-buffer buffer)
 700         (setq buffer-undo-list t)
 701         (setq Man-original-frame (selected-frame))
 702         (setq Man-arguments man-args))
 703       (let ((process-environment (copy-sequence process-environment))
 704             ;; The following is so Awk script gets \n intact
 705             ;; But don't prevent decoding of the outside.
 706             (coding-system-for-write 'raw-text-unix)
 707             ;; We must decode the output by a coding system that the
 708             ;; system's locale suggests in multibyte mode.
 709             (coding-system-for-read
 710              (if default-enable-multibyte-characters
 711                  locale-coding-system 'raw-text-unix))
 712             ;; Avoid possible error by using a directory that always exists.
 713             (default-directory
 714               (if (and (file-directory-p default-directory)
 715                        (not (find-file-name-handler default-directory
 716                                                     'file-directory-p)))
 717                   default-directory
 718                 "/")))
 719         ;; Prevent any attempt to use display terminal fanciness.
 720         (setenv "TERM" "dumb")
 721         ;; In Debian Woody, at least, we get overlong lines under X
 722         ;; unless COLUMNS or MANWIDTH is set.  This isn't a problem on
 723         ;; a tty.  man(1) says:
 724         ;;        MANWIDTH
 725         ;;               If $MANWIDTH is set, its value is used as the  line
 726         ;;               length  for which manual pages should be formatted.
 727         ;;               If it is not set, manual pages  will  be  formatted
 728         ;;               with  a line length appropriate to the current ter-
 729         ;;               minal (using an ioctl(2) if available, the value of
 730         ;;               $COLUMNS,  or falling back to 80 characters if nei-
 731         ;;               ther is available).
 732         (if window-system
 733             (unless (or (getenv "MANWIDTH") (getenv "COLUMNS"))
 734               ;; This isn't strictly correct, since we don't know how
 735               ;; the page will actually be displayed, but it seems
 736               ;; reasonable.
 737               (setenv "COLUMNS" (number-to-string
 738                                  (cond
 739                                   ((and (integerp Man-width) (> Man-width 0))
 740                                    Man-width)
 741                                   (Man-width (frame-width))
 742                                   ((window-width)))))))
 743         (setenv "GROFF_NO_SGR" "1")
 744         (if (fboundp 'start-process)
 745             (set-process-sentinel
 746              (start-process manual-program buffer
 747                             (if (memq system-type '(cygwin windows-nt))
 748                                 shell-file-name
 749                               "sh")
 750                             shell-command-switch
 751                             (format (Man-build-man-command) man-args))
 752              'Man-bgproc-sentinel)
 753           (let ((exit-status
 754                  (call-process shell-file-name nil (list buffer nil) nil
 755                                shell-command-switch
 756                                (format (Man-build-man-command) man-args)))
 757                 (msg ""))
 758             (or (and (numberp exit-status)
 759                      (= exit-status 0))
 760                 (and (numberp exit-status)
 761                      (setq msg
 762                            (format "exited abnormally with code %d"
 763                                    exit-status)))
 764                 (setq msg exit-status))
 765             (Man-bgproc-sentinel bufname msg)))))))
 766
 767 (defun Man-notify-when-ready (man-buffer)
 768   "Notify the user when MAN-BUFFER is ready.
 769 See the variable `Man-notify-method' for the different notification behaviors."
 770   (let ((saved-frame (save-excursion
 771                        (set-buffer man-buffer)
 772                        Man-original-frame)))
 773     (cond
 774      ((eq Man-notify-method 'newframe)
 775       ;; Since we run asynchronously, perhaps while Emacs is waiting
 776       ;; for input, we must not leave a different buffer current.  We
 777       ;; can't rely on the editor command loop to reselect the
 778       ;; selected window's buffer.
 779       (save-excursion
 780         (let ((frame (make-frame Man-frame-parameters)))
 781           (set-window-buffer (frame-selected-window frame) man-buffer)
 782           (set-window-dedicated-p (frame-selected-window frame) t)
 783           (or (display-multi-frame-p frame)
 784               (select-frame frame)))))
 785      ((eq Man-notify-method 'pushy)
 786       (switch-to-buffer man-buffer))
 787      ((eq Man-notify-method 'bully)
 788       (and (frame-live-p saved-frame)
 789            (select-frame saved-frame))
 790       (pop-to-buffer man-buffer)
 791       (delete-other-windows))
 792      ((eq Man-notify-method 'aggressive)
 793       (and (frame-live-p saved-frame)
 794            (select-frame saved-frame))
 795       (pop-to-buffer man-buffer))
 796      ((eq Man-notify-method 'friendly)
 797       (and (frame-live-p saved-frame)
 798            (select-frame saved-frame))
 799       (display-buffer man-buffer 'not-this-window))
 800      ((eq Man-notify-method 'polite)
 801       (beep)
 802       (message "Manual buffer %s is ready" (buffer-name man-buffer)))
 803      ((eq Man-notify-method 'quiet)
 804       (message "Manual buffer %s is ready" (buffer-name man-buffer)))
 805      ((or (eq Man-notify-method 'meek)
 806           t)
 807       (message ""))
 808      )))
 809
 810 (defun Man-softhyphen-to-minus ()
 811   ;; \255 is SOFT HYPHEN in Latin-N.  Versions of Debian man, at
 812   ;; least, emit it even when not in a Latin-N locale.
 813   (unless (eq t (compare-strings "latin-" 0 nil
 814                                  current-language-environment 0 6 t))
 815     (goto-char (point-min))
 816     (let ((str "\255"))
 817       (if enable-multibyte-characters
 818           (setq str (string-as-multibyte str)))
 819       (while (search-forward str nil t) (replace-match "-")))))
 820
 821 (defun Man-fontify-manpage ()
 822   "Convert overstriking and underlining to the correct fonts.
 823 Same for the ANSI bold and normal escape sequences."
 824   (interactive)
 825   (message "Please wait: formatting the %s man page..." Man-arguments)
 826   (goto-char (point-min))
 827   ;; Fontify ANSI escapes.
 828   (let ((faces nil)
 829         (buffer-undo-list t)
 830         (start (point)))
 831     ;; http://www.isthe.com/chongo/tech/comp/ansi_escapes.html
 832     ;; suggests many codes, but we only handle:
 833     ;; ESC [ 00 m       reset to normal display
 834     ;; ESC [ 01 m       bold
 835     ;; ESC [ 04 m       underline
 836     ;; ESC [ 07 m       reverse-video
 837     ;; ESC [ 22 m       no-bold
 838     ;; ESC [ 24 m       no-underline
 839     ;; ESC [ 27 m       no-reverse-video
 840     (while (re-search-forward "\e\\[0?\\([1470]\\|2\\([247]\\)\\)m" nil t)
 841       (if faces (put-text-property start (match-beginning 0) 'face
 842                                    (if (cdr faces) faces (car faces))))
 843       (setq faces
 844             (cond
 845              ((match-beginning 2)
 846               (delq (case (char-after (match-beginning 2))
 847                       (?2 Man-overstrike-face)
 848                       (?4 Man-underline-face)
 849                       (?7 Man-reverse-face))
 850                     faces))
 851              ((eq (char-after (match-beginning 1)) ?0) nil)
 852              (t
 853               (cons (case (char-after (match-beginning 1))
 854                       (?1 Man-overstrike-face)
 855                       (?4 Man-underline-face)
 856                       (?7 Man-reverse-face))
 857                     faces))))
 858       (delete-region (match-beginning 0) (match-end 0))
 859       (setq start (point))))
 860   ;; Other highlighting.
 861   (let ((buffer-undo-list t))
 862     (if (< (buffer-size) (position-bytes (point-max)))
 863         ;; Multibyte characters exist.
 864         (progn
 865           (goto-char (point-min))
 866           (while (search-forward "__\b\b" nil t)
 867             (backward-delete-char 4)
 868             (put-text-property (point) (1+ (point)) 'face Man-underline-face))
 869           (goto-char (point-min))
 870           (while (search-forward "\b\b__" nil t)
 871             (backward-delete-char 4)
 872             (put-text-property (1- (point)) (point) 'face Man-underline-face))))
 873     (goto-char (point-min))
 874     (while (search-forward "_\b" nil t)
 875       (backward-delete-char 2)
 876       (put-text-property (point) (1+ (point)) 'face Man-underline-face))
 877     (goto-char (point-min))
 878     (while (search-forward "\b_" nil t)
 879       (backward-delete-char 2)
 880       (put-text-property (1- (point)) (point) 'face Man-underline-face))
 881     (goto-char (point-min))
 882     (while (re-search-forward "\\(.\\)\\(\b+\\1\\)+" nil t)
 883       (replace-match "\\1")
 884       (put-text-property (1- (point)) (point) 'face Man-overstrike-face))
 885     (goto-char (point-min))
 886     (while (re-search-forward "o\b\\+\\|\\+\bo" nil t)
 887       (replace-match "o")
 888       (put-text-property (1- (point)) (point) 'face 'bold))
 889     (goto-char (point-min))
 890     (while (re-search-forward "[-|]\\(\b[-|]\\)+" nil t)
 891       (replace-match "+")
 892       (put-text-property (1- (point)) (point) 'face 'bold))
 893     (goto-char (point-min))
 894     ;; Try to recognize common forms of cross references.
 895     (Man-highlight-references)
 896     (Man-softhyphen-to-minus)
 897     (goto-char (point-min))
 898     (while (re-search-forward Man-heading-regexp nil t)
 899       (put-text-property (match-beginning 0)
 900                          (match-end 0)
 901                          'face Man-overstrike-face)))
 902   (message "%s man page formatted" Man-arguments))
 903
 904 (defun Man-highlight-references ()
 905   "Highlight the references on mouse-over.
 906 references include items in the SEE ALSO section,
 907 header file(#include <foo.h>) and files in FILES"
 908   (let ((dummy 0))
 909     (Man-highlight-references0
 910      Man-see-also-regexp Man-reference-regexp 1 dummy
 911      'Man-xref-man-page)
 912     (Man-highlight-references0
 913      Man-synopsis-regexp Man-header-regexp 0 2
 914      'Man-xref-header-file)
 915     (Man-highlight-references0
 916      Man-files-regexp Man-normal-file-regexp 0 0
 917      'Man-xref-normal-file)))
 918
 919 (defun Man-highlight-references0 (start-section regexp button-pos target-pos type)
 920   ;; Based on `Man-build-references-alist'
 921   (when (Man-find-section start-section)
 922     (forward-line 1)
 923     (let ((end (save-excursion
 924                  (Man-next-section 1)
 925                  (point))))
 926       (back-to-indentation)
 927       (while (re-search-forward regexp end t)
 928         (make-text-button
 929          (match-beginning button-pos)
 930          (match-end button-pos)
 931          'type type
 932          'Man-target-string (match-string target-pos)
 933          )))))
 934
 935 (defun Man-cleanup-manpage (&optional interactive)
 936   "Remove overstriking and underlining from the current buffer.
 937 Normally skip any jobs that should have been done by the sed script,
 938 but when called interactively, do those jobs even if the sed
 939 script would have done them."
 940   (interactive "p")
 941   (message "Please wait: cleaning up the %s man page..."
 942            Man-arguments)
 943   (if (or interactive (not Man-sed-script))
 944       (progn
 945         (goto-char (point-min))
 946         (while (search-forward "_\b" nil t) (backward-delete-char 2))
 947         (goto-char (point-min))
 948         (while (search-forward "\b_" nil t) (backward-delete-char 2))
 949         (goto-char (point-min))
 950         (while (re-search-forward "\\(.\\)\\(\b\\1\\)+" nil t)
 951           (replace-match "\\1"))
 952         (goto-char (point-min))
 953         (while (re-search-forward "\e\\[[0-9]+m" nil t) (replace-match ""))
 954         (goto-char (point-min))
 955         (while (re-search-forward "o\b\\+\\|\\+\bo" nil t) (replace-match "o"))
 956         ))
 957   (goto-char (point-min))
 958   (while (re-search-forward "[-|]\\(\b[-|]\\)+" nil t) (replace-match "+"))
 959   (Man-softhyphen-to-minus)
 960   (message "%s man page cleaned up" Man-arguments))
 961
 962 (defun Man-bgproc-sentinel (process msg)
 963   "Manpage background process sentinel.
 964 When manpage command is run asynchronously, PROCESS is the process
 965 object for the manpage command; when manpage command is run
 966 synchronously, PROCESS is the name of the buffer where the manpage
 967 command is run.  Second argument MSG is the exit message of the
 968 manpage command."
 969   (let ((Man-buffer (if (stringp process) (get-buffer process)
 970                       (process-buffer process)))
 971         (delete-buff nil)
 972         (err-mess nil))
 973
 974     (if (null (buffer-name Man-buffer)) ;; deleted buffer
 975         (or (stringp process)
 976             (set-process-buffer process nil))
 977
 978       (save-excursion
 979         (set-buffer Man-buffer)
 980         (let ((case-fold-search nil))
 981           (goto-char (point-min))
 982           (cond ((or (looking-at "No \\(manual \\)*entry for")
 983                      (looking-at "[^\n]*: nothing appropriate$"))
 984                  (setq err-mess (buffer-substring (point)
 985                                                   (progn
 986                                                     (end-of-line) (point)))
 987                        delete-buff t))
 988                 ((or (stringp process)
 989                      (not (and (eq (process-status process) 'exit)
 990                                (= (process-exit-status process) 0))))
 991                  (or (zerop (length msg))
 992                      (progn
 993                        (setq err-mess
 994                              (concat (buffer-name Man-buffer)
 995                                      ": process "
 996                                      (let ((eos (1- (length msg))))
 997                                        (if (= (aref msg eos) ?\n)
 998                                            (substring msg 0 eos) msg))))
 999                        (goto-char (point-max))
1000                        (insert (format "\nprocess %s" msg))))
1001                  ))
1002         (if delete-buff
1003             (kill-buffer Man-buffer)
1004           (if Man-fontify-manpage-flag
1005               (Man-fontify-manpage)
1006             (Man-cleanup-manpage))
1007           (run-hooks 'Man-cooked-hook)
1008           (Man-mode)
1009           (set-buffer-modified-p nil)
1010           ))
1011         ;; Restore case-fold-search before calling
1012         ;; Man-notify-when-ready because it may switch buffers.
1013
1014         (if (not delete-buff)
1015             (Man-notify-when-ready Man-buffer))
1016
1017         (if err-mess
1018             (error err-mess))
1019         ))))
1020
1021 \f
1022 ;; ======================================================================
1023 ;; set up manual mode in buffer and build alists
1024
1025 (defun Man-mode ()
1026   "A mode for browsing Un*x manual pages.
1027
1028 The following man commands are available in the buffer.  Try
1029 \"\\[describe-key] <key> RET\" for more information:
1030
1031 \\[man]       Prompt to retrieve a new manpage.
1032 \\[Man-follow-manual-reference]       Retrieve reference in SEE ALSO section.
1033 \\[Man-next-manpage]   Jump to next manpage in circular list.
1034 \\[Man-previous-manpage]   Jump to previous manpage in circular list.
1035 \\[Man-next-section]       Jump to next manpage section.
1036 \\[Man-previous-section]       Jump to previous manpage section.
1037 \\[Man-goto-section]       Go to a manpage section.
1038 \\[Man-goto-see-also-section]       Jumps to the SEE ALSO manpage section.
1039 \\[Man-quit]       Deletes the manpage window, bury its buffer.
1040 \\[Man-kill]       Deletes the manpage window, kill its buffer.
1041 \\[describe-mode]       Prints this help text.
1042
1043 The following variables may be of some use.  Try
1044 \"\\[describe-variable] <variable-name> RET\" for more information:
1045
1046 `Man-notify-method'             What happens when manpage formatting is done.
1047 `Man-downcase-section-letters-flag' Force section letters to lower case.
1048 `Man-circular-pages-flag'       Treat multiple manpage list as circular.
1049 `Man-section-translations-alist' List of section numbers and their Un*x equiv.
1050 `Man-filter-list'               Background manpage filter command.
1051 `Man-mode-map'                  Keymap bindings for Man mode buffers.
1052 `Man-mode-hook'                 Normal hook run on entry to Man mode.
1053 `Man-section-regexp'            Regexp describing manpage section letters.
1054 `Man-heading-regexp'            Regexp describing section headers.
1055 `Man-see-also-regexp'           Regexp for SEE ALSO section (or your equiv).
1056 `Man-first-heading-regexp'      Regexp for first heading on a manpage.
1057 `Man-reference-regexp'          Regexp matching a references in SEE ALSO.
1058 `Man-switches'                  Background `man' command switches.
1059
1060 The following key bindings are currently in effect in the buffer:
1061 \\{Man-mode-map}"
1062   (interactive)
1063   (setq major-mode 'Man-mode
1064         mode-name "Man"
1065         buffer-auto-save-file-name nil
1066         mode-line-buffer-identification
1067         (list (default-value 'mode-line-buffer-identification)
1068               " {" 'Man-page-mode-string "}")
1069         truncate-lines t
1070         buffer-read-only t)
1071   (buffer-disable-undo (current-buffer))
1072   (auto-fill-mode -1)
1073   (use-local-map Man-mode-map)
1074   (set-syntax-table man-mode-syntax-table)
1075   (setq imenu-generic-expression (list (list nil Man-heading-regexp 0)))
1076   (set (make-local-variable 'outline-regexp) Man-heading-regexp)
1077   (set (make-local-variable 'outline-level) (lambda () 1))
1078   (Man-build-page-list)
1079   (Man-strip-page-headers)
1080   (Man-unindent)
1081   (Man-goto-page 1)
1082   (run-hooks 'Man-mode-hook))
1083
1084 (defsubst Man-build-section-alist ()
1085   "Build the association list of manpage sections."
1086   (setq Man-sections-alist nil)
1087   (goto-char (point-min))
1088   (let ((case-fold-search nil))
1089     (while (re-search-forward Man-heading-regexp (point-max) t)
1090       (aput 'Man-sections-alist (match-string 1))
1091       (forward-line 1))))
1092
1093 (defsubst Man-build-references-alist ()
1094   "Build the association list of references (in the SEE ALSO section)."
1095   (setq Man-refpages-alist nil)
1096   (save-excursion
1097     (if (Man-find-section Man-see-also-regexp)
1098         (let ((start (progn (forward-line 1) (point)))
1099               (end (progn
1100                      (Man-next-section 1)
1101                      (point)))
1102               hyphenated
1103               (runningpoint -1))
1104           (save-restriction
1105             (narrow-to-region start end)
1106             (goto-char (point-min))
1107             (back-to-indentation)
1108             (while (and (not (eobp)) (/= (point) runningpoint))
1109               (setq runningpoint (point))
1110               (if (re-search-forward Man-hyphenated-reference-regexp end t)
1111                   (let* ((word (match-string 0))
1112                          (len (1- (length word))))
1113                     (if hyphenated
1114                         (setq word (concat hyphenated word)
1115                               hyphenated nil
1116                               ;; Update len, in case a reference spans
1117                               ;; more than two lines (paranoia).
1118                               len (1- (length word))))
1119                     (if (memq (aref word len) '(?- ?))
1120                         (setq hyphenated (substring word 0 len)))
1121                     (if (string-match Man-reference-regexp word)
1122                         (aput 'Man-refpages-alist word))))
1123               (skip-chars-forward " \t\n,"))))))
1124   (setq Man-refpages-alist (nreverse Man-refpages-alist)))
1125
1126 (defun Man-build-page-list ()
1127   "Build the list of separate manpages in the buffer."
1128   (setq Man-page-list nil)
1129   (let ((page-start (point-min))
1130         (page-end (point-max))
1131         (header ""))
1132     (goto-char page-start)
1133     ;; (switch-to-buffer (current-buffer))(debug)
1134     (while (not (eobp))
1135       (setq header
1136             (if (looking-at Man-page-header-regexp)
1137                 (match-string 1)
1138               nil))
1139       ;; Go past both the current and the next Man-first-heading-regexp
1140       (if (re-search-forward Man-first-heading-regexp nil 'move 2)
1141           (let ((p (progn (beginning-of-line) (point))))
1142             ;; We assume that the page header is delimited by blank
1143             ;; lines and that it contains at most one blank line.  So
1144             ;; if we back by three blank lines we will be sure to be
1145             ;; before the page header but not before the possible
1146             ;; previous page header.
1147             (search-backward "\n\n" nil t 3)
1148             (if (re-search-forward Man-page-header-regexp p 'move)
1149                 (beginning-of-line))))
1150       (setq page-end (point))
1151       (setq Man-page-list (append Man-page-list
1152                                   (list (list (copy-marker page-start)
1153                                               (copy-marker page-end)
1154                                               header))))
1155       (setq page-start page-end)
1156       )))
1157
1158 (defun Man-strip-page-headers ()
1159   "Strip all the page headers but the first from the manpage."
1160   (let ((buffer-read-only nil)
1161         (case-fold-search nil)
1162         (page-list Man-page-list)
1163         (page ())
1164         (header ""))
1165     (while page-list
1166       (setq page (car page-list))
1167       (and (nth 2 page)
1168            (goto-char (car page))
1169            (re-search-forward Man-first-heading-regexp nil t)
1170            (setq header (buffer-substring (car page) (match-beginning 0)))
1171            ;; Since the awk script collapses all successive blank
1172            ;; lines into one, and since we don't want to get rid of
1173            ;; the fast awk script, one must choose between adding
1174            ;; spare blank lines between pages when there were none and
1175            ;; deleting blank lines at page boundaries when there were
1176            ;; some.  We choose the first, so we comment the following
1177            ;; line.
1178            ;; (setq header (concat "\n" header)))
1179            (while (search-forward header (nth 1 page) t)
1180              (replace-match "")))
1181       (setq page-list (cdr page-list)))))
1182
1183 (defun Man-unindent ()
1184   "Delete the leading spaces that indent the manpage."
1185   (let ((buffer-read-only nil)
1186         (case-fold-search nil)
1187         (page-list Man-page-list))
1188     (while page-list
1189       (let ((page (car page-list))
1190             (indent "")
1191             (nindent 0))
1192         (narrow-to-region (car page) (car (cdr page)))
1193         (if Man-uses-untabify-flag
1194             (untabify (point-min) (point-max)))
1195         (if (catch 'unindent
1196               (goto-char (point-min))
1197               (if (not (re-search-forward Man-first-heading-regexp nil t))
1198                   (throw 'unindent nil))
1199               (beginning-of-line)
1200               (setq indent (buffer-substring (point)
1201                                              (progn
1202                                                (skip-chars-forward " ")
1203                                                (point))))
1204               (setq nindent (length indent))
1205               (if (zerop nindent)
1206                   (throw 'unindent nil))
1207               (setq indent (concat indent "\\|$"))
1208               (goto-char (point-min))
1209               (while (not (eobp))
1210                 (if (looking-at indent)
1211                     (forward-line 1)
1212                   (throw 'unindent nil)))
1213               (goto-char (point-min)))
1214             (while (not (eobp))
1215               (or (eolp)
1216                   (delete-char nindent))
1217               (forward-line 1)))
1218         (setq page-list (cdr page-list))
1219         ))))
1220
1221 \f
1222 ;; ======================================================================
1223 ;; Man mode commands
1224
1225 (defun Man-next-section (n)
1226   "Move point to Nth next section (default 1)."
1227   (interactive "p")
1228   (let ((case-fold-search nil))
1229     (if (looking-at Man-heading-regexp)
1230         (forward-line 1))
1231     (if (re-search-forward Man-heading-regexp (point-max) t n)
1232         (beginning-of-line)
1233       (goto-char (point-max)))))
1234
1235 (defun Man-previous-section (n)
1236   "Move point to Nth previous section (default 1)."
1237   (interactive "p")
1238   (let ((case-fold-search nil))
1239     (if (looking-at Man-heading-regexp)
1240         (forward-line -1))
1241     (if (re-search-backward Man-heading-regexp (point-min) t n)
1242         (beginning-of-line)
1243       (goto-char (point-min)))))
1244
1245 (defun Man-find-section (section)
1246   "Move point to SECTION if it exists, otherwise don't move point.
1247 Returns t if section is found, nil otherwise."
1248   (let ((curpos (point))
1249         (case-fold-search nil))
1250     (goto-char (point-min))
1251     (if (re-search-forward (concat "^" section) (point-max) t)
1252         (progn (beginning-of-line) t)
1253       (goto-char curpos)
1254       nil)
1255     ))
1256
1257 (defun Man-goto-section ()
1258   "Query for section to move point to."
1259   (interactive)
1260   (aput 'Man-sections-alist
1261         (let* ((default (aheadsym Man-sections-alist))
1262                (completion-ignore-case t)
1263                chosen
1264                (prompt (concat "Go to section: (default " default ") ")))
1265           (setq chosen (completing-read prompt Man-sections-alist))
1266           (if (or (not chosen)
1267                   (string= chosen ""))
1268               default
1269             chosen)))
1270   (Man-find-section (aheadsym Man-sections-alist)))
1271
1272 (defun Man-goto-see-also-section ()
1273   "Move point to the \"SEE ALSO\" section.
1274 Actually the section moved to is described by `Man-see-also-regexp'."
1275   (interactive)
1276   (if (not (Man-find-section Man-see-also-regexp))
1277       (error (concat "No " Man-see-also-regexp
1278                      " section found in the current manpage"))))
1279
1280 (defun Man-possibly-hyphenated-word ()
1281   "Return a possibly hyphenated word at point.
1282 If the word starts at the first non-whitespace column, and the
1283 previous line ends with a hyphen, return the last word on the previous
1284 line instead.  Thus, if a reference to \"tcgetpgrp(3V)\" is hyphenated
1285 as \"tcgetp-grp(3V)\", and point is at \"grp(3V)\", we return
1286 \"tcgetp-\" instead of \"grp\"."
1287   (save-excursion
1288     (skip-syntax-backward "w()")
1289     (skip-chars-forward " \t")
1290     (let ((beg (point))
1291           (word (current-word)))
1292       (when (eq beg (save-excursion
1293                       (back-to-indentation)
1294                       (point)))
1295         (end-of-line 0)
1296         (if (eq (char-before) ?-)
1297             (setq word (current-word))))
1298       word)))
1299
1300 (defun Man-follow-manual-reference (reference)
1301   "Get one of the manpages referred to in the \"SEE ALSO\" section.
1302 Specify which REFERENCE to use; default is based on word at point."
1303   (interactive
1304    (if (not Man-refpages-alist)
1305        (error "There are no references in the current man page")
1306      (list (let* ((default (or
1307                             (car (all-completions
1308                                   (let ((word
1309                                          (or (Man-possibly-hyphenated-word)
1310                                              "")))
1311                                     ;; strip a trailing '-':
1312                                     (if (string-match "-$" word)
1313                                         (substring word 0
1314                                                    (match-beginning 0))
1315                                       word))
1316                                   Man-refpages-alist))
1317                             (aheadsym Man-refpages-alist)))
1318                    chosen
1319                    (prompt (concat "Refer to: (default " default ") ")))
1320               (setq chosen (completing-read prompt Man-refpages-alist))
1321               (if (or (not chosen)
1322                       (string= chosen ""))
1323                   default
1324                 chosen)))))
1325   (if (not Man-refpages-alist)
1326       (error "Can't find any references in the current manpage")
1327     (aput 'Man-refpages-alist reference)
1328     (Man-getpage-in-background
1329      (Man-translate-references (aheadsym Man-refpages-alist)))))
1330
1331 (defun Man-kill ()
1332   "Kill the buffer containing the manpage."
1333   (interactive)
1334   (quit-window t))
1335
1336 (defun Man-quit ()
1337   "Bury the buffer containing the manpage."
1338   (interactive)
1339   (quit-window))
1340
1341 (defun Man-goto-page (page)
1342   "Go to the manual page on page PAGE."
1343   (interactive
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 (= (length Man-page-list) 1)
1349          (error "You're looking at the only manpage in the buffer")
1350        (list (read-minibuffer (format "Go to manpage [1-%d]: "
1351                                       (length Man-page-list)))))))
1352   (if (not Man-page-list)
1353       (let ((args Man-arguments))
1354         (kill-buffer (current-buffer))
1355         (error "Can't find the %s manpage" args)))
1356   (if (or (< page 1)
1357           (> page (length Man-page-list)))
1358       (error "No manpage %d found" page))
1359   (let* ((page-range (nth (1- page) Man-page-list))
1360          (page-start (car page-range))
1361          (page-end (car (cdr page-range))))
1362     (setq Man-current-page page
1363           Man-page-mode-string (Man-make-page-mode-string))
1364     (widen)
1365     (goto-char page-start)
1366     (narrow-to-region page-start page-end)
1367     (Man-build-section-alist)
1368     (Man-build-references-alist)
1369     (goto-char (point-min))))
1370
1371
1372 (defun Man-next-manpage ()
1373   "Find the next manpage entry in the buffer."
1374   (interactive)
1375   (if (= (length Man-page-list) 1)
1376       (error "This is the only manpage in the buffer"))
1377   (if (< Man-current-page (length Man-page-list))
1378       (Man-goto-page (1+ Man-current-page))
1379     (if Man-circular-pages-flag
1380         (Man-goto-page 1)
1381       (error "You're looking at the last manpage in the buffer"))))
1382
1383 (defun Man-previous-manpage ()
1384   "Find the previous manpage entry in the buffer."
1385   (interactive)
1386   (if (= (length Man-page-list) 1)
1387       (error "This is the only manpage in the buffer"))
1388   (if (> Man-current-page 1)
1389       (Man-goto-page (1- Man-current-page))
1390     (if Man-circular-pages-flag
1391         (Man-goto-page (length Man-page-list))
1392       (error "You're looking at the first manpage in the buffer"))))
1393
1394 ;; Header file support
1395 (defun Man-view-header-file (file)
1396   "View a header file specified by FILE from `Man-header-file-path'."
1397   (let ((path Man-header-file-path)
1398         complete-path)
1399     (while path
1400       (setq complete-path (concat (car path) "/" file)
1401             path (cdr path))
1402       (if (file-readable-p complete-path)
1403           (progn (view-file complete-path)
1404                  (setq path nil))
1405         (setq complete-path nil)))
1406     complete-path))
1407 \f
1408 ;; Init the man package variables, if not already done.
1409 (Man-init-defvars)
1410
1411 (add-to-list 'debug-ignored-errors "^No manpage [0-9]* found$")
1412 (add-to-list 'debug-ignored-errors "^Can't find the .* manpage$")
1413
1414 (provide 'man)
1415
1416 ;; arch-tag: 587cda76-8e23-4594-b1f3-89b6b09a0d47
1417 ;;; man.el ends here