| blob | 52645b61515bf4fac689b2488770b73f9d00f41b |
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 15:34:50 $
7 ;; Version: $Revision: 1.55 $
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)
115 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
116 ;; user variables
127 ;; Use the value of the obsolete user option Man-notify, if set.
129 "*Selects the behavior when manpage is ready.
130 This variable may have one of the following values, where (sf) means
131 that the frames are switched, so the manpage is displayed in the frame
132 where the man command was called from:
134 newframe -- put the manpage in its own frame (see `Man-frame-parameters')
135 pushy -- make the manpage the current buffer in the current window
136 bully -- make the manpage the current buffer and only window (sf)
137 aggressive -- make the manpage the current buffer in the other window (sf)
138 friendly -- display manpage in the other window but don't make current (sf)
139 polite -- don't display manpage, but prints message and beep when ready
140 quiet -- like `polite', but don't beep
141 meek -- make no indication that the manpage is ready
149 "*Reuse a manpage buffer if possible.
150 If non-nil, and a manpage buffer already exists with the same
151 invocation, man just indicates the manpage is ready according to the
152 value of `Man-notify-method'. When nil, it always fires off a
156 "*Letters in sections are converted to lower case.
157 Some Un*x man commands can't handle uppercase letters in sections, for
159 with the upper case letter. When this variable is t, the section
169 ;; Some systems have a real 3x man section, so let's comment this.
170 ;; '("3X" . "3") ; Xlib man pages
173 "*Association list of bogus sections to real section numbers.
174 Some manpages (e.g. the Sun C++ 2.1 manpages) have section numbers in
175 their references which Un*x `man' does not recognize. This
176 association list is used to translate those sections, when found, to
196 mode-line-buffer-identification " "
197 global-mode-string
198 " " Man-page-mode-string
227 "Regular expression for SEE ALSO heading (or your equivalent).
231 "Regular expression describing first heading on a manpage.
243 "-s"
247 ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
248 ;; end user variables
249 \f
250 ;; other variables and keymap initializations
269 :ovstrk
271 t ovstrk
272 }
288 nil
308 )
310 \f
311 ;; ======================================================================
312 ;; utilities
315 "Used for initialising variables based on the value of window-system.
316 This is necessary if one wants to dump man.el with emacs."
318 ;; The following is necessary until fonts are implemented on
319 ;; terminals.
321 window-system))
324 ;; don't use pr: it is buggy
325 ;; (or (not (file-readable-p "/etc/passwd"))
326 ;; (/= 0 (apply 'call-process
327 ;; Man-untabify-command nil nil nil
328 ;; (append Man-untabify-command-args
329 ;; (list "/etc/passwd")))))
335 nil)
337 Man-sysv-sed-script)
339 Man-berkeley-sed-script)
341 nil))
347 Man-sed-command
353 "-e '/\e[789]/s///g'"
354 "-e '/[Nn]o such file or directory/d'"
355 "-e '/Reformatting page. Wait/d'"
356 "-e '/Reformatting entry. Wait/d'"
366 ))
368 Man-awk-command
376 "'"
377 ))
380 Man-untabify-command
381 Man-untabify-command-args)
382 ))
383 "*Manpage cleaning filter command phrases.
384 This variable contains a list of the following form:
386 '((command-string phrase-string*)*)
388 Each phrase-string is concatenated onto the command-string to form a
389 command filter. The (standard) output (and standard error) of the Un*x
390 man command is piped through each command filter in the order the
391 commands appear in the association list. The final output is placed in
393 )
396 "Return the substring matched by the last search.
397 Optional arg N means return the substring matched by the Nth paren
398 grouping. Optional second arg STRING means return a substring from
399 that string instead of from the current buffer."
406 "Formats part of the mode line for Man mode."
410 Man-current-page
414 "Builds the entire background manpage and cleaning command."
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'."
476 ;; Default man entry title is any word the cursor is on, or if
477 ;; cursor not on a word, then nearest preceding word. Cannot
478 ;; use the current-word function because it skips the dots.
488 ;; If looking at something like ioctl(2) or brc(1M), include the
489 ;; section number in the returned value.
491 default-title
495 ))))
497 \f
498 ;; ======================================================================
499 ;; Top level command and background process sentinel
501 ;; For compatibility with older versions.
502 ;;;###autoload
505 ;;;###autoload
507 "Get a Un*x manual page and put it in a buffer.
508 This command is the top-level command in the man package. It runs a Un*x
509 command to retrieve and clean a manpage in the background and places the
510 results in a Man mode (manpage browsing) buffer. See variable
511 `Man-notify-method' for what happens when the buffer is ready.
512 Normally, if a buffer already exists for this man page, it will display
513 immediately; either a prefix argument or a nil value to `Man-reuse-okay-flag'
514 overrides this and forces the man page to be regenerated."
517 ;; first argument
522 ""
527 default-entry)
528 input))
529 ;; second argument
530 current-prefix-arg))
532 ;; Init the man package variables, if not already done.
535 ;; Possibly translate the "subject(section)" syntax into the
536 ;; "section subject" syntax and possibly downcase the section.
543 "Uses TOPIC to build and fire off the manpage and cleaning command.
544 Optional OVERRIDE-REUSE-P, when non-nil, means to
545 start a background process even if a buffer already exists and
546 `Man-reuse-okay-flag' is non-nil."
552 buffer)
562 ;; Prevent any attempt to use display terminal fanciness.
568 )))
571 "Notify the user when MAN-BUFFER is ready.
572 See the variable `Man-notify-method' for the different notification behaviors."
575 Man-original-frame)))
578 ;; Since we run asynchronously, perhaps while Emacs is waiting
579 ;; for input, we must not leave a different buffer current. We
580 ;; can't rely on the editor command loop to reselect the
581 ;; selected window's buffer.
609 t)
611 )))
614 "Convert overstriking and underlining to the correct fonts.
615 Same for the ANSI bold and normal escape sequences."
649 "Remove overstriking and underlining from the current buffer."
652 Man-arguments)
666 ))
672 "Manpage background process sentinel."
690 delete-buff t))
695 ": process "
701 ))
710 ))
711 ;; Restore case-fold-search before calling
712 ;; Man-notify-when-ready because it may switch buffers.
719 )))))
721 \f
722 ;; ======================================================================
723 ;; set up manual mode in buffer and build alists
726 "A mode for browsing Un*x manual pages.
728 The following man commands are available in the buffer. Try
743 The following variables may be of some use. Try
746 Man-notify-method What happens when manpage formatting is done.
747 Man-reuse-okay-flag Reuse already formatted buffer.
748 Man-downcase-section-letters-flag Force section letters to lower case.
749 Man-circular-pages-flag Treat multiple manpage list as circular.
750 Man-auto-section-alist List of major modes and their section numbers.
751 Man-section-translations-alist List of section numbers and their Un*x equiv.
752 Man-filter-list Background manpage filter command.
753 Man-mode-line-format Mode line format for Man mode buffers.
754 Man-mode-map Keymap bindings for Man mode buffers.
755 Man-mode-hook Normal hook run on entry to Man mode.
756 Man-section-regexp Regexp describing manpage section letters.
757 Man-heading-regexp Regexp describing section headers.
758 Man-see-also-regexp Regexp for SEE ALSO section (or your equiv).
759 Man-first-heading-regexp Regexp for first heading on a manpage.
760 Man-reference-regexp Regexp matching a references in SEE ALSO.
761 Man-switches Background `man' command switches.
763 The following key bindings are currently in effect in the buffer:
767 mode-name "Man"
768 buffer-auto-save-file-name nil
769 mode-line-format Man-mode-line-format
770 truncate-lines t
771 buffer-read-only t)
782 "Build the association list of manpage sections."
791 "Build the association list of references (in the SEE ALSO section)."
799 hyphenated
812 hyphenated nil))
819 "Build the list of separate manpages in the buffer."
825 ;; (switch-to-buffer (current-buffer))(debug)
830 nil))
831 ;; Go past both the current and the next Man-first-heading-regexp
834 ;; We assume that the page header is delimited by blank
835 ;; lines and that it contains at most one blank line. So
836 ;; if we back by three blank lines we will be sure to be
837 ;; before the page header but not before the possible
838 ;; previous page header.
846 header))))
848 )))
851 "Strip all the page headers but the first from the manpage."
863 ;; Since the awk script collapses all successive blank
864 ;; lines into one, and since we don't want to get rid of
865 ;; the fast awk script, one must choose between adding
866 ;; spare blank lines between pages when there were none and
867 ;; deleting blank lines at page boundaries when there were
868 ;; some. We choose the first, so we comment the following
869 ;; line.
870 ;; (setq header (concat "\n" header)))
876 "Delete the leading spaces that indent the manpage."
911 ))))
913 \f
914 ;; ======================================================================
915 ;; Man mode commands
918 "Move point to Nth next section (default 1)."
928 "Move point to Nth previous section (default 1)."
938 "Move point to SECTION if it exists, otherwise don't move point.
939 Returns t if section is found, nil otherwise."
946 nil)
947 ))
950 "Query for section to move point to."
955 chosen
960 default
961 chosen)))
966 Actually the section moved to is described by `Man-see-also-regexp'."
974 Specify which reference to use; default is based on word at point.
975 Prefix argument ARG is passed to `Man-getpage-in-background'."
986 ;; strip a trailing '-':
990 word)))
991 Man-refpages-alist))
993 chosen
998 default
999 chosen)))))
1005 arg)))
1008 "Kill the buffer containing the manpage."
1020 "Bury the buffer containing the manpage."
1032 "Go to the manual page on page PAGE."
1063 "Find the next manpage entry in the buffer."
1074 "Find the previous manpage entry in the buffer."
1083 \f
1086 ;;; man.el ends here