| blob | c8c2f8653e214c262dcaf36df63a45cdb15e1a3a |
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."
269 "Regular expression for SEE ALSO heading (or your equivalent).
272 ;; This used to have leading space [ \t]*, but was removed because it
273 ;; causes false page splits on an occasional NAME with leading space
274 ;; inside a manpage. And `Man-heading-regexp' doesn't have [ \t]* anyway.
276 "Regular expression describing first heading on a manpage.
288 "Regular expression for SYNOPSIS heading (or your equivalent).
292 ;; Add \> so as not to match mount(8)'s FILESYSTEM INDEPENDENT MOUNT OPTIONS.
293 "Regular expression for FILES heading (or your equivalent).
316 ;; This includes the section as an optional part to catch hyphenated
317 ;; references to manpages.
323 "Switches passed to the man command, as a single string.
325 If you want to be able to see all the manpages for a subject you type,
330 "-s"
335 "Internal cache for the value of the function `Man-support-local-filenames'.
336 `auto-detect' means the value is not yet determined.
337 Otherwise, the value is whatever the function
340 ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
341 ;; end user variables
342 \f
343 ;; other variables and keymap initializations
366 :ovstrk
368 t ovstrk
369 }
392 table)
415 ;; Not all the man references get buttons currently. The text in the
416 ;; manual page can contain references to other man pages
419 map)
422 ;; buttons
424 'follow-link t
426 'func nil
449 'follow-link t
461 'follow-link t
464 \f
465 ;; ======================================================================
466 ;; utilities
469 "Used for initializing variables based on display's color support.
470 This is necessary if one wants to dump man.el with Emacs."
472 ;; Avoid possible error in call-process by using a directory that must exist.
477 nil)
479 Man-sysv-sed-script)
481 Man-berkeley-sed-script)
483 nil))))
486 ;; Avoid trailing nil which confuses customize.
489 Man-sed-command
491 ;; Windows needs ".." quoting, not '..'.
507 "-e '/\e[789]/s///g'"
508 "-e '/Reformatting page. Wait/d'"
509 "-e '/Reformatting entry. Wait/d'"
520 )))
521 ;; Windows doesn't support multi-line commands, so don't
522 ;; invoke Awk there.
525 Man-awk-command
533 "'"
534 )))
536 ;; The outer list will be stripped off by apply.
538 Man-untabify-command
539 Man-untabify-command-args))
540 )))
541 )
544 "Formats part of the mode line for Man mode."
548 Man-current-page
552 "Builds the entire background manpage and cleaning command."
555 ;; Already has %s
557 ;; Stock MS-DOS shells cannot redirect stderr;
558 ;; `call-process' below sends it to /dev/null,
559 ;; so we don't need `2>' even with DOS shells
560 ;; which do support stderr redirection.
572 phrase)
575 command))
579 "Strip leading, trailing and middle spaces."
581 ;; Strip leading and trailing
584 ;; middle spaces
587 string))
591 Leave it as is if already in that style. Possibly downcase and
592 translate the section (see the `Man-downcase-section-letters-flag'
593 and the `Man-section-translations-alist' variables)."
599 ;; "chmod(2V)" case ?
603 ;; "2v chmod" case ?
609 ref ; Return the reference as is
621 s2)
622 slist nil))))
626 "Return non-nil if the man command supports local filenames.
627 Different man programs support this feature in different ways.
629 \(or `-l') option for this purpose. The default Red Hat man
630 program has no such option, but interprets any name containing
632 `man', or nil."
637 ;; Ensure that `default-directory' exists and is readable.
640 default-directory
646 ;; This feature seems to be present in at least ver 1.4f,
647 ;; which is about 20 years old.
648 ;; I don't know if this version has an official name?
651 Man-support-local-filenames))
653 \f
654 ;; ======================================================================
655 ;; default man entry: get word near point
658 "Guess default manual entry based on the text near position POS.
659 POS defaults to `point'."
664 ;; The default title is the nearest entry-like object before or
665 ;; after POS.
668 ;; Try to handle the special case where POS is on a
669 ;; section number.
672 ;; We skipped a valid section number backwards, look at
673 ;; preceding text.
676 ;; Not a valid entry, move POS after closing paren.
678 ;; We have a candidate, make `start' record its starting
679 ;; position.
681 ;; Otherwise look at char before POS.
684 ;; Our candidate is just before or around POS.
686 ;; Otherwise record the current column and look backwards.
689 ;; Record the distance travelled.
693 ;; Skip section number backwards.
698 ;; We have a candidate before POS ...
704 ;; ... but the one after POS is better.
706 ;; ... and anything after POS is worse.
708 ;; No candidate before POS.
712 ;; We have found a suitable starting point, try to skip at least
713 ;; one character.
716 ;; If there is a continuation at the end of line, check the
717 ;; following line too, eg:
718 ;; see this-
719 ;; command-here(1)
720 ;; Note: This code gets executed iff our entry is after POS.
723 ;; Make sure the section number gets included by the code below.
727 ;; The following was commented out since the preceding code
728 ;; should not produce a leading "*" in the first place.
729 ;;; ;; If looking at something like *strcat(... , remove the '*'
730 ;;; (when (string-match "^*" word)
731 ;;; (setq word (substring word 1)))
733 word
735 ;; If looking at something like ioctl(2) or brc(1M),
736 ;; include the section number in the returned value.
741 \f
742 ;; ======================================================================
743 ;; Top level command and background process sentinel
745 ;; For compatibility with older versions.
746 ;;;###autoload
750 ;; On my machine, "man -k" is so fast that a cache makes no sense,
751 ;; but apparently that's not the case in all cases, so let's add a cache.
759 ;; Let SPC (minibuffer-complete-word) insert the space.
772 ;; Actually for my `man' the arg is a regexp.
773 ;; POSIX says it must be ERE and "man-db" seems to agree,
774 ;; whereas under MacOSX it seems to be BRE-style and doesn't
775 ;; accept backslashes at all. Let's not bother to
776 ;; quote anything.
779 ;; manual-program might not even exist. And since it's
780 ;; run differently in Man-getpage-in-background, an error
781 ;; here may not necessarily mean that we'll also get an
782 ;; error later.
787 (while (re-search-forward "^\\([^ \t\n]+\\)\\(?: ?\\((.+?)\\)\\(?:[ \t]+- \\(.*\\)\\)?\\)?" nil t)
790 table)))
791 ;; Cache the table for later reuse.
793 ;; The table may contain false positives since the match is made
794 ;; by "man -k" not just on the manpage's name.
801 prefix pred action))
802 ;; If the current text looks like a possible section name,
803 ;; then add a completion entry that just adds a space so SPC
804 ;; can be used to insert a space.
808 ;; In case we're completing to a single name that exists in
809 ;; several sections, the longest prefix will look like "foo(".
812 ;; In case the paren was already in `prefix', don't
813 ;; remove it.
816 res)))))))
818 ;;;###autoload
820 "Get a Un*x manual page and put it in a buffer.
821 This command is the top-level command in the man package. It
822 runs a Un*x command to retrieve and clean a manpage in the
823 background and places the results in a `Man-mode' browsing
824 buffer. See variable `Man-notify-method' for what happens when
825 the buffer is ready. If a buffer already exists for this man
826 page, it will display immediately.
828 For a manpage from a particular section, use either of the
832 cat(1)
833 1 cat
835 To see manpages from all sections related to a subject, use an
838 Add to `Man-switches' to make this option permanent.
840 -a chmod
842 An explicit filename can be given too. Use -l if it might
843 otherwise look like a page name.
845 /my/file/name.1.gz
846 -l somefile.1
849 names or descriptions. The pattern argument is usually an
852 -k pattern"
856 ;; ignore case because that's friendly for bizarre
857 ;; caps things like the X11 function names and because
858 ;; "man" itself is case-sensitive on the command line
859 ;; so you're accustomed not to bother about the case
860 ;; ("man -k" is case-insensitive similarly, so the
861 ;; table has everything available to complete)
866 ": "
868 'Man-completion-table
872 input))))
874 ;; Possibly translate the "subject(section)" syntax into the
875 ;; "section subject" syntax and possibly downcase the section.
880 ;;;###autoload
882 "Get a Un*x manual page of the item under point and put it in a buffer."
890 "Use TOPIC to build and fire off the manpage and cleaning command.
891 Return the buffer in which the manpage will appear."
905 ;; The following is so Awk script gets \n intact
906 ;; But don't prevent decoding of the outside.
908 ;; We must decode the output by a coding system that the
909 ;; system's locale suggests in multibyte mode.
913 ;; Avoid possible error by using a directory that always exists.
918 default-directory
920 ;; Prevent any attempt to use display terminal fanciness.
922 ;; In Debian Woody, at least, we get overlong lines under X
923 ;; unless COLUMNS or MANWIDTH is set. This isn't a problem on
924 ;; a tty. man(1) says:
925 ;; MANWIDTH
926 ;; If $MANWIDTH is set, its value is used as the line
927 ;; length for which manual pages should be formatted.
928 ;; If it is not set, manual pages will be formatted
929 ;; with a line length appropriate to the current ter-
930 ;; minal (using an ioctl(2) if available, the value of
931 ;; $COLUMNS, or falling back to 80 characters if nei-
932 ;; ther is available).
934 ;; This isn't strictly correct, since we don't know how
935 ;; the page will actually be displayed, but it seems
936 ;; reasonable.
940 Man-width)
944 ;; Since man-db 2.4.3-1, man writes plain text with no escape
945 ;; sequences when stdout is not a tty. In 2.5.0, the following
946 ;; env-var was added to allow control of this (see Debian Bug#340673).
952 shell-file-name
954 shell-command-switch
959 shell-command-switch
967 exit-status)))
970 buffer))
973 "Notify the user when MAN-BUFFER is ready.
974 See the variable `Man-notify-method' for the different notification behaviors."
976 Man-original-frame)))
979 ;; Since we run asynchronously, perhaps while Emacs is waiting
980 ;; for input, we must not leave a different buffer current. We
981 ;; can't rely on the editor command loop to reselect the
982 ;; selected window's buffer.
1011 )))
1014 ;; \255 is SOFT HYPHEN in Latin-N. Versions of Debian man, at
1015 ;; least, emit it even when not in a Latin-N locale.
1025 "Convert overstriking and underlining to the correct fonts.
1026 Same for the ANSI bold and normal escape sequences."
1030 ;; Fontify ANSI escapes.
1034 ;; http://www.isthe.com/chongo/tech/comp/ansi_escapes.html
1035 ;; suggests many codes, but we only handle:
1036 ;; ESC [ 00 m reset to normal display
1037 ;; ESC [ 01 m bold
1038 ;; ESC [ 04 m underline
1039 ;; ESC [ 07 m reverse-video
1040 ;; ESC [ 22 m no-bold
1041 ;; ESC [ 24 m no-underline
1042 ;; ESC [ 27 m no-reverse-video
1053 faces))
1060 faces))))
1063 ;; Other highlighting.
1066 ;; Multibyte characters exist.
1096 ;; When the header is longer than the manpage name, groff tries to
1097 ;; condense it to a shorter line interspered with ^H. Remove ^H with
1098 ;; their preceding chars (but don't put Man-overstrike-face). (Bug#5566)
1102 ;; Try to recognize common forms of cross references.
1113 "Highlight the references on mouse-over.
1114 References include items in the SEE ALSO section,
1115 header file (#include <foo.h>), and files in FILES.
1116 If optional argument XREF-MAN-TYPE is non-nil, it used as the
1117 button type for items in SEE ALSO section. If it is nil, the
1118 default type, `Man-xref-man-page' is used for the buttons."
1119 ;; `Man-highlight-references' is used from woman.el, too.
1120 ;; woman.el doesn't set `Man-arguments'.
1126 'Man-default-man-entry
1129 'Man-default-man-entry
1132 'Man-default-man-entry
1140 ;; Based on `Man-build-references-alist'
1151 nil)))
1153 ;; An overlay button is preferable because the underlying text
1154 ;; may have text property highlights (Bug#7881).
1158 'type type
1163 target)
1167 "Remove overstriking and underlining from the current buffer.
1168 Normally skip any jobs that should have been done by the sed script,
1169 but when called interactively, do those jobs even if the sed
1170 script would have done them."
1173 Man-arguments)
1187 ))
1190 ;; When the header is longer than the manpage name, groff tries to
1191 ;; condense it to a shorter line interspered with ^H. Remove ^H with
1192 ;; their preceding chars (but don't put Man-overstrike-face). (Bug#5566)
1199 "Manpage background process sentinel.
1200 When manpage command is run asynchronously, PROCESS is the process
1201 object for the manpage command; when manpage command is run
1202 synchronously, PROCESS is the name of the buffer where the manpage
1203 command is run. Second argument MSG is the exit message of the
1204 manpage command."
1222 delete-buff t))
1224 ;; "-k foo", successful exit, but no output (from man-db)
1225 ;; ENHANCE-ME: share the check for -k with
1226 ;; `Man-highlight-references'. The \\s- bits here are
1227 ;; meant to allow for multiple options with -k among them.
1233 delete-buff t))
1242 ": process "
1248 ))
1264 ))
1265 ;; Restore case-fold-search before calling
1266 ;; Man-notify-when-ready because it may switch buffers.
1273 ))))
1275 \f
1276 ;; ======================================================================
1277 ;; set up manual mode in buffer and build alists
1284 "A mode for browsing Un*x manual pages.
1286 The following man commands are available in the buffer. Try
1301 The following variables may be of some use. Try
1304 `Man-notify-method' What happens when manpage formatting is done.
1305 `Man-downcase-section-letters-flag' Force section letters to lower case.
1306 `Man-circular-pages-flag' Treat multiple manpage list as circular.
1307 `Man-section-translations-alist' List of section numbers and their Un*x equiv.
1308 `Man-filter-list' Background manpage filter command.
1309 `Man-mode-map' Keymap bindings for Man mode buffers.
1310 `Man-mode-hook' Normal hook run on entry to Man mode.
1311 `Man-section-regexp' Regexp describing manpage section letters.
1312 `Man-heading-regexp' Regexp describing section headers.
1313 `Man-see-also-regexp' Regexp for SEE ALSO section (or your equiv).
1314 `Man-first-heading-regexp' Regexp for first heading on a manpage.
1315 `Man-reference-regexp' Regexp matching a references in SEE ALSO.
1316 `Man-switches' Background `man' command switches.
1318 The following key bindings are currently in effect in the buffer:
1323 mode-name "Man"
1324 buffer-auto-save-file-name nil
1325 mode-line-buffer-identification
1328 truncate-lines t
1329 buffer-read-only t)
1346 "Build the association list of manpage sections."
1355 "Build the association list of references (in the SEE ALSO section)."
1363 hyphenated
1376 hyphenated nil
1377 ;; Update len, in case a reference spans
1378 ;; more than two lines (paranoia).
1388 "Build the list of separate manpages in the buffer."
1394 ;; (switch-to-buffer (current-buffer))(debug)
1399 nil))
1400 ;; Go past both the current and the next Man-first-heading-regexp
1403 ;; We assume that the page header is delimited by blank
1404 ;; lines and that it contains at most one blank line. So
1405 ;; if we back by three blank lines we will be sure to be
1406 ;; before the page header but not before the possible
1407 ;; previous page header.
1415 header))))
1417 )))
1420 "Strip all the page headers but the first from the manpage."
1429 ;; Since the awk script collapses all successive blank
1430 ;; lines into one, and since we don't want to get rid of
1431 ;; the fast awk script, one must choose between adding
1432 ;; spare blank lines between pages when there were none and
1433 ;; deleting blank lines at page boundaries when there were
1434 ;; some. We choose the first, so we comment the following
1435 ;; line.
1436 ;; (setq header (concat "\n" header)))
1441 "Delete the leading spaces that indent the manpage."
1473 ))))
1475 \f
1476 ;; ======================================================================
1477 ;; Man mode commands
1480 "Move point to Nth next section (default 1)."
1489 ;; The last line doesn't belong to any section.
1491 ;; But don't move back from the starting point (can happen if `start'
1492 ;; is somewhere on the last line).
1496 "Move point to Nth previous section (default 1)."
1506 "Move point to SECTION if it exists, otherwise don't move point.
1507 Returns t if section is found, nil otherwise."
1514 nil)
1515 ))
1518 "Query for section to move point to."
1523 chosen
1528 default
1529 chosen)))
1536 Actually the section moved to is described by `Man-see-also-regexp'."
1543 "Return a possibly hyphenated word at point.
1544 If the word starts at the first non-whitespace column, and the
1545 previous line ends with a hyphen, return the last word on the previous
1560 word)))
1564 Specify which REFERENCE to use; default is based on word at point."
1574 ;; strip a trailing '-':
1578 word))
1579 Man-refpages-alist))
1586 chosen
1589 nil nil nil nil defaults))
1592 default
1593 chosen)))))
1601 "Kill the buffer containing the manpage."
1606 "Bury the buffer containing the manpage."
1611 "Go to the manual page on page PAGE."
1639 "Find the next manpage entry in the buffer."
1650 "Find the previous manpage entry in the buffer."
1660 ;; Header file support
1662 "View a header file specified by FILE from `Man-header-file-path'."
1664 complete-path)
1672 complete-path))
1674 ;;; Bookmark Man Support
1682 "Default bookmark name for Man or WoMan pages.
1683 Uses `Man-name-local-regexp'."
1691 "Make a bookmark entry for a Man buffer."
1698 ;;;###autoload
1700 "Default bookmark handler for Man buffers."
1702 ;; Let bookmark.el do the window handling.
1703 ;; This let-binding needs to be active during the call to both
1704 ;; Man-getpage-in-background and accept-process-output.
1713 \f
1714 ;; Init the man package variables, if not already done.
1722 ;;; man.el ends here