| blob | 4f6e1187e0dfb654e4477c4c481ada55089580c2 |
1 ;;; man.el --- browse UNIX manual pages -*- lexical-binding: t -*-
3 ;; Copyright (C) 1993-1994, 1996-1997, 2001-2017 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 <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 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."
272 "Hook run when Man mode is enabled."
277 "Hook run after removing backspaces but before `Man-mode' processing."
299 "Regular expression for SEE ALSO heading (or your equivalent).
302 ;; This used to have leading space [ \t]*, but was removed because it
303 ;; causes false page splits on an occasional NAME with leading space
304 ;; inside a manpage. And `Man-heading-regexp' doesn't have [ \t]* anyway.
306 "Regular expression describing first heading on a manpage.
320 "Regular expression for SYNOPSIS heading (or your equivalent).
324 ;; Add \> so as not to match mount(8)'s FILESYSTEM INDEPENDENT MOUNT OPTIONS.
325 "Regular expression for FILES heading (or your equivalent).
348 ;; This includes the section as an optional part to catch hyphenated
349 ;; references to manpages.
355 "Switches passed to the man command, as a single string.
356 For example, the -a switch lets you see all the manpages for a
357 specified subject, if your `man' program supports it."
363 "-s"
368 "Internal cache for the value of the function `Man-support-local-filenames'.
369 `auto-detect' means the value is not yet determined.
370 Otherwise, the value is whatever the function
374 "The title to use if man adds a Contents menu to the menubar."
379 \f
380 ;; other variables and keymap initializations
403 :ovstrk
405 t ovstrk
406 }
429 table)
449 ;; Not all the man references get buttons currently. The text in the
450 ;; manual page can contain references to other man pages
454 "`Man-mode' menu."
463 :active Man--refpages
465 "--"
470 "--"
474 map)
477 ;; buttons
479 'follow-link t
481 'func nil
504 'follow-link t
516 'follow-link t
519 \f
520 ;; ======================================================================
521 ;; utilities
524 "Used for initializing variables based on display's color support.
525 This is necessary if one wants to dump man.el with Emacs."
527 ;; Avoid possible error in call-process by using a directory that must exist.
532 nil)
534 Man-sysv-sed-script)
536 Man-berkeley-sed-script)
538 nil))))
541 ;; Avoid trailing nil which confuses customize.
544 Man-sed-command
546 ;; Windows needs ".." quoting, not '..'.
562 "-e '/\e[789]/s///g'"
563 "-e '/Reformatting page. Wait/d'"
564 "-e '/Reformatting entry. Wait/d'"
575 )))
576 ;; Windows doesn't support multi-line commands, so don't
577 ;; invoke Awk there.
580 Man-awk-command
588 "'"
589 )))
591 ;; The outer list will be stripped off by apply.
593 Man-untabify-command
594 Man-untabify-command-args))
595 )))
596 )
599 "Formats part of the mode line for Man mode."
603 Man-current-page
607 "Builds the entire background manpage and cleaning command."
610 ;; Already has %s
612 ;; Stock MS-DOS shells cannot redirect stderr;
613 ;; `call-process' below sends it to /dev/null,
614 ;; so we don't need `2>' even with DOS shells
615 ;; which do support stderr redirection.
627 phrase)
630 command))
634 "Strip leading, trailing and middle spaces."
636 ;; Strip leading and trailing
639 ;; middle spaces
642 string))
646 Leave it as is if already in that style. Possibly downcase and
647 translate the section (see the `Man-downcase-section-letters-flag'
648 and the `Man-section-translations-alist' variables)."
654 ;; "chmod(2V)" case ?
658 ;; "2v chmod" case ?
664 ref ; Return the reference as is
676 s2)
677 slist nil))))
681 "Return non-nil if the man command supports local filenames.
682 Different man programs support this feature in different ways.
684 \(or `-l') option for this purpose. The default Red Hat man
685 program has no such option, but interprets any name containing
687 `man', or nil."
692 ;; Ensure that `default-directory' exists and is readable.
694 default-directory
700 ;; This feature seems to be present in at least ver 1.4f,
701 ;; which is about 20 years old.
702 ;; I don't know if this version has an official name?
705 Man-support-local-filenames))
707 \f
708 ;; ======================================================================
709 ;; default man entry: get word near point
712 "Guess default manual entry based on the text near position POS.
713 POS defaults to `point'."
718 ;; The default title is the nearest entry-like object before or
719 ;; after POS.
722 ;; Try to handle the special case where POS is on a
723 ;; section number.
726 ;; We skipped a valid section number backwards, look at
727 ;; preceding text.
730 ;; Not a valid entry, move POS after closing paren.
732 ;; We have a candidate, make `start' record its starting
733 ;; position.
735 ;; Otherwise look at char before POS.
738 ;; Our candidate is just before or around POS.
740 ;; Otherwise record the current column and look backwards.
743 ;; Record the distance traveled.
748 ;; Skip section number backwards.
753 ;; We have a candidate before POS ...
759 ;; ... but the one after POS is better.
761 ;; ... and anything after POS is worse.
763 ;; No candidate before POS.
767 ;; We have found a suitable starting point, try to skip at least
768 ;; one character.
771 ;; If there is a continuation at the end of line, check the
772 ;; following line too, eg:
773 ;; see this-
774 ;; command-here(1)
775 ;; Note: This code gets executed iff our entry is after POS.
778 ;; Make sure the section number gets included by the code below.
782 ;; The following was commented out since the preceding code
783 ;; should not produce a leading "*" in the first place.
784 ;;; ;; If looking at something like *strcat(... , remove the '*'
785 ;;; (when (string-match "^*" word)
786 ;;; (setq word (substring word 1)))
788 word
790 ;; If looking at something like ioctl(2) or brc(1M),
791 ;; include the section number in the returned value.
796 \f
797 ;; ======================================================================
798 ;; Top level command and background process sentinel
800 ;; For compatibility with older versions.
801 ;;;###autoload
805 ;; On my machine, "man -k" is so fast that a cache makes no sense,
806 ;; but apparently that's not the case in all cases, so let's add a cache.
810 ;; man-db or man-1.*
814 pages whose names start with PREFIX.
816 Currently, the default value depends on `system-type' and is
817 non-nil where the standard man programs are known to behave
818 properly. Setting the value to nil always gives correct results
824 The current buffer should contain the output of a command of the
826 apropos(1).
828 While POSIX man(1p) is a bit vague about what to expect here,
829 this function tries to parse some commonly used formats, which
830 can be described in the following informal way, with square brackets
831 indicating optional parts and whitespace being interpreted
832 somewhat loosely.
834 foo[, bar [, ...]] [other stuff] (sec) - description
835 foo(sec)[, bar(sec) [, ...]] [other stuff] - description
837 For more details and some regression tests, please see
838 test/automated/man-tests.el in the emacs repository."
840 ;; See man-tests for data about which systems use which format (hopefully we
841 ;; will be able to simplify the code if/when some of those formats aren't
842 ;; used any more).
852 ;; The first regexp grouping may already match the section
853 ;; tacked on to the name, which is ok since for the formats we
854 ;; claim to support the third (non-shy) grouping does not
855 ;; match in this case, i.e., section is nil.
858 table)
864 ;; This ends up returning t for pretty much any string, and hence leads to
865 ;; spurious "complete but not unique" messages. And since `man' doesn't
866 ;; require-match anyway, there's not point being clever.
867 ;;((eq action 'lambda) (not (string-match "([^)]*\\'" string)))
869 ;; Let SPC (minibuffer-complete-word) insert the space.
882 ;; Actually for my `man' the arg is a regexp.
883 ;; POSIX says it must be ERE and "man-db" seems to agree,
884 ;; whereas under macOS it seems to be BRE-style and doesn't
885 ;; accept backslashes at all. Let's not bother to
886 ;; quote anything.
889 ;; manual-program might not even exist. And since it's
890 ;; run differently in Man-getpage-in-background, an error
891 ;; here may not necessarily mean that we'll also get an
892 ;; error later.
898 prefix))))
900 ;; Cache the table for later reuse.
902 ;; The table may contain false positives since the match is made
903 ;; by "man -k" not just on the manpage's name.
910 prefix pred action))
911 ;; If the current text looks like a possible section name,
912 ;; then add a completion entry that just adds a space so SPC
913 ;; can be used to insert a space.
917 ;; In case we're completing to a single name that exists in
918 ;; several sections, the longest prefix will look like "foo(".
921 ;; In case the paren was already in `prefix', don't
922 ;; remove it.
925 res)))))))
927 ;;;###autoload
929 "Get a Un*x manual page and put it in a buffer.
930 This command is the top-level command in the man package.
931 It runs a Un*x command to retrieve and clean a manpage in the
932 background and places the results in a `Man-mode' browsing
933 buffer. The variable `Man-width' defines the number of columns in
934 formatted manual pages. The buffer is displayed immediately.
935 The variable `Man-notify-method' defines how the buffer is displayed.
936 If a buffer already exists for this man page, it will be displayed
937 without running the man command.
939 For a manpage from a particular section, use either of the
943 cat(1)
944 1 cat
946 To see manpages from all sections related to a subject, use an
949 Add to `Man-switches' to make this option permanent.
951 -a chmod
953 An explicit filename can be given too. Use -l if it might
954 otherwise look like a page name.
956 /my/file/name.1.gz
957 -l somefile.1
960 names or descriptions. The pattern argument is usually an
963 -k pattern"
967 ;; ignore case because that's friendly for bizarre
968 ;; caps things like the X11 function names and because
969 ;; "man" itself is case-insensitive on the command line
970 ;; so you're accustomed not to bother about the case
971 ;; ("man -k" is case-insensitive similarly, so the
972 ;; table has everything available to complete)
974 Man-completion-cache ;Don't cache across calls.
978 ": "
980 'Man-completion-table
984 input))))
986 ;; Possibly translate the "subject(section)" syntax into the
987 ;; "section subject" syntax and possibly downcase the section.
992 ;;;###autoload
994 "Get a Un*x manual page of the item under point and put it in a buffer."
1002 "Start the man command in `body' after setting up the environment"
1004 ;; The following is so Awk script gets \n intact
1005 ;; But don't prevent decoding of the outside.
1007 ;; We must decode the output by a coding system that the
1008 ;; system's locale suggests in multibyte mode.
1010 ;; Avoid possible error by using a directory that always exists.
1015 default-directory
1017 ;; Prevent any attempt to use display terminal fanciness.
1019 ;; In Debian Woody, at least, we get overlong lines under X
1020 ;; unless COLUMNS or MANWIDTH is set. This isn't a problem on
1021 ;; a tty. man(1) says:
1022 ;; MANWIDTH
1023 ;; If $MANWIDTH is set, its value is used as the line
1024 ;; length for which manual pages should be formatted.
1025 ;; If it is not set, manual pages will be formatted
1026 ;; with a line length appropriate to the current ter-
1027 ;; minal (using an ioctl(2) if available, the value of
1028 ;; $COLUMNS, or falling back to 80 characters if nei-
1029 ;; ther is available).
1032 ;; Since the page buffer is displayed beforehand,
1033 ;; we can select its window and get the window/frame width.
1037 Man-width)
1048 ;; Since man-db 2.4.3-1, man writes plain text with no escape
1049 ;; sequences when stdout is not a tty. In 2.5.0, the following
1050 ;; env-var was added to allow control of this (see Debian Bug#340673).
1055 "Use TOPIC to build and fire off the manpage and cleaning command.
1056 Return the buffer in which the manpage will appear."
1073 "[formatting...]"
1079 manual-program buffer
1081 shell-file-name
1083 shell-command-switch
1090 shell-command-switch
1098 exit-status)))
1104 buffer))
1107 "Reformat current manpage by calling the man command again synchronously."
1110 ;;this shouldn't happen unless it is not in a Man buffer."
1120 shell-command-switch
1126 ;;restore the point, not strictly right.
1134 "Notify the user when MAN-BUFFER is ready.
1135 See the variable `Man-notify-method' for the different notification behaviors."
1137 Man-original-frame)))
1139 (`newframe
1140 ;; Since we run asynchronously, perhaps while Emacs is waiting
1141 ;; for input, we must not leave a different buffer current. We
1142 ;; can't rely on the editor command loop to reselect the
1143 ;; selected window's buffer.
1150 (`pushy
1152 (`bully
1157 (`aggressive
1161 (`friendly
1165 (`polite
1168 (`quiet
1172 )))
1175 ;; \255 is SOFT HYPHEN in Latin-N. Versions of Debian man, at
1176 ;; least, emit it even when not in a Latin-N locale.
1186 "Convert overstriking and underlining to the correct fonts.
1187 Same for the ANSI bold and normal escape sequences."
1190 ;; Fontify ANSI escapes.
1197 ;; Other highlighting.
1200 ;; Multibyte characters exist.
1230 ;; When the header is longer than the manpage name, groff tries to
1231 ;; condense it to a shorter line interspersed with ^H. Remove ^H with
1232 ;; their preceding chars (but don't put Man-overstrike). (Bug#5566)
1236 ;; Try to recognize common forms of cross references.
1246 "Highlight the references on mouse-over.
1247 References include items in the SEE ALSO section,
1248 header file (#include <foo.h>), and files in FILES.
1249 If optional argument XREF-MAN-TYPE is non-nil, it used as the
1250 button type for items in SEE ALSO section. If it is nil, the
1251 default type, `Man-xref-man-page' is used for the buttons."
1252 ;; `Man-highlight-references' is used from woman.el, too.
1253 ;; woman.el doesn't set `Man-arguments'.
1259 'Man-default-man-entry
1262 'Man-default-man-entry
1265 'Man-default-man-entry
1273 ;; Based on `Man-build-references-alist'
1284 nil)))
1286 ;; An overlay button is preferable because the underlying text
1287 ;; may have text property highlights (Bug#7881).
1291 'type type
1296 target)
1300 "Remove overstriking and underlining from the current buffer.
1301 Normally skip any jobs that should have been done by the sed script,
1302 but when called interactively, do those jobs even if the sed
1303 script would have done them."
1318 ))
1321 ;; When the header is longer than the manpage name, groff tries to
1322 ;; condense it to a shorter line interspersed with ^H. Remove ^H with
1323 ;; their preceding chars (but don't put Man-overstrike). (Bug#5566)
1329 "Manpage background process filter.
1330 When manpage command is run asynchronously, PROCESS is the process
1331 object for the manpage command; when manpage command is run
1332 synchronously, PROCESS is the name of the buffer where the manpage
1333 command is run. Second argument STRING is the entire string of output."
1357 "Manpage background process sentinel.
1358 When manpage command is run asynchronously, PROCESS is the process
1359 object for the manpage command; when manpage command is run
1360 synchronously, PROCESS is the name of the buffer where the manpage
1361 command is run. Second argument MSG is the exit message of the
1362 manpage command."
1381 delete-buff t))
1383 ;; "-k foo", successful exit, but no output (from man-db)
1384 ;; ENHANCE-ME: share the check for -k with
1385 ;; `Man-highlight-references'. The \\s- bits here are
1386 ;; meant to allow for multiple options with -k among them.
1392 delete-buff t))
1401 ": process "
1407 ))
1427 ;; Entries hyphenated due to the window's width
1428 ;; won't be found in the man database, so remove
1429 ;; the hyphenation -- assuming Groff hyphenates
1430 ;; either with hyphen-minus (ASCII 45, #x2d),
1431 ;; hyphen (#x2010) or soft hyphen (#xad) -- and
1432 ;; look again.
1451 ))))
1454 ;; Skip arguments and only print the page name.
1456 'identity
1461 elem))
1465 \f
1466 ;; ======================================================================
1467 ;; set up manual mode in buffer and build alists
1472 "A mode for browsing Un*x manual pages.
1474 The following man commands are available in the buffer. Try
1489 The following variables may be of some use. Try
1492 `Man-notify-method' What happens when manpage is ready to display.
1493 `Man-downcase-section-letters-flag' Force section letters to lower case.
1494 `Man-circular-pages-flag' Treat multiple manpage list as circular.
1495 `Man-section-translations-alist' List of section numbers and their Un*x equiv.
1496 `Man-filter-list' Background manpage filter command.
1497 `Man-mode-map' Keymap bindings for Man mode buffers.
1498 `Man-mode-hook' Normal hook run on entry to Man mode.
1499 `Man-section-regexp' Regexp describing manpage section letters.
1500 `Man-heading-regexp' Regexp describing section headers.
1501 `Man-see-also-regexp' Regexp for SEE ALSO section (or your equiv).
1502 `Man-first-heading-regexp' Regexp for first heading on a manpage.
1503 `Man-reference-regexp' Regexp matching a references in SEE ALSO.
1504 `Man-switches' Background `man' command switches.
1506 The following key bindings are currently in effect in the buffer:
1509 mode-line-buffer-identification
1512 truncate-lines t)
1523 "Build the list of manpage sections."
1534 "Build the list of references (in the SEE ALSO section)."
1542 hyphenated
1555 hyphenated nil
1556 ;; Update len, in case a reference spans
1557 ;; more than two lines (paranoia).
1568 "Build the list of separate manpages in the buffer."
1578 nil))
1579 ;; Go past both the current and the next Man-first-heading-regexp
1582 ;; We assume that the page header is delimited by blank
1583 ;; lines and that it contains at most one blank line. So
1584 ;; if we back by three blank lines we will be sure to be
1585 ;; before the page header but not before the possible
1586 ;; previous page header.
1594 header))))
1596 )))
1599 "Strip all the page headers but the first from the manpage."
1608 ;; Since the awk script collapses all successive blank
1609 ;; lines into one, and since we don't want to get rid of
1610 ;; the fast awk script, one must choose between adding
1611 ;; spare blank lines between pages when there were none and
1612 ;; deleting blank lines at page boundaries when there were
1613 ;; some. We choose the first, so we comment the following
1614 ;; line.
1615 ;; (setq header (concat "\n" header)))
1620 "Delete the leading spaces that indent the manpage."
1628 ;; The space characters inserted by `untabify' inherit
1629 ;; sticky text properties, which is unnecessary and looks
1630 ;; ugly with underlining (Bug#11408).
1657 ))))
1659 \f
1660 ;; ======================================================================
1661 ;; Man mode commands
1664 "Move point to Nth next section (default 1)."
1673 ;; The last line doesn't belong to any section.
1675 ;; But don't move back from the starting point (can happen if `start'
1676 ;; is somewhere on the last line).
1680 "Move point to Nth previous section (default 1)."
1690 "Move point to SECTION if it exists, otherwise don't move point.
1691 Returns t if section is found, nil otherwise."
1698 nil)
1699 ))
1704 "Move point to SECTION."
1707 Man--last-section
1712 nil nil nil nil default)))
1721 Actually the section moved to is described by `Man-see-also-regexp'."
1728 "Return a possibly hyphenated word at point.
1729 If the word starts at the first non-whitespace column, and the
1730 previous line ends with a hyphen, return the last word on the previous
1745 word)))
1751 Specify which REFERENCE to use; default is based on word at point."
1761 ;; strip a trailing '-':
1765 word))
1766 Man--refpages))
1768 Man--last-refpage
1775 nil nil nil nil defaults)))
1776 chosen))))
1784 "Kill the buffer containing the manpage."
1789 "Go to the manual page on page PAGE."
1817 "Find the next manpage entry in the buffer."
1828 "Find the previous manpage entry in the buffer."
1838 ;; Header file support
1840 "View a header file specified by FILE from `Man-header-file-path'."
1842 complete-path)
1850 complete-path))
1852 ;;; Bookmark Man Support
1860 "Default bookmark name for Man or WoMan pages.
1861 Uses `Man-name-local-regexp'."
1869 "Make a bookmark entry for a Man buffer."
1876 ;;;###autoload
1878 "Default bookmark handler for Man buffers."
1880 ;; Let bookmark.el do the window handling.
1881 ;; This let-binding needs to be active during the call to both
1882 ;; Man-getpage-in-background and accept-process-output.
1891 \f
1892 ;; Init the man package variables, if not already done.
1897 ;;; man.el ends here