1 ;;; man.el --- browse UNIX manual pages
3 ;; Copyright (C) 1993 Free Software Foundation, Inc.
5 ;; Author: Barry A. Warsaw <bwarsaw@cen.com>
6 ;; Last-Modified: 31-Jul-1991
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 2, or (at your option)
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; see the file COPYING. If not, write to
25 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
29 ;; This code provides a function, manual-entry, with which you can
30 ;; browse UNIX manual pages. Formatting is done in background so that
31 ;; you can continue to use your Emacs while processing is going on.
33 ;; The mode also supports hypertext-like following of manual page SEE
34 ;; ALSO references, and other features. See below or do `?' in a
35 ;; manual page buffer for details.
37 ;; ========== Credits and History ==========
38 ;; In mid 1991, several people posted some interesting improvements to
39 ;; man.el from the standard emacs 18.57 distribution. I liked many of
40 ;; these, but wanted everthing in one single package, so I decided
41 ;; to encorporate them into a single manual browsing mode. While
42 ;; much of the code here has been rewritten, and some features added,
43 ;; these folks deserve lots of credit for providing the initial
44 ;; excellent packages on which this one is based.
46 ;; Nick Duffek <duffek@chaos.cs.brandeis.edu>, posted a very nice
47 ;; improvement which retrieved and cleaned the manpages in a
48 ;; background process, and which correctly deciphered such options as
51 ;; Eric Rose <erose@jessica.stanford.edu>, submitted manual.el which
52 ;; provided a very nice manual browsing mode.
54 ;; This package was available as `superman.el' from the LCD package
55 ;; for some time before it was accepted into Emacs 19. The entry
56 ;; point and some other names have been changed to make it a drop-in
57 ;; replacement for the old man.el package.
59 ;; ========== Features ==========
60 ;; + Runs "man" in the background and pipes the results through a
61 ;; series of sed and awk scripts so that all retrieving and cleaning
62 ;; is done in the background. The cleaning commands are configurable.
63 ;; + Syntax is the same as Un*x man
64 ;; + Functionality is the same as Un*x man, including "man -k" and
65 ;; "man <section>", etc.
66 ;; + Provides a manual browsing mode with keybindings for traversing
67 ;; the sections of a manpage, following references in the SEE ALSO
69 ;; + Multiple manpages created with the same man command are put into
70 ;; a narrowed buffer circular list.
76 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
79 (defvar manual-program
"man"
80 "The name of the program that produces man pages.")
82 (defvar Man-notify
'friendly
83 "*Selects the behavior when manpage is ready.
84 This variable may have one of the following values:
86 newframe -- put the manpage in its own frame (see `Man-frame-parameters')
87 bully -- make the manpage the current buffer and only window
88 aggressive -- make the manpage the current buffer in the other window
89 friendly -- display manpage in other window but don't make current
90 polite -- don't display manpage, but prints message when ready (beeps)
91 quiet -- like `polite', but don't beep
92 meek -- make no indication that manpage is ready
94 Any other value of `Man-notify' is equivalent to `meek'.")
96 (defvar Man-frame-parameters nil
97 "*Frame parameter list for creating a new frame for a manual page.")
99 (defvar Man-reuse-okay-p t
100 "*Reuse a manpage buffer if possible.
101 When t, and a manpage buffer already exists with the same invocation,
102 man just indicates the manpage is ready according to the value of
103 `Man-notify'. When nil, it always fires off a background process, putting
104 the results in a uniquely named buffer.")
106 (defvar Man-downcase-section-letters-p t
107 "*Letters in sections are converted to lower case.
108 Some Un*x man commands can't handle uppercase letters in sections, for
109 example \"man 2V chmod\", but they are often displayed in the manpage
110 with the upper case letter. When this variable is t, the section
111 letter (e.g., \"2V\") is converted to lowercase (e.g., \"2v\") before
112 being sent to the man background process.")
114 (defvar Man-circular-pages-p t
115 "*If t, the manpage list is treated as circular for traversal.")
117 ;; I changed this to nil because it is a bad idea
118 ;; to fail to recognize things in other sections.
119 (defvar Man-auto-section-alist
121 ;; '((c-mode . ("2" "3"))
122 ;; (c++-mode . ("2" "3"))
123 ;; (c++-c-mode . ("2" "3"))
124 ;; (shell-mode . ("1" "8"))
125 ;; (cmushell-mode . ("1" "8"))
128 "*Association list of major modes and their default section numbers.
129 List is of the form: (MAJOR-MODE . [SECTION | (SECTION*)]). If current
130 major mode is not in list, then the default is to check for manpages
133 (defvar Man-section-translations-alist
135 ("3X" .
"3") ; Xlib man pages
138 "*Association list of bogus sections to real section numbers.
139 Some manpages (e.g. the Sun C++ 2.1 manpages) have section numbers in
140 their references which Un*x `man' does not recognize. This
141 association list is used to translate those sections, when found, to
142 the associated section number.")
144 (defvar Man-filter-list
147 "-e '/[Nn]o such file or directory/d'"
148 "-e '/Reformatting page. Wait/d'"
149 "-e '/Reformatting entry. Wait/d'"
150 "-e '/^ *\\([A-Za-z][A-Za-z.]*([0-9A-Za-z][-0-9A-Za-z+]*)\\).*\\1$/d'"
151 "-e '/^[ \\t]*Hewlett-Packard Company[ \\t]*- [0-9]* -.*$/d'"
152 "-e '/^[ \\t]*Hewlett-Packard[ \\t]*- [0-9]* -.*$/d'"
153 "-e '/^ *- [0-9]* - *Formatted:.*[0-9]$/d'"
154 "-e '/^ *Page [0-9]*.*(printed [0-9\\/]*)$/d'"
155 "-e '/^Printed [0-9].*[0-9]$/d'"
156 "-e '/^[ \\t]*X Version 1[01].*Release [0-9]/d'"
157 "-e '/^[A-za-z].*Last change:/d'"
158 "-e '/^Sun Release [0-9].*[0-9]$/d'"
162 ("BEGIN { blankline=0; anonblank=0; }\n"
163 "/^$/ { if (anonblank==0) next; }\n"
165 "/^$/ { blankline++; next; }\n"
166 "{ if (blankline>0) { print \"\"; blankline=0; } print $0; }\n"
170 "*Manpage cleaning filter command phrases.
171 This variable contains an association list of the following form:
173 '((command-string (phrase-string*))*)
175 Each phrase-string is concatenated onto the command-string to form a
176 command filter. The (standard) output (and standard error) of the Un*x
177 man command is piped through each command filter in the order the
178 commands appear in the association list. The final output is placed in
179 the manpage buffer.")
181 (defvar Man-mode-line-format
182 '("" mode-line-modified
183 mode-line-buffer-identification
" "
185 " " Man-page-mode-string
186 " %[(" mode-name minor-mode-alist mode-line-process
")%]----"
188 "*Mode line format for manual mode buffer.")
190 (defvar Man-mode-map nil
191 "*Keymap for Man mode.")
193 (defvar Man-mode-hook nil
194 "*Normal hook run when Man mode is enabled.")
196 (defvar Man-cooked-hook nil
197 "*Normal hook run after removing backspaces but before Man-mode processing.")
199 (defvar Man-section-regexp
"[0-9][a-zA-Z+]*\\|[LNln]"
200 "*Regular expression describing a manpage section within parentheses.")
202 (defvar Man-heading-regexp
"^ ?[A-Z]"
203 "*Regular expression describing a manpage heading entry.")
205 (defvar Man-see-also-regexp
"SEE ALSO"
206 "*Regular expression for SEE ALSO heading (or your equivalent).
207 This regexp should not start with a `^' character.")
209 (defvar Man-first-heading-regexp
"^ ?NAME$\\|^ ?No manual entry for .*$"
210 "*Regular expression describing first heading on a manpage.
211 This regular expression should start with a `^' character.")
213 (defvar Man-reference-regexp
214 "[-a-zA-Z0-9_][-a-zA-Z0-9_.]*\\(([0-9][a-zA-Z+]*)\\)?"
215 "*Regular expression describing a reference in the SEE ALSO section.")
217 (defvar Man-switches
""
218 "*Switches passed to the man command, as a single string.")
220 ;; Would someone like to provide a good test for being on Solaris?
221 ;; We could give it its own value of system-type, but that has drawbacks;
222 ;; it would require changes in lots of places that test system-type.
223 (defvar Man-specified-section-option
224 (if (string-match "-solaris[0-9.]*$" system-configuration
)
227 "*Option that indicates a specified a manual section name.")
229 ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
230 ;; end user variables
232 ;; other variables and keymap initializations
233 (make-variable-buffer-local 'Man-sections-alist
)
234 (make-variable-buffer-local 'Man-refpages-alist
)
235 (make-variable-buffer-local 'Man-page-list
)
236 (make-variable-buffer-local 'Man-current-page
)
237 (make-variable-buffer-local 'Man-page-mode-string
)
238 (make-variable-buffer-local 'Man-original-frame
)
240 (setq-default Man-sections-alist nil
)
241 (setq-default Man-refpages-alist nil
)
242 (setq-default Man-page-list nil
)
243 (setq-default Man-current-page
0)
244 (setq-default Man-page-mode-string
"1 (of 1)")
248 (setq Man-mode-map
(make-keymap))
249 (suppress-keymap Man-mode-map
)
250 (define-key Man-mode-map
" " 'scroll-up
)
251 (define-key Man-mode-map
"\177" 'scroll-down
)
252 (define-key Man-mode-map
"n" 'Man-next-section
)
253 (define-key Man-mode-map
"p" 'Man-previous-section
)
254 (define-key Man-mode-map
"\en" 'Man-next-manpage
)
255 (define-key Man-mode-map
"\ep" 'Man-previous-manpage
)
256 (define-key Man-mode-map
"," 'beginning-of-buffer
)
257 (define-key Man-mode-map
"." 'end-of-buffer
)
258 (define-key Man-mode-map
"r" 'Man-follow-manual-reference
)
259 (define-key Man-mode-map
"t" 'toggle-truncate-lines
)
260 (define-key Man-mode-map
"g" 'Man-goto-section
)
261 (define-key Man-mode-map
"s" 'Man-goto-see-also-section
)
262 (define-key Man-mode-map
"q" 'Man-quit
)
263 (define-key Man-mode-map
"m" 'manual-entry
)
264 (define-key Man-mode-map
"?" 'describe-mode
)
268 ;; ======================================================================
271 (defun Man-page-mode-string ()
272 "Formats part of the mode line for Man mode."
273 (format "%d (of %d)" Man-current-page
(length Man-page-list
)))
275 (defun Man-delete-trailing-newline (str)
276 (if (string= (substring str
(1- (length str
))) "\n")
277 (substring str
0 (1- (length str
)))
280 (defun Man-build-man-command ()
281 "Builds the entire background manpage and cleaning command."
282 (let ((command (concat "man " Man-switches
" %s 2>/dev/null"))
283 (flist Man-filter-list
))
285 (let ((pcom (car (car flist
)))
286 (pargs (car (cdr (car flist
)))))
287 (setq flist
(cdr flist
))
288 (if (or (not (stringp pcom
))
290 (error "malformed Man-filter-list."))
291 (setq command
(concat command
" | " pcom
292 (mapconcat '(lambda (phrase) phrase
)
296 (defun Man-downcase (man-args)
297 "Downcases section letters in MAN-ARGS."
301 (len (length man-args
)))
302 (while (and (< s len
)
303 (setq mstart
(string-match Man-section-regexp man-args s
)))
304 (setq mend
(match-end 0)
305 newargs
(concat newargs
(substring man-args s mstart
)))
306 (setq newargs
(concat newargs
(downcase
307 (substring man-args mstart mend
)))
309 (concat newargs
(substring man-args s len
))))
311 (defun Man-translate-references (ref)
312 "Translates REF from \"chmod(2V)\" to \"2v chmod\" style."
313 (if (string-match (concat "(" Man-section-regexp
")$") ref
)
314 (let* ((word (progn (string-match "(" ref
)
315 (substring ref
0 (1- (match-end 0)))))
316 (section-re (concat "(\\(" Man-section-regexp
"\\))"))
317 (section (if (string-match section-re ref
)
318 (substring ref
(match-beginning 1) (match-end 1))
320 (slist Man-section-translations-alist
)
322 (if Man-downcase-section-letters-p
323 (setq section
(Man-downcase section
)))
325 (let ((s1 (car (car slist
)))
326 (s2 (cdr (car slist
))))
327 (setq slist
(cdr slist
))
328 (if Man-downcase-section-letters-p
329 (setq s1
(Man-downcase s1
)))
330 (if (not (string= s1 section
)) nil
331 (setq section
(if Man-downcase-section-letters-p
335 (concat Man-specified-section-option section
" " word
))
338 (defun Man-linepos (&optional position col-p
)
339 "Return the character position at various line/buffer positions.
340 Preserves the state of point, mark, etc. Optional arg POSITION can be one
341 of the following symbols:
342 bol == beginning of line
343 boi == beginning of indentation
344 eol == end of line [default]
345 bob == beginning of buffer
348 Optional arg COL-P, if non-nil, means to return
349 the current column instead of character position."
353 ((eq position
'bol
) (beginning-of-line))
354 ((eq position
'boi
) (back-to-indentation))
355 ((eq position
'bob
) (goto-char (point-min)))
356 ((eq position
'eob
) (goto-char (point-max)))
358 (setq rval
(if col-p
(current-column) (point)))
363 ;; ======================================================================
364 ;; default man entry and get word under point
366 (defun Man-default-man-args (manword)
367 "Build the default man args from MANWORD and buffer's major mode."
368 (let ((sections (cdr (assq major-mode Man-auto-section-alist
))))
370 ((null sections
) manword
)
372 (mapconcat (lambda (n) (concat Man-specified-section-option
376 (concat sections
" " manword
)))))
378 (defun Man-default-man-entry ()
379 "Make a guess at a default manual entry.
380 This guess is based on the text surrounding the cursor, and the
381 default section number is selected from `Man-auto-section-alist'."
385 ;; Default man entry title is any word the cursor is on,
386 ;; or if cursor not on a word, then nearest preceding
388 (and (not (looking-at "[a-zA-Z_]"))
389 (skip-chars-backward "^a-zA-Z_"))
390 (skip-chars-backward "(a-zA-Z_0-9")
391 (and (looking-at "(") (forward-char 1))
395 (progn (skip-chars-forward "a-zA-Z0-9_") (point))))
397 ;; If looking at something like ioctl(2) or brc(1M), include
398 ;; section number in default-entry
399 (if (looking-at "[ \t]*([ \t]*[0-9][a-zA-Z]?[ \t]*)")
400 (progn (skip-chars-forward "^0-9")
402 (concat Man-specified-section-option
406 (skip-chars-forward "0-9a-zA-Z")
410 (setq default-title
(Man-default-man-args default-title
)))
414 ;; ======================================================================
415 ;; top level command and background process sentinel
417 ;;; This alias makes completion more predictable if ignoring case.
419 (defalias 'man
'manual-entry
)
422 (defun manual-entry (arg)
423 "Get a Un*x manual page and put it in a buffer.
424 This command is the top-level command in the man package. It runs a Un*x
425 command to retrieve and clean a manpage in the background and places the
426 results in a Man mode (manpage browsing) buffer. See variable
427 `Man-notify' for what happens when the buffer is ready.
428 Normally, if a buffer already exists for this man page, it will display
429 immediately; either a prefix argument or a nil value to `Man-reuse-okay-p'
430 overrides this and forces the man page to be regenerated."
432 (let* ((default-entry (Man-default-man-entry))
434 (read-string (format "Manual-entry: %s"
435 (if (string= default-entry
"") ""
436 (format "(default: %s) "
438 (and (string= man-args
"")
439 (if (string= default-entry
"")
440 (error "No man args given.")
441 (setq man-args default-entry
)))
443 ;; Recognize the subject(section) syntax.
444 (setq man-args
(Man-translate-references man-args
))
446 ;; This is apparently already done correctly via Man-translate-references.
447 ;; (if Man-downcase-section-letters-p
448 ;; (setq man-args (Man-downcase man-args)))
449 (Man-getpage-in-background man-args
(consp arg
))
452 (defun Man-getpage-in-background (topic &optional override-reuse-p
)
453 "Uses TOPIC to build and fire off the manpage and cleaning command.
454 Optional OVERRIDE-REUSE-P, when non-nil, means to
455 start a background process even if a buffer already exists and
456 `Man-reuse-okay-p' is non-nil."
457 (let* ((man-args topic
)
458 (bufname (concat "*man " man-args
"*"))
459 (buffer (get-buffer bufname
)))
460 (if (and Man-reuse-okay-p
461 (not override-reuse-p
)
463 (Man-notify-when-ready buffer
)
465 (message "Invoking man %s in background..." man-args
)
466 (setq buffer
(generate-new-buffer bufname
))
469 (setq Man-original-frame
(selected-frame)))
470 (let ((process-environment (copy-sequence process-environment
)))
471 ;; Prevent any attempt to use display terminal fanciness.
472 (setenv "TERM" "dumb")
473 (set-process-sentinel
474 (start-process manual-program buffer
"sh" "-c"
475 (format (Man-build-man-command) man-args
))
476 'Man-bgproc-sentinel
))
479 (defun Man-notify-when-ready (man-buffer)
480 "Notify the user when MAN-BUFFER is ready.
481 See the variable `Man-notify' for the different notification behaviors."
483 ((eq Man-notify
'newframe
)
484 (set-buffer man-buffer
)
485 (new-frame Man-frame-parameters
))
486 ((eq Man-notify
'bully
)
487 (and (frame-live-p Man-original-frame
)
488 (select-frame Man-original-frame
))
489 (pop-to-buffer man-buffer
)
490 (delete-other-windows))
491 ((eq Man-notify
'aggressive
)
492 (and (frame-live-p Man-original-frame
)
493 (select-frame Man-original-frame
))
494 (pop-to-buffer man-buffer
))
495 ((eq Man-notify
'friendly
)
496 (and (frame-live-p Man-original-frame
)
497 (select-frame Man-original-frame
))
498 (display-buffer man-buffer
'not-this-window
))
499 ((eq Man-notify
'polite
)
501 (message "Manual buffer %s is ready." (buffer-name man-buffer
)))
502 ((eq Man-notify
'quiet
)
503 (message "Manual buffer %s is ready." (buffer-name man-buffer
)))
504 ((or (eq Man-notify
'meek
)
509 (defun Man-set-fonts ()
510 (goto-char (point-min))
511 (while (re-search-forward "\\(.\b\\)+" nil t
)
512 (let ((st (match-beginning 0)) (en (match-end 0)))
515 (put-text-property st
(if (= en
(point-max)) en
(1+ en
)) 'face
516 (if (looking-at "_") 'underline
'bold
)))
517 (while (and (< (point) en
) (looking-at ".\b"))
518 (replace-match "")))))
520 (defun Man-bgproc-sentinel (process msg
)
521 "Manpage background process sentinel."
522 (let ((Man-buffer (process-buffer process
))
525 (if (null (buffer-name Man-buffer
)) ;; deleted buffer
526 (set-process-buffer process nil
)
528 (set-buffer Man-buffer
)
529 (goto-char (point-min))
530 (cond ((or (looking-at "No \\(manual \\)*entry for")
531 (looking-at "[^\n]*: nothing appropriate$"))
532 (setq err-mess
(buffer-substring (point) (Man-linepos 'eol
))
535 ((not (and (eq (process-status process
) 'exit
)
536 (= (process-exit-status process
) 0)))
538 (concat (buffer-name Man-buffer
)
540 (let ((eos (1- (length msg
))))
541 (if (= (aref msg eos
) ?
\n)
542 (substring msg
0 eos
) msg
))))
543 (goto-char (point-max))
544 (insert (format "\nprocess %s" msg
))
547 (kill-buffer Man-buffer
)
548 (save-window-excursion
550 (set-buffer Man-buffer
)
552 (run-hooks 'Man-cooked-hook
)
554 (set-buffer-modified-p nil
)))
555 (Man-notify-when-ready Man-buffer
))
562 ;; ======================================================================
563 ;; set up manual mode in buffer and build alists
566 "A mode for browsing Un*x manual pages.
568 The following man commands are available in the buffer. Try
569 \"\\[describe-key] <key> RET\" for more information:
571 \\[manual-entry] Prompt to retrieve a new manpage.
572 \\[Man-follow-manual-reference] Retrieve reference in SEE ALSO section.
573 \\[Man-next-manpage] Jump to next manpage in circular list.
574 \\[Man-previous-manpage] Jump to previous manpage in circular list.
575 \\[Man-next-section] Jump to next manpage section.
576 \\[Man-previous-section] Jump to previous manpage section.
577 \\[Man-goto-section] Go to a manpage section.
578 \\[Man-goto-see-also-section] Jumps to the SEE ALSO manpage section.
579 \\[Man-quit] Deletes the manpage, its buffer, and window.
580 \\[describe-mode] Prints this help text.
582 The following variables may be of some use. Try
583 \"\\[describe-variable] <variable-name> RET\" for more information:
585 Man-notify What happens when manpage formatting is done.
586 Man-reuse-okay-p Okay to reuse already formatted buffer?
587 Man-downcase-section-letters-p Force section letters to lower case?
588 Man-circular-pages-p Multiple manpage list treated as circular?
589 Man-auto-section-alist List of major modes and their section numbers.
590 Man-section-translations-alist List of section numbers and their Un*x equiv.
591 Man-filter-list Background manpage filter command.
592 Man-mode-line-format Mode line format for Man mode buffers.
593 Man-mode-map Keymap bindings for Man mode buffers.
594 Man-mode-hook Normal hook run on entry to Man mode.
595 Man-section-regexp Regexp describing manpage section letters.
596 Man-heading-regexp Regexp describing section headers.
597 Man-see-also-regexp Regexp for SEE ALSO section (or your equiv).
598 Man-first-heading-regexp Regexp for first heading on a manpage.
599 Man-reference-regexp Regexp matching a references in SEE ALSO.
600 Man-switches Background `man' command switches.
602 The following key bindings are currently in effect in the buffer:
605 (setq major-mode
'Man-mode
607 buffer-auto-save-file-name nil
608 mode-line-format Man-mode-line-format
611 (buffer-disable-undo (current-buffer))
613 (use-local-map Man-mode-map
)
614 (goto-char (point-min))
615 (Man-build-page-list)
617 (run-hooks 'Man-mode-hook
))
619 (defun Man-build-section-alist ()
620 "Build the association list of manpage sections."
621 (setq Man-sections-alist nil
)
622 (goto-char (point-min))
623 (while (re-search-forward Man-heading-regexp
(point-max) t
)
624 (aput 'Man-sections-alist
625 (buffer-substring (Man-linepos 'bol
) (Man-linepos)))
629 (defun Man-build-references-alist ()
630 "Build the association list of references (in the SEE ALSO section)."
631 (setq Man-refpages-alist nil
)
633 (if (Man-find-section Man-see-also-regexp
)
634 (let ((start (progn (forward-line 1) (point)))
640 (narrow-to-region start end
)
641 (goto-char (point-min))
642 (back-to-indentation)
643 (while (and (not (eobp)) (/= (point) runningpoint
))
644 (setq runningpoint
(point))
645 (let* ((eow (re-search-forward Man-reference-regexp end t
))
646 (word (buffer-substring (match-beginning 0) (match-end 0)))
647 (len (1- (length word
))))
650 (setq word
(concat hyphenated word
)
652 (if (= (aref word len
) ?-
)
653 (setq hyphenated
(substring word
0 len
))
654 (aput 'Man-refpages-alist word
))))
655 (skip-chars-forward " \t\n,"))
658 (defun Man-build-page-list ()
659 "Build the list of separate manpages in the buffer."
660 (setq Man-page-list nil
)
662 (let ((page-start (Man-linepos 'bob
))
663 (page-end (Man-linepos 'eob
))
664 (regexp Man-first-heading-regexp
))
665 (goto-char (point-min))
666 (re-search-forward regexp
(point-max) t
)
668 (if (re-search-forward regexp
(point-max) t
)
670 (setq page-end
(Man-linepos 'bol
))
672 (goto-char (point-max))
673 (setq page-end
(point)))
674 (setq Man-page-list
(append Man-page-list
675 (list (cons page-start page-end
)))
680 ;; ======================================================================
683 (defun Man-next-section (n)
684 "Move point to Nth next section (default 1)."
686 (if (looking-at Man-heading-regexp
)
688 (if (re-search-forward Man-heading-regexp
(point-max) t n
)
690 (goto-char (point-max))))
692 (defun Man-previous-section (n)
693 "Move point to Nth previous section (default 1)."
695 (if (looking-at Man-heading-regexp
)
697 (if (re-search-backward Man-heading-regexp
(point-min) t n
)
699 (goto-char (point-min))))
701 (defun Man-find-section (section)
702 "Move point to SECTION if it exists, otherwise don't move point.
703 Returns t if section is found, nil otherwise."
704 (let ((curpos (point)))
705 (goto-char (point-min))
706 (if (re-search-forward (concat "^\\s-?" section
) (point-max) t
)
707 (progn (beginning-of-line) t
)
712 (defun Man-goto-section ()
713 "Query for section to move point to."
715 (aput 'Man-sections-alist
716 (let* ((default (aheadsym Man-sections-alist
))
717 (completion-ignore-case t
)
719 (prompt (concat "Go to section: (default " default
") ")))
720 (setq chosen
(completing-read prompt Man-sections-alist
))
725 (Man-find-section (aheadsym Man-sections-alist
)))
727 (defun Man-goto-see-also-section ()
728 "Move point the the \"SEE ALSO\" section.
729 Actually the section moved to is described by `Man-see-also-regexp'."
731 (if (not (Man-find-section Man-see-also-regexp
))
732 (error (concat "No " Man-see-also-regexp
733 " section found in current manpage."))))
735 (defun Man-follow-manual-reference (arg reference
)
736 "Get one of the manpages referred to in the \"SEE ALSO\" section.
737 Specify which reference to use; default is based on word at point.
738 Prefix argument ARG is passed to `Man-getpage-in-background'."
740 (if (not Man-refpages-alist
)
741 (error "No references in current man page")
742 (list current-prefix-arg
744 (car (all-completions
746 (skip-syntax-backward "w()")
747 (skip-chars-forward " \t")
748 (let ((word (current-word)))
749 ;; strip a trailing '-':
750 (if (string-match "-$" word
)
751 (substring word
0 (match-beginning 0))
754 (aheadsym Man-refpages-alist
)))
756 (prompt (concat "Refer to: (default " default
") ")))
757 (setq chosen
(completing-read prompt Man-refpages-alist nil t
))
762 (if (not Man-refpages-alist
)
763 (error "No references found in current manpage")
764 (aput 'Man-refpages-alist reference
)
765 (Man-getpage-in-background
766 (Man-translate-references (aheadsym Man-refpages-alist
))
770 "Kill the buffer containing the manpage."
772 (let ((buff (current-buffer)))
773 (delete-windows-on buff
)
776 (defun Man-goto-page (page)
777 "Go to the manual page on page PAGE."
779 (if (not Man-page-list
)
780 (error "You're looking at the only manpage in the buffer.")
781 (format "nGo to manpage [1-%d]: " (length Man-page-list
))))
783 (> page
(length Man-page-list
)))
784 (error "No manpage %d found" page
))
785 (let* ((page-range (nth (1- page
) Man-page-list
))
786 (page-start (car page-range
))
787 (page-end (cdr page-range
)))
788 (setq Man-current-page page
789 Man-page-mode-string
(Man-page-mode-string))
791 (goto-char page-start
)
792 (narrow-to-region page-start page-end
)
793 (Man-build-section-alist)
794 ;; Don't let bugs in Man-build-references-alist
795 ;; interfere with ordinary use of this package.
797 (Man-build-references-alist)
800 (narrow-to-region page-start page-end
)
801 (goto-char (point-min))))
804 (defun Man-next-manpage ()
805 "Find the next manpage entry in the buffer."
807 (if (= (length Man-page-list
) 1)
808 (error "This is the only manpage in the buffer."))
809 (if (< Man-current-page
(length Man-page-list
))
810 (Man-goto-page (1+ Man-current-page
))
811 (if Man-circular-pages-p
813 (error "You're looking at the last manpage in the buffer."))))
815 (defun Man-previous-manpage ()
816 "Find the previous manpage entry in the buffer."
818 (if (= (length Man-page-list
) 1)
819 (error "This is the only manpage in the buffer."))
820 (if (> Man-current-page
1)
821 (Man-goto-page (1- Man-current-page
))
822 (if Man-circular-pages-p
823 (Man-goto-page (length Man-page-list
))
824 (error "You're looking at the first manpage in the buffer."))))