| blob | 7a9e6e3cca534addfce03d4b0d61ac7e34b866f6 |
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.
287 "Regular expression for SYNOPSIS heading (or your equivalent).
291 ;; Add \> so as not to match mount(8)'s FILESYSTEM INDEPENDENT MOUNT OPTIONS.
292 "Regular expression for FILES heading (or your equivalent).
315 ;; This includes the section as an optional part to catch hyphenated
316 ;; references to manpages.
322 "Switches passed to the man command, as a single string.
324 If you want to be able to see all the manpages for a subject you type,
329 "-s"
334 "Internal cache for the value of the function `Man-support-local-filenames'.
335 `auto-detect' means the value is not yet determined.
336 Otherwise, the value is whatever the function
339 ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
340 ;; end user variables
341 \f
342 ;; other variables and keymap initializations
365 :ovstrk
367 t ovstrk
368 }
391 table)
414 ;; Not all the man references get buttons currently. The text in the
415 ;; manual page can contain references to other man pages
418 map)
421 ;; buttons
423 'follow-link t
425 'func nil
448 'follow-link t
460 'follow-link t
463 \f
464 ;; ======================================================================
465 ;; utilities
468 "Used for initializing variables based on display's color support.
469 This is necessary if one wants to dump man.el with Emacs."
471 ;; Avoid possible error in call-process by using a directory that must exist.
476 nil)
478 Man-sysv-sed-script)
480 Man-berkeley-sed-script)
482 nil))))
485 ;; Avoid trailing nil which confuses customize.
488 Man-sed-command
490 ;; Windows needs ".." quoting, not '..'.
506 "-e '/\e[789]/s///g'"
507 "-e '/Reformatting page. Wait/d'"
508 "-e '/Reformatting entry. Wait/d'"
519 )))
520 ;; Windows doesn't support multi-line commands, so don't
521 ;; invoke Awk there.
524 Man-awk-command
532 "'"
533 )))
535 ;; The outer list will be stripped off by apply.
537 Man-untabify-command
538 Man-untabify-command-args))
539 )))
540 )
543 "Formats part of the mode line for Man mode."
547 Man-current-page
551 "Builds the entire background manpage and cleaning command."
554 ;; Already has %s
556 ;; Stock MS-DOS shells cannot redirect stderr;
557 ;; `call-process' below sends it to /dev/null,
558 ;; so we don't need `2>' even with DOS shells
559 ;; which do support stderr redirection.
571 phrase)
574 command))
578 "Strip leading, trailing and middle spaces."
580 ;; Strip leading and trailing
583 ;; middle spaces
586 string))
590 Leave it as is if already in that style. Possibly downcase and
591 translate the section (see the `Man-downcase-section-letters-flag'
592 and the `Man-section-translations-alist' variables)."
598 ;; "chmod(2V)" case ?
602 ;; "2v chmod" case ?
608 ref ; Return the reference as is
620 s2)
621 slist nil))))
625 "Return non-nil if the man command supports local filenames.
626 Different man programs support this feature in different ways.
628 \(or `-l') option for this purpose. The default Red Hat man
629 program has no such option, but interprets any name containing
631 `man', or nil."
636 ;; Ensure that `default-directory' exists and is readable.
639 default-directory
645 ;; This feature seems to be present in at least ver 1.4f,
646 ;; which is about 20 years old.
647 ;; I don't know if this version has an official name?
650 Man-support-local-filenames))
652 \f
653 ;; ======================================================================
654 ;; default man entry: get word near point
657 "Guess default manual entry based on the text near position POS.
658 POS defaults to `point'."
663 ;; The default title is the nearest entry-like object before or
664 ;; after POS.
667 ;; Try to handle the special case where POS is on a
668 ;; section number.
671 ;; We skipped a valid section number backwards, look at
672 ;; preceding text.
675 ;; Not a valid entry, move POS after closing paren.
677 ;; We have a candidate, make `start' record its starting
678 ;; position.
680 ;; Otherwise look at char before POS.
683 ;; Our candidate is just before or around POS.
685 ;; Otherwise record the current column and look backwards.
688 ;; Record the distance travelled.
692 ;; Skip section number backwards.
697 ;; We have a candidate before POS ...
703 ;; ... but the one after POS is better.
705 ;; ... and anything after POS is worse.
707 ;; No candidate before POS.
711 ;; We have found a suitable starting point, try to skip at least
712 ;; one character.
715 ;; If there is a continuation at the end of line, check the
716 ;; following line too, eg:
717 ;; see this-
718 ;; command-here(1)
719 ;; Note: This code gets executed iff our entry is after POS.
722 ;; Make sure the section number gets included by the code below.
726 ;; The following was commented out since the preceding code
727 ;; should not produce a leading "*" in the first place.
728 ;;; ;; If looking at something like *strcat(... , remove the '*'
729 ;;; (when (string-match "^*" word)
730 ;;; (setq word (substring word 1)))
732 word
734 ;; If looking at something like ioctl(2) or brc(1M),
735 ;; include the section number in the returned value.
740 \f
741 ;; ======================================================================
742 ;; Top level command and background process sentinel
744 ;; For compatibility with older versions.
745 ;;;###autoload
749 ;; On my machine, "man -k" is so fast that a cache makes no sense,
750 ;; but apparently that's not the case in all cases, so let's add a cache.
758 ;; Let SPC (minibuffer-complete-word) insert the space.
771 ;; Actually for my `man' the arg is a regexp.
772 ;; POSIX says it must be ERE and "man-db" seems to agree,
773 ;; whereas under MacOSX it seems to be BRE-style and doesn't
774 ;; accept backslashes at all. Let's not bother to
775 ;; quote anything.
778 ;; manual-program might not even exist. And since it's
779 ;; run differently in Man-getpage-in-background, an error
780 ;; here may not necessarily mean that we'll also get an
781 ;; error later.
786 (while (re-search-forward "^\\([^ \t\n]+\\)\\(?: ?\\((.+?)\\)\\(?:[ \t]+- \\(.*\\)\\)?\\)?" nil t)
789 table)))
790 ;; Cache the table for later reuse.
792 ;; The table may contain false positives since the match is made
793 ;; by "man -k" not just on the manpage's name.
800 prefix pred action))
801 ;; If the current text looks like a possible section name,
802 ;; then add a completion entry that just adds a space so SPC
803 ;; can be used to insert a space.
807 ;; In case we're completing to a single name that exists in
808 ;; several sections, the longest prefix will look like "foo(".
811 ;; In case the paren was already in `prefix', don't
812 ;; remove it.
815 res)))))))
817 ;;;###autoload
819 "Get a Un*x manual page and put it in a buffer.
820 This command is the top-level command in the man package. It
821 runs a Un*x command to retrieve and clean a manpage in the
822 background and places the results in a `Man-mode' browsing
823 buffer. See variable `Man-notify-method' for what happens when
824 the buffer is ready. If a buffer already exists for this man
825 page, it will display immediately.
827 For a manpage from a particular section, use either of the
831 cat(1)
832 1 cat
834 To see manpages from all sections related to a subject, use an
837 Add to `Man-switches' to make this option permanent.
839 -a chmod
841 An explicit filename can be given too. Use -l if it might
842 otherwise look like a page name.
844 /my/file/name.1.gz
845 -l somefile.1
848 names or descriptions. The pattern argument is usually an
851 -k pattern"
855 ;; ignore case because that's friendly for bizarre
856 ;; caps things like the X11 function names and because
857 ;; "man" itself is case-sensitive on the command line
858 ;; so you're accustomed not to bother about the case
859 ;; ("man -k" is case-insensitive similarly, so the
860 ;; table has everything available to complete)
865 ": "
867 'Man-completion-table
871 input))))
873 ;; Possibly translate the "subject(section)" syntax into the
874 ;; "section subject" syntax and possibly downcase the section.
879 ;;;###autoload
881 "Get a Un*x manual page of the item under point and put it in a buffer."
889 "Use TOPIC to build and fire off the manpage and cleaning command.
890 Return the buffer in which the manpage will appear."
904 ;; The following is so Awk script gets \n intact
905 ;; But don't prevent decoding of the outside.
907 ;; We must decode the output by a coding system that the
908 ;; system's locale suggests in multibyte mode.
912 ;; Avoid possible error by using a directory that always exists.
917 default-directory
919 ;; Prevent any attempt to use display terminal fanciness.
921 ;; In Debian Woody, at least, we get overlong lines under X
922 ;; unless COLUMNS or MANWIDTH is set. This isn't a problem on
923 ;; a tty. man(1) says:
924 ;; MANWIDTH
925 ;; If $MANWIDTH is set, its value is used as the line
926 ;; length for which manual pages should be formatted.
927 ;; If it is not set, manual pages will be formatted
928 ;; with a line length appropriate to the current ter-
929 ;; minal (using an ioctl(2) if available, the value of
930 ;; $COLUMNS, or falling back to 80 characters if nei-
931 ;; ther is available).
933 ;; This isn't strictly correct, since we don't know how
934 ;; the page will actually be displayed, but it seems
935 ;; reasonable.
939 Man-width)
943 ;; Since man-db 2.4.3-1, man writes plain text with no escape
944 ;; sequences when stdout is not a tty. In 2.5.0, the following
945 ;; env-var was added to allow control of this (see Debian Bug#340673).
951 shell-file-name
953 shell-command-switch
958 shell-command-switch
966 exit-status)))
969 buffer))
972 "Notify the user when MAN-BUFFER is ready.
973 See the variable `Man-notify-method' for the different notification behaviors."
975 Man-original-frame)))
978 ;; Since we run asynchronously, perhaps while Emacs is waiting
979 ;; for input, we must not leave a different buffer current. We
980 ;; can't rely on the editor command loop to reselect the
981 ;; selected window's buffer.
1010 )))
1013 ;; \255 is SOFT HYPHEN in Latin-N. Versions of Debian man, at
1014 ;; least, emit it even when not in a Latin-N locale.
1024 "Convert overstriking and underlining to the correct fonts.
1025 Same for the ANSI bold and normal escape sequences."
1029 ;; Fontify ANSI escapes.
1033 ;; http://www.isthe.com/chongo/tech/comp/ansi_escapes.html
1034 ;; suggests many codes, but we only handle:
1035 ;; ESC [ 00 m reset to normal display
1036 ;; ESC [ 01 m bold
1037 ;; ESC [ 04 m underline
1038 ;; ESC [ 07 m reverse-video
1039 ;; ESC [ 22 m no-bold
1040 ;; ESC [ 24 m no-underline
1041 ;; ESC [ 27 m no-reverse-video
1052 faces))
1059 faces))))
1062 ;; Other highlighting.
1065 ;; Multibyte characters exist.
1095 ;; When the header is longer than the manpage name, groff tries to
1096 ;; condense it to a shorter line interspered with ^H. Remove ^H with
1097 ;; their preceding chars (but don't put Man-overstrike-face). (Bug#5566)
1101 ;; Try to recognize common forms of cross references.
1112 "Highlight the references on mouse-over.
1113 References include items in the SEE ALSO section,
1114 header file (#include <foo.h>), and files in FILES.
1115 If optional argument XREF-MAN-TYPE is non-nil, it used as the
1116 button type for items in SEE ALSO section. If it is nil, the
1117 default type, `Man-xref-man-page' is used for the buttons."
1118 ;; `Man-highlight-references' is used from woman.el, too.
1119 ;; woman.el doesn't set `Man-arguments'.
1125 'Man-default-man-entry
1128 'Man-default-man-entry
1131 'Man-default-man-entry
1139 ;; Based on `Man-build-references-alist'
1150 nil)))
1152 ;; An overlay button is preferable because the underlying text
1153 ;; may have text property highlights (Bug#7881).
1157 'type type
1162 target)
1166 "Remove overstriking and underlining from the current buffer.
1167 Normally skip any jobs that should have been done by the sed script,
1168 but when called interactively, do those jobs even if the sed
1169 script would have done them."
1172 Man-arguments)
1186 ))
1189 ;; When the header is longer than the manpage name, groff tries to
1190 ;; condense it to a shorter line interspered with ^H. Remove ^H with
1191 ;; their preceding chars (but don't put Man-overstrike-face). (Bug#5566)
1198 "Manpage background process sentinel.
1199 When manpage command is run asynchronously, PROCESS is the process
1200 object for the manpage command; when manpage command is run
1201 synchronously, PROCESS is the name of the buffer where the manpage
1202 command is run. Second argument MSG is the exit message of the
1203 manpage command."
1221 delete-buff t))
1223 ;; "-k foo", successful exit, but no output (from man-db)
1224 ;; ENHANCE-ME: share the check for -k with
1225 ;; `Man-highlight-references'. The \\s- bits here are
1226 ;; meant to allow for multiple options with -k among them.
1232 delete-buff t))
1241 ": process "
1247 ))
1263 ))
1264 ;; Restore case-fold-search before calling
1265 ;; Man-notify-when-ready because it may switch buffers.
1272 ))))
1274 \f
1275 ;; ======================================================================
1276 ;; set up manual mode in buffer and build alists
1283 "A mode for browsing Un*x manual pages.
1285 The following man commands are available in the buffer. Try
1300 The following variables may be of some use. Try
1303 `Man-notify-method' What happens when manpage formatting is done.
1304 `Man-downcase-section-letters-flag' Force section letters to lower case.
1305 `Man-circular-pages-flag' Treat multiple manpage list as circular.
1306 `Man-section-translations-alist' List of section numbers and their Un*x equiv.
1307 `Man-filter-list' Background manpage filter command.
1308 `Man-mode-map' Keymap bindings for Man mode buffers.
1309 `Man-mode-hook' Normal hook run on entry to Man mode.
1310 `Man-section-regexp' Regexp describing manpage section letters.
1311 `Man-heading-regexp' Regexp describing section headers.
1312 `Man-see-also-regexp' Regexp for SEE ALSO section (or your equiv).
1313 `Man-first-heading-regexp' Regexp for first heading on a manpage.
1314 `Man-reference-regexp' Regexp matching a references in SEE ALSO.
1315 `Man-switches' Background `man' command switches.
1317 The following key bindings are currently in effect in the buffer:
1322 mode-name "Man"
1323 buffer-auto-save-file-name nil
1324 mode-line-buffer-identification
1327 truncate-lines t
1328 buffer-read-only t)
1345 "Build the association list of manpage sections."
1354 "Build the association list of references (in the SEE ALSO section)."
1362 hyphenated
1375 hyphenated nil
1376 ;; Update len, in case a reference spans
1377 ;; more than two lines (paranoia).
1387 "Build the list of separate manpages in the buffer."
1393 ;; (switch-to-buffer (current-buffer))(debug)
1398 nil))
1399 ;; Go past both the current and the next Man-first-heading-regexp
1402 ;; We assume that the page header is delimited by blank
1403 ;; lines and that it contains at most one blank line. So
1404 ;; if we back by three blank lines we will be sure to be
1405 ;; before the page header but not before the possible
1406 ;; previous page header.
1414 header))))
1416 )))
1419 "Strip all the page headers but the first from the manpage."
1428 ;; Since the awk script collapses all successive blank
1429 ;; lines into one, and since we don't want to get rid of
1430 ;; the fast awk script, one must choose between adding
1431 ;; spare blank lines between pages when there were none and
1432 ;; deleting blank lines at page boundaries when there were
1433 ;; some. We choose the first, so we comment the following
1434 ;; line.
1435 ;; (setq header (concat "\n" header)))
1440 "Delete the leading spaces that indent the manpage."
1472 ))))
1474 \f
1475 ;; ======================================================================
1476 ;; Man mode commands
1479 "Move point to Nth next section (default 1)."
1488 ;; The last line doesn't belong to any section.
1490 ;; But don't move back from the starting point (can happen if `start'
1491 ;; is somewhere on the last line).
1495 "Move point to Nth previous section (default 1)."
1505 "Move point to SECTION if it exists, otherwise don't move point.
1506 Returns t if section is found, nil otherwise."
1513 nil)
1514 ))
1517 "Query for section to move point to."
1522 chosen
1527 default
1528 chosen)))
1535 Actually the section moved to is described by `Man-see-also-regexp'."
1542 "Return a possibly hyphenated word at point.
1543 If the word starts at the first non-whitespace column, and the
1544 previous line ends with a hyphen, return the last word on the previous
1559 word)))
1563 Specify which REFERENCE to use; default is based on word at point."
1573 ;; strip a trailing '-':
1577 word))
1578 Man-refpages-alist))
1585 chosen
1588 nil nil nil nil defaults))
1591 default
1592 chosen)))))
1600 "Kill the buffer containing the manpage."
1605 "Bury the buffer containing the manpage."
1610 "Go to the manual page on page PAGE."
1638 "Find the next manpage entry in the buffer."
1649 "Find the previous manpage entry in the buffer."
1659 ;; Header file support
1661 "View a header file specified by FILE from `Man-header-file-path'."
1663 complete-path)
1671 complete-path))
1673 ;;; Bookmark Man Support
1681 "Default bookmark name for Man or WoMan pages.
1682 Uses `Man-name-local-regexp'."
1690 "Make a bookmark entry for a Man buffer."
1697 ;;;###autoload
1699 "Default bookmark handler for Man buffers."
1701 ;; Let bookmark.el do the window handling.
1702 ;; This let-binding needs to be active during the call to both
1703 ;; Man-getpage-in-background and accept-process-output.
1712 \f
1713 ;; Init the man package variables, if not already done.
1721 ;;; man.el ends here