| blob | 1a6eda13b7fcd26b10d25f53ca90fcf36e35a0a2 |
1 ;;; man.el --- browse UNIX manual pages -*- lexical-binding: t -*-
3 ;; Copyright (C) 1993-1994, 1996-1997, 2001-2018 Free Software
4 ;; Foundation, Inc.
6 ;; Author: Barry A. Warsaw <bwarsaw@cen.com>
7 ;; Maintainer: emacs-devel@gnu.org
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 <https://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 Potortì <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 one 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:
96 "Browse UNIX manual pages."
104 "Manpage cleaning filter command phrases.
105 This variable contains a list of the following form:
107 ((command-string phrase-string*)*)
109 Each phrase-string is concatenated onto the command-string to form a
110 command filter. The (standard) output (and standard error) of the Un*x
111 man command is piped through each command filter in the order the
112 commands appear in the association list. The final output is placed in
113 the manpage buffer."
125 "Non-nil means make up the manpage with fonts."
131 "Face to use when fontifying overstrike."
137 "Face to use when fontifying underlining."
143 "Face to use when fontifying reverse video."
148 [ default Man-overstrike default Man-underline
149 Man-underline default default Man-reverse ]))
153 ;; Use the value of the obsolete user option Man-notify, if set.
155 "Selects the behavior when manpage is ready.
156 This variable may have one of the following values, where (sf) means
157 that the frames are switched, so the manpage is displayed in the frame
158 where the man command was called from:
160 newframe -- put the manpage in its own frame (see `Man-frame-parameters')
161 pushy -- make the manpage the current buffer in the current window
162 bully -- make the manpage the current buffer and only window (sf)
163 aggressive -- make the manpage the current buffer in the other window (sf)
164 friendly -- display manpage in the other window but don't make current (sf)
165 polite -- don't display manpage, but prints message and beep when ready
166 quiet -- like `polite', but don't beep
167 meek -- make no indication that the manpage is ready
169 Any other value of `Man-notify-method' is equivalent to `meek'."
176 "Number of columns for which manual pages should be formatted.
177 If nil, use the width of the window where the manpage is displayed.
178 If non-nil, use the width of the frame where the manpage is displayed.
179 The value also can be a positive integer for a fixed width."
186 "Frame parameter list for creating a new frame for a manual page."
193 "Non-nil means letters in sections are converted to lower case.
194 Some Un*x man commands can't handle uppercase letters in sections, for
196 with the upper case letter. When this variable is t, the section
198 being sent to the man background process."
203 "Non-nil means the manpage list is treated as circular for traversal."
210 ;; Some systems have a real 3x man section, so let's comment this.
211 ;; '("3X" . "3") ; Xlib man pages
214 "Association list of bogus sections to real section numbers.
215 Some manpages (e.g. the Sun C++ 2.1 manpages) have section numbers in
216 their references which Un*x `man' does not recognize. This
217 association list is used to translate those sections, when found, to
218 the associated section number."
223 ;; FIXME see comments at ffap-c-path.
233 base
235 "C Header file search path used in Man."
241 "Regexp that matches the text that precedes the command's name.
242 Used in `bookmark-set' to get the default bookmark name."
247 "Program used by `man' to produce man pages."
252 "Program used by `man' for untabifying."
257 "List of arguments to be passed to `Man-untabify-command' (which see)."
262 "Program used by `man' to process sed scripts."
267 "Program used by `man' to process awk scripts."
271 ;; This is for people who have UTF-8 encoded man pages in non-UTF-8
272 ;; locales, or who use Cygwin 'man' command from a native MS-Windows
273 ;; build of Emacs.
275 "Coding-system to decode output from the commands run by `man'.
276 If this is nil, `man' will use `locale-coding-system'."
282 "Hook run when Man mode is enabled."
287 "Hook run after removing backspaces but before `Man-mode' processing."
308 (defvar Man-see-also-regexp "\\(SEE ALSO\\|VOIR AUSSI\\|SIEHE AUCH\\|VÉASE TAMBIÉN\\|VEJA TAMBÉM\\|VEDERE ANCHE\\|ZOBACZ TAKŻE\\|İLGİLİ BELGELER\\|参照\\|参见 SEE ALSO\\|參見 SEE ALSO\\)"
309 "Regular expression for SEE ALSO heading (or your equivalent).
312 ;; This used to have leading space [ \t]*, but was removed because it
313 ;; causes false page splits on an occasional NAME with leading space
314 ;; inside a manpage. And `Man-heading-regexp' doesn't have [ \t]* anyway.
316 "Regular expression describing first heading on a manpage.
330 "Regular expression for SYNOPSIS heading (or your equivalent).
334 ;; Add \> so as not to match mount(8)'s FILESYSTEM INDEPENDENT MOUNT OPTIONS.
335 "Regular expression for FILES heading (or your equivalent).
358 ;; This includes the section as an optional part to catch hyphenated
359 ;; references to manpages.
365 "Switches passed to the man command, as a single string.
366 For example, the -a switch lets you see all the manpages for a
367 specified subject, if your `man' program supports it."
373 "-s"
378 "Internal cache for the value of the function `Man-support-local-filenames'.
379 `auto-detect' means the value is not yet determined.
380 Otherwise, the value is whatever the function
384 "The title to use if man adds a Contents menu to the menubar."
389 \f
390 ;; other variables and keymap initializations
413 :ovstrk
415 t ovstrk
416 }
439 table)
459 ;; Not all the man references get buttons currently. The text in the
460 ;; manual page can contain references to other man pages
464 "`Man-mode' menu."
473 :active Man--refpages
475 "--"
480 "--"
484 map)
487 ;; buttons
489 'follow-link t
491 'func nil
514 'follow-link t
526 'follow-link t
529 \f
530 ;; ======================================================================
531 ;; utilities
534 "Used for initializing variables based on display's color support.
535 This is necessary if one wants to dump man.el with Emacs."
537 ;; Avoid possible error in call-process by using a directory that must exist.
542 nil)
544 Man-sysv-sed-script)
546 Man-berkeley-sed-script)
548 nil))))
551 ;; Avoid trailing nil which confuses customize.
554 Man-sed-command
556 ;; Windows needs ".." quoting, not '..'.
572 "-e '/\e[789]/s///g'"
573 "-e '/Reformatting page. Wait/d'"
574 "-e '/Reformatting entry. Wait/d'"
585 )))
586 ;; Windows doesn't support multi-line commands, so don't
587 ;; invoke Awk there.
590 Man-awk-command
598 "'"
599 )))
601 ;; The outer list will be stripped off by apply.
603 Man-untabify-command
604 Man-untabify-command-args))
605 )))
606 )
609 "Formats part of the mode line for Man mode."
613 Man-current-page
617 "Builds the entire background manpage and cleaning command."
620 ;; Already has %s
622 ;; Stock MS-DOS shells cannot redirect stderr;
623 ;; `call-process' below sends it to /dev/null,
624 ;; so we don't need `2>' even with DOS shells
625 ;; which do support stderr redirection.
637 phrase)
640 command))
644 "Strip leading, trailing and middle spaces."
646 ;; Strip leading and trailing
649 ;; middle spaces
652 string))
656 Leave it as is if already in that style. Possibly downcase and
657 translate the section (see the `Man-downcase-section-letters-flag'
658 and the `Man-section-translations-alist' variables)."
664 ;; "chmod(2V)" case ?
668 ;; "2v chmod" case ?
674 ref ; Return the reference as is
686 s2)
687 slist nil))))
691 "Return non-nil if the man command supports local filenames.
692 Different man programs support this feature in different ways.
694 \(or `-l') option for this purpose. The default Red Hat man
695 program has no such option, but interprets any name containing
697 `man', or nil."
702 ;; Ensure that `default-directory' exists and is readable.
704 default-directory
710 ;; This feature seems to be present in at least ver 1.4f,
711 ;; which is about 20 years old.
712 ;; I don't know if this version has an official name?
715 Man-support-local-filenames))
717 \f
718 ;; ======================================================================
719 ;; default man entry: get word near point
722 "Guess default manual entry based on the text near position POS.
723 POS defaults to `point'."
728 ;; The default title is the nearest entry-like object before or
729 ;; after POS.
732 ;; Try to handle the special case where POS is on a
733 ;; section number.
736 ;; We skipped a valid section number backwards, look at
737 ;; preceding text.
740 ;; Not a valid entry, move POS after closing paren.
742 ;; We have a candidate, make `start' record its starting
743 ;; position.
745 ;; Otherwise look at char before POS.
748 ;; Our candidate is just before or around POS.
750 ;; Otherwise record the current column and look backwards.
753 ;; Record the distance traveled.
758 ;; Skip section number backwards.
763 ;; We have a candidate before POS ...
769 ;; ... but the one after POS is better.
771 ;; ... and anything after POS is worse.
773 ;; No candidate before POS.
777 ;; We have found a suitable starting point, try to skip at least
778 ;; one character.
781 ;; If there is a continuation at the end of line, check the
782 ;; following line too, eg:
783 ;; see this-
784 ;; command-here(1)
785 ;; Note: This code gets executed iff our entry is after POS.
788 ;; Make sure the section number gets included by the code below.
792 ;; The following was commented out since the preceding code
793 ;; should not produce a leading "*" in the first place.
794 ;;; ;; If looking at something like *strcat(... , remove the '*'
795 ;;; (when (string-match "^*" word)
796 ;;; (setq word (substring word 1)))
798 word
800 ;; If looking at something like ioctl(2) or brc(1M),
801 ;; include the section number in the returned value.
806 \f
807 ;; ======================================================================
808 ;; Top level command and background process sentinel
810 ;; For compatibility with older versions.
811 ;;;###autoload
815 ;; On my machine, "man -k" is so fast that a cache makes no sense,
816 ;; but apparently that's not the case in all cases, so let's add a cache.
820 ;; man-db or man-1.*
824 pages whose names start with PREFIX.
826 Currently, the default value depends on `system-type' and is
827 non-nil where the standard man programs are known to behave
828 properly. Setting the value to nil always gives correct results
834 The current buffer should contain the output of a command of the
836 apropos(1).
838 While POSIX man(1p) is a bit vague about what to expect here,
839 this function tries to parse some commonly used formats, which
840 can be described in the following informal way, with square brackets
841 indicating optional parts and whitespace being interpreted
842 somewhat loosely.
844 foo[, bar [, ...]] [other stuff] (sec) - description
845 foo(sec)[, bar(sec) [, ...]] [other stuff] - description"
847 ;; See man-tests for data about which systems use which format (hopefully we
848 ;; will be able to simplify the code if/when some of those formats aren't
849 ;; used any more).
859 ;; The first regexp grouping may already match the section
860 ;; tacked on to the name, which is ok since for the formats we
861 ;; claim to support the third (non-shy) grouping does not
862 ;; match in this case, i.e., section is nil.
865 table)
871 ;; This ends up returning t for pretty much any string, and hence leads to
872 ;; spurious "complete but not unique" messages. And since `man' doesn't
873 ;; require-match anyway, there's not point being clever.
874 ;;((eq action 'lambda) (not (string-match "([^)]*\\'" string)))
876 ;; Let SPC (minibuffer-complete-word) insert the space.
889 ;; Actually for my `man' the arg is a regexp.
890 ;; POSIX says it must be ERE and "man-db" seems to agree,
891 ;; whereas under macOS it seems to be BRE-style and doesn't
892 ;; accept backslashes at all. Let's not bother to
893 ;; quote anything.
896 ;; manual-program might not even exist. And since it's
897 ;; run differently in Man-getpage-in-background, an error
898 ;; here may not necessarily mean that we'll also get an
899 ;; error later.
905 prefix))))
907 ;; Cache the table for later reuse.
909 ;; The table may contain false positives since the match is made
910 ;; by "man -k" not just on the manpage's name.
917 prefix pred action))
918 ;; If the current text looks like a possible section name,
919 ;; then add a completion entry that just adds a space so SPC
920 ;; can be used to insert a space.
924 ;; In case we're completing to a single name that exists in
925 ;; several sections, the longest prefix will look like "foo(".
928 ;; In case the paren was already in `prefix', don't
929 ;; remove it.
932 res)))))))
934 ;;;###autoload
936 "Get a Un*x manual page and put it in a buffer.
937 This command is the top-level command in the man package.
938 It runs a Un*x command to retrieve and clean a manpage in the
939 background and places the results in a `Man-mode' browsing
940 buffer. The variable `Man-width' defines the number of columns in
941 formatted manual pages. The buffer is displayed immediately.
942 The variable `Man-notify-method' defines how the buffer is displayed.
943 If a buffer already exists for this man page, it will be displayed
944 without running the man command.
946 For a manpage from a particular section, use either of the
950 cat(1)
951 1 cat
953 To see manpages from all sections related to a subject, use an
956 Add to `Man-switches' to make this option permanent.
958 -a chmod
960 An explicit filename can be given too. Use -l if it might
961 otherwise look like a page name.
963 /my/file/name.1.gz
964 -l somefile.1
967 names or descriptions. The pattern argument is usually an
970 -k pattern"
974 ;; ignore case because that's friendly for bizarre
975 ;; caps things like the X11 function names and because
976 ;; "man" itself is case-insensitive on the command line
977 ;; so you're accustomed not to bother about the case
978 ;; ("man -k" is case-insensitive similarly, so the
979 ;; table has everything available to complete)
981 Man-completion-cache ;Don't cache across calls.
985 ": "
987 'Man-completion-table
991 input))))
993 ;; Possibly translate the "subject(section)" syntax into the
994 ;; "section subject" syntax and possibly downcase the section.
999 ;;;###autoload
1001 "Get a Un*x manual page of the item under point and put it in a buffer."
1009 "Start the man command in `body' after setting up the environment"
1011 ;; The following is so Awk script gets \n intact
1012 ;; But don't prevent decoding of the outside.
1014 ;; We must decode the output by a coding system that the
1015 ;; system's locale suggests in multibyte mode.
1018 Man-coding-system
1019 locale-coding-system))
1020 ;; Avoid possible error by using a directory that always exists.
1025 default-directory
1027 ;; Prevent any attempt to use display terminal fanciness.
1029 ;; In Debian Woody, at least, we get overlong lines under X
1030 ;; unless COLUMNS or MANWIDTH is set. This isn't a problem on
1031 ;; a tty. man(1) says:
1032 ;; MANWIDTH
1033 ;; If $MANWIDTH is set, its value is used as the line
1034 ;; length for which manual pages should be formatted.
1035 ;; If it is not set, manual pages will be formatted
1036 ;; with a line length appropriate to the current ter-
1037 ;; minal (using an ioctl(2) if available, the value of
1038 ;; $COLUMNS, or falling back to 80 characters if nei-
1039 ;; ther is available).
1042 ;; Since the page buffer is displayed beforehand,
1043 ;; we can select its window and get the window/frame width.
1047 Man-width)
1058 ;; Since man-db 2.4.3-1, man writes plain text with no escape
1059 ;; sequences when stdout is not a tty. In 2.5.0, the following
1060 ;; env-var was added to allow control of this (see Debian Bug#340673).
1065 "Use TOPIC to build and fire off the manpage and cleaning command.
1066 Return the buffer in which the manpage will appear."
1083 "[formatting...]"
1089 manual-program buffer
1091 shell-file-name
1093 shell-command-switch
1100 shell-command-switch
1108 exit-status)))
1114 buffer))
1117 "Reformat current manpage by calling the man command again synchronously."
1120 ;;this shouldn't happen unless it is not in a Man buffer."
1130 shell-command-switch
1136 ;;restore the point, not strictly right.
1144 "Notify the user when MAN-BUFFER is ready.
1145 See the variable `Man-notify-method' for the different notification behaviors."
1147 Man-original-frame)))
1149 (`newframe
1150 ;; Since we run asynchronously, perhaps while Emacs is waiting
1151 ;; for input, we must not leave a different buffer current. We
1152 ;; can't rely on the editor command loop to reselect the
1153 ;; selected window's buffer.
1160 (`pushy
1162 (`bully
1167 (`aggressive
1171 (`friendly
1175 (`polite
1178 (`quiet
1182 )))
1185 ;; \255 is SOFT HYPHEN in Latin-N. Versions of Debian man, at
1186 ;; least, emit it even when not in a Latin-N locale.
1193 "Convert overstriking and underlining to the correct fonts.
1194 Same for the ANSI bold and normal escape sequences."
1197 ;; Fontify ANSI escapes.
1204 ;; Other highlighting.
1207 ;; Multibyte characters exist.
1237 ;; When the header is longer than the manpage name, groff tries to
1238 ;; condense it to a shorter line interspersed with ^H. Remove ^H with
1239 ;; their preceding chars (but don't put Man-overstrike). (Bug#5566)
1243 ;; Try to recognize common forms of cross references.
1253 "Highlight the references on mouse-over.
1254 References include items in the SEE ALSO section,
1255 header file (#include <foo.h>), and files in FILES.
1256 If optional argument XREF-MAN-TYPE is non-nil, it used as the
1257 button type for items in SEE ALSO section. If it is nil, the
1258 default type, `Man-xref-man-page' is used for the buttons."
1259 ;; `Man-highlight-references' is used from woman.el, too.
1260 ;; woman.el doesn't set `Man-arguments'.
1266 'Man-default-man-entry
1269 'Man-default-man-entry
1272 'Man-default-man-entry
1280 ;; Based on `Man-build-references-alist'
1291 nil)))
1293 ;; An overlay button is preferable because the underlying text
1294 ;; may have text property highlights (Bug#7881).
1298 'type type
1303 target)
1307 "Remove overstriking and underlining from the current buffer.
1308 Normally skip any jobs that should have been done by the sed script,
1309 but when called interactively, do those jobs even if the sed
1310 script would have done them."
1325 ))
1328 ;; When the header is longer than the manpage name, groff tries to
1329 ;; condense it to a shorter line interspersed with ^H. Remove ^H with
1330 ;; their preceding chars (but don't put Man-overstrike). (Bug#5566)
1336 "Manpage background process filter.
1337 When manpage command is run asynchronously, PROCESS is the process
1338 object for the manpage command; when manpage command is run
1339 synchronously, PROCESS is the name of the buffer where the manpage
1340 command is run. Second argument STRING is the entire string of output."
1364 "Manpage background process sentinel.
1365 When manpage command is run asynchronously, PROCESS is the process
1366 object for the manpage command; when manpage command is run
1367 synchronously, PROCESS is the name of the buffer where the manpage
1368 command is run. Second argument MSG is the exit message of the
1369 manpage command."
1388 delete-buff t))
1390 ;; "-k foo", successful exit, but no output (from man-db)
1391 ;; ENHANCE-ME: share the check for -k with
1392 ;; `Man-highlight-references'. The \\s- bits here are
1393 ;; meant to allow for multiple options with -k among them.
1399 delete-buff t))
1408 ": process "
1414 ))
1434 ;; Entries hyphenated due to the window's width
1435 ;; won't be found in the man database, so remove
1436 ;; the hyphenation -- assuming Groff hyphenates
1437 ;; either with hyphen-minus (ASCII 45, #x2d),
1438 ;; hyphen (#x2010) or soft hyphen (#xad) -- and
1439 ;; look again.
1458 ))))
1461 ;; Skip arguments and only print the page name.
1463 'identity
1468 elem))
1472 \f
1473 ;; ======================================================================
1474 ;; set up manual mode in buffer and build alists
1479 "A mode for browsing Un*x manual pages.
1481 The following man commands are available in the buffer. Try
1496 The following variables may be of some use. Try
1499 `Man-notify-method' What happens when manpage is ready to display.
1500 `Man-downcase-section-letters-flag' Force section letters to lower case.
1501 `Man-circular-pages-flag' Treat multiple manpage list as circular.
1502 `Man-section-translations-alist' List of section numbers and their Un*x equiv.
1503 `Man-filter-list' Background manpage filter command.
1504 `Man-mode-map' Keymap bindings for Man mode buffers.
1505 `Man-mode-hook' Normal hook run on entry to Man mode.
1506 `Man-section-regexp' Regexp describing manpage section letters.
1507 `Man-heading-regexp' Regexp describing section headers.
1508 `Man-see-also-regexp' Regexp for SEE ALSO section (or your equiv).
1509 `Man-first-heading-regexp' Regexp for first heading on a manpage.
1510 `Man-reference-regexp' Regexp matching a references in SEE ALSO.
1511 `Man-switches' Background `man' command switches.
1513 The following key bindings are currently in effect in the buffer:
1516 mode-line-buffer-identification
1519 truncate-lines t)
1530 "Build the list of manpage sections."
1542 "Build the list of references (in the SEE ALSO section)."
1550 hyphenated
1563 hyphenated nil
1564 ;; Update len, in case a reference spans
1565 ;; more than two lines (paranoia).
1576 "Build the list of separate manpages in the buffer."
1586 nil))
1587 ;; Go past both the current and the next Man-first-heading-regexp
1590 ;; We assume that the page header is delimited by blank
1591 ;; lines and that it contains at most one blank line. So
1592 ;; if we back by three blank lines we will be sure to be
1593 ;; before the page header but not before the possible
1594 ;; previous page header.
1602 header))))
1604 )))
1607 "Strip all the page headers but the first from the manpage."
1616 ;; Since the awk script collapses all successive blank
1617 ;; lines into one, and since we don't want to get rid of
1618 ;; the fast awk script, one must choose between adding
1619 ;; spare blank lines between pages when there were none and
1620 ;; deleting blank lines at page boundaries when there were
1621 ;; some. We choose the first, so we comment the following
1622 ;; line.
1623 ;; (setq header (concat "\n" header)))
1628 "Delete the leading spaces that indent the manpage."
1636 ;; The space characters inserted by `untabify' inherit
1637 ;; sticky text properties, which is unnecessary and looks
1638 ;; ugly with underlining (Bug#11408).
1665 ))))
1667 \f
1668 ;; ======================================================================
1669 ;; Man mode commands
1672 "Move point to Nth next section (default 1)."
1681 ;; The last line doesn't belong to any section.
1683 ;; But don't move back from the starting point (can happen if `start'
1684 ;; is somewhere on the last line).
1688 "Move point to Nth previous section (default 1)."
1698 "Move point to SECTION if it exists, otherwise don't move point.
1699 Returns t if section is found, nil otherwise."
1706 nil)
1707 ))
1712 "Move point to SECTION."
1715 Man--last-section
1720 nil nil nil nil default)))
1729 Actually the section moved to is described by `Man-see-also-regexp'."
1736 "Return a possibly hyphenated word at point.
1737 If the word starts at the first non-whitespace column, and the
1738 previous line ends with a hyphen, return the last word on the previous
1753 word)))
1759 Specify which REFERENCE to use; default is based on word at point."
1769 ;; strip a trailing '-':
1773 word))
1774 Man--refpages))
1776 Man--last-refpage
1783 nil nil nil nil defaults)))
1784 chosen))))
1792 "Kill the buffer containing the manpage."
1797 "Go to the manual page on page PAGE."
1825 "Find the next manpage entry in the buffer."
1836 "Find the previous manpage entry in the buffer."
1846 ;; Header file support
1848 "View a header file specified by FILE from `Man-header-file-path'."
1850 complete-path)
1858 complete-path))
1860 ;;; Bookmark Man Support
1868 "Default bookmark name for Man or WoMan pages.
1869 Uses `Man-name-local-regexp'."
1877 "Make a bookmark entry for a Man buffer."
1884 ;;;###autoload
1886 "Default bookmark handler for Man buffers."
1888 ;; Let bookmark.el do the window handling.
1889 ;; This let-binding needs to be active during the call to both
1890 ;; Man-getpage-in-background and accept-process-output.
1899 \f
1900 ;; Init the man package variables, if not already done.
1905 ;;; man.el ends here