| blob | ed24e35f0eaacd89e895b52d007da4e42dcc2f9a |
1 ;;; man.el --- browse UNIX manual pages -*- coding: iso-8859-1 -*-
3 ;; Copyright (C) 1993-1994, 1996-1997, 2001-2011
4 ;; Free Software Foundation, Inc.
6 ;; Author: Barry A. Warsaw <bwarsaw@cen.com>
7 ;; Maintainer: FSF
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 3 of the License, or
16 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
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 behavior 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 heuristics
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.
88 \f
89 ;;; Code:
95 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
96 ;; empty defvars (keep the compiler quiet)
99 "Browse UNIX manual pages."
106 "Manpage cleaning filter command phrases.
107 This variable contains a list of the following form:
109 '((command-string phrase-string*)*)
111 Each phrase-string is concatenated onto the command-string to form a
112 command filter. The (standard) output (and standard error) of the Un*x
113 man command is piped through each command filter in the order the
114 commands appear in the association list. The final output is placed in
115 the manpage buffer."
126 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
127 ;; user variables
130 "Non-nil means make up the manpage with fonts."
135 "Face to use when fontifying overstrike."
140 "Face to use when fontifying underlining."
145 "Face to use when fontifying reverse video."
149 ;; Use the value of the obsolete user option Man-notify, if set.
151 "Selects the behavior when manpage is ready.
152 This variable may have one of the following values, where (sf) means
153 that the frames are switched, so the manpage is displayed in the frame
154 where the man command was called from:
156 newframe -- put the manpage in its own frame (see `Man-frame-parameters')
157 pushy -- make the manpage the current buffer in the current window
158 bully -- make the manpage the current buffer and only window (sf)
159 aggressive -- make the manpage the current buffer in the other window (sf)
160 friendly -- display manpage in the other window but don't make current (sf)
161 polite -- don't display manpage, but prints message and beep when ready
162 quiet -- like `polite', but don't beep
163 meek -- make no indication that the manpage is ready
165 Any other value of `Man-notify-method' is equivalent to `meek'."
172 "Number of columns for which manual pages should be formatted.
173 If nil, the width of the window selected at the moment of man
174 invocation is used. If non-nil, the width of the frame selected
175 at the moment of man invocation is used. The value also can be a
176 positive integer."
183 "Frame parameter list for creating a new frame for a manual page."
188 "Non-nil means letters in sections are converted to lower case.
189 Some Un*x man commands can't handle uppercase letters in sections, for
191 with the upper case letter. When this variable is t, the section
193 being sent to the man background process."
198 "Non-nil means the manpage list is treated as circular for traversal."
205 ;; Some systems have a real 3x man section, so let's comment this.
206 ;; '("3X" . "3") ; Xlib man pages
209 "Association list of bogus sections to real section numbers.
210 Some manpages (e.g. the Sun C++ 2.1 manpages) have section numbers in
211 their references which Un*x `man' does not recognize. This
212 association list is used to translate those sections, when found, to
213 the associated section number."
220 "C Header file search path used in Man."
225 "Regexp that matches the text that precedes the command's name.
226 Used in `bookmark-set' to get the default bookmark name."
268 "Regular expression for SEE ALSO heading (or your equivalent).
271 ;; This used to have leading space [ \t]*, but was removed because it
272 ;; causes false page splits on an occasional NAME with leading space
273 ;; inside a manpage. And `Man-heading-regexp' doesn't have [ \t]* anyway.
275 "Regular expression describing first heading on a manpage.
289 "Regular expression for SYNOPSIS heading (or your equivalent).
293 ;; Add \> so as not to match mount(8)'s FILESYSTEM INDEPENDENT MOUNT OPTIONS.
294 "Regular expression for FILES heading (or your equivalent).
317 ;; This includes the section as an optional part to catch hyphenated
318 ;; references to manpages.
324 "Switches passed to the man command, as a single string.
326 If you want to be able to see all the manpages for a subject you type,
331 "-s"
336 "Internal cache for the value of the function `Man-support-local-filenames'.
337 `auto-detect' means the value is not yet determined.
338 Otherwise, the value is whatever the function
341 ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
342 ;; end user variables
343 \f
344 ;; other variables and keymap initializations
367 :ovstrk
369 t ovstrk
370 }
393 table)
416 ;; Not all the man references get buttons currently. The text in the
417 ;; manual page can contain references to other man pages
420 map)
423 ;; buttons
425 'follow-link t
427 'func nil
450 'follow-link t
462 'follow-link t
465 \f
466 ;; ======================================================================
467 ;; utilities
470 "Used for initializing variables based on display's color support.
471 This is necessary if one wants to dump man.el with Emacs."
473 ;; Avoid possible error in call-process by using a directory that must exist.
478 nil)
480 Man-sysv-sed-script)
482 Man-berkeley-sed-script)
484 nil))))
487 ;; Avoid trailing nil which confuses customize.
490 Man-sed-command
492 ;; Windows needs ".." quoting, not '..'.
508 "-e '/\e[789]/s///g'"
509 "-e '/Reformatting page. Wait/d'"
510 "-e '/Reformatting entry. Wait/d'"
521 )))
522 ;; Windows doesn't support multi-line commands, so don't
523 ;; invoke Awk there.
526 Man-awk-command
534 "'"
535 )))
537 ;; The outer list will be stripped off by apply.
539 Man-untabify-command
540 Man-untabify-command-args))
541 )))
542 )
545 "Formats part of the mode line for Man mode."
549 Man-current-page
553 "Builds the entire background manpage and cleaning command."
556 ;; Already has %s
558 ;; Stock MS-DOS shells cannot redirect stderr;
559 ;; `call-process' below sends it to /dev/null,
560 ;; so we don't need `2>' even with DOS shells
561 ;; which do support stderr redirection.
573 phrase)
576 command))
580 "Strip leading, trailing and middle spaces."
582 ;; Strip leading and trailing
585 ;; middle spaces
588 string))
592 Leave it as is if already in that style. Possibly downcase and
593 translate the section (see the `Man-downcase-section-letters-flag'
594 and the `Man-section-translations-alist' variables)."
600 ;; "chmod(2V)" case ?
604 ;; "2v chmod" case ?
610 ref ; Return the reference as is
622 s2)
623 slist nil))))
627 "Return non-nil if the man command supports local filenames.
628 Different man programs support this feature in different ways.
630 \(or `-l') option for this purpose. The default Red Hat man
631 program has no such option, but interprets any name containing
633 `man', or nil."
638 ;; Ensure that `default-directory' exists and is readable.
641 default-directory
647 ;; This feature seems to be present in at least ver 1.4f,
648 ;; which is about 20 years old.
649 ;; I don't know if this version has an official name?
652 Man-support-local-filenames))
654 \f
655 ;; ======================================================================
656 ;; default man entry: get word near point
659 "Guess default manual entry based on the text near position POS.
660 POS defaults to `point'."
665 ;; The default title is the nearest entry-like object before or
666 ;; after POS.
669 ;; Try to handle the special case where POS is on a
670 ;; section number.
673 ;; We skipped a valid section number backwards, look at
674 ;; preceding text.
677 ;; Not a valid entry, move POS after closing paren.
679 ;; We have a candidate, make `start' record its starting
680 ;; position.
682 ;; Otherwise look at char before POS.
685 ;; Our candidate is just before or around POS.
687 ;; Otherwise record the current column and look backwards.
690 ;; Record the distance travelled.
694 ;; Skip section number backwards.
699 ;; We have a candidate before POS ...
705 ;; ... but the one after POS is better.
707 ;; ... and anything after POS is worse.
709 ;; No candidate before POS.
713 ;; We have found a suitable starting point, try to skip at least
714 ;; one character.
717 ;; If there is a continuation at the end of line, check the
718 ;; following line too, eg:
719 ;; see this-
720 ;; command-here(1)
721 ;; Note: This code gets executed iff our entry is after POS.
724 ;; Make sure the section number gets included by the code below.
728 ;; The following was commented out since the preceding code
729 ;; should not produce a leading "*" in the first place.
730 ;;; ;; If looking at something like *strcat(... , remove the '*'
731 ;;; (when (string-match "^*" word)
732 ;;; (setq word (substring word 1)))
734 word
736 ;; If looking at something like ioctl(2) or brc(1M),
737 ;; include the section number in the returned value.
742 \f
743 ;; ======================================================================
744 ;; Top level command and background process sentinel
746 ;; For compatibility with older versions.
747 ;;;###autoload
751 ;; On my machine, "man -k" is so fast that a cache makes no sense,
752 ;; but apparently that's not the case in all cases, so let's add a cache.
760 ;; Let SPC (minibuffer-complete-word) insert the space.
773 ;; Actually for my `man' the arg is a regexp.
774 ;; POSIX says it must be ERE and "man-db" seems to agree,
775 ;; whereas under MacOSX it seems to be BRE-style and doesn't
776 ;; accept backslashes at all. Let's not bother to
777 ;; quote anything.
780 ;; manual-program might not even exist. And since it's
781 ;; run differently in Man-getpage-in-background, an error
782 ;; here may not necessarily mean that we'll also get an
783 ;; error later.
788 (while (re-search-forward "^\\([^ \t\n]+\\)\\(?: ?\\((.+?)\\)\\(?:[ \t]+- \\(.*\\)\\)?\\)?" nil t)
791 table)))
792 ;; Cache the table for later reuse.
794 ;; The table may contain false positives since the match is made
795 ;; by "man -k" not just on the manpage's name.
802 prefix pred action))
803 ;; If the current text looks like a possible section name,
804 ;; then add a completion entry that just adds a space so SPC
805 ;; can be used to insert a space.
809 ;; In case we're completing to a single name that exists in
810 ;; several sections, the longest prefix will look like "foo(".
813 ;; In case the paren was already in `prefix', don't
814 ;; remove it.
817 res)))))))
819 ;;;###autoload
821 "Get a Un*x manual page and put it in a buffer.
822 This command is the top-level command in the man package. It
823 runs a Un*x command to retrieve and clean a manpage in the
824 background and places the results in a `Man-mode' browsing
825 buffer. See variable `Man-notify-method' for what happens when
826 the buffer is ready. If a buffer already exists for this man
827 page, it will display immediately.
829 For a manpage from a particular section, use either of the
833 cat(1)
834 1 cat
836 To see manpages from all sections related to a subject, use an
839 Add to `Man-switches' to make this option permanent.
841 -a chmod
843 An explicit filename can be given too. Use -l if it might
844 otherwise look like a page name.
846 /my/file/name.1.gz
847 -l somefile.1
850 names or descriptions. The pattern argument is usually an
853 -k pattern"
857 ;; ignore case because that's friendly for bizarre
858 ;; caps things like the X11 function names and because
859 ;; "man" itself is case-sensitive on the command line
860 ;; so you're accustomed not to bother about the case
861 ;; ("man -k" is case-insensitive similarly, so the
862 ;; table has everything available to complete)
867 ": "
869 'Man-completion-table
873 input))))
875 ;; Possibly translate the "subject(section)" syntax into the
876 ;; "section subject" syntax and possibly downcase the section.
881 ;;;###autoload
883 "Get a Un*x manual page of the item under point and put it in a buffer."
891 "Use TOPIC to build and fire off the manpage and cleaning command.
892 Return the buffer in which the manpage will appear."
906 ;; The following is so Awk script gets \n intact
907 ;; But don't prevent decoding of the outside.
909 ;; We must decode the output by a coding system that the
910 ;; system's locale suggests in multibyte mode.
914 ;; Avoid possible error by using a directory that always exists.
919 default-directory
921 ;; Prevent any attempt to use display terminal fanciness.
923 ;; In Debian Woody, at least, we get overlong lines under X
924 ;; unless COLUMNS or MANWIDTH is set. This isn't a problem on
925 ;; a tty. man(1) says:
926 ;; MANWIDTH
927 ;; If $MANWIDTH is set, its value is used as the line
928 ;; length for which manual pages should be formatted.
929 ;; If it is not set, manual pages will be formatted
930 ;; with a line length appropriate to the current ter-
931 ;; minal (using an ioctl(2) if available, the value of
932 ;; $COLUMNS, or falling back to 80 characters if nei-
933 ;; ther is available).
935 ;; This isn't strictly correct, since we don't know how
936 ;; the page will actually be displayed, but it seems
937 ;; reasonable.
941 Man-width)
945 ;; Since man-db 2.4.3-1, man writes plain text with no escape
946 ;; sequences when stdout is not a tty. In 2.5.0, the following
947 ;; env-var was added to allow control of this (see Debian Bug#340673).
953 shell-file-name
955 shell-command-switch
960 shell-command-switch
968 exit-status)))
971 buffer))
974 "Notify the user when MAN-BUFFER is ready.
975 See the variable `Man-notify-method' for the different notification behaviors."
977 Man-original-frame)))
980 ;; Since we run asynchronously, perhaps while Emacs is waiting
981 ;; for input, we must not leave a different buffer current. We
982 ;; can't rely on the editor command loop to reselect the
983 ;; selected window's buffer.
1012 )))
1015 ;; \255 is SOFT HYPHEN in Latin-N. Versions of Debian man, at
1016 ;; least, emit it even when not in a Latin-N locale.
1026 "Convert overstriking and underlining to the correct fonts.
1027 Same for the ANSI bold and normal escape sequences."
1031 ;; Fontify ANSI escapes.
1035 ;; http://www.isthe.com/chongo/tech/comp/ansi_escapes.html
1036 ;; suggests many codes, but we only handle:
1037 ;; ESC [ 00 m reset to normal display
1038 ;; ESC [ 01 m bold
1039 ;; ESC [ 04 m underline
1040 ;; ESC [ 07 m reverse-video
1041 ;; ESC [ 22 m no-bold
1042 ;; ESC [ 24 m no-underline
1043 ;; ESC [ 27 m no-reverse-video
1054 faces))
1061 faces))))
1064 ;; Other highlighting.
1067 ;; Multibyte characters exist.
1097 ;; When the header is longer than the manpage name, groff tries to
1098 ;; condense it to a shorter line interspered with ^H. Remove ^H with
1099 ;; their preceding chars (but don't put Man-overstrike-face). (Bug#5566)
1103 ;; Try to recognize common forms of cross references.
1114 "Highlight the references on mouse-over.
1115 References include items in the SEE ALSO section,
1116 header file (#include <foo.h>), and files in FILES.
1117 If optional argument XREF-MAN-TYPE is non-nil, it used as the
1118 button type for items in SEE ALSO section. If it is nil, the
1119 default type, `Man-xref-man-page' is used for the buttons."
1120 ;; `Man-highlight-references' is used from woman.el, too.
1121 ;; woman.el doesn't set `Man-arguments'.
1127 'Man-default-man-entry
1130 'Man-default-man-entry
1133 'Man-default-man-entry
1141 ;; Based on `Man-build-references-alist'
1152 nil)))
1154 ;; An overlay button is preferable because the underlying text
1155 ;; may have text property highlights (Bug#7881).
1159 'type type
1164 target)
1168 "Remove overstriking and underlining from the current buffer.
1169 Normally skip any jobs that should have been done by the sed script,
1170 but when called interactively, do those jobs even if the sed
1171 script would have done them."
1174 Man-arguments)
1188 ))
1191 ;; When the header is longer than the manpage name, groff tries to
1192 ;; condense it to a shorter line interspered with ^H. Remove ^H with
1193 ;; their preceding chars (but don't put Man-overstrike-face). (Bug#5566)
1200 "Manpage background process sentinel.
1201 When manpage command is run asynchronously, PROCESS is the process
1202 object for the manpage command; when manpage command is run
1203 synchronously, PROCESS is the name of the buffer where the manpage
1204 command is run. Second argument MSG is the exit message of the
1205 manpage command."
1223 delete-buff t))
1225 ;; "-k foo", successful exit, but no output (from man-db)
1226 ;; ENHANCE-ME: share the check for -k with
1227 ;; `Man-highlight-references'. The \\s- bits here are
1228 ;; meant to allow for multiple options with -k among them.
1234 delete-buff t))
1243 ": process "
1249 ))
1265 ;; Restore case-fold-search before calling
1266 ;; Man-notify-when-ready because it may switch buffers.
1273 ))))
1276 ;; Skip arguments and only print the page name.
1278 'identity
1283 elem))
1287 \f
1288 ;; ======================================================================
1289 ;; set up manual mode in buffer and build alists
1296 "A mode for browsing Un*x manual pages.
1298 The following man commands are available in the buffer. Try
1313 The following variables may be of some use. Try
1316 `Man-notify-method' What happens when manpage formatting is done.
1317 `Man-downcase-section-letters-flag' Force section letters to lower case.
1318 `Man-circular-pages-flag' Treat multiple manpage list as circular.
1319 `Man-section-translations-alist' List of section numbers and their Un*x equiv.
1320 `Man-filter-list' Background manpage filter command.
1321 `Man-mode-map' Keymap bindings for Man mode buffers.
1322 `Man-mode-hook' Normal hook run on entry to Man mode.
1323 `Man-section-regexp' Regexp describing manpage section letters.
1324 `Man-heading-regexp' Regexp describing section headers.
1325 `Man-see-also-regexp' Regexp for SEE ALSO section (or your equiv).
1326 `Man-first-heading-regexp' Regexp for first heading on a manpage.
1327 `Man-reference-regexp' Regexp matching a references in SEE ALSO.
1328 `Man-switches' Background `man' command switches.
1330 The following key bindings are currently in effect in the buffer:
1335 mode-name "Man"
1336 buffer-auto-save-file-name nil
1337 mode-line-buffer-identification
1340 truncate-lines t
1341 buffer-read-only t)
1358 "Build the association list of manpage sections."
1367 "Build the association list of references (in the SEE ALSO section)."
1375 hyphenated
1388 hyphenated nil
1389 ;; Update len, in case a reference spans
1390 ;; more than two lines (paranoia).
1400 "Build the list of separate manpages in the buffer."
1406 ;; (switch-to-buffer (current-buffer))(debug)
1411 nil))
1412 ;; Go past both the current and the next Man-first-heading-regexp
1415 ;; We assume that the page header is delimited by blank
1416 ;; lines and that it contains at most one blank line. So
1417 ;; if we back by three blank lines we will be sure to be
1418 ;; before the page header but not before the possible
1419 ;; previous page header.
1427 header))))
1429 )))
1432 "Strip all the page headers but the first from the manpage."
1441 ;; Since the awk script collapses all successive blank
1442 ;; lines into one, and since we don't want to get rid of
1443 ;; the fast awk script, one must choose between adding
1444 ;; spare blank lines between pages when there were none and
1445 ;; deleting blank lines at page boundaries when there were
1446 ;; some. We choose the first, so we comment the following
1447 ;; line.
1448 ;; (setq header (concat "\n" header)))
1453 "Delete the leading spaces that indent the manpage."
1485 ))))
1487 \f
1488 ;; ======================================================================
1489 ;; Man mode commands
1492 "Move point to Nth next section (default 1)."
1501 ;; The last line doesn't belong to any section.
1503 ;; But don't move back from the starting point (can happen if `start'
1504 ;; is somewhere on the last line).
1508 "Move point to Nth previous section (default 1)."
1518 "Move point to SECTION if it exists, otherwise don't move point.
1519 Returns t if section is found, nil otherwise."
1526 nil)
1527 ))
1530 "Query for section to move point to."
1535 chosen
1540 default
1541 chosen)))
1548 Actually the section moved to is described by `Man-see-also-regexp'."
1555 "Return a possibly hyphenated word at point.
1556 If the word starts at the first non-whitespace column, and the
1557 previous line ends with a hyphen, return the last word on the previous
1572 word)))
1576 Specify which REFERENCE to use; default is based on word at point."
1586 ;; strip a trailing '-':
1590 word))
1591 Man-refpages-alist))
1598 chosen
1601 nil nil nil nil defaults))
1604 default
1605 chosen)))))
1613 "Kill the buffer containing the manpage."
1618 "Bury the buffer containing the manpage."
1623 "Go to the manual page on page PAGE."
1651 "Find the next manpage entry in the buffer."
1662 "Find the previous manpage entry in the buffer."
1672 ;; Header file support
1674 "View a header file specified by FILE from `Man-header-file-path'."
1676 complete-path)
1684 complete-path))
1686 ;;; Bookmark Man Support
1694 "Default bookmark name for Man or WoMan pages.
1695 Uses `Man-name-local-regexp'."
1703 "Make a bookmark entry for a Man buffer."
1710 ;;;###autoload
1712 "Default bookmark handler for Man buffers."
1714 ;; Let bookmark.el do the window handling.
1715 ;; This let-binding needs to be active during the call to both
1716 ;; Man-getpage-in-background and accept-process-output.
1725 \f
1726 ;; Init the man package variables, if not already done.
1734 ;;; man.el ends here