1 ;;; man.el --- browse UNIX manual pages -*- coding: iso-8859-1 -*-
3 ;; Copyright (C) 1993, 1994, 1996, 1997, 2001, 2002, 2003, 2004, 2005,
4 ;; 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Author: Barry A. Warsaw <bwarsaw@cen.com>
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 Potorti` <pot@cnuce.cnr.it> cleaned it up thoroughly,
59 ;; making it faster, more robust and more tolerant of different
60 ;; systems' man idiosyncrasies.
62 ;; ========== Features ==========
63 ;; + Runs "man" in the background and pipes the results through a
64 ;; series of sed and awk scripts so that all retrieving and cleaning
65 ;; is done in the background. The cleaning commands are configurable.
66 ;; + Syntax is the same as Un*x man
67 ;; + Functionality is the same as Un*x man, including "man -k" and
68 ;; "man <section>", etc.
69 ;; + Provides a manual browsing mode with keybindings for traversing
70 ;; the sections of a manpage, following references in the SEE ALSO
72 ;; + Multiple manpages created with the same man command are put into
73 ;; a narrowed buffer circular list.
75 ;; ============= TODO ===========
76 ;; - Add a command for printing.
77 ;; - The awk script deletes multiple blank lines. This behavior does
78 ;; not allow to understand if there was indeed a blank line at the
79 ;; end or beginning of a page (after the header, or before the
80 ;; footer). A different algorithm should be used. It is easy to
81 ;; compute how many blank lines there are before and after the page
82 ;; headers, and after the page footer. But it is possible to compute
83 ;; the number of blank lines before the page footer by heuristics
84 ;; only. Is it worth doing?
85 ;; - Allow a user option to mean that all the manpages should go in
86 ;; the same buffer, where they can be browsed with M-n and M-p.
91 (eval-when-compile (require 'cl
))
95 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
96 ;; empty defvars (keep the compiler quiet)
99 "Browse UNIX manual pages."
105 (defcustom Man-filter-list nil
106 "Manpage cleaning filter command phrases.
107 This variable contains a list of the following form:
109 '((command-string phrase-string*)*)
111 Each phrase-string is concatenated onto the command-string to form a
112 command filter. The (standard) output (and standard error) of the Un*x
113 man command is piped through each command filter in the order the
114 commands appear in the association list. The final output is placed in
116 :type
'(repeat (list (string :tag
"Command String")
118 (string :tag
"Phrase String"))))
121 (defvar Man-uses-untabify-flag t
122 "Non-nil means use `untabify' instead of `Man-untabify-command'.")
123 (defvar Man-sed-script nil
124 "Script for sed to nuke backspaces and ANSI codes from manpages.")
126 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
129 (defcustom Man-fontify-manpage-flag t
130 "Non-nil means make up the manpage with fonts."
134 (defcustom Man-overstrike-face
'bold
135 "Face to use when fontifying overstrike."
139 (defcustom Man-underline-face
'underline
140 "Face to use when fontifying underlining."
144 (defcustom Man-reverse-face
'highlight
145 "Face to use when fontifying reverse video."
149 ;; Use the value of the obsolete user option Man-notify, if set.
150 (defcustom Man-notify-method
(if (boundp 'Man-notify
) Man-notify
'friendly
)
151 "Selects the behavior when manpage is ready.
152 This variable may have one of the following values, where (sf) means
153 that the frames are switched, so the manpage is displayed in the frame
154 where the man command was called from:
156 newframe -- put the manpage in its own frame (see `Man-frame-parameters')
157 pushy -- make the manpage the current buffer in the current window
158 bully -- make the manpage the current buffer and only window (sf)
159 aggressive -- make the manpage the current buffer in the other window (sf)
160 friendly -- display manpage in the other window but don't make current (sf)
161 polite -- don't display manpage, but prints message and beep when ready
162 quiet -- like `polite', but don't beep
163 meek -- make no indication that the manpage is ready
165 Any other value of `Man-notify-method' is equivalent to `meek'."
166 :type
'(radio (const newframe
) (const pushy
) (const bully
)
167 (const aggressive
) (const friendly
)
168 (const polite
) (const quiet
) (const meek
))
171 (defcustom Man-width nil
172 "Number of columns for which manual pages should be formatted.
173 If nil, the width of the window selected at the moment of man
174 invocation is used. If non-nil, the width of the frame selected
175 at the moment of man invocation is used. The value also can be a
177 :type
'(choice (const :tag
"Window width" nil
)
178 (const :tag
"Frame width" t
)
179 (integer :tag
"Specific width" :value
65))
182 (defcustom Man-frame-parameters nil
183 "Frame parameter list for creating a new frame for a manual page."
187 (defcustom Man-downcase-section-letters-flag t
188 "Non-nil means letters in sections are converted to lower case.
189 Some Un*x man commands can't handle uppercase letters in sections, for
190 example \"man 2V chmod\", but they are often displayed in the manpage
191 with the upper case letter. When this variable is t, the section
192 letter (e.g., \"2V\") is converted to lowercase (e.g., \"2v\") before
193 being sent to the man background process."
197 (defcustom Man-circular-pages-flag t
198 "Non-nil means the manpage list is treated as circular for traversal."
202 (defcustom Man-section-translations-alist
205 ;; Some systems have a real 3x man section, so let's comment this.
206 ;; '("3X" . "3") ; Xlib man pages
209 "Association list of bogus sections to real section numbers.
210 Some manpages (e.g. the Sun C++ 2.1 manpages) have section numbers in
211 their references which Un*x `man' does not recognize. This
212 association list is used to translate those sections, when found, to
213 the associated section number."
214 :type
'(repeat (cons (string :tag
"Bogus Section")
215 (string :tag
"Real Section")))
218 (defcustom Man-header-file-path
219 '("/usr/include" "/usr/local/include")
220 "C Header file search path used in Man."
221 :type
'(repeat string
)
224 (defvar manual-program
"man"
225 "The name of the program that produces man pages.")
227 (defvar Man-untabify-command
"pr"
228 "Command used for untabifying.")
230 (defvar Man-untabify-command-args
(list "-t" "-e")
231 "List of arguments to be passed to `Man-untabify-command' (which see).")
233 (defvar Man-sed-command
"sed"
234 "Command used for processing sed scripts.")
236 (defvar Man-awk-command
"awk"
237 "Command used for processing awk scripts.")
239 (defvar Man-mode-hook nil
240 "Hook run when Man mode is enabled.")
242 (defvar Man-cooked-hook nil
243 "Hook run after removing backspaces but before `Man-mode' processing.")
245 (defvar Man-name-regexp
"[-a-zA-Z0-9_+][-a-zA-Z0-9_.:+]*"
246 "Regular expression describing the name of a manpage (without section).")
248 (defvar Man-section-regexp
"[0-9][a-zA-Z0-9+]*\\|[LNln]"
249 "Regular expression describing a manpage section within parentheses.")
251 (defvar Man-page-header-regexp
252 (if (and (string-match "-solaris2\\." system-configuration
)
253 (not (string-match "-solaris2\\.[123435]$" system-configuration
)))
254 (concat "^[-A-Za-z0-9_].*[ \t]\\(" Man-name-regexp
255 "(\\(" Man-section-regexp
"\\))\\)$")
256 (concat "^[ \t]*\\(" Man-name-regexp
257 "(\\(" Man-section-regexp
"\\))\\).*\\1"))
258 "Regular expression describing the heading of a page.")
260 (defvar Man-heading-regexp
"^\\([A-Z][A-Z0-9 /-]+\\)$"
261 "Regular expression describing a manpage heading entry.")
263 (defvar Man-see-also-regexp
"SEE ALSO"
264 "Regular expression for SEE ALSO heading (or your equivalent).
265 This regexp should not start with a `^' character.")
267 ;; This used to have leading space [ \t]*, but was removed because it
268 ;; causes false page splits on an occasional NAME with leading space
269 ;; inside a manpage. And `Man-heading-regexp' doesn't have [ \t]* anyway.
270 (defvar Man-first-heading-regexp
"^NAME$\\|^[ \t]*No manual entry fo.*$"
271 "Regular expression describing first heading on a manpage.
272 This regular expression should start with a `^' character.")
274 (defvar Man-reference-regexp
275 (concat "\\(" Man-name-regexp
"\\)[ \t]*(\\(" Man-section-regexp
"\\))")
276 "Regular expression describing a reference to another manpage.")
278 (defvar Man-apropos-regexp
279 (concat "\\\[\\(" Man-name-regexp
"\\)\\\][ \t]*(\\(" Man-section-regexp
"\\))")
280 "Regular expression describing a reference to manpages in \"man -k output\".")
282 (defvar Man-synopsis-regexp
"SYNOPSIS"
283 "Regular expression for SYNOPSIS heading (or your equivalent).
284 This regexp should not start with a `^' character.")
286 (defvar Man-files-regexp
"FILES"
287 "Regular expression for FILES heading (or your equivalent).
288 This regexp should not start with a `^' character.")
290 (defvar Man-include-regexp
"#[ \t]*include[ \t]*"
291 "Regular expression describing the #include (directive of cpp).")
293 (defvar Man-file-name-regexp
"[^<>\", \t\n]+"
294 "Regular expression describing <> in #include line (directive of cpp).")
296 (defvar Man-normal-file-prefix-regexp
"[/~$]"
297 "Regular expression describing a file path appeared in FILES section.")
299 (defvar Man-header-regexp
300 (concat "\\(" Man-include-regexp
"\\)"
302 "\\(" Man-file-name-regexp
"\\)"
304 "Regular expression describing references to header files.")
306 (defvar Man-normal-file-regexp
307 (concat Man-normal-file-prefix-regexp Man-file-name-regexp
)
308 "Regular expression describing references to normal files.")
310 ;; This includes the section as an optional part to catch hyphenated
311 ;; refernces to manpages.
312 (defvar Man-hyphenated-reference-regexp
313 (concat "\\(" Man-name-regexp
"\\)\\((\\(" Man-section-regexp
"\\))\\)?")
314 "Regular expression describing a reference in the SEE ALSO section.")
316 (defvar Man-switches
""
317 "Switches passed to the man command, as a single string.
319 If you want to be able to see all the manpages for a subject you type,
320 make -a one of the switches, if your `man' program supports it.")
322 (defvar Man-specified-section-option
323 (if (string-match "-solaris[0-9.]*$" system-configuration
)
326 "Option that indicates a specified a manual section name.")
328 (defvar Man-support-local-filenames
'auto-detect
329 "Internal cache for the value of the function `Man-support-local-filenames'.
330 `auto-detect' means the value is not yet determined.
331 Otherwise, the value is whatever the function
332 `Man-support-local-filenames' should return.")
334 ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
335 ;; end user variables
337 ;; other variables and keymap initializations
338 (defvar Man-original-frame
)
339 (make-variable-buffer-local 'Man-original-frame
)
340 (defvar Man-arguments
)
341 (make-variable-buffer-local 'Man-arguments
)
342 (put 'Man-arguments
'permanent-local t
)
344 (defvar Man-sections-alist nil
)
345 (make-variable-buffer-local 'Man-sections-alist
)
346 (defvar Man-refpages-alist nil
)
347 (make-variable-buffer-local 'Man-refpages-alist
)
348 (defvar Man-page-list nil
)
349 (make-variable-buffer-local 'Man-page-list
)
350 (defvar Man-current-page
0)
351 (make-variable-buffer-local 'Man-current-page
)
352 (defvar Man-page-mode-string
"1 of 1")
353 (make-variable-buffer-local 'Man-page-mode-string
)
355 (defconst Man-sysv-sed-script
"\
364 /\e\\[[0-9][0-9]*m/ s///g"
365 "Script for sysV-like sed to nuke backspaces and ANSI codes from manpages.")
367 (defconst Man-berkeley-sed-script
"\
373 s/\\(.\\)\b\\1/\\1/g\\
376 /\e\\[[0-9][0-9]*m/ s///g"
377 "Script for berkeley-like sed to nuke backspaces and ANSI codes from manpages.")
379 (defvar Man-topic-history nil
"Topic read history.")
381 (defvar man-mode-syntax-table
382 (let ((table (copy-syntax-table (standard-syntax-table))))
383 (modify-syntax-entry ?.
"w" table
)
384 (modify-syntax-entry ?_
"w" table
)
385 (modify-syntax-entry ?
: "w" table
) ; for PDL::Primitive in Perl man pages
387 "Syntax table used in Man mode buffers.")
390 (let ((map (make-sparse-keymap)))
391 (suppress-keymap map
)
392 (set-keymap-parent map button-buffer-map
)
394 (define-key map
" " 'scroll-up
)
395 (define-key map
"\177" 'scroll-down
)
396 (define-key map
"n" 'Man-next-section
)
397 (define-key map
"p" 'Man-previous-section
)
398 (define-key map
"\en" 'Man-next-manpage
)
399 (define-key map
"\ep" 'Man-previous-manpage
)
400 (define-key map
">" 'end-of-buffer
)
401 (define-key map
"<" 'beginning-of-buffer
)
402 (define-key map
"." 'beginning-of-buffer
)
403 (define-key map
"r" 'Man-follow-manual-reference
)
404 (define-key map
"g" 'Man-goto-section
)
405 (define-key map
"s" 'Man-goto-see-also-section
)
406 (define-key map
"k" 'Man-kill
)
407 (define-key map
"q" 'Man-quit
)
408 (define-key map
"m" 'man
)
409 ;; Not all the man references get buttons currently. The text in the
410 ;; manual page can contain references to other man pages
411 (define-key map
"\r" 'man-follow
)
412 (define-key map
"?" 'describe-mode
)
414 "Keymap for Man mode.")
417 (define-button-type 'Man-abstract-xref-man-page
419 'help-echo
"mouse-2, RET: display this man page"
421 'action
#'Man-xref-button-action
)
423 (defun Man-xref-button-action (button)
424 (let ((target (button-get button
'Man-target-string
)))
426 (button-get button
'func
)
428 (button-label button
))
430 (funcall target
(button-start button
)))
433 (define-button-type 'Man-xref-man-page
434 :supertype
'Man-abstract-xref-man-page
438 (define-button-type 'Man-xref-header-file
439 'action
(lambda (button)
440 (let ((w (button-get button
'Man-target-string
)))
441 (unless (Man-view-header-file w
)
442 (error "Cannot find header file: %s" w
))))
444 'help-echo
"mouse-2: display this header file")
446 (define-button-type 'Man-xref-normal-file
447 'action
(lambda (button)
448 (let ((f (substitute-in-file-name
449 (button-get button
'Man-target-string
))))
450 (if (file-exists-p f
)
451 (if (file-readable-p f
)
453 (error "Cannot read a file: %s" f
))
454 (error "Cannot find a file: %s" f
))))
456 'help-echo
"mouse-2: display this file")
459 ;; ======================================================================
462 (defun Man-init-defvars ()
463 "Used for initializing variables based on display's color support.
464 This is necessary if one wants to dump man.el with Emacs."
466 ;; Avoid possible error in call-process by using a directory that must exist.
467 (let ((default-directory "/"))
470 (Man-fontify-manpage-flag
472 ((eq 0 (call-process Man-sed-command nil nil nil Man-sysv-sed-script
))
474 ((eq 0 (call-process Man-sed-command nil nil nil Man-berkeley-sed-script
))
475 Man-berkeley-sed-script
)
479 (setq Man-filter-list
480 ;; Avoid trailing nil which confuses customize.
484 (if (eq system-type
'windows-nt
)
485 ;; Windows needs ".." quoting, not '..'.
487 "-e \"/Reformatting page. Wait/d\""
488 "-e \"/Reformatting entry. Wait/d\""
489 "-e \"/^[ \t][ \t]*-[ \t][0-9]*[ \t]-[ \t]*Formatted:.*[0-9]$/d\""
490 "-e \"/^[ \t]*Page[ \t][0-9]*.*(printed[ \t][0-9\\/]*)$/d\""
491 "-e \"/^Printed[ \t][0-9].*[0-9]$/d\""
492 "-e \"/^[ \t]*X[ \t]Version[ \t]1[01].*Release[ \t][0-9]/d\""
493 "-e \"/^[A-Za-z].*Last[ \t]change:/d\""
494 "-e \"/[ \t]*Copyright [0-9]* UNIX System Laboratories, Inc.$/d\""
495 "-e \"/^[ \t]*Rev\\..*Page [0-9][0-9]*$/d\"")
498 (concat "-e '" Man-sed-script
"'")
500 "-e '/^[\001-\032][\001-\032]*$/d'"
501 "-e '/\e[789]/s///g'"
502 "-e '/Reformatting page. Wait/d'"
503 "-e '/Reformatting entry. Wait/d'"
504 "-e '/^[ \t]*Hewlett-Packard[ \t]Company[ \t]*-[ \t][0-9]*[ \t]-/d'"
505 "-e '/^[ \t]*Hewlett-Packard[ \t]*-[ \t][0-9]*[ \t]-.*$/d'"
506 "-e '/^[ \t][ \t]*-[ \t][0-9]*[ \t]-[ \t]*Formatted:.*[0-9]$/d'"
507 "-e '/^[ \t]*Page[ \t][0-9]*.*(printed[ \t][0-9\\/]*)$/d'"
508 "-e '/^Printed[ \t][0-9].*[0-9]$/d'"
509 "-e '/^[ \t]*X[ \t]Version[ \t]1[01].*Release[ \t][0-9]/d'"
510 "-e '/^[A-Za-z].*Last[ \t]change:/d'"
511 "-e '/^Sun[ \t]Release[ \t][0-9].*[0-9]$/d'"
512 "-e '/[ \t]*Copyright [0-9]* UNIX System Laboratories, Inc.$/d'"
513 "-e '/^[ \t]*Rev\\..*Page [0-9][0-9]*$/d'"
515 ;; Windows doesn't support multi-line commands, so don't
517 (unless (eq system-type
'windows-nt
)
522 "BEGIN { blankline=0; anonblank=0; }\n"
523 "/^$/ { if (anonblank==0) next; }\n"
525 "/^$/ { blankline++; next; }\n"
526 "{ if (blankline>0) { print \"\"; blankline=0; } print $0; }\n"
529 (if (not Man-uses-untabify-flag
)
530 ;; The outer list will be stripped off by apply.
533 Man-untabify-command-args
))
537 (defsubst Man-make-page-mode-string
()
538 "Formats part of the mode line for Man mode."
539 (format "%s page %d of %d"
540 (or (nth 2 (nth (1- Man-current-page
) Man-page-list
))
543 (length Man-page-list
)))
545 (defsubst Man-build-man-command
()
546 "Builds the entire background manpage and cleaning command."
547 (let ((command (concat manual-program
" " Man-switches
550 ((string-match "%s" manual-program
) "")
551 ;; Stock MS-DOS shells cannot redirect stderr;
552 ;; `call-process' below sends it to /dev/null,
553 ;; so we don't need `2>' even with DOS shells
554 ;; which do support stderr redirection.
555 ((not (fboundp 'start-process
)) " %s")
556 ((concat " %s 2>" null-device
)))))
557 (flist Man-filter-list
))
558 (while (and flist
(car flist
))
559 (let ((pcom (car (car flist
)))
560 (pargs (cdr (car flist
))))
562 (concat command
" | " pcom
" "
563 (mapconcat (lambda (phrase)
564 (if (not (stringp phrase
))
565 (error "Malformed Man-filter-list"))
568 (setq flist
(cdr flist
))))
572 (defun Man-translate-cleanup (string)
573 "Strip leading, trailing and middle spaces."
574 (when (stringp string
)
575 ;; Strip leading and trailing
576 (if (string-match "^[ \t\f\r\n]*\\(.+[^ \t\f\r\n]\\)" string
)
577 (setq string
(match-string 1 string
)))
579 (setq string
(replace-regexp-in-string "[\t\r\n]" " " string
))
580 (setq string
(replace-regexp-in-string " +" " " string
))
583 (defun Man-translate-references (ref)
584 "Translates REF from \"chmod(2V)\" to \"2v chmod\" style.
585 Leave it as is if already in that style. Possibly downcase and
586 translate the section (see the `Man-downcase-section-letters-flag'
587 and the `Man-section-translations-alist' variables)."
590 (slist Man-section-translations-alist
))
591 (setq ref
(Man-translate-cleanup ref
))
593 ;; "chmod(2V)" case ?
594 ((string-match (concat "^" Man-reference-regexp
"$") ref
)
595 (setq name
(match-string 1 ref
)
596 section
(match-string 2 ref
)))
598 ((string-match (concat "^\\(" Man-section-regexp
599 "\\) +\\(" Man-name-regexp
"\\)$") ref
)
600 (setq name
(match-string 2 ref
)
601 section
(match-string 1 ref
))))
602 (if (string= name
"")
603 ref
; Return the reference as is
604 (if Man-downcase-section-letters-flag
605 (setq section
(downcase section
)))
607 (let ((s1 (car (car slist
)))
608 (s2 (cdr (car slist
))))
609 (setq slist
(cdr slist
))
610 (if Man-downcase-section-letters-flag
611 (setq s1
(downcase s1
)))
612 (if (not (string= s1 section
)) nil
613 (setq section
(if Man-downcase-section-letters-flag
617 (concat Man-specified-section-option section
" " name
))))
619 (defun Man-support-local-filenames ()
620 "Check the availability of `-l' option of the man command.
621 This option allows `man' to interpret command line arguments
623 Return the value of the variable `Man-support-local-filenames'
624 if it was set to nil or t before the call of this function.
625 If t, the man command supports `-l' option. If nil, it doesn't.
626 Otherwise, if the value of `Man-support-local-filenames'
627 is neither t nor nil, then determine a new value, set it
628 to the variable `Man-support-local-filenames' and return
630 (if (or (not Man-support-local-filenames
)
631 (eq Man-support-local-filenames t
))
632 Man-support-local-filenames
633 (setq Man-support-local-filenames
635 (and (equal (condition-case nil
636 (let ((default-directory
637 ;; Assure that `default-directory' exists
639 (if (and (file-directory-p default-directory
)
640 (file-readable-p default-directory
))
642 (expand-file-name "~/"))))
643 (call-process manual-program nil t nil
"--help"))
647 (goto-char (point-min))
648 (search-forward "--local-file" nil t
))
652 ;; ======================================================================
653 ;; default man entry: get word near point
655 (defun Man-default-man-entry (&optional pos
)
656 "Guess default manual entry based on the text near position POS.
657 POS defaults to `point'."
658 (let (word start column distance
)
660 (when pos
(goto-char pos
))
662 ;; The default title is the nearest entry-like object before or
664 (if (and (skip-chars-backward " \ta-zA-Z0-9+")
665 (not (zerop (skip-chars-backward "(")))
666 ;; Try to handle the special case where POS is on a
669 (concat "([ \t]*\\(" Man-section-regexp
"\\)[ \t]*)"))
670 ;; We skipped a valid section number backwards, look at
672 (or (and (skip-chars-backward ",; \t")
673 (not (zerop (skip-chars-backward "-a-zA-Z0-9._+:"))))
674 ;; Not a valid entry, move POS after closing paren.
675 (not (setq pos
(match-end 0)))))
676 ;; We have a candidate, make `start' record its starting
679 ;; Otherwise look at char before POS.
681 (if (not (zerop (skip-chars-backward "-a-zA-Z0-9._+:")))
682 ;; Our candidate is just before or around POS.
684 ;; Otherwise record the current column and look backwards.
685 (setq column
(current-column))
686 (skip-chars-backward ",; \t")
687 ;; Record the distance travelled.
688 (setq distance
(- column
(current-column)))
690 (concat "([ \t]*\\(?:" Man-section-regexp
"\\)[ \t]*)"))
691 ;; Skip section number backwards.
692 (goto-char (match-beginning 0))
693 (skip-chars-backward " \t"))
694 (if (not (zerop (skip-chars-backward "-a-zA-Z0-9._+:")))
696 ;; We have a candidate before POS ...
699 (if (and (skip-chars-forward ",; \t")
700 (< (- (current-column) column
) distance
)
701 (looking-at "[-a-zA-Z0-9._+:]"))
702 ;; ... but the one after POS is better.
704 ;; ... and anything after POS is worse.
706 ;; No candidate before POS.
708 (skip-chars-forward ",; \t")
709 (setq start
(point)))))
710 ;; We have found a suitable starting point, try to skip at least
712 (skip-chars-forward "-a-zA-Z0-9._+:")
713 (setq word
(buffer-substring-no-properties start
(point)))
714 ;; If there is a continuation at the end of line, check the
715 ;; following line too, eg:
718 ;; Note: This code gets executed iff our entry is after POS.
719 (when (looking-at "[ \t\r\n]+\\([-a-zA-Z0-9._+:]+\\)([0-9])")
720 (setq word
(concat word
(match-string-no-properties 1)))
721 ;; Make sure the section number gets included by the code below.
722 (goto-char (match-end 1)))
723 (when (string-match "[._]+$" word
)
724 (setq word
(substring word
0 (match-beginning 0))))
725 ;; The following was commented out since the preceding code
726 ;; should not produce a leading "*" in the first place.
727 ;;; ;; If looking at something like *strcat(... , remove the '*'
728 ;;; (when (string-match "^*" word)
729 ;;; (setq word (substring word 1)))
732 (and (not (string-equal word
""))
733 ;; If looking at something like ioctl(2) or brc(1M),
734 ;; include the section number in the returned value.
736 (concat "[ \t]*([ \t]*\\(" Man-section-regexp
"\\)[ \t]*)"))
737 (format "(%s)" (match-string-no-properties 1)))))))
740 ;; ======================================================================
741 ;; Top level command and background process sentinel
743 ;; For compatibility with older versions.
745 (defalias 'manual-entry
'man
)
747 (defvar Man-completion-cache nil
748 ;; On my machine, "man -k" is so fast that a cache makes no sense,
749 ;; but apparently that's not the case in all cases, so let's add a cache.
750 "Cache of completion table of the form (PREFIX . TABLE).")
752 (defun Man-completion-table (string pred action
)
755 (not (string-match "([^)]*\\'" string
)))
757 (let ((table (cdr Man-completion-cache
))
760 (when (string-match "\\`\\([[:digit:]].*?\\) " string
)
761 (setq section
(match-string 1 string
))
762 (setq prefix
(substring string
(match-end 0))))
763 (unless (and Man-completion-cache
764 (string-prefix-p (car Man-completion-cache
) prefix
))
766 (setq default-directory
"/") ;; in case inherited doesn't exist
767 ;; Actually for my `man' the arg is a regexp.
768 ;; POSIX says it must be ERE and "man-db" seems to agree,
769 ;; whereas under MacOSX it seems to be BRE-style and doesn't
770 ;; accept backslashes at all. Let's not bother to
772 (let ((process-environment (copy-sequence process-environment
)))
773 (setenv "COLUMNS" "999") ;; don't truncate long names
774 ;; manual-program might not even exist. And since it's
775 ;; run differently in Man-getpage-in-background, an error
776 ;; here may not necessarily mean that we'll also get an
779 (call-process manual-program nil
'(t nil
) nil
780 "-k" (concat "^" prefix
))))
781 (goto-char (point-min))
782 (while (re-search-forward "^\\([^ \t\n]+\\)\\(?: ?\\((.+?)\\)\\(?:[ \t]+- \\(.*\\)\\)?\\)?" nil t
)
783 (push (propertize (concat (match-string 1) (match-string 2))
784 'help-echo
(match-string 3))
786 ;; Cache the table for later reuse.
787 (setq Man-completion-cache
(cons prefix table
)))
788 ;; The table may contain false positives since the match is made
789 ;; by "man -k" not just on the manpage's name.
791 (let ((re (concat "(" (regexp-quote section
) ")\\'")))
792 (dolist (comp (prog1 table
(setq table nil
)))
793 (if (string-match re comp
)
794 (push (substring comp
0 (match-beginning 0)) table
)))
795 (completion-table-with-context (concat section
" ") table
797 ;; If the current text looks like a possible section name,
798 ;; then add a completion entry that just adds a space so SPC
799 ;; can be used to insert a space.
800 (if (string-match "\\`[[:digit:]]" string
)
801 (push (concat string
" ") table
))
802 (let ((res (complete-with-action action table string pred
)))
803 ;; In case we're completing to a single name that exists in
804 ;; several sections, the longest prefix will look like "foo(".
805 (if (and (stringp res
)
806 (string-match "([^(]*\\'" res
)
807 ;; In case the paren was already in `prefix', don't
809 (> (match-beginning 0) (length prefix
)))
810 (substring res
0 (match-beginning 0))
814 (defun man (man-args)
815 "Get a Un*x manual page and put it in a buffer.
816 This command is the top-level command in the man package. It
817 runs a Un*x command to retrieve and clean a manpage in the
818 background and places the results in a `Man-mode' browsing
819 buffer. See variable `Man-notify-method' for what happens when
820 the buffer is ready. If a buffer already exists for this man
821 page, it will display immediately.
823 For a manpage from a particular section, use either of the
824 following. \"cat(1)\" is how cross-references appear and is
825 passed to man as \"1 cat\".
830 To see manpages from all sections related to a subject, use an
831 \"all pages\" option (which might be \"-a\" if it's not the
832 default), then step through with `Man-next-manpage' (\\<Man-mode-map>\\[Man-next-manpage]) etc.
833 Add to `Man-switches' to make this option permanent.
837 An explicit filename can be given too. Use -l if it might
838 otherwise look like a page name.
843 An \"apropos\" query with -k gives a buffer of matching page
844 names or descriptions. The pattern argument is usually an
845 \"egrep\" style regexp.
850 (list (let* ((default-entry (Man-default-man-entry))
851 ;; ignore case because that's friendly for bizarre
852 ;; caps things like the X11 function names and because
853 ;; "man" itself is case-sensitive on the command line
854 ;; so you're accustomed not to bother about the case
855 ;; ("man -k" is case-insensitive similarly, so the
856 ;; table has everything available to complete)
857 (completion-ignore-case t
)
858 (input (completing-read
859 (format "Manual entry%s"
860 (if (string= default-entry
"")
862 (format " (default %s): " default-entry
)))
863 'Man-completion-table
864 nil nil nil
'Man-topic-history default-entry
)))
865 (if (string= input
"")
866 (error "No man args given")
869 ;; Possibly translate the "subject(section)" syntax into the
870 ;; "section subject" syntax and possibly downcase the section.
871 (setq man-args
(Man-translate-references man-args
))
873 (Man-getpage-in-background man-args
))
876 (defun man-follow (man-args)
877 "Get a Un*x manual page of the item under point and put it in a buffer."
878 (interactive (list (Man-default-man-entry)))
879 (if (or (not man-args
)
880 (string= man-args
""))
881 (error "No item under point")
884 (defun Man-getpage-in-background (topic)
885 "Use TOPIC to build and fire off the manpage and cleaning command."
886 (let* ((man-args topic
)
887 (bufname (concat "*Man " man-args
"*"))
888 (buffer (get-buffer bufname
)))
890 (Man-notify-when-ready buffer
)
892 (message "Invoking %s %s in the background" manual-program man-args
)
893 (setq buffer
(generate-new-buffer bufname
))
894 (with-current-buffer buffer
895 (setq buffer-undo-list t
)
896 (setq Man-original-frame
(selected-frame))
897 (setq Man-arguments man-args
))
898 (let ((process-environment (copy-sequence process-environment
))
899 ;; The following is so Awk script gets \n intact
900 ;; But don't prevent decoding of the outside.
901 (coding-system-for-write 'raw-text-unix
)
902 ;; We must decode the output by a coding system that the
903 ;; system's locale suggests in multibyte mode.
904 (coding-system-for-read
905 (if (default-value 'enable-multibyte-characters
)
906 locale-coding-system
'raw-text-unix
))
907 ;; Avoid possible error by using a directory that always exists.
909 (if (and (file-directory-p default-directory
)
910 (not (find-file-name-handler default-directory
914 ;; Prevent any attempt to use display terminal fanciness.
915 (setenv "TERM" "dumb")
916 ;; In Debian Woody, at least, we get overlong lines under X
917 ;; unless COLUMNS or MANWIDTH is set. This isn't a problem on
918 ;; a tty. man(1) says:
920 ;; If $MANWIDTH is set, its value is used as the line
921 ;; length for which manual pages should be formatted.
922 ;; If it is not set, manual pages will be formatted
923 ;; with a line length appropriate to the current ter-
924 ;; minal (using an ioctl(2) if available, the value of
925 ;; $COLUMNS, or falling back to 80 characters if nei-
926 ;; ther is available).
927 (unless (or (getenv "MANWIDTH") (getenv "COLUMNS"))
928 ;; This isn't strictly correct, since we don't know how
929 ;; the page will actually be displayed, but it seems
931 (setenv "COLUMNS" (number-to-string
933 ((and (integerp Man-width
) (> Man-width
0))
935 (Man-width (frame-width))
937 (setenv "GROFF_NO_SGR" "1")
938 ;; Since man-db 2.4.3-1, man writes plain text with no escape
939 ;; sequences when stdout is not a tty. In 2.5.0, the following
940 ;; env-var was added to allow control of this (see Debian Bug#340673).
941 (setenv "MAN_KEEP_FORMATTING" "1")
942 (if (fboundp 'start-process
)
943 (set-process-sentinel
944 (start-process manual-program buffer
945 (if (memq system-type
'(cygwin windows-nt
))
949 (format (Man-build-man-command) man-args
))
950 'Man-bgproc-sentinel
)
952 (call-process shell-file-name nil
(list buffer nil
) nil
954 (format (Man-build-man-command) man-args
)))
956 (or (and (numberp exit-status
)
958 (and (numberp exit-status
)
960 (format "exited abnormally with code %d"
962 (setq msg exit-status
))
963 (Man-bgproc-sentinel bufname msg
)))))))
965 (defun Man-notify-when-ready (man-buffer)
966 "Notify the user when MAN-BUFFER is ready.
967 See the variable `Man-notify-method' for the different notification behaviors."
968 (let ((saved-frame (with-current-buffer man-buffer
969 Man-original-frame
)))
971 ((eq Man-notify-method
'newframe
)
972 ;; Since we run asynchronously, perhaps while Emacs is waiting
973 ;; for input, we must not leave a different buffer current. We
974 ;; can't rely on the editor command loop to reselect the
975 ;; selected window's buffer.
977 (let ((frame (make-frame Man-frame-parameters
)))
978 (set-window-buffer (frame-selected-window frame
) man-buffer
)
979 (set-window-dedicated-p (frame-selected-window frame
) t
)
980 (or (display-multi-frame-p frame
)
981 (select-frame frame
)))))
982 ((eq Man-notify-method
'pushy
)
983 (switch-to-buffer man-buffer
))
984 ((eq Man-notify-method
'bully
)
985 (and (frame-live-p saved-frame
)
986 (select-frame saved-frame
))
987 (pop-to-buffer man-buffer
)
988 (delete-other-windows))
989 ((eq Man-notify-method
'aggressive
)
990 (and (frame-live-p saved-frame
)
991 (select-frame saved-frame
))
992 (pop-to-buffer man-buffer
))
993 ((eq Man-notify-method
'friendly
)
994 (and (frame-live-p saved-frame
)
995 (select-frame saved-frame
))
996 (display-buffer man-buffer
'not-this-window
))
997 ((eq Man-notify-method
'polite
)
999 (message "Manual buffer %s is ready" (buffer-name man-buffer
)))
1000 ((eq Man-notify-method
'quiet
)
1001 (message "Manual buffer %s is ready" (buffer-name man-buffer
)))
1002 ((or (eq Man-notify-method
'meek
)
1007 (defun Man-softhyphen-to-minus ()
1008 ;; \255 is SOFT HYPHEN in Latin-N. Versions of Debian man, at
1009 ;; least, emit it even when not in a Latin-N locale.
1010 (unless (eq t
(compare-strings "latin-" 0 nil
1011 current-language-environment
0 6 t
))
1012 (goto-char (point-min))
1014 (if enable-multibyte-characters
1015 (setq str
(string-as-multibyte str
)))
1016 (while (search-forward str nil t
) (replace-match "-")))))
1018 (defun Man-fontify-manpage ()
1019 "Convert overstriking and underlining to the correct fonts.
1020 Same for the ANSI bold and normal escape sequences."
1022 (message "Please wait: formatting the %s man page..." Man-arguments
)
1023 (goto-char (point-min))
1024 ;; Fontify ANSI escapes.
1026 (buffer-undo-list t
)
1028 ;; http://www.isthe.com/chongo/tech/comp/ansi_escapes.html
1029 ;; suggests many codes, but we only handle:
1030 ;; ESC [ 00 m reset to normal display
1032 ;; ESC [ 04 m underline
1033 ;; ESC [ 07 m reverse-video
1034 ;; ESC [ 22 m no-bold
1035 ;; ESC [ 24 m no-underline
1036 ;; ESC [ 27 m no-reverse-video
1037 (while (re-search-forward "\e\\[0?\\([1470]\\|2\\([247]\\)\\)m" nil t
)
1038 (if faces
(put-text-property start
(match-beginning 0) 'face
1039 (if (cdr faces
) faces
(car faces
))))
1042 ((match-beginning 2)
1043 (delq (case (char-after (match-beginning 2))
1044 (?
2 Man-overstrike-face
)
1045 (?
4 Man-underline-face
)
1046 (?
7 Man-reverse-face
))
1048 ((eq (char-after (match-beginning 1)) ?
0) nil
)
1050 (cons (case (char-after (match-beginning 1))
1051 (?
1 Man-overstrike-face
)
1052 (?
4 Man-underline-face
)
1053 (?
7 Man-reverse-face
))
1055 (delete-region (match-beginning 0) (match-end 0))
1056 (setq start
(point))))
1057 ;; Other highlighting.
1058 (let ((buffer-undo-list t
))
1059 (if (< (buffer-size) (position-bytes (point-max)))
1060 ;; Multibyte characters exist.
1062 (goto-char (point-min))
1063 (while (search-forward "__\b\b" nil t
)
1064 (backward-delete-char 4)
1065 (put-text-property (point) (1+ (point)) 'face Man-underline-face
))
1066 (goto-char (point-min))
1067 (while (search-forward "\b\b__" nil t
)
1068 (backward-delete-char 4)
1069 (put-text-property (1- (point)) (point) 'face Man-underline-face
))))
1070 (goto-char (point-min))
1071 (while (search-forward "_\b" nil t
)
1072 (backward-delete-char 2)
1073 (put-text-property (point) (1+ (point)) 'face Man-underline-face
))
1074 (goto-char (point-min))
1075 (while (search-forward "\b_" nil t
)
1076 (backward-delete-char 2)
1077 (put-text-property (1- (point)) (point) 'face Man-underline-face
))
1078 (goto-char (point-min))
1079 (while (re-search-forward "\\(.\\)\\(\b+\\1\\)+" nil t
)
1080 (replace-match "\\1")
1081 (put-text-property (1- (point)) (point) 'face Man-overstrike-face
))
1082 (goto-char (point-min))
1083 (while (re-search-forward "o\b\\+\\|\\+\bo" nil t
)
1085 (put-text-property (1- (point)) (point) 'face
'bold
))
1086 (goto-char (point-min))
1087 (while (re-search-forward "[-|]\\(\b[-|]\\)+" nil t
)
1089 (put-text-property (1- (point)) (point) 'face
'bold
))
1090 ;; When the header is longer than the manpage name, groff tries to
1091 ;; condense it to a shorter line interspered with ^H. Remove ^H with
1092 ;; their preceding chars (but don't put Man-overstrike-face). (Bug#5566)
1093 (goto-char (point-min))
1094 (while (re-search-forward ".\b" nil t
) (backward-delete-char 2))
1095 (goto-char (point-min))
1096 ;; Try to recognize common forms of cross references.
1097 (Man-highlight-references)
1098 (Man-softhyphen-to-minus)
1099 (goto-char (point-min))
1100 (while (re-search-forward Man-heading-regexp nil t
)
1101 (put-text-property (match-beginning 0)
1103 'face Man-overstrike-face
)))
1104 (message "%s man page formatted" Man-arguments
))
1106 (defun Man-highlight-references (&optional xref-man-type
)
1107 "Highlight the references on mouse-over.
1108 References include items in the SEE ALSO section,
1109 header file (#include <foo.h>), and files in FILES.
1110 If optional argument XREF-MAN-TYPE is non-nil, it used as the
1111 button type for items in SEE ALSO section. If it is nil, the
1112 default type, `Man-xref-man-page' is used for the buttons."
1113 ;; `Man-highlight-references' is used from woman.el, too.
1114 ;; woman.el doesn't set `Man-arguments'.
1115 (unless Man-arguments
1116 (setq Man-arguments
""))
1117 (if (string-match "-k " Man-arguments
)
1119 (Man-highlight-references0 nil Man-reference-regexp
1
1120 'Man-default-man-entry
1121 (or xref-man-type
'Man-xref-man-page
))
1122 (Man-highlight-references0 nil Man-apropos-regexp
1
1123 'Man-default-man-entry
1124 (or xref-man-type
'Man-xref-man-page
)))
1125 (Man-highlight-references0 Man-see-also-regexp Man-reference-regexp
1
1126 'Man-default-man-entry
1127 (or xref-man-type
'Man-xref-man-page
))
1128 (Man-highlight-references0 Man-synopsis-regexp Man-header-regexp
0 2
1129 'Man-xref-header-file
)
1130 (Man-highlight-references0 Man-files-regexp Man-normal-file-regexp
0 0
1131 'Man-xref-normal-file
)))
1133 (defun Man-highlight-references0 (start-section regexp button-pos target type
)
1134 ;; Based on `Man-build-references-alist'
1135 (when (or (null start-section
)
1136 (Man-find-section start-section
))
1137 (let ((end (if start-section
1140 (back-to-indentation)
1142 (Man-next-section 1)
1144 (goto-char (point-min))
1146 (while (re-search-forward regexp end t
)
1148 (match-beginning button-pos
)
1149 (match-end button-pos
)
1151 'Man-target-string
(cond
1153 (match-string target
))
1158 (defun Man-cleanup-manpage (&optional interactive
)
1159 "Remove overstriking and underlining from the current buffer.
1160 Normally skip any jobs that should have been done by the sed script,
1161 but when called interactively, do those jobs even if the sed
1162 script would have done them."
1164 (message "Please wait: cleaning up the %s man page..."
1166 (if (or interactive
(not Man-sed-script
))
1168 (goto-char (point-min))
1169 (while (search-forward "_\b" nil t
) (backward-delete-char 2))
1170 (goto-char (point-min))
1171 (while (search-forward "\b_" nil t
) (backward-delete-char 2))
1172 (goto-char (point-min))
1173 (while (re-search-forward "\\(.\\)\\(\b\\1\\)+" nil t
)
1174 (replace-match "\\1"))
1175 (goto-char (point-min))
1176 (while (re-search-forward "\e\\[[0-9]+m" nil t
) (replace-match ""))
1177 (goto-char (point-min))
1178 (while (re-search-forward "o\b\\+\\|\\+\bo" nil t
) (replace-match "o"))
1180 (goto-char (point-min))
1181 (while (re-search-forward "[-|]\\(\b[-|]\\)+" nil t
) (replace-match "+"))
1182 ;; When the header is longer than the manpage name, groff tries to
1183 ;; condense it to a shorter line interspered with ^H. Remove ^H with
1184 ;; their preceding chars (but don't put Man-overstrike-face). (Bug#5566)
1185 (goto-char (point-min))
1186 (while (re-search-forward ".\b" nil t
) (backward-delete-char 2))
1187 (Man-softhyphen-to-minus)
1188 (message "%s man page cleaned up" Man-arguments
))
1190 (defun Man-bgproc-sentinel (process msg
)
1191 "Manpage background process sentinel.
1192 When manpage command is run asynchronously, PROCESS is the process
1193 object for the manpage command; when manpage command is run
1194 synchronously, PROCESS is the name of the buffer where the manpage
1195 command is run. Second argument MSG is the exit message of the
1197 (let ((Man-buffer (if (stringp process
) (get-buffer process
)
1198 (process-buffer process
)))
1202 (if (null (buffer-name Man-buffer
)) ;; deleted buffer
1203 (or (stringp process
)
1204 (set-process-buffer process nil
))
1206 (with-current-buffer Man-buffer
1207 (let ((case-fold-search nil
))
1208 (goto-char (point-min))
1209 (cond ((or (looking-at "No \\(manual \\)*entry for")
1210 (looking-at "[^\n]*: nothing appropriate$"))
1211 (setq err-mess
(buffer-substring (point)
1213 (end-of-line) (point)))
1216 ;; "-k foo", successful exit, but no output (from man-db)
1217 ;; ENHANCE-ME: share the check for -k with
1218 ;; `Man-highlight-references'. The \\s- bits here are
1219 ;; meant to allow for multiple options with -k among them.
1220 ((and (string-match "\\(\\`\\|\\s-\\)-k\\s-" Man-arguments
)
1221 (eq (process-status process
) 'exit
)
1222 (= (process-exit-status process
) 0)
1223 (= (point-min) (point-max)))
1224 (setq err-mess
(format "%s: no matches" Man-arguments
)
1227 ((or (stringp process
)
1228 (not (and (eq (process-status process
) 'exit
)
1229 (= (process-exit-status process
) 0))))
1230 (or (zerop (length msg
))
1233 (concat (buffer-name Man-buffer
)
1235 (let ((eos (1- (length msg
))))
1236 (if (= (aref msg eos
) ?
\n)
1237 (substring msg
0 eos
) msg
))))
1238 (goto-char (point-max))
1239 (insert (format "\nprocess %s" msg
))))
1242 (kill-buffer Man-buffer
)
1243 (if Man-fontify-manpage-flag
1244 (Man-fontify-manpage)
1245 (Man-cleanup-manpage))
1247 (run-hooks 'Man-cooked-hook
)
1250 (if (not Man-page-list
)
1251 (let ((args Man-arguments
))
1252 (kill-buffer (current-buffer))
1253 (error "Can't find the %s manpage" args
)))
1255 (set-buffer-modified-p nil
)
1257 ;; Restore case-fold-search before calling
1258 ;; Man-notify-when-ready because it may switch buffers.
1260 (if (not delete-buff
)
1261 (Man-notify-when-ready Man-buffer
))
1264 (error "%s" err-mess
))
1268 ;; ======================================================================
1269 ;; set up manual mode in buffer and build alists
1271 (put 'Man-mode
'mode-class
'special
)
1274 "A mode for browsing Un*x manual pages.
1276 The following man commands are available in the buffer. Try
1277 \"\\[describe-key] <key> RET\" for more information:
1279 \\[man] Prompt to retrieve a new manpage.
1280 \\[Man-follow-manual-reference] Retrieve reference in SEE ALSO section.
1281 \\[Man-next-manpage] Jump to next manpage in circular list.
1282 \\[Man-previous-manpage] Jump to previous manpage in circular list.
1283 \\[Man-next-section] Jump to next manpage section.
1284 \\[Man-previous-section] Jump to previous manpage section.
1285 \\[Man-goto-section] Go to a manpage section.
1286 \\[Man-goto-see-also-section] Jumps to the SEE ALSO manpage section.
1287 \\[Man-quit] Deletes the manpage window, bury its buffer.
1288 \\[Man-kill] Deletes the manpage window, kill its buffer.
1289 \\[describe-mode] Prints this help text.
1291 The following variables may be of some use. Try
1292 \"\\[describe-variable] <variable-name> RET\" for more information:
1294 `Man-notify-method' What happens when manpage formatting is done.
1295 `Man-downcase-section-letters-flag' Force section letters to lower case.
1296 `Man-circular-pages-flag' Treat multiple manpage list as circular.
1297 `Man-section-translations-alist' List of section numbers and their Un*x equiv.
1298 `Man-filter-list' Background manpage filter command.
1299 `Man-mode-map' Keymap bindings for Man mode buffers.
1300 `Man-mode-hook' Normal hook run on entry to Man mode.
1301 `Man-section-regexp' Regexp describing manpage section letters.
1302 `Man-heading-regexp' Regexp describing section headers.
1303 `Man-see-also-regexp' Regexp for SEE ALSO section (or your equiv).
1304 `Man-first-heading-regexp' Regexp for first heading on a manpage.
1305 `Man-reference-regexp' Regexp matching a references in SEE ALSO.
1306 `Man-switches' Background `man' command switches.
1308 The following key bindings are currently in effect in the buffer:
1311 (kill-all-local-variables)
1312 (setq major-mode
'Man-mode
1314 buffer-auto-save-file-name nil
1315 mode-line-buffer-identification
1316 (list (default-value 'mode-line-buffer-identification
)
1317 " {" 'Man-page-mode-string
"}")
1320 (buffer-disable-undo)
1322 (use-local-map Man-mode-map
)
1323 (set-syntax-table man-mode-syntax-table
)
1324 (setq imenu-generic-expression
(list (list nil Man-heading-regexp
0)))
1325 (set (make-local-variable 'outline-regexp
) Man-heading-regexp
)
1326 (set (make-local-variable 'outline-level
) (lambda () 1))
1327 (Man-build-page-list)
1328 (Man-strip-page-headers)
1331 (run-mode-hooks 'Man-mode-hook
))
1333 (defsubst Man-build-section-alist
()
1334 "Build the association list of manpage sections."
1335 (setq Man-sections-alist nil
)
1336 (goto-char (point-min))
1337 (let ((case-fold-search nil
))
1338 (while (re-search-forward Man-heading-regexp
(point-max) t
)
1339 (aput 'Man-sections-alist
(match-string 1))
1342 (defsubst Man-build-references-alist
()
1343 "Build the association list of references (in the SEE ALSO section)."
1344 (setq Man-refpages-alist nil
)
1346 (if (Man-find-section Man-see-also-regexp
)
1347 (let ((start (progn (forward-line 1) (point)))
1349 (Man-next-section 1)
1354 (narrow-to-region start end
)
1355 (goto-char (point-min))
1356 (back-to-indentation)
1357 (while (and (not (eobp)) (/= (point) runningpoint
))
1358 (setq runningpoint
(point))
1359 (if (re-search-forward Man-hyphenated-reference-regexp end t
)
1360 (let* ((word (match-string 0))
1361 (len (1- (length word
))))
1363 (setq word
(concat hyphenated word
)
1365 ;; Update len, in case a reference spans
1366 ;; more than two lines (paranoia).
1367 len
(1- (length word
))))
1368 (if (memq (aref word len
) '(?- ?
))
1369 (setq hyphenated
(substring word
0 len
)))
1370 (if (string-match Man-reference-regexp word
)
1371 (aput 'Man-refpages-alist word
))))
1372 (skip-chars-forward " \t\n,"))))))
1373 (setq Man-refpages-alist
(nreverse Man-refpages-alist
)))
1375 (defun Man-build-page-list ()
1376 "Build the list of separate manpages in the buffer."
1377 (setq Man-page-list nil
)
1378 (let ((page-start (point-min))
1379 (page-end (point-max))
1381 (goto-char page-start
)
1382 ;; (switch-to-buffer (current-buffer))(debug)
1385 (if (looking-at Man-page-header-regexp
)
1388 ;; Go past both the current and the next Man-first-heading-regexp
1389 (if (re-search-forward Man-first-heading-regexp nil
'move
2)
1390 (let ((p (progn (beginning-of-line) (point))))
1391 ;; We assume that the page header is delimited by blank
1392 ;; lines and that it contains at most one blank line. So
1393 ;; if we back by three blank lines we will be sure to be
1394 ;; before the page header but not before the possible
1395 ;; previous page header.
1396 (search-backward "\n\n" nil t
3)
1397 (if (re-search-forward Man-page-header-regexp p
'move
)
1398 (beginning-of-line))))
1399 (setq page-end
(point))
1400 (setq Man-page-list
(append Man-page-list
1401 (list (list (copy-marker page-start
)
1402 (copy-marker page-end
)
1404 (setq page-start page-end
)
1407 (defun Man-strip-page-headers ()
1408 "Strip all the page headers but the first from the manpage."
1409 (let ((inhibit-read-only t
)
1410 (case-fold-search nil
)
1412 (dolist (page Man-page-list
)
1414 (goto-char (car page
))
1415 (re-search-forward Man-first-heading-regexp nil t
)
1416 (setq header
(buffer-substring (car page
) (match-beginning 0)))
1417 ;; Since the awk script collapses all successive blank
1418 ;; lines into one, and since we don't want to get rid of
1419 ;; the fast awk script, one must choose between adding
1420 ;; spare blank lines between pages when there were none and
1421 ;; deleting blank lines at page boundaries when there were
1422 ;; some. We choose the first, so we comment the following
1424 ;; (setq header (concat "\n" header)))
1425 (while (search-forward header
(nth 1 page
) t
)
1426 (replace-match ""))))))
1428 (defun Man-unindent ()
1429 "Delete the leading spaces that indent the manpage."
1430 (let ((inhibit-read-only t
)
1431 (case-fold-search nil
))
1432 (dolist (page Man-page-list
)
1435 (narrow-to-region (car page
) (car (cdr page
)))
1436 (if Man-uses-untabify-flag
1437 (untabify (point-min) (point-max)))
1438 (if (catch 'unindent
1439 (goto-char (point-min))
1440 (if (not (re-search-forward Man-first-heading-regexp nil t
))
1441 (throw 'unindent nil
))
1443 (setq indent
(buffer-substring (point)
1445 (skip-chars-forward " ")
1447 (setq nindent
(length indent
))
1449 (throw 'unindent nil
))
1450 (setq indent
(concat indent
"\\|$"))
1451 (goto-char (point-min))
1453 (if (looking-at indent
)
1455 (throw 'unindent nil
)))
1456 (goto-char (point-min)))
1459 (delete-char nindent
))
1464 ;; ======================================================================
1465 ;; Man mode commands
1467 (defun Man-next-section (n)
1468 "Move point to Nth next section (default 1)."
1470 (let ((case-fold-search nil
)
1472 (if (looking-at Man-heading-regexp
)
1474 (if (re-search-forward Man-heading-regexp
(point-max) t n
)
1476 (goto-char (point-max))
1477 ;; The last line doesn't belong to any section.
1479 ;; But don't move back from the starting point (can happen if `start'
1480 ;; is somewhere on the last line).
1481 (if (< (point) start
) (goto-char start
))))
1483 (defun Man-previous-section (n)
1484 "Move point to Nth previous section (default 1)."
1486 (let ((case-fold-search nil
))
1487 (if (looking-at Man-heading-regexp
)
1489 (if (re-search-backward Man-heading-regexp
(point-min) t n
)
1491 (goto-char (point-min)))))
1493 (defun Man-find-section (section)
1494 "Move point to SECTION if it exists, otherwise don't move point.
1495 Returns t if section is found, nil otherwise."
1496 (let ((curpos (point))
1497 (case-fold-search nil
))
1498 (goto-char (point-min))
1499 (if (re-search-forward (concat "^" section
) (point-max) t
)
1500 (progn (beginning-of-line) t
)
1505 (defun Man-goto-section ()
1506 "Query for section to move point to."
1508 (aput 'Man-sections-alist
1509 (let* ((default (aheadsym Man-sections-alist
))
1510 (completion-ignore-case t
)
1512 (prompt (concat "Go to section (default " default
"): ")))
1513 (setq chosen
(completing-read prompt Man-sections-alist
))
1514 (if (or (not chosen
)
1515 (string= chosen
""))
1518 (unless (Man-find-section (aheadsym Man-sections-alist
))
1519 (error "Section not found")))
1522 (defun Man-goto-see-also-section ()
1523 "Move point to the \"SEE ALSO\" section.
1524 Actually the section moved to is described by `Man-see-also-regexp'."
1526 (if (not (Man-find-section Man-see-also-regexp
))
1527 (error "%s" (concat "No " Man-see-also-regexp
1528 " section found in the current manpage"))))
1530 (defun Man-possibly-hyphenated-word ()
1531 "Return a possibly hyphenated word at point.
1532 If the word starts at the first non-whitespace column, and the
1533 previous line ends with a hyphen, return the last word on the previous
1534 line instead. Thus, if a reference to \"tcgetpgrp(3V)\" is hyphenated
1535 as \"tcgetp-grp(3V)\", and point is at \"grp(3V)\", we return
1536 \"tcgetp-\" instead of \"grp\"."
1538 (skip-syntax-backward "w()")
1539 (skip-chars-forward " \t")
1541 (word (current-word)))
1542 (when (eq beg
(save-excursion
1543 (back-to-indentation)
1546 (if (eq (char-before) ?-
)
1547 (setq word
(current-word))))
1550 (defun Man-follow-manual-reference (reference)
1551 "Get one of the manpages referred to in the \"SEE ALSO\" section.
1552 Specify which REFERENCE to use; default is based on word at point."
1554 (if (not Man-refpages-alist
)
1555 (error "There are no references in the current man page")
1558 (car (all-completions
1560 (or (Man-possibly-hyphenated-word)
1562 ;; strip a trailing '-':
1563 (if (string-match "-$" word
)
1565 (match-beginning 0))
1567 Man-refpages-alist
))
1568 (aheadsym Man-refpages-alist
)))
1570 (mapcar 'substring-no-properties
1572 (delq nil
(cons default
1573 (mapcar 'car Man-refpages-alist
))))))
1575 (prompt (concat "Refer to (default " default
"): ")))
1576 (setq chosen
(completing-read prompt Man-refpages-alist
1577 nil nil nil nil defaults
))
1578 (if (or (not chosen
)
1579 (string= chosen
""))
1582 (if (not Man-refpages-alist
)
1583 (error "Can't find any references in the current manpage")
1584 (aput 'Man-refpages-alist reference
)
1585 (Man-getpage-in-background
1586 (Man-translate-references (aheadsym Man-refpages-alist
)))))
1589 "Kill the buffer containing the manpage."
1594 "Bury the buffer containing the manpage."
1598 (defun Man-goto-page (page &optional noerror
)
1599 "Go to the manual page on page PAGE."
1601 (if (not Man-page-list
)
1602 (error "Not a man page buffer")
1603 (if (= (length Man-page-list
) 1)
1604 (error "You're looking at the only manpage in the buffer")
1605 (list (read-minibuffer (format "Go to manpage [1-%d]: "
1606 (length Man-page-list
)))))))
1607 (if (and (not Man-page-list
) (not noerror
))
1608 (error "Not a man page buffer"))
1611 (> page
(length Man-page-list
)))
1612 (error "No manpage %d found" page
))
1613 (let* ((page-range (nth (1- page
) Man-page-list
))
1614 (page-start (car page-range
))
1615 (page-end (car (cdr page-range
))))
1616 (setq Man-current-page page
1617 Man-page-mode-string
(Man-make-page-mode-string))
1619 (goto-char page-start
)
1620 (narrow-to-region page-start page-end
)
1621 (Man-build-section-alist)
1622 (Man-build-references-alist)
1623 (goto-char (point-min)))))
1626 (defun Man-next-manpage ()
1627 "Find the next manpage entry in the buffer."
1629 (if (= (length Man-page-list
) 1)
1630 (error "This is the only manpage in the buffer"))
1631 (if (< Man-current-page
(length Man-page-list
))
1632 (Man-goto-page (1+ Man-current-page
))
1633 (if Man-circular-pages-flag
1635 (error "You're looking at the last manpage in the buffer"))))
1637 (defun Man-previous-manpage ()
1638 "Find the previous manpage entry in the buffer."
1640 (if (= (length Man-page-list
) 1)
1641 (error "This is the only manpage in the buffer"))
1642 (if (> Man-current-page
1)
1643 (Man-goto-page (1- Man-current-page
))
1644 (if Man-circular-pages-flag
1645 (Man-goto-page (length Man-page-list
))
1646 (error "You're looking at the first manpage in the buffer"))))
1648 ;; Header file support
1649 (defun Man-view-header-file (file)
1650 "View a header file specified by FILE from `Man-header-file-path'."
1651 (let ((path Man-header-file-path
)
1654 (setq complete-path
(expand-file-name file
(car path
))
1656 (if (file-readable-p complete-path
)
1657 (progn (view-file complete-path
)
1659 (setq complete-path nil
)))
1662 ;; Init the man package variables, if not already done.
1665 (add-to-list 'debug-ignored-errors
"^No manpage [0-9]* found$")
1666 (add-to-list 'debug-ignored-errors
"^Can't find the .* manpage$")
1670 ;; arch-tag: 587cda76-8e23-4594-b1f3-89b6b09a0d47
1671 ;;; man.el ends here