home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / emacs-19.28-src.tgz / tar.out / fsf / emacs / lisp / man.el < prev    next >
Lisp/Scheme  |  1996-09-28  |  31KB  |  849 lines
  1. ;;; man.el --- browse UNIX manual pages
  2.  
  3. ;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
  4.  
  5. ;; Author:        Barry A. Warsaw <bwarsaw@cen.com>
  6. ;; Last-Modified:    31-Jul-1991
  7. ;; Version:        1.1
  8. ;; Keywords:        help
  9. ;; Adapted-By:        ESR
  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
  25. ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  26.  
  27. ;;; Commentary:
  28.  
  29. ;; This code provides a function, manual-entry, with which you can
  30. ;; browse UNIX manual pages.  Formatting is done in background so that
  31. ;; you can continue to use your Emacs while processing is going on.
  32. ;;
  33. ;; The mode also supports hypertext-like following of manual page SEE
  34. ;; ALSO references, and other features.  See below or do `?' in a
  35. ;; manual page buffer for details.
  36.  
  37. ;; ========== Credits and History ========== 
  38. ;; In mid 1991, several people posted some interesting improvements to
  39. ;; man.el from the standard emacs 18.57 distribution.  I liked many of
  40. ;; these, but wanted everthing in one single package, so I decided
  41. ;; to encorporate them into a single manual browsing mode.  While
  42. ;; much of the code here has been rewritten, and some features added,
  43. ;; these folks deserve lots of credit for providing the initial
  44. ;; excellent packages on which this one is based.
  45.  
  46. ;; Nick Duffek <duffek@chaos.cs.brandeis.edu>, posted a very nice
  47. ;; improvement which retrieved and cleaned the manpages in a
  48. ;; background process, and which correctly deciphered such options as
  49. ;; man -k.
  50.  
  51. ;; Eric Rose <erose@jessica.stanford.edu>, submitted manual.el which
  52. ;; provided a very nice manual browsing mode.
  53.  
  54. ;; This package was available as `superman.el' from the LCD package
  55. ;; for some time before it was accepted into Emacs 19.  The entry
  56. ;; point and some other names have been changed to make it a drop-in
  57. ;; replacement for the old man.el package.
  58.  
  59. ;; ========== Features ==========
  60. ;; + Runs "man" in the background and pipes the results through a
  61. ;;   series of sed and awk scripts so that all retrieving and cleaning
  62. ;;   is done in the background. The cleaning commands are configurable.
  63. ;; + Syntax is the same as Un*x man
  64. ;; + Functionality is the same as Un*x man, including "man -k" and
  65. ;;   "man <section>", etc.
  66. ;; + Provides a manual browsing mode with keybindings for traversing
  67. ;;   the sections of a manpage, following references in the SEE ALSO
  68. ;;   section, and more.
  69. ;; + Multiple manpages created with the same man command are put into
  70. ;;   a narrowed buffer circular list.
  71.  
  72. ;;; Code:
  73.  
  74. (require 'assoc)
  75.  
  76. ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
  77. ;; user variables
  78.  
  79. (defvar manual-program "man"
  80.   "The name of the program that produces man pages.")
  81.  
  82. (defvar Man-notify 'friendly
  83.   "*Selects the behavior when manpage is ready.
  84. This variable may have one of the following values:
  85.  
  86. newframe   -- put the manpage in its own frame (see `Man-frame-parameters')
  87. bully      -- make the manpage the current buffer and only window
  88. aggressive -- make the manpage the current buffer in the other window
  89. friendly   -- display manpage in other window but don't make current
  90. polite     -- don't display manpage, but prints message when ready (beeps)
  91. quiet      -- like `polite', but don't beep
  92. meek       -- make no indication that manpage is ready
  93.  
  94. Any other value of `Man-notify' is equivalent to `meek'.")
  95.  
  96. (defvar Man-frame-parameters nil
  97.   "*Frame parameter list for creating a new frame for a manual page.")
  98.  
  99. (defvar Man-reuse-okay-p t
  100.   "*Reuse a manpage buffer if possible.
  101. If non-nil, and a manpage buffer already exists with the same
  102. invocation, man just indicates the manpage is ready according to the
  103. value of `Man-notify'.  When nil, it always fires off a background
  104. process, putting the results in a uniquely named buffer.")
  105.  
  106. (defvar Man-downcase-section-letters-p t
  107.   "*Letters in sections are converted to lower case.
  108. Some Un*x man commands can't handle uppercase letters in sections, for
  109. example \"man 2V chmod\", but they are often displayed in the manpage
  110. with the upper case letter.  When this variable is t, the section
  111. letter (e.g., \"2V\") is converted to lowercase (e.g., \"2v\") before
  112. being sent to the man background process.")
  113.  
  114. (defvar Man-circular-pages-p t
  115.   "*If t, the manpage list is treated as circular for traversal.")
  116.  
  117. ;; I changed this to nil because it is a bad idea
  118. ;; to fail to recognize things in other sections.
  119. (defvar Man-auto-section-alist
  120.   nil
  121. ;;  '((c-mode . ("2" "3"))
  122. ;;    (c++-mode . ("2" "3"))
  123. ;;    (c++-c-mode . ("2" "3"))
  124. ;;    (shell-mode . ("1" "8"))
  125. ;;    (cmushell-mode . ("1" "8"))
  126. ;;    (text-mode . "1")
  127. ;;    )
  128.   "*Association list of major modes and their default section numbers.
  129. List is of the form: (MAJOR-MODE . [SECTION | (SECTION*)]). If current
  130. major mode is not in list, then the default is to check for manpages
  131. in all sections.")
  132.  
  133. (defvar Man-section-translations-alist
  134.   '(("3C++" . "3")
  135.     ("3X" . "3")                        ; Xlib man pages
  136.     ("3X11" . "3")
  137.     ("1-UCB" . ""))
  138.   "*Association list of bogus sections to real section numbers.
  139. Some manpages (e.g. the Sun C++ 2.1 manpages) have section numbers in
  140. their references which Un*x `man' does not recognize.  This
  141. association list is used to translate those sections, when found, to
  142. the associated section number.")
  143.  
  144. (defvar Man-filter-list
  145.   '(("sed "
  146.      (;;"-e 's/.\010//g'"
  147.       "-e '/[Nn]o such file or directory/d'"
  148.       "-e '/Reformatting page.  Wait/d'"
  149.       "-e '/Reformatting entry.  Wait/d'"
  150.       "-e '/^ *\\([A-Za-z][A-Za-z.]*([0-9A-Za-z][-0-9A-Za-z+]*)\\).*\\1$/d'"
  151.       "-e '/^[ \t]*Hewlett-Packard Company[ \t]*- [0-9]* -.*$/d'"
  152.       "-e '/^[ \t]*Hewlett-Packard[ \t]*- [0-9]* -.*$/d'"
  153.       "-e '/^  *- [0-9]* - *Formatted:.*[0-9]$/d'"
  154.       "-e '/^[ \t]*Page [0-9]*.*(printed [0-9\\/]*)$/d'"
  155.       "-e '/^Printed [0-9].*[0-9]$/d'"
  156.       "-e '/^[ \t]*X Version 1[01].*Release [0-9]/d'"
  157.       "-e '/^[A-za-z].*Last change:/d'"
  158.       "-e '/^Sun Release [0-9].*[0-9]$/d'"
  159.       "-e '/^\\n$/D'"
  160.       ))
  161.     ("awk '\n"
  162.      ("BEGIN { blankline=0; anonblank=0; }\n"
  163.       "/^$/ { if (anonblank==0) next; }\n"
  164.       "{ anonblank=1; }\n"
  165.       "/^$/ { blankline++; next; }\n"
  166.       "{ if (blankline>0) { print \"\"; blankline=0; } print $0; }\n"
  167.       "'"
  168.       ))
  169.      )
  170.   "*Manpage cleaning filter command phrases.
  171. This variable contains an association list of the following form:
  172.  
  173. '((command-string (phrase-string*))*)
  174.  
  175. Each phrase-string is concatenated onto the command-string to form a
  176. command filter.  The (standard) output (and standard error) of the Un*x
  177. man command is piped through each command filter in the order the
  178. commands appear in the association list.  The final output is placed in
  179. the manpage buffer.")
  180.  
  181. (defvar Man-mode-line-format
  182.   '("" mode-line-modified
  183.        mode-line-buffer-identification "   "
  184.        global-mode-string
  185.        " " Man-page-mode-string
  186.        "    %[(" mode-name mode-line-process minor-mode-alist ")%]----"
  187.        (-3 . "%p") "-%-")
  188.   "*Mode line format for manual mode buffer.")
  189.  
  190. (defvar Man-mode-map nil
  191.   "*Keymap for Man mode.")
  192.  
  193. (defvar Man-mode-hook nil
  194.   "*Normal hook run when Man mode is enabled.")
  195.  
  196. (defvar Man-cooked-hook nil
  197.   "*Normal hook run after removing backspaces but before Man-mode processing.")
  198.  
  199. (defvar Man-section-regexp "[0-9][a-zA-Z+]*\\|[LNln]"
  200.   "*Regular expression describing a manpage section within parentheses.")
  201.  
  202. ;; Unless some system actually adds leading whitespace other than one space,
  203. ;; it is more reliable not to accept any other leading whitespace.
  204. (defvar Man-heading-regexp "^[ \t]*\\([A-Z][A-Z \t]+\\)$"
  205.   "*Regular expression describing a manpage heading entry.")
  206.  
  207. (defvar Man-see-also-regexp "SEE ALSO"
  208.   "*Regular expression for SEE ALSO heading (or your equivalent).
  209. This regexp should not start with a `^' character.")
  210.  
  211. (defvar Man-first-heading-regexp "^[ \t]*NAME$\\|^[ \t]*No manual entry fo.*$"
  212.   "*Regular expression describing first heading on a manpage.
  213. This regular expression should start with a `^' character.")
  214.  
  215. (defvar Man-reference-regexp
  216.   "[-a-zA-Z0-9_][-a-zA-Z0-9_.]*\\(([0-9][a-zA-Z+]*)\\)?"
  217.   "*Regular expression describing a reference in the SEE ALSO section.")
  218.  
  219. (defvar Man-switches ""
  220.   "*Switches passed to the man command, as a single string.")
  221.  
  222. ;; Would someone like to provide a good test for being on Solaris?
  223. ;; We could give it its own value of system-type, but that has drawbacks;
  224. ;; it would require changes in lots of places that test system-type.
  225. (defvar Man-specified-section-option
  226.   (if (string-match "-solaris[0-9.]*$" system-configuration)
  227.       "-s"
  228.     "")
  229.   "*Option that indicates a specified a manual section name.")
  230.  
  231. ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  232. ;; end user variables
  233.  
  234. ;; other variables and keymap initializations
  235. (make-variable-buffer-local 'Man-sections-alist)
  236. (make-variable-buffer-local 'Man-refpages-alist)
  237. (make-variable-buffer-local 'Man-page-list)
  238. (make-variable-buffer-local 'Man-current-page)
  239. (make-variable-buffer-local 'Man-page-mode-string)
  240. (make-variable-buffer-local 'Man-original-frame)
  241.  
  242. (setq-default Man-sections-alist nil)
  243. (setq-default Man-refpages-alist nil)
  244. (setq-default Man-page-list nil)
  245. (setq-default Man-current-page 0)
  246. (setq-default Man-page-mode-string "1 (of 1)")
  247.  
  248. (if Man-mode-map
  249.     nil
  250.   (setq Man-mode-map (make-keymap))
  251.   (suppress-keymap Man-mode-map)
  252.   (define-key Man-mode-map " "    'scroll-up)
  253.   (define-key Man-mode-map "\177" 'scroll-down)
  254.   (define-key Man-mode-map "n"    'Man-next-section)
  255.   (define-key Man-mode-map "p"    'Man-previous-section)
  256.   (define-key Man-mode-map "\en"  'Man-next-manpage)
  257.   (define-key Man-mode-map "\ep"  'Man-previous-manpage)
  258.   (define-key Man-mode-map ","    'beginning-of-buffer)
  259.   (define-key Man-mode-map "."    'end-of-buffer)
  260.   (define-key Man-mode-map "r"    'Man-follow-manual-reference)
  261.   (define-key Man-mode-map "t"    'toggle-truncate-lines)
  262.   (define-key Man-mode-map "g"    'Man-goto-section)
  263.   (define-key Man-mode-map "s"    'Man-goto-see-also-section)
  264.   (define-key Man-mode-map "q"    'Man-quit)
  265.   (define-key Man-mode-map "m"    'manual-entry)
  266.   (define-key Man-mode-map "?"    'describe-mode)
  267.   )
  268.  
  269.  
  270. ;; ======================================================================
  271. ;; utilities
  272.  
  273. (defun Man-page-mode-string ()
  274.   "Formats part of the mode line for Man mode."
  275.   (format "%d (of %d)" Man-current-page (length Man-page-list)))
  276.  
  277. (defun Man-delete-trailing-newline (str)
  278.   (if (string= (substring str (1- (length str))) "\n")
  279.       (substring str 0 (1- (length str)))
  280.     str))
  281.  
  282. (defun Man-build-man-command ()
  283.   "Builds the entire background manpage and cleaning command."
  284.   (let ((command (concat manual-program " " Man-switches " %s 2>/dev/null"))
  285.     (flist Man-filter-list))
  286.     (while flist
  287.       (let ((pcom (car (car flist)))
  288.         (pargs (car (cdr (car flist)))))
  289.     (setq flist (cdr flist))
  290.     (if (or (not (stringp pcom))
  291.         (not (listp pargs)))
  292.         (error "Malformed Man-filter-list"))
  293.     (setq command (concat command " | " pcom
  294.                   (mapconcat '(lambda (phrase) phrase)
  295.                      pargs " ")))))
  296.     command))
  297.  
  298. (defun Man-downcase (man-args)
  299.   "Downcases section letters in MAN-ARGS."
  300.   (let ((newargs "")
  301.     (s 0)
  302.     mstart mend
  303.     (len (length man-args)))
  304.     (while (and (< s len)
  305.         (setq mstart (string-match Man-section-regexp man-args s)))
  306.       (setq mend (match-end 0)
  307.         newargs (concat newargs (substring man-args s mstart)))
  308.       (setq newargs (concat newargs (downcase
  309.                      (substring man-args mstart mend)))
  310.         s mend))
  311.     (concat newargs (substring man-args s len))))
  312.  
  313. (defun Man-translate-references (ref)
  314.   "Translates REF from \"chmod(2V)\" to \"2v chmod\" style."
  315.   (if (string-match (concat "(" Man-section-regexp ")$") ref)
  316.       (let* ((word (progn (string-match "(" ref)
  317.               (substring ref 0 (1- (match-end 0)))))
  318.          (section-re (concat "(\\(" Man-section-regexp "\\))"))
  319.          (section (if (string-match section-re ref)
  320.               (substring ref (match-beginning 1) (match-end 1))
  321.             ""))
  322.          (slist Man-section-translations-alist)
  323.          )
  324.     (if Man-downcase-section-letters-p
  325.         (setq section (Man-downcase section)))
  326.     (while slist
  327.       (let ((s1 (car (car slist)))
  328.         (s2 (cdr (car slist))))
  329.         (setq slist (cdr slist))
  330.         (if Man-downcase-section-letters-p
  331.         (setq s1 (Man-downcase s1)))
  332.         (if (not (string= s1 section)) nil
  333.           (setq section (if Man-downcase-section-letters-p
  334.                 (Man-downcase s2)
  335.                   s2)
  336.             slist nil))))
  337.     (concat Man-specified-section-option section " " word))
  338.     ref))
  339.  
  340. (defun Man-linepos (&optional position col-p)
  341.   "Return the character position at various line/buffer positions.
  342. Preserves the state of point, mark, etc.  Optional arg POSITION can be one
  343. of the following symbols:
  344.      bol == beginning of line
  345.      boi == beginning of indentation
  346.      eol == end of line [default]
  347.      bob == beginning of buffer
  348.      eob == end of buffer
  349.  
  350. Optional arg COL-P, if non-nil, means to return
  351. the current column instead of character position."
  352.   (let ((tpnt (point))
  353.     rval)
  354.     (cond
  355.      ((eq position 'bol) (beginning-of-line))
  356.      ((eq position 'boi) (back-to-indentation))
  357.      ((eq position 'bob) (goto-char (point-min)))
  358.      ((eq position 'eob) (goto-char (point-max)))
  359.      (t (end-of-line)))
  360.     (setq rval (if col-p (current-column) (point)))
  361.     (goto-char tpnt)
  362.     rval))
  363.  
  364.  
  365. ;; ======================================================================
  366. ;; default man entry and get word under point
  367.  
  368. (defun Man-default-man-args (manword)
  369.   "Build the default man args from MANWORD and buffer's major mode."
  370.   (let ((sections (cdr (assq major-mode Man-auto-section-alist))))
  371.     (cond
  372.      ((null sections) manword)
  373.      ((consp sections) 
  374.       (mapconcat (lambda (n) (concat Man-specified-section-option
  375.                      n " " manword))
  376.          sections " "))
  377.      (t
  378.       (concat sections " " manword)))))
  379.  
  380. (defun Man-default-man-entry ()
  381.   "Make a guess at a default manual entry.
  382. This guess is based on the text surrounding the cursor, and the
  383. default section number is selected from `Man-auto-section-alist'."
  384.   (let (default-title)
  385.     (save-excursion
  386.       
  387.       ;; Default man entry title is any word the cursor is on,
  388.       ;; or if cursor not on a word, then nearest preceding
  389.       ;; word.
  390.       (and (not (looking-at "[a-zA-Z_]"))
  391.        (skip-chars-backward "^a-zA-Z_"))
  392.       (skip-chars-backward "(a-zA-Z_0-9")
  393.       (and (looking-at "(") (forward-char 1))
  394.       (setq default-title
  395.         (buffer-substring
  396.          (point)
  397.          (progn (skip-chars-forward "a-zA-Z0-9_") (point))))
  398.       
  399.       ;; If looking at something like ioctl(2) or brc(1M), include
  400.       ;; section number in default-entry
  401.       (if (looking-at "[ \t]*([ \t]*[0-9][a-zA-Z]?[ \t]*)")
  402.       (progn (skip-chars-forward "^0-9")
  403.          (setq default-title
  404.                (concat Man-specified-section-option
  405.                    (buffer-substring
  406.                 (point)
  407.                 (progn
  408.                   (skip-chars-forward "0-9a-zA-Z")
  409.                   (point)))
  410.                    " "
  411.                    default-title)))
  412.     (setq default-title (Man-default-man-args default-title)))
  413.       default-title)))
  414.      
  415.  
  416. ;; ======================================================================
  417. ;; top level command and background process sentinel
  418.  
  419. ;;; This alias makes completion more predictable if ignoring case.
  420. ;;;###autoload
  421. (defalias 'man 'manual-entry)
  422.  
  423. ;;;###autoload
  424. (defun manual-entry (arg)
  425.   "Get a Un*x manual page and put it in a buffer.
  426. This command is the top-level command in the man package.  It runs a Un*x
  427. command to retrieve and clean a manpage in the background and places the
  428. results in a Man mode (manpage browsing) buffer.  See variable
  429. `Man-notify' for what happens when the buffer is ready.
  430. Normally, if a buffer already exists for this man page, it will display
  431. immediately; either a prefix argument or a nil value to `Man-reuse-okay-p'
  432. overrides this and forces the man page to be regenerated."
  433.   (interactive "P")
  434.   (let* ((default-entry (Man-default-man-entry))
  435.      (man-args
  436.       (read-string (format "Manual-entry: %s"
  437.                    (if (string= default-entry "") ""
  438.                  (format "(default: %s) "
  439.                      default-entry))))))
  440.     (and (string= man-args "")
  441.      (if (string= default-entry "")
  442.          (error "No man args given")
  443.        (setq man-args default-entry)))
  444.  
  445.     ;; Recognize the subject(section) syntax.
  446.     (setq man-args (Man-translate-references man-args))
  447.  
  448.     ;; This is apparently already done correctly via Man-translate-references.
  449.     ;; (if Man-downcase-section-letters-p
  450.     ;;    (setq man-args (Man-downcase man-args)))
  451.     (Man-getpage-in-background man-args (consp arg))
  452.     ))
  453.  
  454. (defun Man-getpage-in-background (topic &optional override-reuse-p)
  455.   "Uses TOPIC to build and fire off the manpage and cleaning command.
  456. Optional OVERRIDE-REUSE-P, when non-nil, means to
  457. start a background process even if a buffer already exists and
  458. `Man-reuse-okay-p' is non-nil."
  459.   (let* ((man-args topic)
  460.      (bufname (concat "*man " man-args "*"))
  461.      (buffer  (get-buffer bufname)))
  462.     (if (and Man-reuse-okay-p
  463.          (not override-reuse-p)
  464.          buffer)
  465.     (Man-notify-when-ready buffer)
  466.       (require 'env)
  467.       (message "Invoking %s %s in background" manual-program man-args)
  468.       (setq buffer (generate-new-buffer bufname))
  469.       (save-excursion
  470.     (set-buffer buffer)
  471.     (setq Man-original-frame (selected-frame)))
  472.       (let ((process-environment (copy-sequence process-environment)))
  473.     ;; Prevent any attempt to use display terminal fanciness.
  474.     (setenv "TERM" "dumb")
  475.     (set-process-sentinel
  476.      (start-process manual-program buffer "sh" "-c"
  477.             (format (Man-build-man-command) man-args))
  478.      'Man-bgproc-sentinel))
  479.       )))
  480.  
  481. (defun Man-notify-when-ready (man-buffer)
  482.   "Notify the user when MAN-BUFFER is ready.
  483. See the variable `Man-notify' for the different notification behaviors."
  484.   (let ((saved-frame (save-excursion
  485.                (set-buffer man-buffer)
  486.                Man-original-frame)))
  487.     (cond
  488.      ((eq Man-notify 'newframe)
  489.       ;; Since we run asynchronously, perhaps while Emacs is waiting for input,
  490.       ;; we must not leave a different buffer current.
  491.       ;; We can't rely on the editor command loop to reselect
  492.       ;; the selected window's buffer.
  493.       (save-excursion
  494.     (set-buffer man-buffer)
  495.     (make-frame Man-frame-parameters)))
  496.      ((eq Man-notify 'bully)
  497.       (and window-system
  498.        (frame-live-p saved-frame)
  499.        (select-frame saved-frame))
  500.       (pop-to-buffer man-buffer)
  501.       (delete-other-windows))
  502.      ((eq Man-notify 'aggressive)
  503.       (and window-system
  504.        (frame-live-p saved-frame)
  505.        (select-frame saved-frame))
  506.       (pop-to-buffer man-buffer))
  507.      ((eq Man-notify 'friendly)
  508.       (and window-system
  509.        (frame-live-p saved-frame)
  510.        (select-frame saved-frame))
  511.       (display-buffer man-buffer 'not-this-window))
  512.      ((eq Man-notify 'polite)
  513.       (beep)
  514.       (message "Manual buffer %s is ready." (buffer-name man-buffer)))
  515.      ((eq Man-notify 'quiet)
  516.       (message "Manual buffer %s is ready." (buffer-name man-buffer)))
  517.      ((or (eq Man-notify 'meek)
  518.       t)
  519.       (message ""))
  520.      )))
  521.  
  522. (defun Man-set-fonts ()
  523.   (goto-char (point-min))
  524.   (while (re-search-forward "\\(.\b\\)+" nil t)
  525.     (let ((st (match-beginning 0)) (en (match-end 0)))
  526.       (goto-char st)
  527.       (if window-system
  528.       (put-text-property st (if (= en (point-max)) en (1+ en)) 'face 
  529.                  (if (looking-at "_") 'underline 'bold)))
  530.       (while (and (< (point) en) (looking-at ".\b"))
  531.     (replace-match "")))))
  532.  
  533. (defun Man-bgproc-sentinel (process msg)
  534.   "Manpage background process sentinel."
  535.   (let ((Man-buffer (process-buffer process))
  536.     (delete-buff nil)
  537.     (err-mess nil))
  538.     (if (null (buffer-name Man-buffer)) ;; deleted buffer
  539.     (set-process-buffer process nil)
  540.       (save-match-data
  541.     (save-excursion
  542.       (set-buffer Man-buffer)
  543.       (goto-char (point-min))
  544.       (let ((case-fold-search nil))
  545.         (cond ((or (looking-at "No \\(manual \\)*entry for")
  546.                (looking-at "[^\n]*: nothing appropriate$"))
  547.            (setq err-mess (buffer-substring (point) (Man-linepos 'eol))
  548.              delete-buff t))
  549.           ((not (and (eq (process-status process) 'exit)
  550.                  (= (process-exit-status process) 0)))
  551.            (setq err-mess
  552.              (concat (buffer-name Man-buffer)
  553.                  ": process "
  554.                  (let ((eos (1- (length msg))))
  555.                    (if (= (aref msg eos) ?\n)
  556.                        (substring msg 0 eos) msg))))
  557.            (goto-char (point-max))
  558.            (insert (format "\nprocess %s" msg))
  559.            ))))
  560.     (if delete-buff
  561.         (kill-buffer Man-buffer)
  562.       (save-window-excursion
  563.         (save-excursion
  564.           (set-buffer Man-buffer)
  565.           (let ((case-fold-search nil))
  566.         (Man-set-fonts)
  567.         (run-hooks 'Man-cooked-hook)
  568.         (Man-mode))
  569.           (set-buffer-modified-p nil)))
  570.       (Man-notify-when-ready Man-buffer))
  571.  
  572.     (if err-mess
  573.         (error err-mess))))))
  574.  
  575.  
  576. ;; ======================================================================
  577. ;; set up manual mode in buffer and build alists
  578.  
  579. (defun Man-mode ()
  580.   "A mode for browsing Un*x manual pages.
  581.  
  582. The following man commands are available in the buffer. Try
  583. \"\\[describe-key] <key> RET\" for more information:
  584.  
  585. \\[manual-entry]       Prompt to retrieve a new manpage.
  586. \\[Man-follow-manual-reference]       Retrieve reference in SEE ALSO section.
  587. \\[Man-next-manpage]   Jump to next manpage in circular list.
  588. \\[Man-previous-manpage]   Jump to previous manpage in circular list.
  589. \\[Man-next-section]       Jump to next manpage section.
  590. \\[Man-previous-section]       Jump to previous manpage section.
  591. \\[Man-goto-section]       Go to a manpage section.
  592. \\[Man-goto-see-also-section]       Jumps to the SEE ALSO manpage section.
  593. \\[Man-quit]       Deletes the manpage, its buffer, and window.
  594. \\[describe-mode]       Prints this help text.
  595.  
  596. The following variables may be of some use. Try
  597. \"\\[describe-variable] <variable-name> RET\" for more information:
  598.  
  599. Man-notify                      What happens when manpage formatting is done.
  600. Man-reuse-okay-p                Okay to reuse already formatted buffer?
  601. Man-downcase-section-letters-p  Force section letters to lower case?
  602. Man-circular-pages-p            Multiple manpage list treated as circular?
  603. Man-auto-section-alist          List of major modes and their section numbers.
  604. Man-section-translations-alist  List of section numbers and their Un*x equiv.
  605. Man-filter-list                 Background manpage filter command.
  606. Man-mode-line-format            Mode line format for Man mode buffers.
  607. Man-mode-map                    Keymap bindings for Man mode buffers.
  608. Man-mode-hook                   Normal hook run on entry to Man mode.
  609. Man-section-regexp              Regexp describing manpage section letters.
  610. Man-heading-regexp              Regexp describing section headers.
  611. Man-see-also-regexp             Regexp for SEE ALSO section (or your equiv).
  612. Man-first-heading-regexp        Regexp for first heading on a manpage.
  613. Man-reference-regexp            Regexp matching a references in SEE ALSO.
  614. Man-switches            Background `man' command switches.
  615.  
  616. The following key bindings are currently in effect in the buffer:
  617. \\{Man-mode-map}"
  618.   (interactive)
  619.   (setq major-mode 'Man-mode
  620.     mode-name "Man"
  621.     buffer-auto-save-file-name nil
  622.     mode-line-format Man-mode-line-format
  623.     truncate-lines t
  624.     buffer-read-only t)
  625.   (buffer-disable-undo (current-buffer))
  626.   (auto-fill-mode -1)
  627.   (use-local-map Man-mode-map)
  628.   (goto-char (point-min))
  629.   (Man-build-page-list)
  630.   (Man-goto-page 1)
  631.   (run-hooks 'Man-mode-hook))
  632.  
  633. (defun Man-build-section-alist ()
  634.   "Build the association list of manpage sections."
  635.   (setq Man-sections-alist nil)
  636.   (goto-char (point-min))
  637.   (let ((case-fold-search nil))
  638.     (while (re-search-forward Man-heading-regexp (point-max) t)
  639.       (aput 'Man-sections-alist
  640.         (buffer-substring (match-beginning 1) (match-end 1)))
  641.       (forward-line 1))))
  642.  
  643. (defun Man-build-references-alist ()
  644.   "Build the association list of references (in the SEE ALSO section)."
  645.   (setq Man-refpages-alist nil)
  646.   (save-excursion
  647.     (if (Man-find-section Man-see-also-regexp)
  648.     (let ((start (progn (forward-line 1) (point)))
  649.           (end (progn
  650.              (Man-next-section 1)
  651.              (point)))
  652.           hyphenated
  653.           (runningpoint -1))
  654.       (save-restriction
  655.         (narrow-to-region start end)
  656.         (goto-char (point-min))
  657.         (back-to-indentation)
  658.         (while (and (not (eobp)) (/= (point) runningpoint))
  659.           (setq runningpoint (point))
  660.           (let* ((eow (re-search-forward Man-reference-regexp end t))
  661.              (word (buffer-substring
  662.                 (match-beginning 0) (match-end 0)))
  663.              (len (1- (length word))))
  664.         (if (not eow) nil
  665.           (if hyphenated
  666.               (setq word (concat hyphenated word)
  667.                 hyphenated nil))
  668.           (if (= (aref word len) ?-)
  669.               (setq hyphenated (substring word 0 len))
  670.             (aput 'Man-refpages-alist word))))
  671.           (skip-chars-forward " \t\n,")))))))
  672.  
  673. (defun Man-build-page-list ()
  674.   "Build the list of separate manpages in the buffer."
  675.   (setq Man-page-list nil)
  676.   (save-excursion
  677.     (let ((page-start (Man-linepos 'bob))
  678.       (page-end (Man-linepos 'eob))
  679.       (regexp Man-first-heading-regexp))
  680.       (goto-char (point-min))
  681.       (re-search-forward regexp (point-max) t)
  682.       (while (not (eobp))
  683.     (if (re-search-forward regexp (point-max) t)
  684.         (progn
  685.           (setq page-end (Man-linepos 'bol))
  686.           (end-of-line))
  687.       (goto-char (point-max))
  688.       (setq page-end (point)))
  689.     (setq Man-page-list (append Man-page-list
  690.                     (list (cons page-start page-end)))
  691.           page-start page-end)
  692.     ))))
  693.  
  694.  
  695. ;; ======================================================================
  696. ;; Man mode commands
  697.  
  698. (defun Man-next-section (n)
  699.   "Move point to Nth next section (default 1)."
  700.   (interactive "p")
  701.   (let ((case-fold-search nil))
  702.     (if (looking-at Man-heading-regexp)
  703.     (forward-line 1))
  704.     (if (re-search-forward Man-heading-regexp (point-max) t n)
  705.     (beginning-of-line)
  706.       (goto-char (point-max)))))
  707.  
  708. (defun Man-previous-section (n)
  709.   "Move point to Nth previous section (default 1)."
  710.   (interactive "p")
  711.   (let ((case-fold-search nil))
  712.     (if (looking-at Man-heading-regexp)
  713.     (forward-line -1))
  714.     (if (re-search-backward Man-heading-regexp (point-min) t n)
  715.     (beginning-of-line)
  716.       (goto-char (point-min)))))
  717.  
  718. (defun Man-find-section (section)
  719.   "Move point to SECTION if it exists, otherwise don't move point.
  720. Returns t if section is found, nil otherwise."
  721.   (let ((curpos (point))
  722.     (case-fold-search nil))
  723.     (goto-char (point-min))
  724.     (if (re-search-forward (concat "^[ \t]*" section) (point-max) t)
  725.     (progn (beginning-of-line) t)
  726.       (goto-char curpos)
  727.       nil)
  728.     ))
  729.  
  730. (defun Man-goto-section ()
  731.   "Query for section to move point to."
  732.   (interactive)
  733.   (aput 'Man-sections-alist
  734.     (let* ((default (aheadsym Man-sections-alist))
  735.            (completion-ignore-case t)
  736.            chosen
  737.            (prompt (concat "Go to section: (default " default ") ")))
  738.       (setq chosen (completing-read prompt Man-sections-alist))
  739.       (if (or (not chosen)
  740.           (string= chosen ""))
  741.           default
  742.         chosen)))
  743.   (Man-find-section (aheadsym Man-sections-alist)))
  744.  
  745. (defun Man-goto-see-also-section ()
  746.   "Move point the the \"SEE ALSO\" section.
  747. Actually the section moved to is described by `Man-see-also-regexp'."
  748.   (interactive)
  749.   (if (not (Man-find-section Man-see-also-regexp))
  750.       (error (concat "No " Man-see-also-regexp
  751.              " section found in current manpage"))))
  752.  
  753. (defun Man-follow-manual-reference (arg reference)
  754.   "Get one of the manpages referred to in the \"SEE ALSO\" section.
  755. Specify which reference to use; default is based on word at point.
  756. Prefix argument ARG is passed to `Man-getpage-in-background'."
  757.   (interactive
  758.    (if (not Man-refpages-alist)
  759.        (error "No references in current man page")
  760.      (list current-prefix-arg
  761.        (let* ((default (or
  762.                  (car (all-completions
  763.                    (save-excursion
  764.                      (skip-syntax-backward "w()")
  765.                      (skip-chars-forward " \t")
  766.                      (let ((word (current-word)))
  767.                        ;; strip a trailing '-':
  768.                        (if (string-match "-$" word)
  769.                        (substring word 0
  770.                               (match-beginning 0))
  771.                      word)))
  772.                    Man-refpages-alist))
  773.                  (aheadsym Man-refpages-alist)))
  774.            chosen
  775.            (prompt (concat "Refer to: (default " default ") ")))
  776.           (setq chosen (completing-read prompt Man-refpages-alist nil t))
  777.           (if (or (not chosen)
  778.               (string= chosen ""))
  779.           default
  780.         chosen)))))
  781.   (if (not Man-refpages-alist)
  782.       (error "No references found in current manpage")
  783.     (aput 'Man-refpages-alist reference)
  784.     (Man-getpage-in-background
  785.      (Man-translate-references (aheadsym Man-refpages-alist))
  786.      arg)))
  787.  
  788. (defun Man-quit ()
  789.   "Kill the buffer containing the manpage."
  790.   (interactive)
  791.   (let ((buff (current-buffer)))
  792.     (delete-windows-on buff)
  793.     (kill-buffer buff)))
  794.  
  795. (defun Man-goto-page (page)
  796.   "Go to the manual page on page PAGE."
  797.   (interactive
  798.    (if (= (length Man-page-list) 1)
  799.        (error "You're looking at the only manpage in the buffer.")
  800.      (list (read-minibuffer (format "Go to manpage [1-%d]: "
  801.                     (length Man-page-list))))))
  802.   (if (or (< page 1)
  803.       (> page (length Man-page-list)))
  804.       (error "No manpage %d found" page))
  805.   (let* ((page-range (nth (1- page) Man-page-list))
  806.      (page-start (car page-range))
  807.      (page-end (cdr page-range)))
  808.     (setq Man-current-page page
  809.       Man-page-mode-string (Man-page-mode-string))
  810.     (widen)
  811.     (goto-char page-start)
  812.     (narrow-to-region page-start page-end)
  813.     (Man-build-section-alist)
  814.     ;; Don't let bugs in Man-build-references-alist
  815.     ;; interfere with ordinary use of this package.
  816.     (condition-case nil
  817.     (Man-build-references-alist)
  818.       (error))
  819.     (widen)
  820.     (narrow-to-region page-start page-end)
  821.     (goto-char (point-min))))
  822.  
  823.  
  824. (defun Man-next-manpage ()
  825.   "Find the next manpage entry in the buffer."
  826.   (interactive)
  827.   (if (= (length Man-page-list) 1)
  828.       (error "This is the only manpage in the buffer"))
  829.   (if (< Man-current-page (length Man-page-list))
  830.       (Man-goto-page (1+ Man-current-page))
  831.     (if Man-circular-pages-p
  832.     (Man-goto-page 1)
  833.       (error "You're looking at the last manpage in the buffer"))))
  834.  
  835. (defun Man-previous-manpage ()
  836.   "Find the previous manpage entry in the buffer."
  837.   (interactive)
  838.   (if (= (length Man-page-list) 1)
  839.       (error "This is the only manpage in the buffer"))
  840.   (if (> Man-current-page 1)
  841.       (Man-goto-page (1- Man-current-page))
  842.     (if Man-circular-pages-p
  843.     (Man-goto-page (length Man-page-list))
  844.       (error "You're looking at the first manpage in the buffer"))))
  845.  
  846. (provide 'man)
  847.  
  848. ;;; man.el ends here
  849.