| blob | 719b12ee9d1c5beca0d953d0f1c90ba1cc8e9cca |
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/11/09 12:38:31 $
7 ;; Version: $Revision: 1.59 $
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 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)
114 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
115 ;; user variables
126 ;; Use the value of the obsolete user option Man-notify, if set.
128 "*Selects the behavior when manpage is ready.
129 This variable may have one of the following values, where (sf) means
130 that the frames are switched, so the manpage is displayed in the frame
131 where the man command was called from:
133 newframe -- put the manpage in its own frame (see `Man-frame-parameters')
134 pushy -- make the manpage the current buffer in the current window
135 bully -- make the manpage the current buffer and only window (sf)
136 aggressive -- make the manpage the current buffer in the other window (sf)
137 friendly -- display manpage in the other window but don't make current (sf)
138 polite -- don't display manpage, but prints message and beep when ready
139 quiet -- like `polite', but don't beep
140 meek -- make no indication that the manpage is ready
148 "*Letters in sections are converted to lower case.
149 Some Un*x man commands can't handle uppercase letters in sections, for
151 with the upper case letter. When this variable is t, the section
161 ;; Some systems have a real 3x man section, so let's comment this.
162 ;; '("3X" . "3") ; Xlib man pages
165 "*Association list of bogus sections to real section numbers.
166 Some manpages (e.g. the Sun C++ 2.1 manpages) have section numbers in
167 their references which Un*x `man' does not recognize. This
168 association list is used to translate those sections, when found, to
188 mode-line-buffer-identification " "
189 global-mode-string
190 " " Man-page-mode-string
219 "Regular expression for SEE ALSO heading (or your equivalent).
223 "Regular expression describing first heading on a manpage.
235 "-s"
239 ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
240 ;; end user variables
241 \f
242 ;; other variables and keymap initializations
262 :ovstrk
264 t ovstrk
265 }
282 nil
302 )
304 \f
305 ;; ======================================================================
306 ;; utilities
309 "Used for initialising variables based on the value of window-system.
310 This is necessary if one wants to dump man.el with emacs."
312 ;; The following is necessary until fonts are implemented on
313 ;; terminals.
315 window-system))
318 ;; don't use pr: it is buggy
319 ;; (or (not (file-readable-p "/etc/passwd"))
320 ;; (/= 0 (apply 'call-process
321 ;; Man-untabify-command nil nil nil
322 ;; (append Man-untabify-command-args
323 ;; (list "/etc/passwd")))))
329 nil)
331 Man-sysv-sed-script)
333 Man-berkeley-sed-script)
335 nil))
341 Man-sed-command
347 "-e '/\e[789]/s///g'"
348 "-e '/[Nn]o such file or directory/d'"
349 "-e '/Reformatting page. Wait/d'"
350 "-e '/Reformatting entry. Wait/d'"
360 ))
362 Man-awk-command
370 "'"
371 ))
374 Man-untabify-command
375 Man-untabify-command-args)
376 ))
377 "*Manpage cleaning filter command phrases.
378 This variable contains a list of the following form:
380 '((command-string phrase-string*)*)
382 Each phrase-string is concatenated onto the command-string to form a
383 command filter. The (standard) output (and standard error) of the Un*x
384 man command is piped through each command filter in the order the
385 commands appear in the association list. The final output is placed in
387 )
390 "Return the substring matched by the last search.
391 Optional arg N means return the substring matched by the Nth paren
392 grouping. Optional second arg STRING means return a substring from
393 that string instead of from the current buffer."
400 "Formats part of the mode line for Man mode."
404 Man-current-page
408 "Builds the entire background manpage and cleaning command."
419 phrase)
422 command))
426 Leave it as is if already in that style. Possibly downcase and
427 translate the section (see the Man-downcase-section-letters-flag
428 and the Man-section-translations-alist variables)."
433 ;; "chmod(2V)" case ?
437 ;; "2v chmod" case ?
443 ref ; Return the reference as is
455 s2)
456 slist nil))))
459 \f
460 ;; ======================================================================
461 ;; default man entry: get word under point
464 "Make a guess at a default manual entry.
465 This guess is based on the text surrounding the cursor, and the
466 default section number is selected from `Man-auto-section-alist'."
470 ;; Default man entry title is any word the cursor is on, or if
471 ;; cursor not on a word, then nearest preceding word. Cannot
472 ;; use the current-word function because it skips the dots.
482 ;; If looking at something like ioctl(2) or brc(1M), include the
483 ;; section number in the returned value.
485 default-title
489 ))))
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 ;; Init the man package variables, if not already done.
523 ;; Possibly translate the "subject(section)" syntax into the
524 ;; "section subject" syntax and possibly downcase the section.
531 "Uses TOPIC to build and fire off the manpage and cleaning command."
545 ;; Prevent any attempt to use display terminal fanciness.
553 "Notify the user when MAN-BUFFER is ready.
554 See the variable `Man-notify-method' for the different notification behaviors."
557 Man-original-frame)))
560 ;; Since we run asynchronously, perhaps while Emacs is waiting
561 ;; for input, we must not leave a different buffer current. We
562 ;; can't rely on the editor command loop to reselect the
563 ;; selected window's buffer.
591 t)
593 )))
596 "Convert overstriking and underlining to the correct fonts.
597 Same for the ANSI bold and normal escape sequences."
631 "Remove overstriking and underlining from the current buffer."
634 Man-arguments)
648 ))
654 "Manpage background process sentinel."
671 delete-buff t))
676 ": process "
682 ))
691 ))
692 ;; Restore case-fold-search before calling
693 ;; Man-notify-when-ready because it may switch buffers.
700 ))))
702 \f
703 ;; ======================================================================
704 ;; set up manual mode in buffer and build alists
707 "A mode for browsing Un*x manual pages.
709 The following man commands are available in the buffer. Try
724 The following variables may be of some use. Try
727 Man-notify-method What happens when manpage formatting is done.
728 Man-downcase-section-letters-flag Force section letters to lower case.
729 Man-circular-pages-flag Treat multiple manpage list as circular.
730 Man-auto-section-alist List of major modes and their section numbers.
731 Man-section-translations-alist List of section numbers and their Un*x equiv.
732 Man-filter-list Background manpage filter command.
733 Man-mode-line-format Mode line format for Man mode buffers.
734 Man-mode-map Keymap bindings for Man mode buffers.
735 Man-mode-hook Normal hook run on entry to Man mode.
736 Man-section-regexp Regexp describing manpage section letters.
737 Man-heading-regexp Regexp describing section headers.
738 Man-see-also-regexp Regexp for SEE ALSO section (or your equiv).
739 Man-first-heading-regexp Regexp for first heading on a manpage.
740 Man-reference-regexp Regexp matching a references in SEE ALSO.
741 Man-switches Background `man' command switches.
743 The following key bindings are currently in effect in the buffer:
747 mode-name "Man"
748 buffer-auto-save-file-name nil
749 mode-line-format Man-mode-line-format
750 truncate-lines t
751 buffer-read-only t)
762 "Build the association list of manpage sections."
771 "Build the association list of references (in the SEE ALSO section)."
779 hyphenated
792 hyphenated nil))
799 "Build the list of separate manpages in the buffer."
805 ;; (switch-to-buffer (current-buffer))(debug)
810 nil))
811 ;; Go past both the current and the next Man-first-heading-regexp
814 ;; We assume that the page header is delimited by blank
815 ;; lines and that it contains at most one blank line. So
816 ;; if we back by three blank lines we will be sure to be
817 ;; before the page header but not before the possible
818 ;; previous page header.
826 header))))
828 )))
831 "Strip all the page headers but the first from the manpage."
843 ;; Since the awk script collapses all successive blank
844 ;; lines into one, and since we don't want to get rid of
845 ;; the fast awk script, one must choose between adding
846 ;; spare blank lines between pages when there were none and
847 ;; deleting blank lines at page boundaries when there were
848 ;; some. We choose the first, so we comment the following
849 ;; line.
850 ;; (setq header (concat "\n" header)))
856 "Delete the leading spaces that indent the manpage."
891 ))))
893 \f
894 ;; ======================================================================
895 ;; Man mode commands
898 "Move point to Nth next section (default 1)."
908 "Move point to Nth previous section (default 1)."
918 "Move point to SECTION if it exists, otherwise don't move point.
919 Returns t if section is found, nil otherwise."
926 nil)
927 ))
930 "Query for section to move point to."
935 chosen
940 default
941 chosen)))
946 Actually the section moved to is described by `Man-see-also-regexp'."
954 Specify which reference to use; default is based on word at point."
964 ;; strip a trailing '-':
968 word)))
969 Man-refpages-alist))
971 chosen
976 default
977 chosen)))))
985 "Kill the buffer containing the manpage."
997 "Bury the buffer containing the manpage."
1009 "Go to the manual page on page PAGE."
1040 "Find the next manpage entry in the buffer."
1051 "Find the previous manpage entry in the buffer."
1060 \f
1063 ;;; man.el ends here