| blob | 8b4d9072cb7092f535e23040f0351dd39d61cccf |
1 ;;; man.el --- browse UNIX manual pages
3 ;; Copyright (C) 1993, 1994, 1996 Free Software Foundation, Inc.
5 ;; Author: Barry A. Warsaw <bwarsaw@cen.com>
6 ;; Keywords: help
7 ;; Adapted-By: ESR, pot
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;; Commentary:
28 ;; This code provides a function, `man', with which you can browse
29 ;; UNIX manual pages. Formatting is done in background so that you
30 ;; can continue to use your Emacs while processing is going on.
31 ;;
32 ;; The mode also supports hypertext-like following of manual page SEE
33 ;; ALSO references, and other features. See below or do `?' in a
34 ;; manual page buffer for details.
36 ;; ========== Credits and History ==========
37 ;; In mid 1991, several people posted some interesting improvements to
38 ;; man.el from the standard emacs 18.57 distribution. I liked many of
39 ;; these, but wanted everything in one single package, so I decided
40 ;; to incorporate them into a single manual browsing mode. While
41 ;; much of the code here has been rewritten, and some features added,
42 ;; these folks deserve lots of credit for providing the initial
43 ;; excellent packages on which this one is based.
45 ;; Nick Duffek <duffek@chaos.cs.brandeis.edu>, posted a very nice
46 ;; improvement which retrieved and cleaned the manpages in a
47 ;; background process, and which correctly deciphered such options as
48 ;; man -k.
50 ;; Eric Rose <erose@jessica.stanford.edu>, submitted manual.el which
51 ;; provided a very nice manual browsing mode.
53 ;; This package was available as `superman.el' from the LCD package
54 ;; for some time before it was accepted into Emacs 19. The entry
55 ;; point and some other names have been changed to make it a drop-in
56 ;; replacement for the old man.el package.
58 ;; Francesco Potorti` <pot@cnuce.cnr.it> cleaned it up thoroughly,
59 ;; making it faster, more robust and more tolerant of different
60 ;; systems' man idiosyncrasies.
62 ;; ========== Features ==========
63 ;; + Runs "man" in the background and pipes the results through a
64 ;; series of sed and awk scripts so that all retrieving and cleaning
65 ;; is done in the background. The cleaning commands are configurable.
66 ;; + Syntax is the same as Un*x man
67 ;; + Functionality is the same as Un*x man, including "man -k" and
68 ;; "man <section>", etc.
69 ;; + Provides a manual browsing mode with keybindings for traversing
70 ;; the sections of a manpage, following references in the SEE ALSO
71 ;; section, and more.
72 ;; + Multiple manpages created with the same man command are put into
73 ;; a narrowed buffer circular list.
75 ;; ============= TODO ===========
76 ;; - Add a command for printing.
77 ;; - The awk script deletes multiple blank lines. This behaviour does
78 ;; not allow to understand if there was indeed a blank line at the
79 ;; end or beginning of a page (after the header, or before the
80 ;; footer). A different algorithm should be used. It is easy to
81 ;; compute how many blank lines there are before and after the page
82 ;; headers, and after the page footer. But it is possible to compute
83 ;; the number of blank lines before the page footer by euristhics
84 ;; only. Is it worth doing?
85 ;; - Allow a user option to mean that all the manpages should go in
86 ;; the same buffer, where they can be browsed with M-n and M-p.
87 ;; - Allow completion on the manpage name when calling man. This
88 ;; requires a reliable list of places where manpages can be found. The
89 ;; drawback would be that if the list is not complete, the user might
90 ;; be led to believe that the manpages in the missing directories do
91 ;; not exist.
93 \f
94 ;;; Code:
98 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
99 ;; empty defvars (keep the compiler quiet)
105 "*Manpage cleaning filter command phrases.
106 This variable contains a list of the following form:
108 '((command-string phrase-string*)*)
110 Each phrase-string is concatenated onto the command-string to form a
111 command filter. The (standard) output (and standard error) of the Un*x
112 man command is piped through each command filter in the order the
113 commands appear in the association list. The final output is placed in
126 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
127 ;; user variables
138 ;; Use the value of the obsolete user option Man-notify, if set.
140 "*Selects the behavior when manpage is ready.
141 This variable may have one of the following values, where (sf) means
142 that the frames are switched, so the manpage is displayed in the frame
143 where the man command was called from:
145 newframe -- put the manpage in its own frame (see `Man-frame-parameters')
146 pushy -- make the manpage the current buffer in the current window
147 bully -- make the manpage the current buffer and only window (sf)
148 aggressive -- make the manpage the current buffer in the other window (sf)
149 friendly -- display manpage in the other window but don't make current (sf)
150 polite -- don't display manpage, but prints message and beep when ready
151 quiet -- like `polite', but don't beep
152 meek -- make no indication that the manpage is ready
160 "*Letters in sections are converted to lower case.
161 Some Un*x man commands can't handle uppercase letters in sections, for
163 with the upper case letter. When this variable is t, the section
173 ;; Some systems have a real 3x man section, so let's comment this.
174 ;; '("3X" . "3") ; Xlib man pages
177 "*Association list of bogus sections to real section numbers.
178 Some manpages (e.g. the Sun C++ 2.1 manpages) have section numbers in
179 their references which Un*x `man' does not recognize. This
180 association list is used to translate those sections, when found, to
200 mode-line-buffer-identification " "
201 global-mode-string
202 " " Man-page-mode-string
231 "Regular expression for SEE ALSO heading (or your equivalent).
235 "Regular expression describing first heading on a manpage.
247 "-s"
251 ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
252 ;; end user variables
253 \f
254 ;; other variables and keymap initializations
274 :ovstrk
276 t ovstrk
277 }
297 table)
301 nil
321 )
323 \f
324 ;; ======================================================================
325 ;; utilities
328 "Used for initialising variables based on the value of window-system.
329 This is necessary if one wants to dump man.el with emacs."
331 ;; The following is necessary until fonts are implemented on
332 ;; terminals.
334 window-system))
339 nil)
341 Man-sysv-sed-script)
343 Man-berkeley-sed-script)
345 nil)))
350 Man-sed-command
356 "-e '/\e[789]/s///g'"
357 "-e '/Reformatting page. Wait/d'"
358 "-e '/Reformatting entry. Wait/d'"
369 ))
371 Man-awk-command
379 "'"
380 ))
383 Man-untabify-command
384 Man-untabify-command-args)
385 )))
386 )
389 "Return the substring matched by the last search.
390 Optional arg N means return the substring matched by the Nth paren
391 grouping. Optional second arg STRING means return a substring from
392 that string instead of from the current buffer."
399 "Formats part of the mode line for Man mode."
403 Man-current-page
407 "Builds the entire background manpage and cleaning command."
409 ; Stock MS-DOS shells cannot redirect stderr;
410 ; `call-process' below sends it to /dev/null,
411 ; so we don't need `2>' even with DOS shells
412 ; which do support stderr redirection.
414 " %s"
425 phrase)
428 command))
432 Leave it as is if already in that style. Possibly downcase and
433 translate the section (see the Man-downcase-section-letters-flag
434 and the Man-section-translations-alist variables)."
439 ;; "chmod(2V)" case ?
443 ;; "2v chmod" case ?
449 ref ; Return the reference as is
461 s2)
462 slist nil))))
465 \f
466 ;; ======================================================================
467 ;; default man entry: get word under point
470 "Make a guess at a default manual entry.
471 This guess is based on the text surrounding the cursor, and the
472 default section number is selected from `Man-auto-section-alist'."
475 ;; Default man entry title is any word the cursor is on, or if
476 ;; cursor not on a word, then nearest preceding word.
480 ;; If looking at something like ioctl(2) or brc(1M), include the
481 ;; section number in the returned value. Remove text properties.
483 ;; Use `format' here to clear any text props from `word'.
485 word
491 \f
492 ;; ======================================================================
493 ;; Top level command and background process sentinel
495 ;; For compatibility with older versions.
496 ;;;###autoload
499 ;;;###autoload
501 "Get a Un*x manual page and put it in a buffer.
502 This command is the top-level command in the man package. It runs a Un*x
503 command to retrieve and clean a manpage in the background and places the
504 results in a Man mode (manpage browsing) buffer. See variable
505 `Man-notify-method' for what happens when the buffer is ready.
506 If a buffer already exists for this man page, it will display immediately."
512 ""
517 default-entry)
518 input))))
520 ;; Possibly translate the "subject(section)" syntax into the
521 ;; "section subject" syntax and possibly downcase the section.
526 ;;;###autoload
528 "Get a Un*x manual page of the item under point and put it in a buffer."
536 "Uses TOPIC to build and fire off the manpage and cleaning command."
550 ;; Prevent any attempt to use display terminal fanciness.
567 exit-status)))
572 "Notify the user when MAN-BUFFER is ready.
573 See the variable `Man-notify-method' for the different notification behaviors."
576 Man-original-frame)))
579 ;; Since we run asynchronously, perhaps while Emacs is waiting
580 ;; for input, we must not leave a different buffer current. We
581 ;; can't rely on the editor command loop to reselect the
582 ;; selected window's buffer.
610 t)
612 )))
615 "Convert overstriking and underlining to the correct fonts.
616 Same for the ANSI bold and normal escape sequences."
647 ;; \255 is some kind of dash in Latin-1.
653 "Remove overstriking and underlining from the current buffer."
656 Man-arguments)
670 ))
673 ;; \255 is some kind of dash in Latin-1.
679 "Manpage background process sentinel.
680 When manpage command is run asynchronously, PROCESS is the process
681 object for the manpage command; when manpage command is run
682 synchronously, PROCESS is the name of the buffer where the manpage
683 command is run. Second argument MSG is the exit message of the
684 manpage command."
703 delete-buff t))
711 ": process "
717 ))
726 ))
727 ;; Restore case-fold-search before calling
728 ;; Man-notify-when-ready because it may switch buffers.
735 ))))
737 \f
738 ;; ======================================================================
739 ;; set up manual mode in buffer and build alists
742 "A mode for browsing Un*x manual pages.
744 The following man commands are available in the buffer. Try
759 The following variables may be of some use. Try
762 Man-notify-method What happens when manpage formatting is done.
763 Man-downcase-section-letters-flag Force section letters to lower case.
764 Man-circular-pages-flag Treat multiple manpage list as circular.
765 Man-auto-section-alist List of major modes and their section numbers.
766 Man-section-translations-alist List of section numbers and their Un*x equiv.
767 Man-filter-list Background manpage filter command.
768 Man-mode-line-format Mode line format for Man mode buffers.
769 Man-mode-map Keymap bindings for Man mode buffers.
770 Man-mode-hook Normal hook run on entry to Man mode.
771 Man-section-regexp Regexp describing manpage section letters.
772 Man-heading-regexp Regexp describing section headers.
773 Man-see-also-regexp Regexp for SEE ALSO section (or your equiv).
774 Man-first-heading-regexp Regexp for first heading on a manpage.
775 Man-reference-regexp Regexp matching a references in SEE ALSO.
776 Man-switches Background `man' command switches.
778 The following key bindings are currently in effect in the buffer:
782 mode-name "Man"
783 buffer-auto-save-file-name nil
784 mode-line-format Man-mode-line-format
785 truncate-lines t
786 buffer-read-only t)
798 "Build the association list of manpage sections."
807 "Build the association list of references (in the SEE ALSO section)."
815 hyphenated
828 hyphenated nil))
835 "Build the list of separate manpages in the buffer."
841 ;; (switch-to-buffer (current-buffer))(debug)
846 nil))
847 ;; Go past both the current and the next Man-first-heading-regexp
850 ;; We assume that the page header is delimited by blank
851 ;; lines and that it contains at most one blank line. So
852 ;; if we back by three blank lines we will be sure to be
853 ;; before the page header but not before the possible
854 ;; previous page header.
862 header))))
864 )))
867 "Strip all the page headers but the first from the manpage."
879 ;; Since the awk script collapses all successive blank
880 ;; lines into one, and since we don't want to get rid of
881 ;; the fast awk script, one must choose between adding
882 ;; spare blank lines between pages when there were none and
883 ;; deleting blank lines at page boundaries when there were
884 ;; some. We choose the first, so we comment the following
885 ;; line.
886 ;; (setq header (concat "\n" header)))
892 "Delete the leading spaces that indent the manpage."
927 ))))
929 \f
930 ;; ======================================================================
931 ;; Man mode commands
934 "Move point to Nth next section (default 1)."
944 "Move point to Nth previous section (default 1)."
954 "Move point to SECTION if it exists, otherwise don't move point.
955 Returns t if section is found, nil otherwise."
962 nil)
963 ))
966 "Query for section to move point to."
971 chosen
976 default
977 chosen)))
982 Actually the section moved to is described by `Man-see-also-regexp'."
990 Specify which reference to use; default is based on word at point."
1000 ;; strip a trailing '-':
1004 word)))
1005 Man-refpages-alist))
1007 chosen
1012 default
1013 chosen)))))
1021 "Kill the buffer containing the manpage."
1033 "Bury the buffer containing the manpage."
1045 "Go to the manual page on page PAGE."
1076 "Find the next manpage entry in the buffer."
1087 "Find the previous manpage entry in the buffer."
1096 \f
1097 ;; Init the man package variables, if not already done.
1102 ;;; man.el ends here