| blob | ab27a6b74ab1963532d0f24e60966e287b94a372 |
1 ;;; man.el --- browse UNIX manual pages
3 ;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
5 ;; Author: Barry A. Warsaw <bwarsaw@cen.com>
6 ;; Last-Modified: $Date: 1994/10/24 12:37:01 $
7 ;; Version: $Revision: 1.54 $
8 ;; Keywords: help
9 ;; Adapted-By: ESR, pot
11 ;; This file is part of GNU Emacs.
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.
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.
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.
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 everthing 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 idiosynchrasies.
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 the Man-reuse-okay-flag to be set to 'always, meaning that all
87 ;; the manpages should go in the same buffer, where they can be browsed
88 ;; 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.
95 \f
96 ;;; Code:
100 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
101 ;; empty defvars (keep the compiler quiet)
116 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
117 ;; user variables
122 ;; Use the value of the obsolete user option Man-notify, if set.
124 "*Selects the behavior when manpage is ready.
125 This variable may have one of the following values, where (sf) means
126 that the frames are switched, so the manpage is displayed in the frame
127 where the man command was called from:
129 newframe -- put the manpage in its own frame (see `Man-frame-parameters')
130 pushy -- make the manpage the current buffer in the current window
131 bully -- make the manpage the current buffer and only window (sf)
132 aggressive -- make the manpage the current buffer in the other window (sf)
133 friendly -- display manpage in the other window but don't make current (sf)
134 polite -- don't display manpage, but prints message and beep when ready
135 quiet -- like `polite', but don't beep
136 meek -- make no indication that the manpage is ready
144 "*Reuse a manpage buffer if possible.
145 If non-nil, and a manpage buffer already exists with the same
146 invocation, man just indicates the manpage is ready according to the
147 value of `Man-notify-method'. When nil, it always fires off a
151 "*Letters in sections are converted to lower case.
152 Some Un*x man commands can't handle uppercase letters in sections, for
154 with the upper case letter. When this variable is t, the section
164 ;; Some systems have a real 3x man section, so let's comment this.
165 ;; '("3X" . "3") ; Xlib man pages
168 "*Association list of bogus sections to real section numbers.
169 Some manpages (e.g. the Sun C++ 2.1 manpages) have section numbers in
170 their references which Un*x `man' does not recognize. This
171 association list is used to translate those sections, when found, to
190 :ovstrk
192 t ovstrk
193 }
210 mode-line-buffer-identification " "
211 global-mode-string
212 " " Man-page-mode-string
241 "*Regular expression for SEE ALSO heading (or your equivalent).
245 "*Regular expression describing first heading on a manpage.
255 ;; Would someone like to provide a good test for being on Solaris?
256 ;; We could give it its own value of system-type, but that has drawbacks;
257 ;; it would require changes in lots of places that test system-type.
260 "-s"
264 ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
265 ;; end user variables
266 \f
267 ;; other variables and keymap initializations
283 nil
303 )
305 \f
306 ;; ======================================================================
307 ;; utilities
310 "Used for initialising variables based on the value of window-system.
311 This is necessary if one wants to dump man.el with emacs."
315 ;; The following is necessary until fonts are implemented on
316 ;; terminals.
318 window-system))
321 ;; don't use pr: it is buggy
322 ;; (or (not (file-readable-p "/etc/passwd"))
323 ;; (/= 0 (apply 'call-process
324 ;; Man-untabify-command nil nil nil
325 ;; (append Man-untabify-command-args
326 ;; (list "/etc/passwd")))))
332 nil)
334 Man-sysv-sed-script)
336 Man-berkeley-sed-script)
338 nil))
344 Man-sed-command
350 "-e '/\e[789]/s///g'"
351 "-e '/[Nn]o such file or directory/d'"
352 "-e '/Reformatting page. Wait/d'"
353 "-e '/Reformatting entry. Wait/d'"
363 ))
365 Man-awk-command
373 "'"
374 ))
377 Man-untabify-command
378 Man-untabify-command-args)
379 ))
380 "*Manpage cleaning filter command phrases.
381 This variable contains a list of the following form:
383 '((command-string phrase-string*)*)
385 Each phrase-string is concatenated onto the command-string to form a
386 command filter. The (standard) output (and standard error) of the Un*x
387 man command is piped through each command filter in the order the
388 commands appear in the association list. The final output is placed in
390 )
393 "Return the substring matched by the last search.
394 Optional arg N means return the substring matched by the Nth paren
395 grouping. Optional second arg STRING means return a substring from
396 that string instead of from the current buffer."
403 "Formats part of the mode line for Man mode."
407 Man-current-page
411 "Builds the entire background manpage and cleaning command."
422 phrase)
425 command))
429 Leave it as is if already in that style. Possibly downcase and
430 translate the section (see the Man-downcase-section-letters-flag
431 and the Man-section-translations-alist variables)."
436 ;; "chmod(2V)" case ?
440 ;; "2v chmod" case ?
446 ref ; Return the reference as is
458 s2)
459 slist nil))))
462 \f
463 ;; ======================================================================
464 ;; default man entry: get word under point
467 "Make a guess at a default manual entry.
468 This guess is based on the text surrounding the cursor, and the
469 default section number is selected from `Man-auto-section-alist'."
473 ;; Default man entry title is any word the cursor is on, or if
474 ;; cursor not on a word, then nearest preceding word. Cannot
475 ;; use the current-word function because it skips the dots.
485 ;; If looking at something like ioctl(2) or brc(1M), include the
486 ;; section number in the returned value.
488 default-title
492 ))))
494 \f
495 ;; ======================================================================
496 ;; Top level command and background process sentinel
498 ;; For compatibility with older versions.
499 ;;;###autoload
502 ;;;###autoload
504 "Get a Un*x manual page and put it in a buffer.
505 This command is the top-level command in the man package. It runs a Un*x
506 command to retrieve and clean a manpage in the background and places the
507 results in a Man mode (manpage browsing) buffer. See variable
508 `Man-notify-method' for what happens when the buffer is ready.
509 Normally, if a buffer already exists for this man page, it will display
510 immediately; either a prefix argument or a nil value to `Man-reuse-okay-flag'
511 overrides this and forces the man page to be regenerated."
514 ;; first argument
519 ""
524 default-entry)
525 input))
526 ;; second argument
527 current-prefix-arg))
529 ;; Init the man package variables, if not already done.
532 ;; Possibly translate the "subject(section)" syntax into the
533 ;; "section subject" syntax and possibly downcase the section.
540 "Uses TOPIC to build and fire off the manpage and cleaning command.
541 Optional OVERRIDE-REUSE-P, when non-nil, means to
542 start a background process even if a buffer already exists and
543 `Man-reuse-okay-flag' is non-nil."
549 buffer)
559 ;; Prevent any attempt to use display terminal fanciness.
565 )))
568 "Notify the user when MAN-BUFFER is ready.
569 See the variable `Man-notify-method' for the different notification behaviors."
572 Man-original-frame)))
575 ;; Since we run asynchronously, perhaps while Emacs is waiting
576 ;; for input, we must not leave a different buffer current. We
577 ;; can't rely on the editor command loop to reselect the
578 ;; selected window's buffer.
606 t)
608 )))
611 "Convert overstriking and underlining to the correct fonts.
612 Same for the ANSI bold and normal escape sequences."
646 "Remove overstriking and underlining from the current buffer."
649 Man-arguments)
663 ))
669 "Manpage background process sentinel."
687 delete-buff t))
692 ": process "
698 ))
707 ))
708 ;; Restore case-fold-search before calling
709 ;; Man-notify-when-ready because it may switch buffers.
716 )))))
718 \f
719 ;; ======================================================================
720 ;; set up manual mode in buffer and build alists
723 "A mode for browsing Un*x manual pages.
725 The following man commands are available in the buffer. Try
740 The following variables may be of some use. Try
743 Man-notify-method What happens when manpage formatting is done.
744 Man-reuse-okay-flag Reuse already formatted buffer.
745 Man-downcase-section-letters-flag Force section letters to lower case.
746 Man-circular-pages-flag Treat multiple manpage list as circular.
747 Man-auto-section-alist List of major modes and their section numbers.
748 Man-section-translations-alist List of section numbers and their Un*x equiv.
749 Man-filter-list Background manpage filter command.
750 Man-mode-line-format Mode line format for Man mode buffers.
751 Man-mode-map Keymap bindings for Man mode buffers.
752 Man-mode-hook Normal hook run on entry to Man mode.
753 Man-section-regexp Regexp describing manpage section letters.
754 Man-heading-regexp Regexp describing section headers.
755 Man-see-also-regexp Regexp for SEE ALSO section (or your equiv).
756 Man-first-heading-regexp Regexp for first heading on a manpage.
757 Man-reference-regexp Regexp matching a references in SEE ALSO.
758 Man-switches Background `man' command switches.
760 The following key bindings are currently in effect in the buffer:
764 mode-name "Man"
765 buffer-auto-save-file-name nil
766 mode-line-format Man-mode-line-format
767 truncate-lines t
768 buffer-read-only t)
779 "Build the association list of manpage sections."
788 "Build the association list of references (in the SEE ALSO section)."
796 hyphenated
809 hyphenated nil))
816 "Build the list of separate manpages in the buffer."
822 ;; (switch-to-buffer (current-buffer))(debug)
827 nil))
828 ;; Go past both the current and the next Man-first-heading-regexp
831 ;; We assume that the page header is delimited by blank
832 ;; lines and that it contains at most one blank line. So
833 ;; if we back by three blank lines we will be sure to be
834 ;; before the page header but not before the possible
835 ;; previous page header.
843 header))))
845 )))
848 "Strip all the page headers but the first from the manpage."
860 ;; Since the awk script collapses all successive blank
861 ;; lines into one, and since we don't want to get rid of
862 ;; the fast awk script, one must choose between adding
863 ;; spare blank lines between pages when there were none and
864 ;; deleting blank lines at page boundaries when there were
865 ;; some. We choose the first, so we comment the following
866 ;; line.
867 ;; (setq header (concat "\n" header)))
873 "Delete the leading spaces that indent the manpage."
908 ))))
910 \f
911 ;; ======================================================================
912 ;; Man mode commands
915 "Move point to Nth next section (default 1)."
925 "Move point to Nth previous section (default 1)."
935 "Move point to SECTION if it exists, otherwise don't move point.
936 Returns t if section is found, nil otherwise."
943 nil)
944 ))
947 "Query for section to move point to."
952 chosen
957 default
958 chosen)))
963 Actually the section moved to is described by `Man-see-also-regexp'."
971 Specify which reference to use; default is based on word at point.
972 Prefix argument ARG is passed to `Man-getpage-in-background'."
983 ;; strip a trailing '-':
987 word)))
988 Man-refpages-alist))
990 chosen
995 default
996 chosen)))))
1002 arg)))
1005 "Kill the buffer containing the manpage."
1017 "Bury the buffer containing the manpage."
1029 "Go to the manual page on page PAGE."
1060 "Find the next manpage entry in the buffer."
1071 "Find the previous manpage entry in the buffer."
1080 \f
1083 ;;; man.el ends here