| blob | 198cdbafab574a50828f794fd4b6c60e56bbb0de |
1 ;;; man.el --- browse UNIX manual pages -*- coding: iso-8859-1 -*-
3 ;; Copyright (C) 1993-1994, 1996-1997, 2001-2012
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 "Browse UNIX manual pages."
103 "Manpage cleaning filter command phrases.
104 This variable contains a list of the following form:
106 '((command-string phrase-string*)*)
108 Each phrase-string is concatenated onto the command-string to form a
109 command filter. The (standard) output (and standard error) of the Un*x
110 man command is piped through each command filter in the order the
111 commands appear in the association list. The final output is placed in
112 the manpage buffer."
124 "Non-nil means make up the manpage with fonts."
130 "Face to use when fontifying overstrike."
136 "Face to use when fontifying underlining."
142 "Face to use when fontifying reverse video."
147 [ default Man-overstrike default Man-underline
148 Man-underline default default Man-reverse ]))
152 ;; Use the value of the obsolete user option Man-notify, if set.
154 "Selects the behavior when manpage is ready.
155 This variable may have one of the following values, where (sf) means
156 that the frames are switched, so the manpage is displayed in the frame
157 where the man command was called from:
159 newframe -- put the manpage in its own frame (see `Man-frame-parameters')
160 pushy -- make the manpage the current buffer in the current window
161 bully -- make the manpage the current buffer and only window (sf)
162 aggressive -- make the manpage the current buffer in the other window (sf)
163 friendly -- display manpage in the other window but don't make current (sf)
164 polite -- don't display manpage, but prints message and beep when ready
165 quiet -- like `polite', but don't beep
166 meek -- make no indication that the manpage is ready
168 Any other value of `Man-notify-method' is equivalent to `meek'."
175 "Number of columns for which manual pages should be formatted.
176 If nil, the width of the window selected at the moment of man
177 invocation is used. If non-nil, the width of the frame selected
178 at the moment of man invocation is used. The value also can be a
179 positive integer."
186 "Frame parameter list for creating a new frame for a manual page."
191 "Non-nil means letters in sections are converted to lower case.
192 Some Un*x man commands can't handle uppercase letters in sections, for
194 with the upper case letter. When this variable is t, the section
196 being sent to the man background process."
201 "Non-nil means the manpage list is treated as circular for traversal."
208 ;; Some systems have a real 3x man section, so let's comment this.
209 ;; '("3X" . "3") ; Xlib man pages
212 "Association list of bogus sections to real section numbers.
213 Some manpages (e.g. the Sun C++ 2.1 manpages) have section numbers in
214 their references which Un*x `man' does not recognize. This
215 association list is used to translate those sections, when found, to
216 the associated section number."
221 ;; FIXME see comments at ffap-c-path.
231 base
233 "C Header file search path used in Man."
239 "Regexp that matches the text that precedes the command's name.
240 Used in `bookmark-set' to get the default bookmark name."
245 "Program used by `man' to produce man pages."
250 "Program used by `man' for untabifying."
255 "List of arguments to be passed to `Man-untabify-command' (which see)."
260 "Program used by `man' to process sed scripts."
265 "Program used by `man' to process awk scripts."
270 "Hook run when Man mode is enabled."
275 "Hook run after removing backspaces but before `Man-mode' processing."
297 "Regular expression for SEE ALSO heading (or your equivalent).
300 ;; This used to have leading space [ \t]*, but was removed because it
301 ;; causes false page splits on an occasional NAME with leading space
302 ;; inside a manpage. And `Man-heading-regexp' doesn't have [ \t]* anyway.
304 "Regular expression describing first heading on a manpage.
318 "Regular expression for SYNOPSIS heading (or your equivalent).
322 ;; Add \> so as not to match mount(8)'s FILESYSTEM INDEPENDENT MOUNT OPTIONS.
323 "Regular expression for FILES heading (or your equivalent).
346 ;; This includes the section as an optional part to catch hyphenated
347 ;; references to manpages.
353 "Switches passed to the man command, as a single string.
354 For example, the -a switch lets you see all the manpages for a
355 specified subject, if your `man' program supports it."
361 "-s"
366 "Internal cache for the value of the function `Man-support-local-filenames'.
367 `auto-detect' means the value is not yet determined.
368 Otherwise, the value is whatever the function
371 \f
372 ;; other variables and keymap initializations
395 :ovstrk
397 t ovstrk
398 }
421 table)
444 ;; Not all the man references get buttons currently. The text in the
445 ;; manual page can contain references to other man pages
448 map)
451 ;; buttons
453 'follow-link t
455 'func nil
478 'follow-link t
490 'follow-link t
493 \f
494 ;; ======================================================================
495 ;; utilities
498 "Used for initializing variables based on display's color support.
499 This is necessary if one wants to dump man.el with Emacs."
501 ;; Avoid possible error in call-process by using a directory that must exist.
506 nil)
508 Man-sysv-sed-script)
510 Man-berkeley-sed-script)
512 nil))))
515 ;; Avoid trailing nil which confuses customize.
518 Man-sed-command
520 ;; Windows needs ".." quoting, not '..'.
536 "-e '/\e[789]/s///g'"
537 "-e '/Reformatting page. Wait/d'"
538 "-e '/Reformatting entry. Wait/d'"
549 )))
550 ;; Windows doesn't support multi-line commands, so don't
551 ;; invoke Awk there.
554 Man-awk-command
562 "'"
563 )))
565 ;; The outer list will be stripped off by apply.
567 Man-untabify-command
568 Man-untabify-command-args))
569 )))
570 )
573 "Formats part of the mode line for Man mode."
577 Man-current-page
581 "Builds the entire background manpage and cleaning command."
584 ;; Already has %s
586 ;; Stock MS-DOS shells cannot redirect stderr;
587 ;; `call-process' below sends it to /dev/null,
588 ;; so we don't need `2>' even with DOS shells
589 ;; which do support stderr redirection.
601 phrase)
604 command))
608 "Strip leading, trailing and middle spaces."
610 ;; Strip leading and trailing
613 ;; middle spaces
616 string))
620 Leave it as is if already in that style. Possibly downcase and
621 translate the section (see the `Man-downcase-section-letters-flag'
622 and the `Man-section-translations-alist' variables)."
628 ;; "chmod(2V)" case ?
632 ;; "2v chmod" case ?
638 ref ; Return the reference as is
650 s2)
651 slist nil))))
655 "Return non-nil if the man command supports local filenames.
656 Different man programs support this feature in different ways.
658 \(or `-l') option for this purpose. The default Red Hat man
659 program has no such option, but interprets any name containing
661 `man', or nil."
666 ;; Ensure that `default-directory' exists and is readable.
669 default-directory
675 ;; This feature seems to be present in at least ver 1.4f,
676 ;; which is about 20 years old.
677 ;; I don't know if this version has an official name?
680 Man-support-local-filenames))
682 \f
683 ;; ======================================================================
684 ;; default man entry: get word near point
687 "Guess default manual entry based on the text near position POS.
688 POS defaults to `point'."
693 ;; The default title is the nearest entry-like object before or
694 ;; after POS.
697 ;; Try to handle the special case where POS is on a
698 ;; section number.
701 ;; We skipped a valid section number backwards, look at
702 ;; preceding text.
705 ;; Not a valid entry, move POS after closing paren.
707 ;; We have a candidate, make `start' record its starting
708 ;; position.
710 ;; Otherwise look at char before POS.
713 ;; Our candidate is just before or around POS.
715 ;; Otherwise record the current column and look backwards.
718 ;; Record the distance traveled.
722 ;; Skip section number backwards.
727 ;; We have a candidate before POS ...
733 ;; ... but the one after POS is better.
735 ;; ... and anything after POS is worse.
737 ;; No candidate before POS.
741 ;; We have found a suitable starting point, try to skip at least
742 ;; one character.
745 ;; If there is a continuation at the end of line, check the
746 ;; following line too, eg:
747 ;; see this-
748 ;; command-here(1)
749 ;; Note: This code gets executed iff our entry is after POS.
752 ;; Make sure the section number gets included by the code below.
756 ;; The following was commented out since the preceding code
757 ;; should not produce a leading "*" in the first place.
758 ;;; ;; If looking at something like *strcat(... , remove the '*'
759 ;;; (when (string-match "^*" word)
760 ;;; (setq word (substring word 1)))
762 word
764 ;; If looking at something like ioctl(2) or brc(1M),
765 ;; include the section number in the returned value.
770 \f
771 ;; ======================================================================
772 ;; Top level command and background process sentinel
774 ;; For compatibility with older versions.
775 ;;;###autoload
779 ;; On my machine, "man -k" is so fast that a cache makes no sense,
780 ;; but apparently that's not the case in all cases, so let's add a cache.
785 ;; This ends up returning t for pretty much any string, and hence leads to
786 ;; spurious "complete but not unique" messages. And since `man' doesn't
787 ;; require-match anyway, there's not point being clever.
788 ;;((eq action 'lambda) (not (string-match "([^)]*\\'" string)))
790 ;; Let SPC (minibuffer-complete-word) insert the space.
803 ;; Actually for my `man' the arg is a regexp.
804 ;; POSIX says it must be ERE and "man-db" seems to agree,
805 ;; whereas under MacOSX it seems to be BRE-style and doesn't
806 ;; accept backslashes at all. Let's not bother to
807 ;; quote anything.
810 ;; manual-program might not even exist. And since it's
811 ;; run differently in Man-getpage-in-background, an error
812 ;; here may not necessarily mean that we'll also get an
813 ;; error later.
818 (while (re-search-forward "^\\([^ \t\n]+\\)\\(?: ?\\((.+?)\\)\\(?:[ \t]+- \\(.*\\)\\)?\\)?" nil t)
821 table)))
822 ;; Cache the table for later reuse.
824 ;; The table may contain false positives since the match is made
825 ;; by "man -k" not just on the manpage's name.
832 prefix pred action))
833 ;; If the current text looks like a possible section name,
834 ;; then add a completion entry that just adds a space so SPC
835 ;; can be used to insert a space.
839 ;; In case we're completing to a single name that exists in
840 ;; several sections, the longest prefix will look like "foo(".
843 ;; In case the paren was already in `prefix', don't
844 ;; remove it.
847 res)))))))
849 ;;;###autoload
851 "Get a Un*x manual page and put it in a buffer.
852 This command is the top-level command in the man package. It
853 runs a Un*x command to retrieve and clean a manpage in the
854 background and places the results in a `Man-mode' browsing
855 buffer. See variable `Man-notify-method' for what happens when
856 the buffer is ready. If a buffer already exists for this man
857 page, it will display immediately.
859 For a manpage from a particular section, use either of the
863 cat(1)
864 1 cat
866 To see manpages from all sections related to a subject, use an
869 Add to `Man-switches' to make this option permanent.
871 -a chmod
873 An explicit filename can be given too. Use -l if it might
874 otherwise look like a page name.
876 /my/file/name.1.gz
877 -l somefile.1
880 names or descriptions. The pattern argument is usually an
883 -k pattern"
887 ;; ignore case because that's friendly for bizarre
888 ;; caps things like the X11 function names and because
889 ;; "man" itself is case-insensitive on the command line
890 ;; so you're accustomed not to bother about the case
891 ;; ("man -k" is case-insensitive similarly, so the
892 ;; table has everything available to complete)
897 ": "
899 'Man-completion-table
903 input))))
905 ;; Possibly translate the "subject(section)" syntax into the
906 ;; "section subject" syntax and possibly downcase the section.
911 ;;;###autoload
913 "Get a Un*x manual page of the item under point and put it in a buffer."
921 "Use TOPIC to build and fire off the manpage and cleaning command.
922 Return the buffer in which the manpage will appear."
936 ;; The following is so Awk script gets \n intact
937 ;; But don't prevent decoding of the outside.
939 ;; We must decode the output by a coding system that the
940 ;; system's locale suggests in multibyte mode.
944 ;; Avoid possible error by using a directory that always exists.
949 default-directory
951 ;; Prevent any attempt to use display terminal fanciness.
953 ;; In Debian Woody, at least, we get overlong lines under X
954 ;; unless COLUMNS or MANWIDTH is set. This isn't a problem on
955 ;; a tty. man(1) says:
956 ;; MANWIDTH
957 ;; If $MANWIDTH is set, its value is used as the line
958 ;; length for which manual pages should be formatted.
959 ;; If it is not set, manual pages will be formatted
960 ;; with a line length appropriate to the current ter-
961 ;; minal (using an ioctl(2) if available, the value of
962 ;; $COLUMNS, or falling back to 80 characters if nei-
963 ;; ther is available).
966 ;; This isn't strictly correct, since we don't know how
967 ;; the page will actually be displayed, but it seems
968 ;; reasonable.
972 Man-width)
975 ;; Since man-db 2.4.3-1, man writes plain text with no escape
976 ;; sequences when stdout is not a tty. In 2.5.0, the following
977 ;; env-var was added to allow control of this (see Debian Bug#340673).
983 shell-file-name
985 shell-command-switch
990 shell-command-switch
998 exit-status)))
1001 buffer))
1004 "Notify the user when MAN-BUFFER is ready.
1005 See the variable `Man-notify-method' for the different notification behaviors."
1007 Man-original-frame)))
1009 (`newframe
1010 ;; Since we run asynchronously, perhaps while Emacs is waiting
1011 ;; for input, we must not leave a different buffer current. We
1012 ;; can't rely on the editor command loop to reselect the
1013 ;; selected window's buffer.
1020 (`pushy
1022 (`bully
1027 (`aggressive
1031 (`friendly
1035 (`polite
1038 (`quiet
1042 )))
1045 ;; \255 is SOFT HYPHEN in Latin-N. Versions of Debian man, at
1046 ;; least, emit it even when not in a Latin-N locale.
1056 "Convert overstriking and underlining to the correct fonts.
1057 Same for the ANSI bold and normal escape sequences."
1061 ;; Fontify ANSI escapes.
1068 ;; Other highlighting.
1071 ;; Multibyte characters exist.
1101 ;; When the header is longer than the manpage name, groff tries to
1102 ;; condense it to a shorter line interspersed with ^H. Remove ^H with
1103 ;; their preceding chars (but don't put Man-overstrike). (Bug#5566)
1107 ;; Try to recognize common forms of cross references.
1118 "Highlight the references on mouse-over.
1119 References include items in the SEE ALSO section,
1120 header file (#include <foo.h>), and files in FILES.
1121 If optional argument XREF-MAN-TYPE is non-nil, it used as the
1122 button type for items in SEE ALSO section. If it is nil, the
1123 default type, `Man-xref-man-page' is used for the buttons."
1124 ;; `Man-highlight-references' is used from woman.el, too.
1125 ;; woman.el doesn't set `Man-arguments'.
1131 'Man-default-man-entry
1134 'Man-default-man-entry
1137 'Man-default-man-entry
1145 ;; Based on `Man-build-references-alist'
1156 nil)))
1158 ;; An overlay button is preferable because the underlying text
1159 ;; may have text property highlights (Bug#7881).
1163 'type type
1168 target)
1172 "Remove overstriking and underlining from the current buffer.
1173 Normally skip any jobs that should have been done by the sed script,
1174 but when called interactively, do those jobs even if the sed
1175 script would have done them."
1178 Man-arguments)
1192 ))
1195 ;; When the header is longer than the manpage name, groff tries to
1196 ;; condense it to a shorter line interspersed with ^H. Remove ^H with
1197 ;; their preceding chars (but don't put Man-overstrike). (Bug#5566)
1204 "Manpage background process sentinel.
1205 When manpage command is run asynchronously, PROCESS is the process
1206 object for the manpage command; when manpage command is run
1207 synchronously, PROCESS is the name of the buffer where the manpage
1208 command is run. Second argument MSG is the exit message of the
1209 manpage command."
1227 delete-buff t))
1229 ;; "-k foo", successful exit, but no output (from man-db)
1230 ;; ENHANCE-ME: share the check for -k with
1231 ;; `Man-highlight-references'. The \\s- bits here are
1232 ;; meant to allow for multiple options with -k among them.
1238 delete-buff t))
1247 ": process "
1253 ))
1269 ;; Restore case-fold-search before calling
1270 ;; Man-notify-when-ready because it may switch buffers.
1277 ))))
1280 ;; Skip arguments and only print the page name.
1282 'identity
1287 elem))
1291 \f
1292 ;; ======================================================================
1293 ;; set up manual mode in buffer and build alists
1300 "A mode for browsing Un*x manual pages.
1302 The following man commands are available in the buffer. Try
1317 The following variables may be of some use. Try
1320 `Man-notify-method' What happens when manpage formatting is done.
1321 `Man-downcase-section-letters-flag' Force section letters to lower case.
1322 `Man-circular-pages-flag' Treat multiple manpage list as circular.
1323 `Man-section-translations-alist' List of section numbers and their Un*x equiv.
1324 `Man-filter-list' Background manpage filter command.
1325 `Man-mode-map' Keymap bindings for Man mode buffers.
1326 `Man-mode-hook' Normal hook run on entry to Man mode.
1327 `Man-section-regexp' Regexp describing manpage section letters.
1328 `Man-heading-regexp' Regexp describing section headers.
1329 `Man-see-also-regexp' Regexp for SEE ALSO section (or your equiv).
1330 `Man-first-heading-regexp' Regexp for first heading on a manpage.
1331 `Man-reference-regexp' Regexp matching a references in SEE ALSO.
1332 `Man-switches' Background `man' command switches.
1334 The following key bindings are currently in effect in the buffer:
1339 mode-name "Man"
1340 buffer-auto-save-file-name nil
1341 mode-line-buffer-identification
1344 truncate-lines t
1345 buffer-read-only t)
1362 "Build the list of manpage sections."
1373 "Build the list of references (in the SEE ALSO section)."
1381 hyphenated
1394 hyphenated nil
1395 ;; Update len, in case a reference spans
1396 ;; more than two lines (paranoia).
1407 "Build the list of separate manpages in the buffer."
1413 ;; (switch-to-buffer (current-buffer))(debug)
1418 nil))
1419 ;; Go past both the current and the next Man-first-heading-regexp
1422 ;; We assume that the page header is delimited by blank
1423 ;; lines and that it contains at most one blank line. So
1424 ;; if we back by three blank lines we will be sure to be
1425 ;; before the page header but not before the possible
1426 ;; previous page header.
1434 header))))
1436 )))
1439 "Strip all the page headers but the first from the manpage."
1448 ;; Since the awk script collapses all successive blank
1449 ;; lines into one, and since we don't want to get rid of
1450 ;; the fast awk script, one must choose between adding
1451 ;; spare blank lines between pages when there were none and
1452 ;; deleting blank lines at page boundaries when there were
1453 ;; some. We choose the first, so we comment the following
1454 ;; line.
1455 ;; (setq header (concat "\n" header)))
1460 "Delete the leading spaces that indent the manpage."
1468 ;; The space characters inserted by `untabify' inherit
1469 ;; sticky text properties, which is unnecessary and looks
1470 ;; ugly with underlining (Bug#11408).
1497 ))))
1499 \f
1500 ;; ======================================================================
1501 ;; Man mode commands
1504 "Move point to Nth next section (default 1)."
1513 ;; The last line doesn't belong to any section.
1515 ;; But don't move back from the starting point (can happen if `start'
1516 ;; is somewhere on the last line).
1520 "Move point to Nth previous section (default 1)."
1530 "Move point to SECTION if it exists, otherwise don't move point.
1531 Returns t if section is found, nil otherwise."
1538 nil)
1539 ))
1544 "Move point to SECTION."
1547 Man--last-section
1552 nil nil nil nil default)))
1561 Actually the section moved to is described by `Man-see-also-regexp'."
1568 "Return a possibly hyphenated word at point.
1569 If the word starts at the first non-whitespace column, and the
1570 previous line ends with a hyphen, return the last word on the previous
1585 word)))
1591 Specify which REFERENCE to use; default is based on word at point."
1601 ;; strip a trailing '-':
1605 word))
1606 Man--refpages))
1608 Man--last-refpage
1615 nil nil nil nil defaults)))
1616 chosen))))
1624 "Kill the buffer containing the manpage."
1629 "Bury the buffer containing the manpage."
1634 "Go to the manual page on page PAGE."
1662 "Find the next manpage entry in the buffer."
1673 "Find the previous manpage entry in the buffer."
1683 ;; Header file support
1685 "View a header file specified by FILE from `Man-header-file-path'."
1687 complete-path)
1695 complete-path))
1697 ;;; Bookmark Man Support
1705 "Default bookmark name for Man or WoMan pages.
1706 Uses `Man-name-local-regexp'."
1714 "Make a bookmark entry for a Man buffer."
1721 ;;;###autoload
1723 "Default bookmark handler for Man buffers."
1725 ;; Let bookmark.el do the window handling.
1726 ;; This let-binding needs to be active during the call to both
1727 ;; Man-getpage-in-background and accept-process-output.
1736 \f
1737 ;; Init the man package variables, if not already done.
1742 ;;; man.el ends here