| blob | 4a768e1effbb5c324d03aec5a1bb98319c01f56c |
1 ;;; man.el --- browse UNIX manual pages -*- coding: iso-8859-1 -*-
3 ;; Copyright (C) 1993, 1994, 1996, 1997, 2001, 2003 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 heuristics
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:
100 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
101 ;; empty defvars (keep the compiler quiet)
104 "Browse UNIX manual pages."
113 "*Manpage cleaning filter command phrases.
114 This variable contains a list of the following form:
116 '((command-string phrase-string*)*)
118 Each phrase-string is concatenated onto the command-string to form a
119 command filter. The (standard) output (and standard error) of the Un*x
120 man command is piped through each command filter in the order the
121 commands appear in the association list. The final output is placed in
122 the manpage buffer."
138 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
139 ;; user variables
142 "*Non-nil means make up the manpage with fonts."
147 "*Face to use when fontifying overstrike."
152 "*Face to use when fontifying underlining."
156 ;; Use the value of the obsolete user option Man-notify, if set.
158 "*Selects the behavior when manpage is ready.
159 This variable may have one of the following values, where (sf) means
160 that the frames are switched, so the manpage is displayed in the frame
161 where the man command was called from:
163 newframe -- put the manpage in its own frame (see `Man-frame-parameters')
164 pushy -- make the manpage the current buffer in the current window
165 bully -- make the manpage the current buffer and only window (sf)
166 aggressive -- make the manpage the current buffer in the other window (sf)
167 friendly -- display manpage in the other window but don't make current (sf)
168 polite -- don't display manpage, but prints message and beep when ready
169 quiet -- like `polite', but don't beep
170 meek -- make no indication that the manpage is ready
172 Any other value of `Man-notify-method' is equivalent to `meek'."
179 "*Frame parameter list for creating a new frame for a manual page."
184 "*Non-nil means letters in sections are converted to lower case.
185 Some Un*x man commands can't handle uppercase letters in sections, for
187 with the upper case letter. When this variable is t, the section
189 being sent to the man background process."
194 "*Non-nil means the manpage list is treated as circular for traversal."
201 ;; Some systems have a real 3x man section, so let's comment this.
202 ;; '("3X" . "3") ; Xlib man pages
205 "*Association list of bogus sections to real section numbers.
206 Some manpages (e.g. the Sun C++ 2.1 manpages) have section numbers in
207 their references which Un*x `man' does not recognize. This
208 association list is used to translate those sections, when found, to
209 the associated section number."
216 "C Header file search path used in Man."
263 "Regular expression for SEE ALSO heading (or your equivalent).
267 "Regular expression describing first heading on a manpage.
275 "Regular expression for SYNOPSIS heading (or your equivalent).
279 "Regular expression for FILES heading (or your equivalent).
302 ;; This includes the section as an optional part to catch hyphenated
303 ;; refernces to manpages.
309 "Switches passed to the man command, as a single string.
311 If you want to be able to see all the manpages for a subject you type,
316 "-s"
320 ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
321 ;; end user variables
322 \f
323 ;; other variables and keymap initializations
343 :ovstrk
345 t ovstrk
346 }
366 table)
370 nil
389 )
391 ;; buttons
414 \f
415 ;; ======================================================================
416 ;; utilities
419 "Used for initialising variables based on display's color support.
420 This is necessary if one wants to dump man.el with Emacs."
422 ;; Avoid possible error in call-process by using a directory that must exist.
427 nil)
429 Man-sysv-sed-script)
431 Man-berkeley-sed-script)
433 nil))))
436 ;; Avoid trailing nil which confuses customize.
439 Man-sed-command
445 "-e '/\e[789]/s///g'"
446 "-e '/Reformatting page. Wait/d'"
447 "-e '/Reformatting entry. Wait/d'"
458 ))
460 Man-awk-command
468 "'"
469 ))
471 ;; The outer list will be stripped off by apply.
473 Man-untabify-command
474 Man-untabify-command-args))
475 )))
476 )
479 "Formats part of the mode line for Man mode."
483 Man-current-page
487 "Builds the entire background manpage and cleaning command."
489 ; Stock MS-DOS shells cannot redirect stderr;
490 ; `call-process' below sends it to /dev/null,
491 ; so we don't need `2>' even with DOS shells
492 ; which do support stderr redirection.
494 " %s"
505 phrase)
508 command))
512 "Strip leading, trailing and middle spaces."
514 ;; Strip leading and trailing
517 ;; middle spaces
520 string))
524 Leave it as is if already in that style. Possibly downcase and
525 translate the section (see the Man-downcase-section-letters-flag
526 and the Man-section-translations-alist variables)."
532 ;; "chmod(2V)" case ?
536 ;; "2v chmod" case ?
542 ref ; Return the reference as is
554 s2)
555 slist nil))))
558 \f
559 ;; ======================================================================
560 ;; default man entry: get word under point
563 "Make a guess at a default manual entry.
564 This guess is based on the text surrounding the cursor."
567 ;; Default man entry title is any word the cursor is on, or if
568 ;; cursor not on a word, then nearest preceding word.
575 ;; If looking at something like *strcat(... , remove the '*'
578 ;; If looking at something like ioctl(2) or brc(1M), include the
579 ;; section number in the returned value. Remove text properties.
585 \f
586 ;; ======================================================================
587 ;; Top level command and background process sentinel
589 ;; For compatibility with older versions.
590 ;;;###autoload
594 ;;;###autoload
596 "Get a Un*x manual page and put it in a buffer.
597 This command is the top-level command in the man package. It runs a Un*x
598 command to retrieve and clean a manpage in the background and places the
599 results in a Man mode (manpage browsing) buffer. See variable
600 `Man-notify-method' for what happens when the buffer is ready.
601 If a buffer already exists for this man page, it will display immediately.
603 To specify a man page from a certain section, type SUBJECT(SECTION) or
604 SECTION SUBJECT when prompted for a manual entry. To see manpages from
605 all sections related to a subject, put something appropriate into the
606 `Man-switches' variable, which see."
612 ""
614 nil nil default-entry)))
617 input))))
619 ;; Possibly translate the "subject(section)" syntax into the
620 ;; "section subject" syntax and possibly downcase the section.
625 ;;;###autoload
627 "Get a Un*x manual page of the item under point and put it in a buffer."
635 "Use TOPIC to build and fire off the manpage and cleaning command."
649 ;; The following is so Awk script gets \n intact
650 ;; But don't prevent decoding of the outside.
652 ;; We must decode the output by a coding system that the
653 ;; system's locale suggests in multibyte mode.
657 ;; Avoid possible error by using a directory that always exists.
662 default-directory
664 ;; Prevent any attempt to use display terminal fanciness.
666 ;; In Debian Woody, at least, we get overlong lines under X
667 ;; unless COLUMNS or MANWIDTH is set. This isn't a problem on
668 ;; a tty. man(1) says:
669 ;; MANWIDTH
670 ;; If $MANWIDTH is set, its value is used as the line
671 ;; length for which manual pages should be formatted.
672 ;; If it is not set, manual pages will be formatted
673 ;; with a line length appropriate to the current ter-
674 ;; minal (using an ioctl(2) if available, the value of
675 ;; $COLUMNS, or falling back to 80 characters if nei-
676 ;; ther is available).
679 ;; This isn't strictly correct, since we don't know how
680 ;; the page will actually be displayed, but it seems
681 ;; reasonable.
698 exit-status)))
703 "Notify the user when MAN-BUFFER is ready.
704 See the variable `Man-notify-method' for the different notification behaviors."
707 Man-original-frame)))
710 ;; Since we run asynchronously, perhaps while Emacs is waiting
711 ;; for input, we must not leave a different buffer current. We
712 ;; can't rely on the editor command loop to reselect the
713 ;; selected window's buffer.
741 t)
743 )))
746 ;; \255 is SOFT HYPHEN in Latin-N. Versions of Debian man, at
747 ;; least, emit it even when not in a Latin-N locale.
757 "Convert overstriking and underlining to the correct fonts.
758 Same for the ANSI bold and normal escape sequences."
770 ;; Multibyte characters exist.
801 ;; Try to recognize common forms of cross references.
807 "Highlight the references on mouse-over.
808 references include items in the SEE ALSO section,
809 header file(#include <foo.h>) and files in FILES"
812 Man-see-also-regexp Man-reference-regexp 1 dummy
815 Man-synopsis-regexp Man-header-regexp 0 2
818 Man-files-regexp Man-normal-file-regexp 0 0
822 ;; Based on `Man-build-references-alist'
833 'type type
835 )))))
838 "Remove overstriking and underlining from the current buffer."
841 Man-arguments)
855 ))
862 "Manpage background process sentinel.
863 When manpage command is run asynchronously, PROCESS is the process
864 object for the manpage command; when manpage command is run
865 synchronously, PROCESS is the name of the buffer where the manpage
866 command is run. Second argument MSG is the exit message of the
867 manpage command."
886 delete-buff t))
894 ": process "
900 ))
909 ))
910 ;; Restore case-fold-search before calling
911 ;; Man-notify-when-ready because it may switch buffers.
918 ))))
920 \f
921 ;; ======================================================================
922 ;; set up manual mode in buffer and build alists
925 "A mode for browsing Un*x manual pages.
927 The following man commands are available in the buffer. Try
942 The following variables may be of some use. Try
945 `Man-notify-method' What happens when manpage formatting is done.
946 `Man-downcase-section-letters-flag' Force section letters to lower case.
947 `Man-circular-pages-flag' Treat multiple manpage list as circular.
948 `Man-section-translations-alist' List of section numbers and their Un*x equiv.
949 `Man-filter-list' Background manpage filter command.
950 `Man-mode-map' Keymap bindings for Man mode buffers.
951 `Man-mode-hook' Normal hook run on entry to Man mode.
952 `Man-section-regexp' Regexp describing manpage section letters.
953 `Man-heading-regexp' Regexp describing section headers.
954 `Man-see-also-regexp' Regexp for SEE ALSO section (or your equiv).
955 `Man-first-heading-regexp' Regexp for first heading on a manpage.
956 `Man-reference-regexp' Regexp matching a references in SEE ALSO.
957 `Man-switches' Background `man' command switches.
959 The following key bindings are currently in effect in the buffer:
963 mode-name "Man"
964 buffer-auto-save-file-name nil
965 mode-line-buffer-identification
968 truncate-lines t
969 buffer-read-only t)
981 "Build the association list of manpage sections."
990 "Build the association list of references (in the SEE ALSO section)."
998 hyphenated
1011 hyphenated nil
1012 ;; Update len, in case a reference spans
1013 ;; more than two lines (paranoia).
1023 "Build the list of separate manpages in the buffer."
1029 ;; (switch-to-buffer (current-buffer))(debug)
1034 nil))
1035 ;; Go past both the current and the next Man-first-heading-regexp
1038 ;; We assume that the page header is delimited by blank
1039 ;; lines and that it contains at most one blank line. So
1040 ;; if we back by three blank lines we will be sure to be
1041 ;; before the page header but not before the possible
1042 ;; previous page header.
1050 header))))
1052 )))
1055 "Strip all the page headers but the first from the manpage."
1067 ;; Since the awk script collapses all successive blank
1068 ;; lines into one, and since we don't want to get rid of
1069 ;; the fast awk script, one must choose between adding
1070 ;; spare blank lines between pages when there were none and
1071 ;; deleting blank lines at page boundaries when there were
1072 ;; some. We choose the first, so we comment the following
1073 ;; line.
1074 ;; (setq header (concat "\n" header)))
1080 "Delete the leading spaces that indent the manpage."
1115 ))))
1117 \f
1118 ;; ======================================================================
1119 ;; Man mode commands
1122 "Move point to Nth next section (default 1)."
1132 "Move point to Nth previous section (default 1)."
1142 "Move point to SECTION if it exists, otherwise don't move point.
1143 Returns t if section is found, nil otherwise."
1150 nil)
1151 ))
1154 "Query for section to move point to."
1159 chosen
1164 default
1165 chosen)))
1170 Actually the section moved to is described by `Man-see-also-regexp'."
1177 "Return a possibly hyphenated word at point.
1178 If the word starts at the first non-whitespace column, and the
1179 previous line ends with a hyphen, return the last word on the previous
1194 word)))
1198 Specify which REFERENCE to use; default is based on word at point."
1205 ;; strip a trailing '-':
1209 word))
1210 Man-refpages-alist))
1212 chosen
1217 default
1218 chosen)))))
1226 "Kill the buffer containing the manpage."
1231 "Bury the buffer containing the manpage."
1236 "Go to the manual page on page PAGE."
1267 "Find the next manpage entry in the buffer."
1278 "Find the previous manpage entry in the buffer."
1288 ;; Header file support
1290 "View a header file specified by FILE from `Man-header-file-path'."
1292 complete-path)
1300 complete-path))
1301 \f
1302 ;; Init the man package variables, if not already done.
1310 ;;; arch-tag: 587cda76-8e23-4594-b1f3-89b6b09a0d47
1311 ;;; man.el ends here