1 ;;; man.el --- browse UNIX manual pages
3 ;; Copyright (C) 1993-1994, 1996-1997, 2001-2016 Free Software
6 ;; Author: Barry A. Warsaw <bwarsaw@cen.com>
7 ;; Maintainer: emacs-devel@gnu.org
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/>.
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.
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
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
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.
96 "Browse UNIX manual pages."
103 (defcustom Man-filter-list nil
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
114 :type
'(repeat (list (string :tag
"Command String")
116 (string :tag
"Phrase String"))))
119 (defvar Man-uses-untabify-flag t
120 "Non-nil means use `untabify' instead of `Man-untabify-command'.")
121 (defvar Man-sed-script nil
122 "Script for sed to nuke backspaces and ANSI codes from manpages.")
124 (defcustom Man-fontify-manpage-flag t
125 "Non-nil means make up the manpage with fonts."
129 (defface Man-overstrike
130 '((t (:inherit bold
)))
131 "Face to use when fontifying overstrike."
135 (defface Man-underline
136 '((t (:inherit underline
)))
137 "Face to use when fontifying underlining."
142 '((t (:inherit highlight
)))
143 "Face to use when fontifying reverse video."
147 (defvar Man-ansi-color-map
(let ((ansi-color-faces-vector
148 [ default Man-overstrike default Man-underline
149 Man-underline default default Man-reverse
]))
150 (ansi-color-make-color-map))
151 "The value used here for `ansi-color-map'.")
153 ;; Use the value of the obsolete user option Man-notify, if set.
154 (defcustom Man-notify-method
(if (boundp 'Man-notify
) Man-notify
'friendly
)
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'."
170 :type
'(radio (const newframe
) (const pushy
) (const bully
)
171 (const aggressive
) (const friendly
)
172 (const polite
) (const quiet
) (const meek
))
175 (defcustom Man-width nil
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."
180 :type
'(choice (const :tag
"Window width" nil
)
181 (const :tag
"Frame width" t
)
182 (integer :tag
"Fixed width" :value
65))
185 (defcustom Man-frame-parameters nil
186 "Frame parameter list for creating a new frame for a manual page."
187 :type
'(repeat (cons :format
"%v"
188 (symbol :tag
"Parameter")
189 (sexp :tag
"Value")))
192 (defcustom Man-downcase-section-letters-flag t
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
195 example \"man 2V chmod\", but they are often displayed in the manpage
196 with the upper case letter. When this variable is t, the section
197 letter (e.g., \"2V\") is converted to lowercase (e.g., \"2v\") before
198 being sent to the man background process."
202 (defcustom Man-circular-pages-flag t
203 "Non-nil means the manpage list is treated as circular for traversal."
207 (defcustom Man-section-translations-alist
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."
219 :type
'(repeat (cons (string :tag
"Bogus Section")
220 (string :tag
"Real Section")))
223 ;; FIXME see comments at ffap-c-path.
224 (defcustom Man-header-file-path
225 (let ((arch (with-temp-buffer
226 (when (eq 0 (ignore-errors
227 (call-process "gcc" nil
'(t nil
) nil
228 "-print-multiarch")))
229 (goto-char (point-min))
230 (buffer-substring (point) (line-end-position)))))
231 (base '("/usr/include" "/usr/local/include")))
232 (if (zerop (length arch
))
234 (append base
(list (expand-file-name arch
"/usr/include")))))
235 "C Header file search path used in Man."
236 :version
"24.1" ; add multiarch
237 :type
'(repeat string
)
240 (defcustom Man-name-local-regexp
(concat "^" (regexp-opt '("NOM" "NAME")) "$")
241 "Regexp that matches the text that precedes the command's name.
242 Used in `bookmark-set' to get the default bookmark name."
244 :type
'string
:group
'bookmark
)
246 (defcustom manual-program
"man"
247 "Program used by `man' to produce man pages."
251 (defcustom Man-untabify-command
"pr"
252 "Program used by `man' for untabifying."
256 (defcustom Man-untabify-command-args
(list "-t" "-e")
257 "List of arguments to be passed to `Man-untabify-command' (which see)."
258 :type
'(repeat string
)
261 (defcustom Man-sed-command
"sed"
262 "Program used by `man' to process sed scripts."
266 (defcustom Man-awk-command
"awk"
267 "Program used by `man' to process awk scripts."
271 (defcustom Man-mode-hook nil
272 "Hook run when Man mode is enabled."
276 (defcustom Man-cooked-hook nil
277 "Hook run after removing backspaces but before `Man-mode' processing."
281 (defvar Man-name-regexp
"[-a-zA-Z0-9_Â+][-a-zA-Z0-9_.:Â+]*"
282 "Regular expression describing the name of a manpage (without section).")
284 (defvar Man-section-regexp
"[0-9][a-zA-Z0-9+]*\\|[LNln]"
285 "Regular expression describing a manpage section within parentheses.")
287 (defvar Man-page-header-regexp
288 (if (string-match "-solaris2\\." system-configuration
)
289 (concat "^[-A-Za-z0-9_].*[ \t]\\(" Man-name-regexp
290 "(\\(" Man-section-regexp
"\\))\\)$")
291 (concat "^[ \t]*\\(" Man-name-regexp
292 "(\\(" Man-section-regexp
"\\))\\).*\\1"))
293 "Regular expression describing the heading of a page.")
295 (defvar Man-heading-regexp
"^\\([A-Z][A-Z0-9 /-]+\\)$"
296 "Regular expression describing a manpage heading entry.")
298 (defvar Man-see-also-regexp
"SEE ALSO"
299 "Regular expression for SEE ALSO heading (or your equivalent).
300 This regexp should not start with a `^' character.")
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.
305 (defvar Man-first-heading-regexp
"^NAME$\\|^[ \t]*No manual entry fo.*$"
306 "Regular expression describing first heading on a manpage.
307 This regular expression should start with a `^' character.")
309 (defvar Man-reference-regexp
310 (concat "\\(" Man-name-regexp
311 "\\(\n[ \t]+" Man-name-regexp
"\\)*\\)[ \t]*(\\("
312 Man-section-regexp
"\\))")
313 "Regular expression describing a reference to another manpage.")
315 (defvar Man-apropos-regexp
316 (concat "\\[\\(" Man-name-regexp
"\\)\\][ \t]*(\\(" Man-section-regexp
"\\))")
317 "Regular expression describing a reference to manpages in \"man -k output\".")
319 (defvar Man-synopsis-regexp
"SYNOPSIS"
320 "Regular expression for SYNOPSIS heading (or your equivalent).
321 This regexp should not start with a `^' character.")
323 (defvar Man-files-regexp
"FILES\\>"
324 ;; Add \> so as not to match mount(8)'s FILESYSTEM INDEPENDENT MOUNT OPTIONS.
325 "Regular expression for FILES heading (or your equivalent).
326 This regexp should not start with a `^' character.")
328 (defvar Man-include-regexp
"#[ \t]*include[ \t]*"
329 "Regular expression describing the #include (directive of cpp).")
331 (defvar Man-file-name-regexp
"[^<>\", \t\n]+"
332 "Regular expression describing <> in #include line (directive of cpp).")
334 (defvar Man-normal-file-prefix-regexp
"[/~$]"
335 "Regular expression describing a file path appeared in FILES section.")
337 (defvar Man-header-regexp
338 (concat "\\(" Man-include-regexp
"\\)"
340 "\\(" Man-file-name-regexp
"\\)"
342 "Regular expression describing references to header files.")
344 (defvar Man-normal-file-regexp
345 (concat Man-normal-file-prefix-regexp Man-file-name-regexp
)
346 "Regular expression describing references to normal files.")
348 ;; This includes the section as an optional part to catch hyphenated
349 ;; references to manpages.
350 (defvar Man-hyphenated-reference-regexp
351 (concat "\\(" Man-name-regexp
"\\)\\((\\(" Man-section-regexp
"\\))\\)?")
352 "Regular expression describing a reference in the SEE ALSO section.")
354 (defcustom Man-switches
""
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."
361 (defvar Man-specified-section-option
362 (if (string-match "-solaris[0-9.]*$" system-configuration
)
365 "Option that indicates a specified a manual section name.")
367 (defvar Man-support-local-filenames
'auto-detect
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
371 `Man-support-local-filenames' should return.")
373 (defcustom man-imenu-title
"Contents"
374 "The title to use if man adds a Contents menu to the menubar."
380 ;; other variables and keymap initializations
381 (defvar Man-original-frame
)
382 (make-variable-buffer-local 'Man-original-frame
)
383 (defvar Man-arguments
)
384 (make-variable-buffer-local 'Man-arguments
)
385 (put 'Man-arguments
'permanent-local t
)
387 (defvar Man--sections nil
)
388 (make-variable-buffer-local 'Man--sections
)
389 (defvar Man--refpages nil
)
390 (make-variable-buffer-local 'Man--refpages
)
391 (defvar Man-page-list nil
)
392 (make-variable-buffer-local 'Man-page-list
)
393 (defvar Man-current-page
0)
394 (make-variable-buffer-local 'Man-current-page
)
395 (defvar Man-page-mode-string
"1 of 1")
396 (make-variable-buffer-local 'Man-page-mode-string
)
398 (defconst Man-sysv-sed-script
"\
407 /\e\\[[0-9][0-9]*m/ s///g"
408 "Script for sysV-like sed to nuke backspaces and ANSI codes from manpages.")
410 (defconst Man-berkeley-sed-script
"\
416 s/\\(.\\)\b\\1/\\1/g\\
419 /\e\\[[0-9][0-9]*m/ s///g"
420 "Script for berkeley-like sed to nuke backspaces and ANSI codes from manpages.")
422 (defvar Man-topic-history nil
"Topic read history.")
424 (defvar Man-mode-syntax-table
425 (let ((table (copy-syntax-table (standard-syntax-table))))
426 (modify-syntax-entry ?.
"w" table
)
427 (modify-syntax-entry ?_
"w" table
)
428 (modify-syntax-entry ?
: "w" table
) ; for PDL::Primitive in Perl man pages
430 "Syntax table used in Man mode buffers.")
433 (let ((map (make-sparse-keymap)))
434 (suppress-keymap map
)
435 (set-keymap-parent map button-buffer-map
)
437 (define-key map
[?\S-\
] 'scroll-down-command
)
438 (define-key map
" " 'scroll-up-command
)
439 (define-key map
"\177" 'scroll-down-command
)
440 (define-key map
"n" 'Man-next-section
)
441 (define-key map
"p" 'Man-previous-section
)
442 (define-key map
"\en" 'Man-next-manpage
)
443 (define-key map
"\ep" 'Man-previous-manpage
)
444 (define-key map
">" 'end-of-buffer
)
445 (define-key map
"<" 'beginning-of-buffer
)
446 (define-key map
"." 'beginning-of-buffer
)
447 (define-key map
"r" 'Man-follow-manual-reference
)
448 (define-key map
"g" 'Man-goto-section
)
449 (define-key map
"s" 'Man-goto-see-also-section
)
450 (define-key map
"k" 'Man-kill
)
451 (define-key map
"q" 'Man-quit
)
452 (define-key map
"u" 'Man-update-manpage
)
453 (define-key map
"m" 'man
)
454 ;; Not all the man references get buttons currently. The text in the
455 ;; manual page can contain references to other man pages
456 (define-key map
"\r" 'man-follow
)
457 (define-key map
"?" 'describe-mode
)
459 (easy-menu-define nil map
462 ["Next Section" Man-next-section t
]
463 ["Previous Section" Man-previous-section t
]
464 ["Go To Section..." Man-goto-section t
]
465 ["Go To \"SEE ALSO\" Section" Man-goto-see-also-section
466 :active
(cl-member Man-see-also-regexp Man--sections
467 :test
#'string-match-p
)]
468 ["Follow Reference..." Man-follow-manual-reference
469 :active Man--refpages
470 :help
"Go to a manpage referred to in the \"SEE ALSO\" section"]
472 ["Next Manpage" Man-next-manpage
473 :active
(> (length Man-page-list
) 1)]
474 ["Previous Manpage" Man-previous-manpage
475 :active
(> (length Man-page-list
) 1)]
478 ["Kill Buffer" Man-kill t
]
479 ["Quit" Man-quit t
]))
481 "Keymap for Man mode.")
484 (define-button-type 'Man-abstract-xref-man-page
486 'help-echo
"mouse-2, RET: display this man page"
488 'action
#'Man-xref-button-action
)
490 (defun Man-xref-button-action (button)
491 (let ((target (button-get button
'Man-target-string
)))
493 (button-get button
'func
)
495 (button-label button
))
497 (funcall target
(button-start button
)))
500 (define-button-type 'Man-xref-man-page
501 :supertype
'Man-abstract-xref-man-page
505 (define-button-type 'Man-xref-header-file
506 'action
(lambda (button)
507 (let ((w (button-get button
'Man-target-string
)))
508 (unless (Man-view-header-file w
)
509 (error "Cannot find header file: %s" w
))))
511 'help-echo
"mouse-2: display this header file")
513 (define-button-type 'Man-xref-normal-file
514 'action
(lambda (button)
515 (let ((f (substitute-in-file-name
516 (button-get button
'Man-target-string
))))
517 (if (file-exists-p f
)
518 (if (file-readable-p f
)
520 (error "Cannot read a file: %s" f
))
521 (error "Cannot find a file: %s" f
))))
523 'help-echo
"mouse-2: display this file")
526 ;; ======================================================================
529 (defun Man-init-defvars ()
530 "Used for initializing variables based on display's color support.
531 This is necessary if one wants to dump man.el with Emacs."
533 ;; Avoid possible error in call-process by using a directory that must exist.
534 (let ((default-directory "/"))
537 (Man-fontify-manpage-flag
539 ((eq 0 (call-process Man-sed-command nil nil nil Man-sysv-sed-script
))
541 ((eq 0 (call-process Man-sed-command nil nil nil Man-berkeley-sed-script
))
542 Man-berkeley-sed-script
)
546 (setq Man-filter-list
547 ;; Avoid trailing nil which confuses customize.
551 (if (eq system-type
'windows-nt
)
552 ;; Windows needs ".." quoting, not '..'.
554 "-e \"/Reformatting page. Wait/d\""
555 "-e \"/Reformatting entry. Wait/d\""
556 "-e \"/^[ \t][ \t]*-[ \t][0-9]*[ \t]-[ \t]*Formatted:.*[0-9]$/d\""
557 "-e \"/^[ \t]*Page[ \t][0-9]*.*(printed[ \t][0-9\\/]*)$/d\""
558 "-e \"/^Printed[ \t][0-9].*[0-9]$/d\""
559 "-e \"/^[ \t]*X[ \t]Version[ \t]1[01].*Release[ \t][0-9]/d\""
560 "-e \"/^[A-Za-z].*Last[ \t]change:/d\""
561 "-e \"/[ \t]*Copyright [0-9]* UNIX System Laboratories, Inc.$/d\""
562 "-e \"/^[ \t]*Rev\\..*Page [0-9][0-9]*$/d\"")
565 (concat "-e '" Man-sed-script
"'")
567 "-e '/^[\001-\032][\001-\032]*$/d'"
568 "-e '/\e[789]/s///g'"
569 "-e '/Reformatting page. Wait/d'"
570 "-e '/Reformatting entry. Wait/d'"
571 "-e '/^[ \t]*Hewlett-Packard[ \t]Company[ \t]*-[ \t][0-9]*[ \t]-/d'"
572 "-e '/^[ \t]*Hewlett-Packard[ \t]*-[ \t][0-9]*[ \t]-.*$/d'"
573 "-e '/^[ \t][ \t]*-[ \t][0-9]*[ \t]-[ \t]*Formatted:.*[0-9]$/d'"
574 "-e '/^[ \t]*Page[ \t][0-9]*.*(printed[ \t][0-9\\/]*)$/d'"
575 "-e '/^Printed[ \t][0-9].*[0-9]$/d'"
576 "-e '/^[ \t]*X[ \t]Version[ \t]1[01].*Release[ \t][0-9]/d'"
577 "-e '/^[A-Za-z].*Last[ \t]change:/d'"
578 "-e '/^Sun[ \t]Release[ \t][0-9].*[0-9]$/d'"
579 "-e '/[ \t]*Copyright [0-9]* UNIX System Laboratories, Inc.$/d'"
580 "-e '/^[ \t]*Rev\\..*Page [0-9][0-9]*$/d'"
582 ;; Windows doesn't support multi-line commands, so don't
584 (unless (eq system-type
'windows-nt
)
589 "BEGIN { blankline=0; anonblank=0; }\n"
590 "/^$/ { if (anonblank==0) next; }\n"
592 "/^$/ { blankline++; next; }\n"
593 "{ if (blankline>0) { print \"\"; blankline=0; } print $0; }\n"
596 (if (not Man-uses-untabify-flag
)
597 ;; The outer list will be stripped off by apply.
600 Man-untabify-command-args
))
604 (defsubst Man-make-page-mode-string
()
605 "Formats part of the mode line for Man mode."
606 (format "%s page %d of %d"
607 (or (nth 2 (nth (1- Man-current-page
) Man-page-list
))
610 (length Man-page-list
)))
612 (defsubst Man-build-man-command
()
613 "Builds the entire background manpage and cleaning command."
614 (let ((command (concat manual-program
" " Man-switches
617 ((string-match "%s" manual-program
) "")
618 ;; Stock MS-DOS shells cannot redirect stderr;
619 ;; `call-process' below sends it to /dev/null,
620 ;; so we don't need `2>' even with DOS shells
621 ;; which do support stderr redirection.
622 ((not (fboundp 'make-process
)) " %s")
623 ((concat " %s 2>" null-device
)))))
624 (flist Man-filter-list
))
625 (while (and flist
(car flist
))
626 (let ((pcom (car (car flist
)))
627 (pargs (cdr (car flist
))))
629 (concat command
" | " pcom
" "
630 (mapconcat (lambda (phrase)
631 (if (not (stringp phrase
))
632 (error "Malformed Man-filter-list"))
635 (setq flist
(cdr flist
))))
639 (defun Man-translate-cleanup (string)
640 "Strip leading, trailing and middle spaces."
641 (when (stringp string
)
642 ;; Strip leading and trailing
643 (if (string-match "^[ \t\f\r\n]*\\(.+[^ \t\f\r\n]\\)" string
)
644 (setq string
(match-string 1 string
)))
646 (setq string
(replace-regexp-in-string "[\t\r\n]" " " string
))
647 (setq string
(replace-regexp-in-string " +" " " string
))
650 (defun Man-translate-references (ref)
651 "Translates REF from \"chmod(2V)\" to \"2v chmod\" style.
652 Leave it as is if already in that style. Possibly downcase and
653 translate the section (see the `Man-downcase-section-letters-flag'
654 and the `Man-section-translations-alist' variables)."
657 (slist Man-section-translations-alist
))
658 (setq ref
(Man-translate-cleanup ref
))
660 ;; "chmod(2V)" case ?
661 ((string-match (concat "^" Man-reference-regexp
"$") ref
)
662 (setq name
(replace-regexp-in-string "[\n\t ]" "" (match-string 1 ref
))
663 section
(match-string 3 ref
)))
665 ((string-match (concat "^\\(" Man-section-regexp
666 "\\) +\\(" Man-name-regexp
"\\)$") ref
)
667 (setq name
(match-string 2 ref
)
668 section
(match-string 1 ref
))))
669 (if (string= name
"")
670 ref
; Return the reference as is
671 (if Man-downcase-section-letters-flag
672 (setq section
(downcase section
)))
674 (let ((s1 (car (car slist
)))
675 (s2 (cdr (car slist
))))
676 (setq slist
(cdr slist
))
677 (if Man-downcase-section-letters-flag
678 (setq s1
(downcase s1
)))
679 (if (not (string= s1 section
)) nil
680 (setq section
(if Man-downcase-section-letters-flag
684 (concat Man-specified-section-option section
" " name
))))
686 (defun Man-support-local-filenames ()
687 "Return non-nil if the man command supports local filenames.
688 Different man programs support this feature in different ways.
689 The default Debian man program (\"man-db\") has a `--local-file'
690 \(or `-l') option for this purpose. The default Red Hat man
691 program has no such option, but interprets any name containing
692 a \"/\" as a local filename. The function returns either `man-db'
694 (if (eq Man-support-local-filenames
'auto-detect
)
695 (setq Man-support-local-filenames
697 (let ((default-directory
698 ;; Ensure that `default-directory' exists and is readable.
699 (if (file-accessible-directory-p default-directory
)
701 (expand-file-name "~/"))))
703 (call-process manual-program nil t nil
"--help")))
704 (cond ((search-backward "--local-file" nil
'move
)
706 ;; This feature seems to be present in at least ver 1.4f,
707 ;; which is about 20 years old.
708 ;; I don't know if this version has an official name?
709 ((looking-at "^man, versione? [1-9]")
711 Man-support-local-filenames
))
714 ;; ======================================================================
715 ;; default man entry: get word near point
717 (defun Man-default-man-entry (&optional pos
)
718 "Guess default manual entry based on the text near position POS.
719 POS defaults to `point'."
720 (let (word start column distance
)
722 (when pos
(goto-char pos
))
724 ;; The default title is the nearest entry-like object before or
726 (if (and (skip-chars-backward " \ta-zA-Z0-9+")
727 (not (zerop (skip-chars-backward "(")))
728 ;; Try to handle the special case where POS is on a
731 (concat "([ \t]*\\(" Man-section-regexp
"\\)[ \t]*)"))
732 ;; We skipped a valid section number backwards, look at
734 (or (and (skip-chars-backward ",; \t")
735 (not (zerop (skip-chars-backward "-a-zA-Z0-9._+:"))))
736 ;; Not a valid entry, move POS after closing paren.
737 (not (setq pos
(match-end 0)))))
738 ;; We have a candidate, make `start' record its starting
741 ;; Otherwise look at char before POS.
743 (if (not (zerop (skip-chars-backward "-a-zA-Z0-9._+:")))
744 ;; Our candidate is just before or around POS.
746 ;; Otherwise record the current column and look backwards.
747 (setq column
(current-column))
748 (skip-chars-backward ",; \t")
749 ;; Record the distance traveled.
750 (setq distance
(- column
(current-column)))
752 (concat "([ \t]*\\(?:" Man-section-regexp
"\\)[ \t]*)")
753 (line-beginning-position))
754 ;; Skip section number backwards.
755 (goto-char (match-beginning 0))
756 (skip-chars-backward " \t"))
757 (if (not (zerop (skip-chars-backward "-a-zA-Z0-9._+:")))
759 ;; We have a candidate before POS ...
762 (if (and (skip-chars-forward ",; \t")
763 (< (- (current-column) column
) distance
)
764 (looking-at "[-a-zA-Z0-9._+:]"))
765 ;; ... but the one after POS is better.
767 ;; ... and anything after POS is worse.
769 ;; No candidate before POS.
771 (skip-chars-forward ",; \t")
772 (setq start
(point)))))
773 ;; We have found a suitable starting point, try to skip at least
775 (skip-chars-forward "-a-zA-Z0-9._+:")
776 (setq word
(buffer-substring-no-properties start
(point)))
777 ;; If there is a continuation at the end of line, check the
778 ;; following line too, eg:
781 ;; Note: This code gets executed iff our entry is after POS.
782 (when (looking-at "[ \t\r\n]+\\([-a-zA-Z0-9._+:]+\\)([0-9])")
783 (setq word
(concat word
(match-string-no-properties 1)))
784 ;; Make sure the section number gets included by the code below.
785 (goto-char (match-end 1)))
786 (when (string-match "[-._]+$" word
)
787 (setq word
(substring word
0 (match-beginning 0))))
788 ;; The following was commented out since the preceding code
789 ;; should not produce a leading "*" in the first place.
790 ;;; ;; If looking at something like *strcat(... , remove the '*'
791 ;;; (when (string-match "^*" word)
792 ;;; (setq word (substring word 1)))
795 (and (not (string-equal word
""))
796 ;; If looking at something like ioctl(2) or brc(1M),
797 ;; include the section number in the returned value.
799 (concat "[ \t]*([ \t]*\\(" Man-section-regexp
"\\)[ \t]*)"))
800 (format "(%s)" (match-string-no-properties 1)))))))
803 ;; ======================================================================
804 ;; Top level command and background process sentinel
806 ;; For compatibility with older versions.
808 (defalias 'manual-entry
'man
)
810 (defvar Man-completion-cache nil
811 ;; On my machine, "man -k" is so fast that a cache makes no sense,
812 ;; but apparently that's not the case in all cases, so let's add a cache.
813 "Cache of completion table of the form (PREFIX . TABLE).")
815 (defvar Man-man-k-use-anchor
817 (memq system-type
'(gnu gnu
/linux gnu
/kfreebsd
))
818 "If non-nil prepend ^ to the prefix passed to \"man -k\" for completion.
819 The value should be nil if \"man -k ^PREFIX\" may omit some man
820 pages whose names start with PREFIX.
822 Currently, the default value depends on `system-type' and is
823 non-nil where the standard man programs are known to behave
824 properly. Setting the value to nil always gives correct results
825 but computing the list of completions may take a bit longer.")
827 (defun Man-parse-man-k ()
828 "Parse \"man -k\" output and return the list of page names.
830 The current buffer should contain the output of a command of the
831 form \"man -k keyword\", which is traditionally also available with
834 While POSIX man(1p) is a bit vague about what to expect here,
835 this function tries to parse some commonly used formats, which
836 can be described in the following informal way, with square brackets
837 indicating optional parts and whitespace being interpreted
840 foo[, bar [, ...]] [other stuff] (sec) - description
841 foo(sec)[, bar(sec) [, ...]] [other stuff] - description
843 For more details and some regression tests, please see
844 test/automated/man-tests.el in the emacs repository."
845 (goto-char (point-min))
846 ;; See man-tests for data about which systems use which format (hopefully we
847 ;; will be able to simplify the code if/when some of those formats aren't
850 (while (search-forward-regexp "^\\([^ \t,\n]+\\)\\(.*?\\)\
851 \\(?:[ \t]\\(([^ \t,\n]+?)\\)\\)?\\(?:[ \t]+- ?\\(.*\\)\\)?$" nil t
)
852 (let ((section (match-string 3))
853 (description (match-string 4))
854 (bound (match-end 2)))
855 (goto-char (match-end 1))
858 ;; The first regexp grouping may already match the section
859 ;; tacked on to the name, which is ok since for the formats we
860 ;; claim to support the third (non-shy) grouping does not
861 ;; match in this case, i.e., section is nil.
862 (push (propertize (concat (match-string 1) section
)
863 'help-echo description
)
865 (search-forward-regexp "\\=, *\\([^ \t,]+\\)" bound t
)))))
868 (defun Man-completion-table (string pred action
)
870 ;; This ends up returning t for pretty much any string, and hence leads to
871 ;; spurious "complete but not unique" messages. And since `man' doesn't
872 ;; require-match anyway, there's not point being clever.
873 ;;((eq action 'lambda) (not (string-match "([^)]*\\'" string)))
875 ;; Let SPC (minibuffer-complete-word) insert the space.
876 (complete-with-action action
'("-k ") string pred
))
878 (let ((table (cdr Man-completion-cache
))
881 (when (string-match "\\`\\([[:digit:]].*?\\) " string
)
882 (setq section
(match-string 1 string
))
883 (setq prefix
(substring string
(match-end 0))))
884 (unless (and Man-completion-cache
885 (string-prefix-p (car Man-completion-cache
) prefix
))
887 (setq default-directory
"/") ;; in case inherited doesn't exist
888 ;; Actually for my `man' the arg is a regexp.
889 ;; POSIX says it must be ERE and "man-db" seems to agree,
890 ;; whereas under macOS it seems to be BRE-style and doesn't
891 ;; accept backslashes at all. Let's not bother to
893 (let ((process-environment (copy-sequence process-environment
)))
894 (setenv "COLUMNS" "999") ;; don't truncate long names
895 ;; manual-program might not even exist. And since it's
896 ;; run differently in Man-getpage-in-background, an error
897 ;; here may not necessarily mean that we'll also get an
900 (call-process manual-program nil
'(t nil
) nil
901 "-k" (concat (when (or Man-man-k-use-anchor
902 (string-equal prefix
""))
905 (setq table
(Man-parse-man-k)))
906 ;; Cache the table for later reuse.
907 (setq Man-completion-cache
(cons prefix table
)))
908 ;; The table may contain false positives since the match is made
909 ;; by "man -k" not just on the manpage's name.
911 (let ((re (concat "(" (regexp-quote section
) ")\\'")))
912 (dolist (comp (prog1 table
(setq table nil
)))
913 (if (string-match re comp
)
914 (push (substring comp
0 (match-beginning 0)) table
)))
915 (completion-table-with-context (concat section
" ") table
917 ;; If the current text looks like a possible section name,
918 ;; then add a completion entry that just adds a space so SPC
919 ;; can be used to insert a space.
920 (if (string-match "\\`[[:digit:]]" string
)
921 (push (concat string
" ") table
))
922 (let ((res (complete-with-action action table string pred
)))
923 ;; In case we're completing to a single name that exists in
924 ;; several sections, the longest prefix will look like "foo(".
925 (if (and (stringp res
)
926 (string-match "([^(]*\\'" res
)
927 ;; In case the paren was already in `prefix', don't
929 (> (match-beginning 0) (length prefix
)))
930 (substring res
0 (match-beginning 0))
934 (defun man (man-args)
935 "Get a Un*x manual page and put it in a buffer.
936 This command is the top-level command in the man package.
937 It runs a Un*x command to retrieve and clean a manpage in the
938 background and places the results in a `Man-mode' browsing
939 buffer. The variable `Man-width' defines the number of columns in
940 formatted manual pages. The buffer is displayed immediately.
941 The variable `Man-notify-method' defines how the buffer is displayed.
942 If a buffer already exists for this man page, it will be displayed
943 without running the man command.
945 For a manpage from a particular section, use either of the
946 following. \"cat(1)\" is how cross-references appear and is
947 passed to man as \"1 cat\".
952 To see manpages from all sections related to a subject, use an
953 \"all pages\" option (which might be \"-a\" if it's not the
954 default), then step through with `Man-next-manpage' (\\<Man-mode-map>\\[Man-next-manpage]) etc.
955 Add to `Man-switches' to make this option permanent.
959 An explicit filename can be given too. Use -l if it might
960 otherwise look like a page name.
965 An \"apropos\" query with -k gives a buffer of matching page
966 names or descriptions. The pattern argument is usually an
967 \"grep -E\" style regexp.
972 (list (let* ((default-entry (Man-default-man-entry))
973 ;; ignore case because that's friendly for bizarre
974 ;; caps things like the X11 function names and because
975 ;; "man" itself is case-insensitive on the command line
976 ;; so you're accustomed not to bother about the case
977 ;; ("man -k" is case-insensitive similarly, so the
978 ;; table has everything available to complete)
979 (completion-ignore-case t
)
980 Man-completion-cache
;Don't cache across calls.
981 (input (completing-read
982 (format "Manual entry%s"
983 (if (string= default-entry
"")
985 (format " (default %s): " default-entry
)))
986 'Man-completion-table
987 nil nil nil
'Man-topic-history default-entry
)))
988 (if (string= input
"")
989 (error "No man args given")
992 ;; Possibly translate the "subject(section)" syntax into the
993 ;; "section subject" syntax and possibly downcase the section.
994 (setq man-args
(Man-translate-references man-args
))
996 (Man-getpage-in-background man-args
))
999 (defun man-follow (man-args)
1000 "Get a Un*x manual page of the item under point and put it in a buffer."
1001 (interactive (list (Man-default-man-entry)))
1002 (if (or (not man-args
)
1003 (string= man-args
""))
1004 (error "No item under point")
1007 (defmacro Man-start-calling
(&rest body
)
1008 "Start the man command in `body' after setting up the environment"
1009 `(let ((process-environment (copy-sequence process-environment
))
1010 ;; The following is so Awk script gets \n intact
1011 ;; But don't prevent decoding of the outside.
1012 (coding-system-for-write 'raw-text-unix
)
1013 ;; We must decode the output by a coding system that the
1014 ;; system's locale suggests in multibyte mode.
1015 (coding-system-for-read locale-coding-system
)
1016 ;; Avoid possible error by using a directory that always exists.
1018 (if (and (file-directory-p default-directory
)
1019 (not (find-file-name-handler default-directory
1020 'file-directory-p
)))
1023 ;; Prevent any attempt to use display terminal fanciness.
1024 (setenv "TERM" "dumb")
1025 ;; In Debian Woody, at least, we get overlong lines under X
1026 ;; unless COLUMNS or MANWIDTH is set. This isn't a problem on
1027 ;; a tty. man(1) says:
1029 ;; If $MANWIDTH is set, its value is used as the line
1030 ;; length for which manual pages should be formatted.
1031 ;; If it is not set, manual pages will be formatted
1032 ;; with a line length appropriate to the current ter-
1033 ;; minal (using an ioctl(2) if available, the value of
1034 ;; $COLUMNS, or falling back to 80 characters if nei-
1035 ;; ther is available).
1036 (when (or window-system
1037 (not (or (getenv "MANWIDTH") (getenv "COLUMNS"))))
1038 ;; Since the page buffer is displayed beforehand,
1039 ;; we can select its window and get the window/frame width.
1040 (setenv "COLUMNS" (number-to-string
1042 ((and (integerp Man-width
) (> Man-width
0))
1045 (if (window-live-p (get-buffer-window (current-buffer) t
))
1046 (with-selected-window (get-buffer-window (current-buffer) t
)
1050 (if (window-live-p (get-buffer-window (current-buffer) t
))
1051 (with-selected-window (get-buffer-window (current-buffer) t
)
1053 (window-width)))))))
1054 ;; Since man-db 2.4.3-1, man writes plain text with no escape
1055 ;; sequences when stdout is not a tty. In 2.5.0, the following
1056 ;; env-var was added to allow control of this (see Debian Bug#340673).
1057 (setenv "MAN_KEEP_FORMATTING" "1")
1060 (defun Man-getpage-in-background (topic)
1061 "Use TOPIC to build and fire off the manpage and cleaning command.
1062 Return the buffer in which the manpage will appear."
1063 (let* ((man-args topic
)
1064 (bufname (concat "*Man " man-args
"*"))
1065 (buffer (get-buffer bufname
)))
1067 (Man-notify-when-ready buffer
)
1069 (message "Invoking %s %s in the background" manual-program man-args
)
1070 (setq buffer
(generate-new-buffer bufname
))
1071 (with-current-buffer buffer
1072 (Man-notify-when-ready buffer
)
1073 (setq buffer-undo-list t
)
1074 (setq Man-original-frame
(selected-frame))
1075 (setq Man-arguments man-args
)
1077 (setq mode-line-process
1078 (concat " " (propertize (if Man-fontify-manpage-flag
1081 'face
'mode-line-emphasis
)))
1083 (if (fboundp 'make-process
)
1084 (let ((proc (start-process
1085 manual-program buffer
1086 (if (memq system-type
'(cygwin windows-nt
))
1089 shell-command-switch
1090 (format (Man-build-man-command) man-args
))))
1091 (set-process-sentinel proc
'Man-bgproc-sentinel
)
1092 (set-process-filter proc
'Man-bgproc-filter
))
1093 (let* ((inhibit-read-only t
)
1095 (call-process shell-file-name nil
(list buffer nil
) nil
1096 shell-command-switch
1097 (format (Man-build-man-command) man-args
)))
1099 (or (and (numberp exit-status
)
1101 (and (numberp exit-status
)
1103 (format "exited abnormally with code %d"
1105 (setq msg exit-status
))
1106 (if Man-fontify-manpage-flag
1107 (Man-fontify-manpage)
1108 (Man-cleanup-manpage))
1109 (Man-bgproc-sentinel bufname msg
))))))
1112 (defun Man-update-manpage ()
1113 "Reformat current manpage by calling the man command again synchronously."
1115 (when (eq Man-arguments nil
)
1116 ;;this shouldn't happen unless it is not in a Man buffer."
1117 (error "Man-arguments not initialized"))
1118 (let ((old-pos (point))
1119 (text (current-word))
1120 (old-size (buffer-size))
1121 (inhibit-read-only t
)
1122 (buffer-read-only nil
))
1125 (call-process shell-file-name nil
(list (current-buffer) nil
) nil
1126 shell-command-switch
1127 (format (Man-build-man-command) Man-arguments
)))
1128 (if Man-fontify-manpage-flag
1129 (Man-fontify-manpage)
1130 (Man-cleanup-manpage))
1132 ;;restore the point, not strictly right.
1133 (unless (or (eq text nil
) (= old-size
(buffer-size)))
1134 (let ((case-fold-search nil
))
1135 (if (> old-size
(buffer-size))
1136 (search-backward text nil t
))
1137 (search-forward text nil t
)))))
1139 (defun Man-notify-when-ready (man-buffer)
1140 "Notify the user when MAN-BUFFER is ready.
1141 See the variable `Man-notify-method' for the different notification behaviors."
1142 (let ((saved-frame (with-current-buffer man-buffer
1143 Man-original-frame
)))
1144 (pcase Man-notify-method
1146 ;; Since we run asynchronously, perhaps while Emacs is waiting
1147 ;; for input, we must not leave a different buffer current. We
1148 ;; can't rely on the editor command loop to reselect the
1149 ;; selected window's buffer.
1151 (let ((frame (make-frame Man-frame-parameters
)))
1152 (set-window-buffer (frame-selected-window frame
) man-buffer
)
1153 (set-window-dedicated-p (frame-selected-window frame
) t
)
1154 (or (display-multi-frame-p frame
)
1155 (select-frame frame
)))))
1157 (switch-to-buffer man-buffer
))
1159 (and (frame-live-p saved-frame
)
1160 (select-frame saved-frame
))
1161 (pop-to-buffer man-buffer
)
1162 (delete-other-windows))
1164 (and (frame-live-p saved-frame
)
1165 (select-frame saved-frame
))
1166 (pop-to-buffer man-buffer
))
1168 (and (frame-live-p saved-frame
)
1169 (select-frame saved-frame
))
1170 (display-buffer man-buffer
'not-this-window
))
1173 (message "Manual buffer %s is ready" (buffer-name man-buffer
)))
1175 (message "Manual buffer %s is ready" (buffer-name man-buffer
)))
1180 (defun Man-softhyphen-to-minus ()
1181 ;; \255 is SOFT HYPHEN in Latin-N. Versions of Debian man, at
1182 ;; least, emit it even when not in a Latin-N locale.
1183 (unless (eq t
(compare-strings "latin-" 0 nil
1184 current-language-environment
0 6 t
))
1185 (goto-char (point-min))
1187 (if enable-multibyte-characters
1188 (setq str
(string-as-multibyte str
)))
1189 (while (search-forward str nil t
) (replace-match "-")))))
1191 (defun Man-fontify-manpage ()
1192 "Convert overstriking and underlining to the correct fonts.
1193 Same for the ANSI bold and normal escape sequences."
1195 (goto-char (point-min))
1196 ;; Fontify ANSI escapes.
1197 (let ((ansi-color-apply-face-function
1198 (lambda (beg end face
)
1200 (put-text-property beg end
'face face
))))
1201 (ansi-color-map Man-ansi-color-map
))
1202 (ansi-color-apply-on-region (point-min) (point-max)))
1203 ;; Other highlighting.
1204 (let ((buffer-undo-list t
))
1205 (if (< (buffer-size) (position-bytes (point-max)))
1206 ;; Multibyte characters exist.
1208 (goto-char (point-min))
1209 (while (and (search-forward "__\b\b" nil t
) (not (eobp)))
1210 (backward-delete-char 4)
1211 (put-text-property (point) (1+ (point)) 'face
'Man-underline
))
1212 (goto-char (point-min))
1213 (while (search-forward "\b\b__" nil t
)
1214 (backward-delete-char 4)
1215 (put-text-property (1- (point)) (point) 'face
'Man-underline
))))
1216 (goto-char (point-min))
1217 (while (and (search-forward "_\b" nil t
) (not (eobp)))
1218 (backward-delete-char 2)
1219 (put-text-property (point) (1+ (point)) 'face
'Man-underline
))
1220 (goto-char (point-min))
1221 (while (search-forward "\b_" nil t
)
1222 (backward-delete-char 2)
1223 (put-text-property (1- (point)) (point) 'face
'Man-underline
))
1224 (goto-char (point-min))
1225 (while (re-search-forward "\\(.\\)\\(\b+\\1\\)+" nil t
)
1226 (replace-match "\\1")
1227 (put-text-property (1- (point)) (point) 'face
'Man-overstrike
))
1228 (goto-char (point-min))
1229 (while (re-search-forward "o\b\\+\\|\\+\bo" nil t
)
1231 (put-text-property (1- (point)) (point) 'face
'bold
))
1232 (goto-char (point-min))
1233 (while (re-search-forward "[-|]\\(\b[-|]\\)+" nil t
)
1235 (put-text-property (1- (point)) (point) 'face
'bold
))
1236 ;; When the header is longer than the manpage name, groff tries to
1237 ;; condense it to a shorter line interspersed with ^H. Remove ^H with
1238 ;; their preceding chars (but don't put Man-overstrike). (Bug#5566)
1239 (goto-char (point-min))
1240 (while (re-search-forward ".\b" nil t
) (backward-delete-char 2))
1241 (goto-char (point-min))
1242 ;; Try to recognize common forms of cross references.
1243 (Man-highlight-references)
1244 (Man-softhyphen-to-minus)
1245 (goto-char (point-min))
1246 (while (re-search-forward Man-heading-regexp nil t
)
1247 (put-text-property (match-beginning 0)
1249 'face
'Man-overstrike
))))
1251 (defun Man-highlight-references (&optional xref-man-type
)
1252 "Highlight the references on mouse-over.
1253 References include items in the SEE ALSO section,
1254 header file (#include <foo.h>), and files in FILES.
1255 If optional argument XREF-MAN-TYPE is non-nil, it used as the
1256 button type for items in SEE ALSO section. If it is nil, the
1257 default type, `Man-xref-man-page' is used for the buttons."
1258 ;; `Man-highlight-references' is used from woman.el, too.
1259 ;; woman.el doesn't set `Man-arguments'.
1260 (unless Man-arguments
1261 (setq Man-arguments
""))
1262 (if (string-match "-k " Man-arguments
)
1264 (Man-highlight-references0 nil Man-reference-regexp
1
1265 'Man-default-man-entry
1266 (or xref-man-type
'Man-xref-man-page
))
1267 (Man-highlight-references0 nil Man-apropos-regexp
1
1268 'Man-default-man-entry
1269 (or xref-man-type
'Man-xref-man-page
)))
1270 (Man-highlight-references0 Man-see-also-regexp Man-reference-regexp
1
1271 'Man-default-man-entry
1272 (or xref-man-type
'Man-xref-man-page
))
1273 (Man-highlight-references0 Man-synopsis-regexp Man-header-regexp
0 2
1274 'Man-xref-header-file
)
1275 (Man-highlight-references0 Man-files-regexp Man-normal-file-regexp
0 0
1276 'Man-xref-normal-file
)))
1278 (defun Man-highlight-references0 (start-section regexp button-pos target type
)
1279 ;; Based on `Man-build-references-alist'
1280 (when (or (null start-section
)
1281 (Man-find-section start-section
))
1282 (let ((end (if start-section
1285 (back-to-indentation)
1287 (Man-next-section 1)
1289 (goto-char (point-min))
1291 (while (re-search-forward regexp end t
)
1292 ;; An overlay button is preferable because the underlying text
1293 ;; may have text property highlights (Bug#7881).
1295 (match-beginning button-pos
)
1296 (match-end button-pos
)
1298 'Man-target-string
(cond
1300 (match-string target
))
1305 (defun Man-cleanup-manpage (&optional interactive
)
1306 "Remove overstriking and underlining from the current buffer.
1307 Normally skip any jobs that should have been done by the sed script,
1308 but when called interactively, do those jobs even if the sed
1309 script would have done them."
1311 (if (or interactive
(not Man-sed-script
))
1313 (goto-char (point-min))
1314 (while (search-forward "_\b" nil t
) (backward-delete-char 2))
1315 (goto-char (point-min))
1316 (while (search-forward "\b_" nil t
) (backward-delete-char 2))
1317 (goto-char (point-min))
1318 (while (re-search-forward "\\(.\\)\\(\b\\1\\)+" nil t
)
1319 (replace-match "\\1"))
1320 (goto-char (point-min))
1321 (while (re-search-forward "\e\\[[0-9]+m" nil t
) (replace-match ""))
1322 (goto-char (point-min))
1323 (while (re-search-forward "o\b\\+\\|\\+\bo" nil t
) (replace-match "o"))
1325 (goto-char (point-min))
1326 (while (re-search-forward "[-|]\\(\b[-|]\\)+" nil t
) (replace-match "+"))
1327 ;; When the header is longer than the manpage name, groff tries to
1328 ;; condense it to a shorter line interspersed with ^H. Remove ^H with
1329 ;; their preceding chars (but don't put Man-overstrike). (Bug#5566)
1330 (goto-char (point-min))
1331 (while (re-search-forward ".\b" nil t
) (backward-delete-char 2))
1332 (Man-softhyphen-to-minus))
1334 (defun Man-bgproc-filter (process string
)
1335 "Manpage background process filter.
1336 When manpage command is run asynchronously, PROCESS is the process
1337 object for the manpage command; when manpage command is run
1338 synchronously, PROCESS is the name of the buffer where the manpage
1339 command is run. Second argument STRING is the entire string of output."
1341 (let ((Man-buffer (process-buffer process
)))
1342 (if (null (buffer-name Man-buffer
)) ;; deleted buffer
1343 (set-process-buffer process nil
)
1345 (with-current-buffer Man-buffer
1346 (let ((inhibit-read-only t
)
1347 (beg (marker-position (process-mark process
))))
1355 (line-beginning-position))
1357 (if Man-fontify-manpage-flag
1358 (Man-fontify-manpage)
1359 (Man-cleanup-manpage)))
1360 (set-marker (process-mark process
) (point-max)))))))))
1362 (defun Man-bgproc-sentinel (process msg
)
1363 "Manpage background process sentinel.
1364 When manpage command is run asynchronously, PROCESS is the process
1365 object for the manpage command; when manpage command is run
1366 synchronously, PROCESS is the name of the buffer where the manpage
1367 command is run. Second argument MSG is the exit message of the
1369 (let ((Man-buffer (if (stringp process
) (get-buffer process
)
1370 (process-buffer process
)))
1374 (if (null (buffer-name Man-buffer
)) ;; deleted buffer
1375 (or (stringp process
)
1376 (set-process-buffer process nil
))
1378 (with-current-buffer Man-buffer
1380 (let ((case-fold-search nil
))
1381 (goto-char (point-min))
1382 (cond ((or (looking-at "No \\(manual \\)*entry for")
1383 (looking-at "[^\n]*: nothing appropriate$"))
1384 (setq err-mess
(buffer-substring (point)
1386 (end-of-line) (point)))
1389 ;; "-k foo", successful exit, but no output (from man-db)
1390 ;; ENHANCE-ME: share the check for -k with
1391 ;; `Man-highlight-references'. The \\s- bits here are
1392 ;; meant to allow for multiple options with -k among them.
1393 ((and (string-match "\\(\\`\\|\\s-\\)-k\\s-" Man-arguments
)
1394 (eq (process-status process
) 'exit
)
1395 (= (process-exit-status process
) 0)
1396 (= (point-min) (point-max)))
1397 (setq err-mess
(format "%s: no matches" Man-arguments
)
1400 ((or (stringp process
)
1401 (not (and (eq (process-status process
) 'exit
)
1402 (= (process-exit-status process
) 0))))
1403 (or (zerop (length msg
))
1406 (concat (buffer-name Man-buffer
)
1408 (let ((eos (1- (length msg
))))
1409 (if (= (aref msg eos
) ?
\n)
1410 (substring msg
0 eos
) msg
))))
1411 (goto-char (point-max))
1412 (insert (format "\nprocess %s" msg
))))
1415 (if (window-live-p (get-buffer-window Man-buffer t
))
1416 (quit-restore-window
1417 (get-buffer-window Man-buffer t
) 'kill
)
1418 (kill-buffer Man-buffer
))
1420 (run-hooks 'Man-cooked-hook
)
1422 (Man-build-page-list)
1423 (Man-strip-page-headers)
1427 (if (not Man-page-list
)
1428 (let ((args Man-arguments
))
1429 (if (window-live-p (get-buffer-window (current-buffer) t
))
1430 (quit-restore-window
1431 (get-buffer-window (current-buffer) t
) 'kill
)
1432 (kill-buffer (current-buffer)))
1433 (message "Can't find the %s manpage"
1434 (Man-page-from-arguments args
)))
1436 (if Man-fontify-manpage-flag
1437 (message "%s man page formatted"
1438 (Man-page-from-arguments Man-arguments
))
1439 (message "%s man page cleaned up"
1440 (Man-page-from-arguments Man-arguments
)))
1441 (unless (and (processp process
)
1442 (not (eq (process-status process
) 'exit
)))
1443 (setq mode-line-process nil
))
1444 (set-buffer-modified-p nil
)))))
1447 (message "%s" err-mess
))
1450 (defun Man-page-from-arguments (args)
1451 ;; Skip arguments and only print the page name.
1457 (and (not (string-match "^-" elem
))
1459 (split-string args
" ")))
1463 ;; ======================================================================
1464 ;; set up manual mode in buffer and build alists
1466 (defvar bookmark-make-record-function
)
1468 (put 'Man-mode
'mode-class
'special
)
1470 (define-derived-mode Man-mode fundamental-mode
"Man"
1471 "A mode for browsing Un*x manual pages.
1473 The following man commands are available in the buffer. Try
1474 \"\\[describe-key] <key> RET\" for more information:
1476 \\[man] Prompt to retrieve a new manpage.
1477 \\[Man-follow-manual-reference] Retrieve reference in SEE ALSO section.
1478 \\[Man-next-manpage] Jump to next manpage in circular list.
1479 \\[Man-previous-manpage] Jump to previous manpage in circular list.
1480 \\[Man-next-section] Jump to next manpage section.
1481 \\[Man-previous-section] Jump to previous manpage section.
1482 \\[Man-goto-section] Go to a manpage section.
1483 \\[Man-goto-see-also-section] Jumps to the SEE ALSO manpage section.
1484 \\[Man-quit] Deletes the manpage window, bury its buffer.
1485 \\[Man-kill] Deletes the manpage window, kill its buffer.
1486 \\[describe-mode] Prints this help text.
1488 The following variables may be of some use. Try
1489 \"\\[describe-variable] <variable-name> RET\" for more information:
1491 `Man-notify-method' What happens when manpage is ready to display.
1492 `Man-downcase-section-letters-flag' Force section letters to lower case.
1493 `Man-circular-pages-flag' Treat multiple manpage list as circular.
1494 `Man-section-translations-alist' List of section numbers and their Un*x equiv.
1495 `Man-filter-list' Background manpage filter command.
1496 `Man-mode-map' Keymap bindings for Man mode buffers.
1497 `Man-mode-hook' Normal hook run on entry to Man mode.
1498 `Man-section-regexp' Regexp describing manpage section letters.
1499 `Man-heading-regexp' Regexp describing section headers.
1500 `Man-see-also-regexp' Regexp for SEE ALSO section (or your equiv).
1501 `Man-first-heading-regexp' Regexp for first heading on a manpage.
1502 `Man-reference-regexp' Regexp matching a references in SEE ALSO.
1503 `Man-switches' Background `man' command switches.
1505 The following key bindings are currently in effect in the buffer:
1507 (setq buffer-auto-save-file-name nil
1508 mode-line-buffer-identification
1509 (list (default-value 'mode-line-buffer-identification
)
1510 " {" 'Man-page-mode-string
"}")
1513 (buffer-disable-undo)
1515 (setq imenu-generic-expression
(list (list nil Man-heading-regexp
0)))
1516 (imenu-add-to-menubar man-imenu-title
)
1517 (set (make-local-variable 'outline-regexp
) Man-heading-regexp
)
1518 (set (make-local-variable 'outline-level
) (lambda () 1))
1519 (set (make-local-variable 'bookmark-make-record-function
)
1520 'Man-bookmark-make-record
))
1522 (defsubst Man-build-section-alist
()
1523 "Build the list of manpage sections."
1524 (setq Man--sections nil
)
1525 (goto-char (point-min))
1526 (let ((case-fold-search nil
))
1527 (while (re-search-forward Man-heading-regexp
(point-max) t
)
1528 (let ((section (match-string 1)))
1529 (unless (member section Man--sections
)
1530 (push section Man--sections
)))
1533 (defsubst Man-build-references-alist
()
1534 "Build the list of references (in the SEE ALSO section)."
1535 (setq Man--refpages nil
)
1537 (if (Man-find-section Man-see-also-regexp
)
1538 (let ((start (progn (forward-line 1) (point)))
1540 (Man-next-section 1)
1545 (narrow-to-region start end
)
1546 (goto-char (point-min))
1547 (back-to-indentation)
1548 (while (and (not (eobp)) (/= (point) runningpoint
))
1549 (setq runningpoint
(point))
1550 (if (re-search-forward Man-hyphenated-reference-regexp end t
)
1551 (let* ((word (match-string 0))
1552 (len (1- (length word
))))
1554 (setq word
(concat hyphenated word
)
1556 ;; Update len, in case a reference spans
1557 ;; more than two lines (paranoia).
1558 len
(1- (length word
))))
1559 (if (memq (aref word len
) '(?- ?Â
))
1560 (setq hyphenated
(substring word
0 len
)))
1561 (and (string-match Man-reference-regexp word
)
1562 (not (member word Man--refpages
))
1563 (push word Man--refpages
))))
1564 (skip-chars-forward " \t\n,"))))))
1565 (setq Man--refpages
(nreverse Man--refpages
)))
1567 (defun Man-build-page-list ()
1568 "Build the list of separate manpages in the buffer."
1569 (setq Man-page-list nil
)
1570 (let ((page-start (point-min))
1571 (page-end (point-max))
1573 (goto-char page-start
)
1576 (if (looking-at Man-page-header-regexp
)
1579 ;; Go past both the current and the next Man-first-heading-regexp
1580 (if (re-search-forward Man-first-heading-regexp nil
'move
2)
1581 (let ((p (progn (beginning-of-line) (point))))
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.
1587 (search-backward "\n\n" nil t
3)
1588 (if (re-search-forward Man-page-header-regexp p
'move
)
1589 (beginning-of-line))))
1590 (setq page-end
(point))
1591 (setq Man-page-list
(append Man-page-list
1592 (list (list (copy-marker page-start
)
1593 (copy-marker page-end
)
1595 (setq page-start page-end
)
1598 (defun Man-strip-page-headers ()
1599 "Strip all the page headers but the first from the manpage."
1600 (let ((inhibit-read-only t
)
1601 (case-fold-search nil
)
1603 (dolist (page Man-page-list
)
1605 (goto-char (car page
))
1606 (re-search-forward Man-first-heading-regexp nil t
)
1607 (setq header
(buffer-substring (car page
) (match-beginning 0)))
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
1615 ;; (setq header (concat "\n" header)))
1616 (while (search-forward header
(nth 1 page
) t
)
1617 (replace-match ""))))))
1619 (defun Man-unindent ()
1620 "Delete the leading spaces that indent the manpage."
1621 (let ((inhibit-read-only t
)
1622 (case-fold-search nil
))
1623 (dolist (page Man-page-list
)
1626 (narrow-to-region (car page
) (car (cdr page
)))
1627 (if Man-uses-untabify-flag
1628 ;; The space characters inserted by `untabify' inherit
1629 ;; sticky text properties, which is unnecessary and looks
1630 ;; ugly with underlining (Bug#11408).
1631 (let ((text-property-default-nonsticky
1632 (cons '(face . t
) text-property-default-nonsticky
)))
1633 (untabify (point-min) (point-max))))
1634 (if (catch 'unindent
1635 (goto-char (point-min))
1636 (if (not (re-search-forward Man-first-heading-regexp nil t
))
1637 (throw 'unindent nil
))
1639 (setq indent
(buffer-substring (point)
1641 (skip-chars-forward " ")
1643 (setq nindent
(length indent
))
1645 (throw 'unindent nil
))
1646 (setq indent
(concat indent
"\\|$"))
1647 (goto-char (point-min))
1649 (if (looking-at indent
)
1651 (throw 'unindent nil
)))
1652 (goto-char (point-min)))
1655 (delete-char nindent
))
1660 ;; ======================================================================
1661 ;; Man mode commands
1663 (defun Man-next-section (n)
1664 "Move point to Nth next section (default 1)."
1666 (let ((case-fold-search nil
)
1668 (if (looking-at Man-heading-regexp
)
1670 (if (re-search-forward Man-heading-regexp
(point-max) t n
)
1672 (goto-char (point-max))
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).
1677 (if (< (point) start
) (goto-char start
))))
1679 (defun Man-previous-section (n)
1680 "Move point to Nth previous section (default 1)."
1682 (let ((case-fold-search nil
))
1683 (if (looking-at Man-heading-regexp
)
1685 (if (re-search-backward Man-heading-regexp
(point-min) t n
)
1687 (goto-char (point-min)))))
1689 (defun Man-find-section (section)
1690 "Move point to SECTION if it exists, otherwise don't move point.
1691 Returns t if section is found, nil otherwise."
1692 (let ((curpos (point))
1693 (case-fold-search nil
))
1694 (goto-char (point-min))
1695 (if (re-search-forward (concat "^" section
) (point-max) t
)
1696 (progn (beginning-of-line) t
)
1701 (defvar Man--last-section nil
)
1703 (defun Man-goto-section (section)
1704 "Move point to SECTION."
1706 (let* ((default (if (member Man--last-section Man--sections
)
1708 (car Man--sections
)))
1709 (completion-ignore-case t
)
1710 (prompt (concat "Go to section (default " default
"): "))
1711 (chosen (completing-read prompt Man--sections
1712 nil nil nil nil default
)))
1714 (setq Man--last-section section
)
1715 (unless (Man-find-section section
)
1716 (error "Section %s not found" section
)))
1719 (defun Man-goto-see-also-section ()
1720 "Move point to the \"SEE ALSO\" section.
1721 Actually the section moved to is described by `Man-see-also-regexp'."
1723 (if (not (Man-find-section Man-see-also-regexp
))
1724 (error "%s" (concat "No " Man-see-also-regexp
1725 " section found in the current manpage"))))
1727 (defun Man-possibly-hyphenated-word ()
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
1731 line instead. Thus, if a reference to \"tcgetpgrp(3V)\" is hyphenated
1732 as \"tcgetp-grp(3V)\", and point is at \"grp(3V)\", we return
1733 \"tcgetp-\" instead of \"grp\"."
1735 (skip-syntax-backward "w()")
1736 (skip-chars-forward " \t")
1738 (word (current-word)))
1739 (when (eq beg
(save-excursion
1740 (back-to-indentation)
1743 (if (eq (char-before) ?-
)
1744 (setq word
(current-word))))
1747 (defvar Man--last-refpage nil
)
1749 (defun Man-follow-manual-reference (reference)
1750 "Get one of the manpages referred to in the \"SEE ALSO\" section.
1751 Specify which REFERENCE to use; default is based on word at point."
1753 (if (not Man--refpages
)
1754 (error "There are no references in the current man page")
1757 (car (all-completions
1759 (or (Man-possibly-hyphenated-word)
1761 ;; strip a trailing '-':
1762 (if (string-match "-$" word
)
1764 (match-beginning 0))
1767 (if (member Man--last-refpage Man--refpages
)
1769 (car Man--refpages
))))
1771 (mapcar 'substring-no-properties
1772 (cons default Man--refpages
)))
1773 (prompt (concat "Refer to (default " default
"): "))
1774 (chosen (completing-read prompt Man--refpages
1775 nil nil nil nil defaults
)))
1777 (if (not Man--refpages
)
1778 (error "Can't find any references in the current manpage")
1779 (setq Man--last-refpage reference
)
1780 (Man-getpage-in-background
1781 (Man-translate-references reference
))))
1784 "Kill the buffer containing the manpage."
1789 "Bury the buffer containing the manpage."
1793 (defun Man-goto-page (page &optional noerror
)
1794 "Go to the manual page on page PAGE."
1796 (if (not Man-page-list
)
1797 (error "Not a man page buffer")
1798 (if (= (length Man-page-list
) 1)
1799 (error "You're looking at the only manpage in the buffer")
1800 (list (read-minibuffer (format "Go to manpage [1-%d]: "
1801 (length Man-page-list
)))))))
1802 (if (and (not Man-page-list
) (not noerror
))
1803 (error "Not a man page buffer"))
1806 (> page
(length Man-page-list
)))
1807 (user-error "No manpage %d found" page
))
1808 (let* ((page-range (nth (1- page
) Man-page-list
))
1809 (page-start (car page-range
))
1810 (page-end (car (cdr page-range
))))
1811 (setq Man-current-page page
1812 Man-page-mode-string
(Man-make-page-mode-string))
1814 (goto-char page-start
)
1815 (narrow-to-region page-start page-end
)
1816 (Man-build-section-alist)
1817 (Man-build-references-alist)
1818 (goto-char (point-min)))))
1821 (defun Man-next-manpage ()
1822 "Find the next manpage entry in the buffer."
1824 (if (= (length Man-page-list
) 1)
1825 (error "This is the only manpage in the buffer"))
1826 (if (< Man-current-page
(length Man-page-list
))
1827 (Man-goto-page (1+ Man-current-page
))
1828 (if Man-circular-pages-flag
1830 (error "You're looking at the last manpage in the buffer"))))
1832 (defun Man-previous-manpage ()
1833 "Find the previous manpage entry in the buffer."
1835 (if (= (length Man-page-list
) 1)
1836 (error "This is the only manpage in the buffer"))
1837 (if (> Man-current-page
1)
1838 (Man-goto-page (1- Man-current-page
))
1839 (if Man-circular-pages-flag
1840 (Man-goto-page (length Man-page-list
))
1841 (error "You're looking at the first manpage in the buffer"))))
1843 ;; Header file support
1844 (defun Man-view-header-file (file)
1845 "View a header file specified by FILE from `Man-header-file-path'."
1846 (let ((path Man-header-file-path
)
1849 (setq complete-path
(expand-file-name file
(car path
))
1851 (if (file-readable-p complete-path
)
1852 (progn (view-file complete-path
)
1854 (setq complete-path nil
)))
1857 ;;; Bookmark Man Support
1858 (declare-function bookmark-make-record-default
1859 "bookmark" (&optional no-file no-context posn
))
1860 (declare-function bookmark-prop-get
"bookmark" (bookmark prop
))
1861 (declare-function bookmark-default-handler
"bookmark" (bmk))
1862 (declare-function bookmark-get-bookmark-record
"bookmark" (bmk))
1864 (defun Man-default-bookmark-title ()
1865 "Default bookmark name for Man or WoMan pages.
1866 Uses `Man-name-local-regexp'."
1868 (goto-char (point-min))
1869 (when (re-search-forward Man-name-local-regexp nil t
)
1870 (skip-chars-forward "\n\t ")
1871 (buffer-substring-no-properties (point) (line-end-position)))))
1873 (defun Man-bookmark-make-record ()
1874 "Make a bookmark entry for a Man buffer."
1875 `(,(Man-default-bookmark-title)
1876 ,@(bookmark-make-record-default 'no-file
)
1877 (location .
,(concat "man " Man-arguments
))
1878 (man-args .
,Man-arguments
)
1879 (handler . Man-bookmark-jump
)))
1882 (defun Man-bookmark-jump (bookmark)
1883 "Default bookmark handler for Man buffers."
1884 (let* ((man-args (bookmark-prop-get bookmark
'man-args
))
1885 ;; Let bookmark.el do the window handling.
1886 ;; This let-binding needs to be active during the call to both
1887 ;; Man-getpage-in-background and accept-process-output.
1888 (Man-notify-method 'meek
)
1889 (buf (Man-getpage-in-background man-args
))
1890 (proc (get-buffer-process buf
)))
1891 (while (and proc
(eq (process-status proc
) 'run
))
1892 (accept-process-output proc
))
1893 (bookmark-default-handler
1894 `("" (buffer .
,buf
) .
,(bookmark-get-bookmark-record bookmark
)))))
1897 ;; Init the man package variables, if not already done.
1902 ;;; man.el ends here