| blob | 550d1c5f04040f16dcde38872f288d61c1bdb0eb |
1 ;;; man.el --- browse UNIX manual pages
3 ;; Copyright (C) 1993, 1994, 1996, 1997, 2001 Free Software Foundation, Inc.
5 ;; Author: Barry A. Warsaw <bwarsaw@cen.com>
6 ;; Maintainer: FSF
7 ;; Keywords: help
8 ;; Adapted-By: ESR, pot
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; This code provides a function, `man', with which you can browse
30 ;; UNIX manual pages. Formatting is done in background so that you
31 ;; 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.
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 everything in one single package, so I decided
41 ;; to incorporate 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.
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.
51 ;; Eric Rose <erose@jessica.stanford.edu>, submitted manual.el which
52 ;; provided a very nice manual browsing mode.
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.
59 ;; Francesco Potorti` <pot@cnuce.cnr.it> cleaned it up thoroughly,
60 ;; making it faster, more robust and more tolerant of different
61 ;; systems' man idiosyncrasies.
63 ;; ========== Features ==========
64 ;; + Runs "man" in the background and pipes the results through a
65 ;; series of sed and awk scripts so that all retrieving and cleaning
66 ;; is done in the background. The cleaning commands are configurable.
67 ;; + Syntax is the same as Un*x man
68 ;; + Functionality is the same as Un*x man, including "man -k" and
69 ;; "man <section>", etc.
70 ;; + Provides a manual browsing mode with keybindings for traversing
71 ;; the sections of a manpage, following references in the SEE ALSO
72 ;; section, and more.
73 ;; + Multiple manpages created with the same man command are put into
74 ;; a narrowed buffer circular list.
76 ;; ============= TODO ===========
77 ;; - Add a command for printing.
78 ;; - The awk script deletes multiple blank lines. This behaviour does
79 ;; not allow to understand if there was indeed a blank line at the
80 ;; end or beginning of a page (after the header, or before the
81 ;; footer). A different algorithm should be used. It is easy to
82 ;; compute how many blank lines there are before and after the page
83 ;; headers, and after the page footer. But it is possible to compute
84 ;; the number of blank lines before the page footer by euristhics
85 ;; only. Is it worth doing?
86 ;; - Allow a user option to mean that all the manpages should go in
87 ;; the same buffer, where they can be browsed with M-n and M-p.
88 ;; - Allow completion on the manpage name when calling man. This
89 ;; requires a reliable list of places where manpages can be found. The
90 ;; drawback would be that if the list is not complete, the user might
91 ;; be led to believe that the manpages in the missing directories do
92 ;; not exist.
94 \f
95 ;;; Code:
99 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
100 ;; empty defvars (keep the compiler quiet)
103 "Browse UNIX manual pages."
112 "*Manpage cleaning filter command phrases.
113 This variable contains a list of the following form:
115 '((command-string phrase-string*)*)
117 Each phrase-string is concatenated onto the command-string to form a
118 command filter. The (standard) output (and standard error) of the Un*x
119 man command is piped through each command filter in the order the
120 commands appear in the association list. The final output is placed in
121 the manpage buffer."
137 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
138 ;; user variables
141 "*Non-nil means make up the manpage with fonts."
146 "*Face to use when fontifying overstrike."
151 "*Face to use when fontifying underlining."
155 ;; Use the value of the obsolete user option Man-notify, if set.
157 "*Selects the behavior when manpage is ready.
158 This variable may have one of the following values, where (sf) means
159 that the frames are switched, so the manpage is displayed in the frame
160 where the man command was called from:
162 newframe -- put the manpage in its own frame (see `Man-frame-parameters')
163 pushy -- make the manpage the current buffer in the current window
164 bully -- make the manpage the current buffer and only window (sf)
165 aggressive -- make the manpage the current buffer in the other window (sf)
166 friendly -- display manpage in the other window but don't make current (sf)
167 polite -- don't display manpage, but prints message and beep when ready
168 quiet -- like `polite', but don't beep
169 meek -- make no indication that the manpage is ready
171 Any other value of `Man-notify-method' is equivalent to `meek'."
178 "*Frame parameter list for creating a new frame for a manual page."
183 "*Non-nil means letters in sections are converted to lower case.
184 Some Un*x man commands can't handle uppercase letters in sections, for
186 with the upper case letter. When this variable is t, the section
188 being sent to the man background process."
193 "*Non-nil means the manpage list is treated as circular for traversal."
200 ;; Some systems have a real 3x man section, so let's comment this.
201 ;; '("3X" . "3") ; Xlib man pages
204 "*Association list of bogus sections to real section numbers.
205 Some manpages (e.g. the Sun C++ 2.1 manpages) have section numbers in
206 their references which Un*x `man' does not recognize. This
207 association list is used to translate those sections, when found, to
208 the associated section number."
256 "Regular expression for SEE ALSO heading (or your equivalent).
260 "Regular expression describing first heading on a manpage.
267 ;; This includes the section as an optional part to catch hyphenated
268 ;; refernces to manpages.
274 "Switches passed to the man command, as a single string.
276 If you want to be able to see all the manpages for a subject you type,
281 "-s"
285 ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
286 ;; end user variables
287 \f
288 ;; other variables and keymap initializations
308 :ovstrk
310 t ovstrk
311 }
331 table)
335 nil
355 )
357 \f
358 ;; ======================================================================
359 ;; utilities
362 "Used for initialising variables based on display's color support.
363 This is necessary if one wants to dump man.el with Emacs."
365 ;; Avoid possible error in call-process by using a directory that must exist.
370 nil)
372 Man-sysv-sed-script)
374 Man-berkeley-sed-script)
376 nil))))
379 ;; Avoid trailing nil which confuses customize.
382 Man-sed-command
388 "-e '/\e[789]/s///g'"
389 "-e '/Reformatting page. Wait/d'"
390 "-e '/Reformatting entry. Wait/d'"
401 ))
403 Man-awk-command
411 "'"
412 ))
414 ;; The outer list will be stripped off by apply.
416 Man-untabify-command
417 Man-untabify-command-args))
418 )))
419 )
422 "Return the substring matched by the last search.
423 Optional arg N means return the substring matched by the Nth paren
424 grouping. Optional second arg STRING means return a substring from
425 that string instead of from the current buffer."
432 "Formats part of the mode line for Man mode."
436 Man-current-page
440 "Builds the entire background manpage and cleaning command."
442 ; Stock MS-DOS shells cannot redirect stderr;
443 ; `call-process' below sends it to /dev/null,
444 ; so we don't need `2>' even with DOS shells
445 ; which do support stderr redirection.
447 " %s"
458 phrase)
461 command))
465 Leave it as is if already in that style. Possibly downcase and
466 translate the section (see the Man-downcase-section-letters-flag
467 and the Man-section-translations-alist variables)."
472 ;; "chmod(2V)" case ?
476 ;; "2v chmod" case ?
482 ref ; Return the reference as is
494 s2)
495 slist nil))))
498 \f
499 ;; ======================================================================
500 ;; default man entry: get word under point
503 "Make a guess at a default manual entry.
504 This guess is based on the text surrounding the cursor."
507 ;; Default man entry title is any word the cursor is on, or if
508 ;; cursor not on a word, then nearest preceding word.
512 ;; If looking at something like ioctl(2) or brc(1M), include the
513 ;; section number in the returned value. Remove text properties.
515 ;; Use `format' here to clear any text props from `word'.
517 word
523 \f
524 ;; ======================================================================
525 ;; Top level command and background process sentinel
527 ;; For compatibility with older versions.
528 ;;;###autoload
531 ;;;###autoload
533 "Get a Un*x manual page and put it in a buffer.
534 This command is the top-level command in the man package. It runs a Un*x
535 command to retrieve and clean a manpage in the background and places the
536 results in a Man mode (manpage browsing) buffer. See variable
537 `Man-notify-method' for what happens when the buffer is ready.
538 If a buffer already exists for this man page, it will display immediately.
540 To specify a man page from a certain section, type SUBJECT(SECTION) or
541 SECTION SUBJECT when prompted for a manual entry. To see manpages from
542 all sections related to a subject, put something appropriate into the
543 `Man-switches' variable, which see."
549 ""
554 default-entry)
555 input))))
557 ;; Possibly translate the "subject(section)" syntax into the
558 ;; "section subject" syntax and possibly downcase the section.
563 ;;;###autoload
565 "Get a Un*x manual page of the item under point and put it in a buffer."
573 "Use TOPIC to build and fire off the manpage and cleaning command."
587 ;; The following is so Awk script gets \n intact
588 ;; But don't prevent decoding of the outside.
590 ;; We must decode the output by a coding system that the
591 ;; system's locale suggests in multibyte mode.
595 ;; Avoid possible error by using a directory that always exists.
597 ;; Prevent any attempt to use display terminal fanciness.
614 exit-status)))
619 "Notify the user when MAN-BUFFER is ready.
620 See the variable `Man-notify-method' for the different notification behaviors."
623 Man-original-frame)))
626 ;; Since we run asynchronously, perhaps while Emacs is waiting
627 ;; for input, we must not leave a different buffer current. We
628 ;; can't rely on the editor command loop to reselect the
629 ;; selected window's buffer.
657 t)
659 )))
662 ;; \255 is some kind of dash in Latin-N. Versions of Debian man, at
663 ;; least, emit it even when not in a Latin-N locale.
673 "Convert overstriking and underlining to the correct fonts.
674 Same for the ANSI bold and normal escape sequences."
686 ;; Multibyte characters exist.
720 "Remove overstriking and underlining from the current buffer."
723 Man-arguments)
737 ))
744 "Manpage background process sentinel.
745 When manpage command is run asynchronously, PROCESS is the process
746 object for the manpage command; when manpage command is run
747 synchronously, PROCESS is the name of the buffer where the manpage
748 command is run. Second argument MSG is the exit message of the
749 manpage command."
768 delete-buff t))
776 ": process "
782 ))
791 ))
792 ;; Restore case-fold-search before calling
793 ;; Man-notify-when-ready because it may switch buffers.
800 ))))
802 \f
803 ;; ======================================================================
804 ;; set up manual mode in buffer and build alists
807 "A mode for browsing Un*x manual pages.
809 The following man commands are available in the buffer. Try
824 The following variables may be of some use. Try
827 `Man-notify-method' What happens when manpage formatting is done.
828 `Man-downcase-section-letters-flag' Force section letters to lower case.
829 `Man-circular-pages-flag' Treat multiple manpage list as circular.
830 `Man-section-translations-alist' List of section numbers and their Un*x equiv.
831 `Man-filter-list' Background manpage filter command.
832 `Man-mode-map' Keymap bindings for Man mode buffers.
833 `Man-mode-hook' Normal hook run on entry to Man mode.
834 `Man-section-regexp' Regexp describing manpage section letters.
835 `Man-heading-regexp' Regexp describing section headers.
836 `Man-see-also-regexp' Regexp for SEE ALSO section (or your equiv).
837 `Man-first-heading-regexp' Regexp for first heading on a manpage.
838 `Man-reference-regexp' Regexp matching a references in SEE ALSO.
839 `Man-switches' Background `man' command switches.
841 The following key bindings are currently in effect in the buffer:
845 mode-name "Man"
846 buffer-auto-save-file-name nil
847 mode-line-buffer-identification
850 truncate-lines t
851 buffer-read-only t)
863 "Build the association list of manpage sections."
872 "Build the association list of references (in the SEE ALSO section)."
880 hyphenated
893 hyphenated nil
894 ;; Update len, in case a reference spans
895 ;; more than two lines (paranoia).
905 "Build the list of separate manpages in the buffer."
911 ;; (switch-to-buffer (current-buffer))(debug)
916 nil))
917 ;; Go past both the current and the next Man-first-heading-regexp
920 ;; We assume that the page header is delimited by blank
921 ;; lines and that it contains at most one blank line. So
922 ;; if we back by three blank lines we will be sure to be
923 ;; before the page header but not before the possible
924 ;; previous page header.
932 header))))
934 )))
937 "Strip all the page headers but the first from the manpage."
949 ;; Since the awk script collapses all successive blank
950 ;; lines into one, and since we don't want to get rid of
951 ;; the fast awk script, one must choose between adding
952 ;; spare blank lines between pages when there were none and
953 ;; deleting blank lines at page boundaries when there were
954 ;; some. We choose the first, so we comment the following
955 ;; line.
956 ;; (setq header (concat "\n" header)))
962 "Delete the leading spaces that indent the manpage."
997 ))))
999 \f
1000 ;; ======================================================================
1001 ;; Man mode commands
1004 "Move point to Nth next section (default 1)."
1014 "Move point to Nth previous section (default 1)."
1024 "Move point to SECTION if it exists, otherwise don't move point.
1025 Returns t if section is found, nil otherwise."
1032 nil)
1033 ))
1036 "Query for section to move point to."
1041 chosen
1046 default
1047 chosen)))
1052 Actually the section moved to is described by `Man-see-also-regexp'."
1059 "Return a possibly hyphenated word at point.
1060 If the word starts at the first non-whitespace column, and the
1061 previous line ends with a hyphen, return the last word on the previous
1076 word)))
1080 Specify which REFERENCE to use; default is based on word at point."
1087 ;; strip a trailing '-':
1091 word))
1092 Man-refpages-alist))
1094 chosen
1099 default
1100 chosen)))))
1108 "Kill the buffer containing the manpage."
1113 "Bury the buffer containing the manpage."
1118 "Go to the manual page on page PAGE."
1149 "Find the next manpage entry in the buffer."
1160 "Find the previous manpage entry in the buffer."
1169 \f
1170 ;; Init the man package variables, if not already done.
1178 ;;; man.el ends here