annotate lisp/man.el @ 22620:9c8dfd0b1442

(Qemacs_mule): Extern it.
author Kenichi Handa <handa@m17n.org>
date Fri, 26 Jun 1998 04:14:52 +0000
parents c3a15ab5924f
children a804a047b23d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1 ;;; man.el --- browse UNIX manual pages
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
3 ;; Copyright (C) 1993, 1994, 1996, 1997 Free Software Foundation, Inc.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5 ;; Author: Barry A. Warsaw <bwarsaw@cen.com>
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6 ;; Keywords: help
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
7 ;; Adapted-By: ESR, pot
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 ;; This file is part of GNU Emacs.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 ;; it under the terms of the GNU General Public License as published by
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 ;; the Free Software Foundation; either version 2, or (at your option)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 ;; any later version.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 ;; GNU Emacs is distributed in the hope that it will be useful,
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 ;; GNU General Public License for more details.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 ;; You should have received a copy of the GNU General Public License
14169
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14057
diff changeset
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14057
diff changeset
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
83f275dcd93a Update FSF's address.
Erik Naggum <erik@naggum.no>
parents: 14057
diff changeset
24 ;; Boston, MA 02111-1307, USA.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26 ;;; Commentary:
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
28 ;; This code provides a function, `man', with which you can browse
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
29 ;; UNIX manual pages. Formatting is done in background so that you
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
30 ;; can continue to use your Emacs while processing is going on.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 ;;
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32 ;; The mode also supports hypertext-like following of manual page SEE
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 ;; ALSO references, and other features. See below or do `?' in a
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 ;; manual page buffer for details.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 ;; ========== Credits and History ==========
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 ;; In mid 1991, several people posted some interesting improvements to
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38 ;; man.el from the standard emacs 18.57 distribution. I liked many of
14040
187735b53d52 Comment fixes.
Karl Heuer <kwzh@gnu.org>
parents: 13921
diff changeset
39 ;; these, but wanted everything in one single package, so I decided
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
40 ;; to incorporate them into a single manual browsing mode. While
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
41 ;; much of the code here has been rewritten, and some features added,
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
42 ;; these folks deserve lots of credit for providing the initial
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
43 ;; excellent packages on which this one is based.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 ;; Nick Duffek <duffek@chaos.cs.brandeis.edu>, posted a very nice
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46 ;; improvement which retrieved and cleaned the manpages in a
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47 ;; background process, and which correctly deciphered such options as
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
48 ;; man -k.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50 ;; Eric Rose <erose@jessica.stanford.edu>, submitted manual.el which
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51 ;; provided a very nice manual browsing mode.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52
3591
507f64624555 Apply typo patches from Paul Eggert.
Jim Blandy <jimb@redhat.com>
parents: 3307
diff changeset
53 ;; This package was available as `superman.el' from the LCD package
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
54 ;; for some time before it was accepted into Emacs 19. The entry
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
55 ;; point and some other names have been changed to make it a drop-in
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
56 ;; replacement for the old man.el package.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
57
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
58 ;; Francesco Potorti` <pot@cnuce.cnr.it> cleaned it up thoroughly,
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
59 ;; making it faster, more robust and more tolerant of different
14040
187735b53d52 Comment fixes.
Karl Heuer <kwzh@gnu.org>
parents: 13921
diff changeset
60 ;; systems' man idiosyncrasies.
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
61
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 ;; ========== Features ==========
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63 ;; + Runs "man" in the background and pipes the results through a
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64 ;; series of sed and awk scripts so that all retrieving and cleaning
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65 ;; is done in the background. The cleaning commands are configurable.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66 ;; + Syntax is the same as Un*x man
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
67 ;; + Functionality is the same as Un*x man, including "man -k" and
3909
192e7aa8389a (Man-auto-section-alist): Default value nil.
Richard M. Stallman <rms@gnu.org>
parents: 3833
diff changeset
68 ;; "man <section>", etc.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
69 ;; + Provides a manual browsing mode with keybindings for traversing
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
70 ;; the sections of a manpage, following references in the SEE ALSO
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71 ;; section, and more.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72 ;; + Multiple manpages created with the same man command are put into
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73 ;; a narrowed buffer circular list.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
75 ;; ============= TODO ===========
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
76 ;; - Add a command for printing.
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
77 ;; - The awk script deletes multiple blank lines. This behaviour does
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
78 ;; not allow to understand if there was indeed a blank line at the
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
79 ;; end or beginning of a page (after the header, or before the
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
80 ;; footer). A different algorithm should be used. It is easy to
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
81 ;; compute how many blank lines there are before and after the page
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
82 ;; headers, and after the page footer. But it is possible to compute
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
83 ;; the number of blank lines before the page footer by euristhics
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
84 ;; only. Is it worth doing?
9828
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
85 ;; - Allow a user option to mean that all the manpages should go in
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
86 ;; the same buffer, where they can be browsed with M-n and M-p.
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
87 ;; - Allow completion on the manpage name when calling man. This
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
88 ;; requires a reliable list of places where manpages can be found. The
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
89 ;; drawback would be that if the list is not complete, the user might
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
90 ;; be led to believe that the manpages in the missing directories do
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
91 ;; not exist.
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
92
9354
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
93
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
94 ;;; Code:
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
95
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
96 (require 'assoc)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
97
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
98 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
9354
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
99 ;; empty defvars (keep the compiler quiet)
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
100
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
101 (defgroup man nil
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
102 "Browse UNIX manual pages."
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
103 :prefix "Man-"
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
104 :group 'help)
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
105
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
106
9354
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
107 (defvar Man-notify)
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
108 (defvar Man-current-page)
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
109 (defvar Man-page-list)
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
110 (defcustom Man-filter-list nil
14672
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
111 "*Manpage cleaning filter command phrases.
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
112 This variable contains a list of the following form:
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
113
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
114 '((command-string phrase-string*)*)
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
115
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
116 Each phrase-string is concatenated onto the command-string to form a
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
117 command filter. The (standard) output (and standard error) of the Un*x
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
118 man command is piped through each command filter in the order the
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
119 commands appear in the association list. The final output is placed in
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
120 the manpage buffer."
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
121 :type '(repeat (list (string :tag "Command String")
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
122 (repeat :inline t
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
123 (string :tag "Phrase String"))))
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
124 :group 'man)
14672
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
125
9354
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
126 (defvar Man-original-frame)
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
127 (defvar Man-arguments)
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
128 (defvar Man-sections-alist)
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
129 (defvar Man-refpages-alist)
14672
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
130 (defvar Man-uses-untabify-flag t
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
131 "When non-nil use `untabify' instead of Man-untabify-command.")
9354
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
132 (defvar Man-page-mode-string)
14672
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
133 (defvar Man-sed-script nil
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
134 "Script for sed to nuke backspaces and ANSI codes from manpages.")
9354
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
135
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
136 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
137 ;; user variables
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
138
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
139 (defcustom Man-fontify-manpage-flag t
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
140 "*Make up the manpage with fonts."
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
141 :type 'boolean
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
142 :group 'man)
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
143
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
144 (defcustom Man-overstrike-face 'bold
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
145 "*Face to use when fontifying overstrike."
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
146 :type 'face
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
147 :group 'man)
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
148
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
149 (defcustom Man-underline-face 'underline
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
150 "*Face to use when fontifying underlining."
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
151 :type 'face
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
152 :group 'man)
6676
7251020c1c79 (manual-program): New (actually reintroduced) variable.
Karl Heuer <kwzh@gnu.org>
parents: 6613
diff changeset
153
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
154 ;; Use the value of the obsolete user option Man-notify, if set.
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
155 (defcustom Man-notify-method (if (boundp 'Man-notify) Man-notify 'friendly)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
156 "*Selects the behavior when manpage is ready.
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
157 This variable may have one of the following values, where (sf) means
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
158 that the frames are switched, so the manpage is displayed in the frame
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
159 where the man command was called from:
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
160
4915
c0523a78e6a5 (Man-frame-parameters): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 4444
diff changeset
161 newframe -- put the manpage in its own frame (see `Man-frame-parameters')
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
162 pushy -- make the manpage the current buffer in the current window
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
163 bully -- make the manpage the current buffer and only window (sf)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
164 aggressive -- make the manpage the current buffer in the other window (sf)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
165 friendly -- display manpage in the other window but don't make current (sf)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
166 polite -- don't display manpage, but prints message and beep when ready
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
167 quiet -- like `polite', but don't beep
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
168 meek -- make no indication that the manpage is ready
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
169
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
170 Any other value of `Man-notify-method' is equivalent to `meek'."
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
171 :type '(radio (const newframe) (const pushy) (const bully)
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
172 (const aggressive) (const friendly)
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
173 (const polite) (const quiet) (const meek))
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
174 :group 'man)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
175
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
176 (defcustom Man-frame-parameters nil
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
177 "*Frame parameter list for creating a new frame for a manual page."
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
178 :type 'sexp
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
179 :group 'man)
4915
c0523a78e6a5 (Man-frame-parameters): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 4444
diff changeset
180
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
181 (defcustom Man-downcase-section-letters-flag t
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
182 "*Letters in sections are converted to lower case.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
183 Some Un*x man commands can't handle uppercase letters in sections, for
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
184 example \"man 2V chmod\", but they are often displayed in the manpage
3909
192e7aa8389a (Man-auto-section-alist): Default value nil.
Richard M. Stallman <rms@gnu.org>
parents: 3833
diff changeset
185 with the upper case letter. When this variable is t, the section
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
186 letter (e.g., \"2V\") is converted to lowercase (e.g., \"2v\") before
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
187 being sent to the man background process."
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
188 :type 'boolean
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
189 :group 'man)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
190
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
191 (defcustom Man-circular-pages-flag t
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
192 "*If t, the manpage list is treated as circular for traversal."
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
193 :type 'boolean
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
194 :group 'man)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
195
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
196 (defcustom Man-section-translations-alist
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
197 (list
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
198 '("3C++" . "3")
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
199 ;; Some systems have a real 3x man section, so let's comment this.
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
200 ;; '("3X" . "3") ; Xlib man pages
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
201 '("3X11" . "3")
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
202 '("1-UCB" . ""))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
203 "*Association list of bogus sections to real section numbers.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
204 Some manpages (e.g. the Sun C++ 2.1 manpages) have section numbers in
3909
192e7aa8389a (Man-auto-section-alist): Default value nil.
Richard M. Stallman <rms@gnu.org>
parents: 3833
diff changeset
205 their references which Un*x `man' does not recognize. This
3591
507f64624555 Apply typo patches from Paul Eggert.
Jim Blandy <jimb@redhat.com>
parents: 3307
diff changeset
206 association list is used to translate those sections, when found, to
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
207 the associated section number."
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
208 :type '(repeat (cons (string :tag "Bogus Section")
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
209 (string :tag "Real Section")))
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
210 :group 'man)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
211
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
212 (defvar manual-program "man"
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
213 "The name of the program that produces man pages.")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
214
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
215 (defvar Man-untabify-command "pr"
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
216 "Command used for untabifying.")
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
217
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
218 (defvar Man-untabify-command-args (list "-t" "-e")
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
219 "List of arguments to be passed to Man-untabify-command (which see).")
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
220
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
221 (defvar Man-sed-command "sed"
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
222 "Command used for processing sed scripts.")
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
223
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
224 (defvar Man-awk-command "awk"
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
225 "Command used for processing awk scripts.")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
226
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
227 (defvar Man-mode-line-format
20463
08329ac11410 (Man-mode-line-format): Update to include the new format
Andreas Schwab <schwab@suse.de>
parents: 20266
diff changeset
228 '("-"
08329ac11410 (Man-mode-line-format): Update to include the new format
Andreas Schwab <schwab@suse.de>
parents: 20266
diff changeset
229 mode-line-mule-info
08329ac11410 (Man-mode-line-format): Update to include the new format
Andreas Schwab <schwab@suse.de>
parents: 20266
diff changeset
230 mode-line-modified
08329ac11410 (Man-mode-line-format): Update to include the new format
Andreas Schwab <schwab@suse.de>
parents: 20266
diff changeset
231 mode-line-frame-identification
08329ac11410 (Man-mode-line-format): Update to include the new format
Andreas Schwab <schwab@suse.de>
parents: 20266
diff changeset
232 mode-line-buffer-identification " "
08329ac11410 (Man-mode-line-format): Update to include the new format
Andreas Schwab <schwab@suse.de>
parents: 20266
diff changeset
233 global-mode-string
08329ac11410 (Man-mode-line-format): Update to include the new format
Andreas Schwab <schwab@suse.de>
parents: 20266
diff changeset
234 " " Man-page-mode-string
08329ac11410 (Man-mode-line-format): Update to include the new format
Andreas Schwab <schwab@suse.de>
parents: 20266
diff changeset
235 " %[(" mode-name mode-line-process minor-mode-alist "%n)%]--"
08329ac11410 (Man-mode-line-format): Update to include the new format
Andreas Schwab <schwab@suse.de>
parents: 20266
diff changeset
236 (line-number-mode "L%l--")
08329ac11410 (Man-mode-line-format): Update to include the new format
Andreas Schwab <schwab@suse.de>
parents: 20266
diff changeset
237 (column-number-mode "C%c--")
08329ac11410 (Man-mode-line-format): Update to include the new format
Andreas Schwab <schwab@suse.de>
parents: 20266
diff changeset
238 (-3 . "%p") "-%-")
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
239 "Mode line format for manual mode buffer.")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
240
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
241 (defvar Man-mode-map nil
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
242 "Keymap for Man mode.")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
243
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
244 (defvar Man-mode-hook nil
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
245 "Hook run when Man mode is enabled.")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
246
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
247 (defvar Man-cooked-hook nil
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
248 "Hook run after removing backspaces but before Man-mode processing.")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
249
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
250 (defvar Man-name-regexp "[-a-zA-Z0-9_][-a-zA-Z0-9_.]*"
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
251 "Regular expression describing the name of a manpage (without section).")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
252
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
253 (defvar Man-section-regexp "[0-9][a-zA-Z+]*\\|[LNln]"
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
254 "Regular expression describing a manpage section within parentheses.")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
255
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
256 (defvar Man-page-header-regexp
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
257 (concat "^[ \t]*\\(" Man-name-regexp
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
258 "(\\(" Man-section-regexp "\\))\\).*\\1")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
259 "Regular expression describing the heading of a page.")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
260
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
261 (defvar Man-heading-regexp "^\\([A-Z][A-Z ]+\\)$"
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
262 "Regular expression describing a manpage heading entry.")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
263
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
264 (defvar Man-see-also-regexp "SEE ALSO"
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
265 "Regular expression for SEE ALSO heading (or your equivalent).
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
266 This regexp should not start with a `^' character.")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
267
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
268 (defvar Man-first-heading-regexp "^[ \t]*NAME$\\|^[ \t]*No manual entry fo.*$"
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
269 "Regular expression describing first heading on a manpage.
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
270 This regular expression should start with a `^' character.")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
271
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
272 (defvar Man-reference-regexp
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
273 (concat "\\(" Man-name-regexp "\\)(\\(" Man-section-regexp "\\))")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
274 "Regular expression describing a reference in the SEE ALSO section.")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
275
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
276 (defvar Man-switches ""
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
277 "Switches passed to the man command, as a single string.")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
278
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
279 (defvar Man-specified-section-option
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
280 (if (string-match "-solaris[0-9.]*$" system-configuration)
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
281 "-s"
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
282 "")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
283 "Option that indicates a specified a manual section name.")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
284
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
285 ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
286 ;; end user variables
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
287
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
288 ;; other variables and keymap initializations
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
289 (make-variable-buffer-local 'Man-sections-alist)
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
290 (make-variable-buffer-local 'Man-refpages-alist)
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
291 (make-variable-buffer-local 'Man-page-list)
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
292 (make-variable-buffer-local 'Man-current-page)
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
293 (make-variable-buffer-local 'Man-page-mode-string)
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
294 (make-variable-buffer-local 'Man-original-frame)
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
295 (make-variable-buffer-local 'Man-arguments)
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
296
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
297 (setq-default Man-sections-alist nil)
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
298 (setq-default Man-refpages-alist nil)
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
299 (setq-default Man-page-list nil)
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
300 (setq-default Man-current-page 0)
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
301 (setq-default Man-page-mode-string "1 of 1")
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
302
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
303 (defconst Man-sysv-sed-script "\
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
304 /\b/ { s/_\b//g
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
305 s/\b_//g
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
306 s/o\b+/o/g
9867
57ee6c3a0a3c * man.el (Man-berkeley-sed-script, Man-sysv-sed-script,
Francesco Potortì <pot@gnu.org>
parents: 9838
diff changeset
307 s/+\bo/o/g
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
308 :ovstrk
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
309 s/\\(.\\)\b\\1/\\1/g
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
310 t ovstrk
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
311 }
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
312 /\e\\[[0-9][0-9]*m/ s///g"
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
313 "Script for sysV-like sed to nuke backspaces and ANSI codes from manpages.")
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
314
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
315 (defconst Man-berkeley-sed-script "\
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
316 /\b/ { s/_\b//g\\
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
317 s/\b_//g\\
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
318 s/o\b+/o/g\\
9867
57ee6c3a0a3c * man.el (Man-berkeley-sed-script, Man-sysv-sed-script,
Francesco Potortì <pot@gnu.org>
parents: 9838
diff changeset
319 s/+\bo/o/g\\
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
320 :ovstrk\\
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
321 s/\\(.\\)\b\\1/\\1/g\\
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
322 t ovstrk\\
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
323 }\\
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
324 /\e\\[[0-9][0-9]*m/ s///g"
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
325 "Script for berkeley-like sed to nuke backspaces and ANSI codes from manpages.")
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
326
17132
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
327 (defvar man-mode-syntax-table
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
328 (let ((table (copy-syntax-table (standard-syntax-table))))
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
329 (modify-syntax-entry ?. "w" table)
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
330 (modify-syntax-entry ?_ "w" table)
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
331 table)
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
332 "Syntax table used in Man mode buffers.")
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
333
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
334 (if Man-mode-map
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
335 nil
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
336 (setq Man-mode-map (make-keymap))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
337 (suppress-keymap Man-mode-map)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
338 (define-key Man-mode-map " " 'scroll-up)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
339 (define-key Man-mode-map "\177" 'scroll-down)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
340 (define-key Man-mode-map "n" 'Man-next-section)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
341 (define-key Man-mode-map "p" 'Man-previous-section)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
342 (define-key Man-mode-map "\en" 'Man-next-manpage)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
343 (define-key Man-mode-map "\ep" 'Man-previous-manpage)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
344 (define-key Man-mode-map ">" 'end-of-buffer)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
345 (define-key Man-mode-map "<" 'beginning-of-buffer)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
346 (define-key Man-mode-map "." 'beginning-of-buffer)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
347 (define-key Man-mode-map "r" 'Man-follow-manual-reference)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
348 (define-key Man-mode-map "g" 'Man-goto-section)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
349 (define-key Man-mode-map "s" 'Man-goto-see-also-section)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
350 (define-key Man-mode-map "k" 'Man-kill)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
351 (define-key Man-mode-map "q" 'Man-quit)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
352 (define-key Man-mode-map "m" 'man)
17129
79f712c639b7 (man-follow): New function.
Karl Heuer <kwzh@gnu.org>
parents: 16974
diff changeset
353 (define-key Man-mode-map "\r" 'man-follow)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
354 (define-key Man-mode-map "?" 'describe-mode)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
355 )
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
356
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
357
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
358 ;; ======================================================================
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
359 ;; utilities
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
360
14672
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
361 (defun Man-init-defvars ()
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
362 "Used for initialising variables based on the value of window-system.
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
363 This is necessary if one wants to dump man.el with emacs."
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
364
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
365 ;; The following is necessary until fonts are implemented on
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
366 ;; terminals.
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
367 (setq Man-fontify-manpage-flag (and Man-fontify-manpage-flag
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
368 window-system))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
369
20266
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
370 ;; Avoid possible error in call-process by using a directory that must exist.
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
371 (let ((default-directory "/"))
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
372 (setq Man-sed-script
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
373 (cond
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
374 (Man-fontify-manpage-flag
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
375 nil)
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
376 ((= 0 (call-process Man-sed-command nil nil nil Man-sysv-sed-script))
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
377 Man-sysv-sed-script)
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
378 ((= 0 (call-process Man-sed-command nil nil nil Man-berkeley-sed-script))
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
379 Man-berkeley-sed-script)
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
380 (t
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
381 nil))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
382
14672
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
383 (setq Man-filter-list
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
384 (list
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
385 (cons
14672
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
386 Man-sed-command
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
387 (list
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
388 (if Man-sed-script
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
389 (concat "-e '" Man-sed-script "'")
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
390 "")
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
391 "-e '/^[\001-\032][\001-\032]*$/d'"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
392 "-e '/\e[789]/s///g'"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
393 "-e '/Reformatting page. Wait/d'"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
394 "-e '/Reformatting entry. Wait/d'"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
395 "-e '/^[ \t]*Hewlett-Packard[ \t]Company[ \t]*-[ \t][0-9]*[ \t]-/d'"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
396 "-e '/^[ \t]*Hewlett-Packard[ \t]*-[ \t][0-9]*[ \t]-.*$/d'"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
397 "-e '/^[ \t][ \t]*-[ \t][0-9]*[ \t]-[ \t]*Formatted:.*[0-9]$/d'"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
398 "-e '/^[ \t]*Page[ \t][0-9]*.*(printed[ \t][0-9\\/]*)$/d'"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
399 "-e '/^Printed[ \t][0-9].*[0-9]$/d'"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
400 "-e '/^[ \t]*X[ \t]Version[ \t]1[01].*Release[ \t][0-9]/d'"
16974
f4eb94106c89 (Man-init-defvars): Fix case in a char set range.
Richard M. Stallman <rms@gnu.org>
parents: 16973
diff changeset
401 "-e '/^[A-Za-z].*Last[ \t]change:/d'"
14672
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
402 "-e '/^Sun[ \t]Release[ \t][0-9].*[0-9]$/d'"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
403 "-e '/[ \t]*Copyright [0-9]* UNIX System Laboratories, Inc.$/d'"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
404 "-e '/^[ \t]*Rev\\..*Page [0-9][0-9]*$/d'"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
405 ))
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
406 (cons
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
407 Man-awk-command
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
408 (list
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
409 "'\n"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
410 "BEGIN { blankline=0; anonblank=0; }\n"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
411 "/^$/ { if (anonblank==0) next; }\n"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
412 "{ anonblank=1; }\n"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
413 "/^$/ { blankline++; next; }\n"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
414 "{ if (blankline>0) { print \"\"; blankline=0; } print $0; }\n"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
415 "'"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
416 ))
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
417 (if (not Man-uses-untabify-flag)
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
418 (cons
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
419 Man-untabify-command
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
420 Man-untabify-command-args)
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
421 )))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
422 )
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
423
9354
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
424 (defsubst Man-match-substring (&optional n string)
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
425 "Return the substring matched by the last search.
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
426 Optional arg N means return the substring matched by the Nth paren
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
427 grouping. Optional second arg STRING means return a substring from
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
428 that string instead of from the current buffer."
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
429 (if (null n) (setq n 0))
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
430 (if string
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
431 (substring string (match-beginning n) (match-end n))
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
432 (buffer-substring (match-beginning n) (match-end n))))
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
433
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
434 (defsubst Man-make-page-mode-string ()
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
435 "Formats part of the mode line for Man mode."
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
436 (format "%s page %d of %d"
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
437 (or (nth 2 (nth (1- Man-current-page) Man-page-list))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
438 "")
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
439 Man-current-page
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
440 (length Man-page-list)))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
441
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
442 (defsubst Man-build-man-command ()
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
443 "Builds the entire background manpage and cleaning command."
16973
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
444 (let ((command (concat manual-program " " Man-switches
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
445 ; Stock MS-DOS shells cannot redirect stderr;
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
446 ; `call-process' below sends it to /dev/null,
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
447 ; so we don't need `2>' even with DOS shells
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
448 ; which do support stderr redirection.
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
449 (if (not (fboundp 'start-process))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
450 " %s"
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
451 " %s 2>/dev/null")))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
452 (flist Man-filter-list))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
453 (while (and flist (car flist))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
454 (let ((pcom (car (car flist)))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
455 (pargs (cdr (car flist))))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
456 (setq command
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
457 (concat command " | " pcom " "
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
458 (mapconcat '(lambda (phrase)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
459 (if (not (stringp phrase))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
460 (error "Malformed Man-filter-list"))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
461 phrase)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
462 pargs " ")))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
463 (setq flist (cdr flist))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
464 command))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
465
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
466 (defun Man-translate-references (ref)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
467 "Translates REF from \"chmod(2V)\" to \"2v chmod\" style.
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
468 Leave it as is if already in that style. Possibly downcase and
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
469 translate the section (see the Man-downcase-section-letters-flag
12809
c388f6f7f210 * man.el (Man-translate-references): Anchor the regexps.
Francesco Potortì <pot@gnu.org>
parents: 12457
diff changeset
470 and the Man-section-translations-alist variables)."
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
471 (let ((name "")
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
472 (section "")
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
473 (slist Man-section-translations-alist))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
474 (cond
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
475 ;; "chmod(2V)" case ?
12809
c388f6f7f210 * man.el (Man-translate-references): Anchor the regexps.
Francesco Potortì <pot@gnu.org>
parents: 12457
diff changeset
476 ((string-match (concat "^" Man-reference-regexp "$") ref)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
477 (setq name (Man-match-substring 1 ref)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
478 section (Man-match-substring 2 ref)))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
479 ;; "2v chmod" case ?
12809
c388f6f7f210 * man.el (Man-translate-references): Anchor the regexps.
Francesco Potortì <pot@gnu.org>
parents: 12457
diff changeset
480 ((string-match (concat "^\\(" Man-section-regexp
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
481 "\\) +\\(" Man-name-regexp "\\)$") ref)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
482 (setq name (Man-match-substring 2 ref)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
483 section (Man-match-substring 1 ref))))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
484 (if (string= name "")
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
485 ref ; Return the reference as is
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
486 (if Man-downcase-section-letters-flag
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
487 (setq section (downcase section)))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
488 (while slist
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
489 (let ((s1 (car (car slist)))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
490 (s2 (cdr (car slist))))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
491 (setq slist (cdr slist))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
492 (if Man-downcase-section-letters-flag
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
493 (setq s1 (downcase s1)))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
494 (if (not (string= s1 section)) nil
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
495 (setq section (if Man-downcase-section-letters-flag
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
496 (downcase s2)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
497 s2)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
498 slist nil))))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
499 (concat Man-specified-section-option section " " name))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
500
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
501
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
502 ;; ======================================================================
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
503 ;; default man entry: get word under point
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
504
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
505 (defsubst Man-default-man-entry ()
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
506 "Make a guess at a default manual entry.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
507 This guess is based on the text surrounding the cursor, and the
3909
192e7aa8389a (Man-auto-section-alist): Default value nil.
Richard M. Stallman <rms@gnu.org>
parents: 3833
diff changeset
508 default section number is selected from `Man-auto-section-alist'."
17132
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
509 (let (word)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
510 (save-excursion
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
511 ;; Default man entry title is any word the cursor is on, or if
17132
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
512 ;; cursor not on a word, then nearest preceding word.
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
513 (setq word (current-word))
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
514 (if (string-match "[._]+$" word)
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
515 (setq word (substring word 0 (match-beginning 0))))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
516 ;; If looking at something like ioctl(2) or brc(1M), include the
10642
0e6b71f2ebad * man.el (Man-default-man-entry): Remove text properties from result.
Francesco Potortì <pot@gnu.org>
parents: 10040
diff changeset
517 ;; section number in the returned value. Remove text properties.
17132
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
518 (forward-word 1)
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
519 ;; Use `format' here to clear any text props from `word'.
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
520 (format "%s%s"
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
521 word
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
522 (if (looking-at
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
523 (concat "[ \t]*([ \t]*\\(" Man-section-regexp "\\)[ \t]*)"))
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
524 (format "(%s)" (Man-match-substring 1))
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
525 "")))))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
526
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
527
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
528 ;; ======================================================================
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
529 ;; Top level command and background process sentinel
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
530
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
531 ;; For compatibility with older versions.
4444
0a428f48e71a (man): Define as alias.
Richard M. Stallman <rms@gnu.org>
parents: 4378
diff changeset
532 ;;;###autoload
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
533 (defalias 'manual-entry 'man)
4444
0a428f48e71a (man): Define as alias.
Richard M. Stallman <rms@gnu.org>
parents: 4378
diff changeset
534
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
535 ;;;###autoload
9828
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
536 (defun man (man-args)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
537 "Get a Un*x manual page and put it in a buffer.
3909
192e7aa8389a (Man-auto-section-alist): Default value nil.
Richard M. Stallman <rms@gnu.org>
parents: 3833
diff changeset
538 This command is the top-level command in the man package. It runs a Un*x
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
539 command to retrieve and clean a manpage in the background and places the
3909
192e7aa8389a (Man-auto-section-alist): Default value nil.
Richard M. Stallman <rms@gnu.org>
parents: 3833
diff changeset
540 results in a Man mode (manpage browsing) buffer. See variable
9003
bfe446409b77 User option Man-notify-flag renamed to Man-notify-method.
Francesco Potortì <pot@gnu.org>
parents: 8970
diff changeset
541 `Man-notify-method' for what happens when the buffer is ready.
9828
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
542 If a buffer already exists for this man page, it will display immediately."
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
543 (interactive
9828
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
544 (list (let* ((default-entry (Man-default-man-entry))
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
545 (input (read-string
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
546 (format "Manual entry%s: "
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
547 (if (string= default-entry "")
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
548 ""
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
549 (format " (default %s)" default-entry))))))
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
550 (if (string= input "")
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
551 (if (string= default-entry "")
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
552 (error "No man args given")
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
553 default-entry)
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
554 input))))
4002
511feb3c2874 * man.el (Man-build-man-command): Don't leave a pipe symbol at the
Jim Blandy <jimb@redhat.com>
parents: 3909
diff changeset
555
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
556 ;; Possibly translate the "subject(section)" syntax into the
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
557 ;; "section subject" syntax and possibly downcase the section.
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
558 (setq man-args (Man-translate-references man-args))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
559
9828
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
560 (Man-getpage-in-background man-args))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
561
17129
79f712c639b7 (man-follow): New function.
Karl Heuer <kwzh@gnu.org>
parents: 16974
diff changeset
562 ;;;###autoload
79f712c639b7 (man-follow): New function.
Karl Heuer <kwzh@gnu.org>
parents: 16974
diff changeset
563 (defun man-follow (man-args)
79f712c639b7 (man-follow): New function.
Karl Heuer <kwzh@gnu.org>
parents: 16974
diff changeset
564 "Get a Un*x manual page of the item under point and put it in a buffer."
79f712c639b7 (man-follow): New function.
Karl Heuer <kwzh@gnu.org>
parents: 16974
diff changeset
565 (interactive (list (Man-default-man-entry)))
79f712c639b7 (man-follow): New function.
Karl Heuer <kwzh@gnu.org>
parents: 16974
diff changeset
566 (if (or (not man-args)
79f712c639b7 (man-follow): New function.
Karl Heuer <kwzh@gnu.org>
parents: 16974
diff changeset
567 (string= man-args ""))
79f712c639b7 (man-follow): New function.
Karl Heuer <kwzh@gnu.org>
parents: 16974
diff changeset
568 (error "No item under point")
79f712c639b7 (man-follow): New function.
Karl Heuer <kwzh@gnu.org>
parents: 16974
diff changeset
569 (man man-args)))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
570
9828
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
571 (defun Man-getpage-in-background (topic)
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
572 "Uses TOPIC to build and fire off the manpage and cleaning command."
5269
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
573 (let* ((man-args topic)
9354
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
574 (bufname (concat "*Man " man-args "*"))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
575 (buffer (get-buffer bufname)))
9828
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
576 (if buffer
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
577 (Man-notify-when-ready buffer)
6353
f00fc681daa4 (Man-build-man-command): Redirect desc 2 to /dev/null.
Richard M. Stallman <rms@gnu.org>
parents: 6292
diff changeset
578 (require 'env)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
579 (message "Invoking %s %s in the background" manual-program man-args)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
580 (setq buffer (generate-new-buffer bufname))
6363
e5d9ea7852bf (Man-original-frame): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 6362
diff changeset
581 (save-excursion
e5d9ea7852bf (Man-original-frame): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 6362
diff changeset
582 (set-buffer buffer)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
583 (setq Man-original-frame (selected-frame))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
584 (setq Man-arguments man-args))
20266
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
585 (let ((process-environment (copy-sequence process-environment))
22217
e83578642825 (Man-getpage-in-background): Bind coding-system-for-write
Richard M. Stallman <rms@gnu.org>
parents: 21581
diff changeset
586 ;; The following is so Awk script gets \n intact
e83578642825 (Man-getpage-in-background): Bind coding-system-for-write
Richard M. Stallman <rms@gnu.org>
parents: 21581
diff changeset
587 ;; But don't prevent decoding of the outside.
e83578642825 (Man-getpage-in-background): Bind coding-system-for-write
Richard M. Stallman <rms@gnu.org>
parents: 21581
diff changeset
588 (coding-system-for-write 'raw-text-unix)
20266
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
589 ;; Avoid possible error by using a directory that always exists.
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
590 (default-directory "/"))
3713
c77a3da2d08d (Man-getpage-in-background): Use TERM=dumb to prevent
Richard M. Stallman <rms@gnu.org>
parents: 3659
diff changeset
591 ;; Prevent any attempt to use display terminal fanciness.
c77a3da2d08d (Man-getpage-in-background): Use TERM=dumb to prevent
Richard M. Stallman <rms@gnu.org>
parents: 3659
diff changeset
592 (setenv "TERM" "dumb")
16973
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
593 (if (fboundp 'start-process)
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
594 (set-process-sentinel
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
595 (start-process manual-program buffer "sh" "-c"
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
596 (format (Man-build-man-command) man-args))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
597 'Man-bgproc-sentinel)
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
598 (progn
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
599 (let ((exit-status
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
600 (call-process shell-file-name nil (list buffer nil) nil "-c"
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
601 (format (Man-build-man-command) man-args)))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
602 (msg ""))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
603 (or (and (numberp exit-status)
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
604 (= exit-status 0))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
605 (and (numberp exit-status)
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
606 (setq msg
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
607 (format "exited abnormally with code %d"
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
608 exit-status)))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
609 (setq msg exit-status))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
610 (Man-bgproc-sentinel bufname msg))))))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
611
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
612 (defun Man-notify-when-ready (man-buffer)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
613 "Notify the user when MAN-BUFFER is ready.
9003
bfe446409b77 User option Man-notify-flag renamed to Man-notify-method.
Francesco Potortì <pot@gnu.org>
parents: 8970
diff changeset
614 See the variable `Man-notify-method' for the different notification behaviors."
8697
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
615 (let ((saved-frame (save-excursion
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
616 (set-buffer man-buffer)
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
617 Man-original-frame)))
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
618 (cond
9003
bfe446409b77 User option Man-notify-flag renamed to Man-notify-method.
Francesco Potortì <pot@gnu.org>
parents: 8970
diff changeset
619 ((eq Man-notify-method 'newframe)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
620 ;; Since we run asynchronously, perhaps while Emacs is waiting
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
621 ;; for input, we must not leave a different buffer current. We
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
622 ;; can't rely on the editor command loop to reselect the
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
623 ;; selected window's buffer.
8697
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
624 (save-excursion
21581
3aad7ffd0cd3 (Man-notify-when-ready) <newframe>:
Richard M. Stallman <rms@gnu.org>
parents: 21433
diff changeset
625 (let ((frame (make-frame Man-frame-parameters)))
3aad7ffd0cd3 (Man-notify-when-ready) <newframe>:
Richard M. Stallman <rms@gnu.org>
parents: 21433
diff changeset
626 (set-window-buffer (frame-selected-window frame) man-buffer)
3aad7ffd0cd3 (Man-notify-when-ready) <newframe>:
Richard M. Stallman <rms@gnu.org>
parents: 21433
diff changeset
627 (set-window-dedicated-p (frame-selected-window frame) t))))
9003
bfe446409b77 User option Man-notify-flag renamed to Man-notify-method.
Francesco Potortì <pot@gnu.org>
parents: 8970
diff changeset
628 ((eq Man-notify-method 'pushy)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
629 (switch-to-buffer man-buffer))
9003
bfe446409b77 User option Man-notify-flag renamed to Man-notify-method.
Francesco Potortì <pot@gnu.org>
parents: 8970
diff changeset
630 ((eq Man-notify-method 'bully)
8697
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
631 (and window-system
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
632 (frame-live-p saved-frame)
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
633 (select-frame saved-frame))
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
634 (pop-to-buffer man-buffer)
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
635 (delete-other-windows))
9003
bfe446409b77 User option Man-notify-flag renamed to Man-notify-method.
Francesco Potortì <pot@gnu.org>
parents: 8970
diff changeset
636 ((eq Man-notify-method 'aggressive)
8697
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
637 (and window-system
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
638 (frame-live-p saved-frame)
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
639 (select-frame saved-frame))
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
640 (pop-to-buffer man-buffer))
9003
bfe446409b77 User option Man-notify-flag renamed to Man-notify-method.
Francesco Potortì <pot@gnu.org>
parents: 8970
diff changeset
641 ((eq Man-notify-method 'friendly)
8697
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
642 (and window-system
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
643 (frame-live-p saved-frame)
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
644 (select-frame saved-frame))
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
645 (display-buffer man-buffer 'not-this-window))
9003
bfe446409b77 User option Man-notify-flag renamed to Man-notify-method.
Francesco Potortì <pot@gnu.org>
parents: 8970
diff changeset
646 ((eq Man-notify-method 'polite)
8697
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
647 (beep)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
648 (message "Manual buffer %s is ready" (buffer-name man-buffer)))
9003
bfe446409b77 User option Man-notify-flag renamed to Man-notify-method.
Francesco Potortì <pot@gnu.org>
parents: 8970
diff changeset
649 ((eq Man-notify-method 'quiet)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
650 (message "Manual buffer %s is ready" (buffer-name man-buffer)))
9003
bfe446409b77 User option Man-notify-flag renamed to Man-notify-method.
Francesco Potortì <pot@gnu.org>
parents: 8970
diff changeset
651 ((or (eq Man-notify-method 'meek)
8697
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
652 t)
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
653 (message ""))
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
654 )))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
655
20154
d0550e30957c (Man-getpage-in-background): Bind inhibit-eol-conversion
Kenichi Handa <handa@m17n.org>
parents: 17436
diff changeset
656 (defun Man-softhyphen-to-minus ()
d0550e30957c (Man-getpage-in-background): Bind inhibit-eol-conversion
Kenichi Handa <handa@m17n.org>
parents: 17436
diff changeset
657 ;; \255 is some kind of dash in Latin-1.
d0550e30957c (Man-getpage-in-background): Bind inhibit-eol-conversion
Kenichi Handa <handa@m17n.org>
parents: 17436
diff changeset
658 (goto-char (point-min))
d0550e30957c (Man-getpage-in-background): Bind inhibit-eol-conversion
Kenichi Handa <handa@m17n.org>
parents: 17436
diff changeset
659 (if enable-multibyte-characters
d0550e30957c (Man-getpage-in-background): Bind inhibit-eol-conversion
Kenichi Handa <handa@m17n.org>
parents: 17436
diff changeset
660 (while (search-forward "\255" nil t)
d0550e30957c (Man-getpage-in-background): Bind inhibit-eol-conversion
Kenichi Handa <handa@m17n.org>
parents: 17436
diff changeset
661 (if (= (preceding-char) ?\255)
d0550e30957c (Man-getpage-in-background): Bind inhibit-eol-conversion
Kenichi Handa <handa@m17n.org>
parents: 17436
diff changeset
662 (replace-match "-")))
d0550e30957c (Man-getpage-in-background): Bind inhibit-eol-conversion
Kenichi Handa <handa@m17n.org>
parents: 17436
diff changeset
663 (while (search-forward "\255" nil t) (replace-match "-"))))
d0550e30957c (Man-getpage-in-background): Bind inhibit-eol-conversion
Kenichi Handa <handa@m17n.org>
parents: 17436
diff changeset
664
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
665 (defun Man-fontify-manpage ()
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
666 "Convert overstriking and underlining to the correct fonts.
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
667 Same for the ANSI bold and normal escape sequences."
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
668 (interactive)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
669 (message "Please wait: making up the %s man page..." Man-arguments)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
670 (goto-char (point-min))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
671 (while (search-forward "\e[1m" nil t)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
672 (delete-backward-char 4)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
673 (put-text-property (point)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
674 (progn (if (search-forward "\e[0m" nil 'move)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
675 (delete-backward-char 4))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
676 (point))
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
677 'face Man-overstrike-face))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
678 (goto-char (point-min))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
679 (while (search-forward "_\b" nil t)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
680 (backward-delete-char 2)
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
681 (put-text-property (point) (1+ (point)) 'face Man-underline-face))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
682 (goto-char (point-min))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
683 (while (search-forward "\b_" nil t)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
684 (backward-delete-char 2)
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
685 (put-text-property (1- (point)) (point) 'face Man-underline-face))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
686 (goto-char (point-min))
9210
8d35fd88194d * man.el (Man-init-defvars, Man-cleanup-manpage,
Francesco Potortì <pot@gnu.org>
parents: 9177
diff changeset
687 (while (re-search-forward "\\(.\\)\\(\b\\1\\)+" nil t)
8d35fd88194d * man.el (Man-init-defvars, Man-cleanup-manpage,
Francesco Potortì <pot@gnu.org>
parents: 9177
diff changeset
688 (replace-match "\\1")
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
689 (put-text-property (1- (point)) (point) 'face Man-overstrike-face))
9210
8d35fd88194d * man.el (Man-init-defvars, Man-cleanup-manpage,
Francesco Potortì <pot@gnu.org>
parents: 9177
diff changeset
690 (goto-char (point-min))
9867
57ee6c3a0a3c * man.el (Man-berkeley-sed-script, Man-sysv-sed-script,
Francesco Potortì <pot@gnu.org>
parents: 9838
diff changeset
691 (while (re-search-forward "o\b\\+\\|\\+\bo" nil t)
57ee6c3a0a3c * man.el (Man-berkeley-sed-script, Man-sysv-sed-script,
Francesco Potortì <pot@gnu.org>
parents: 9838
diff changeset
692 (replace-match "o")
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
693 (put-text-property (1- (point)) (point) 'face 'bold))
9210
8d35fd88194d * man.el (Man-init-defvars, Man-cleanup-manpage,
Francesco Potortì <pot@gnu.org>
parents: 9177
diff changeset
694 (goto-char (point-min))
9620
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
695 (while (re-search-forward "[-|]\\(\b[-|]\\)+" nil t)
9177
5c7bf3247185 * man.el
Francesco Potortì <pot@gnu.org>
parents: 9003
diff changeset
696 (replace-match "+")
5c7bf3247185 * man.el
Francesco Potortì <pot@gnu.org>
parents: 9003
diff changeset
697 (put-text-property (1- (point)) (point) 'face 'bold))
20154
d0550e30957c (Man-getpage-in-background): Bind inhibit-eol-conversion
Kenichi Handa <handa@m17n.org>
parents: 17436
diff changeset
698 (Man-softhyphen-to-minus)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
699 (message "%s man page made up" Man-arguments))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
700
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
701 (defun Man-cleanup-manpage ()
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
702 "Remove overstriking and underlining from the current buffer."
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
703 (interactive)
9620
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
704 (message "Please wait: cleaning up the %s man page..."
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
705 Man-arguments)
9675
5186676f806f *** empty log message ***
Francesco Potortì <pot@gnu.org>
parents: 9620
diff changeset
706 (if (or (interactive-p) (not Man-sed-script))
9620
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
707 (progn
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
708 (goto-char (point-min))
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
709 (while (search-forward "_\b" nil t) (backward-delete-char 2))
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
710 (goto-char (point-min))
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
711 (while (search-forward "\b_" nil t) (backward-delete-char 2))
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
712 (goto-char (point-min))
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
713 (while (re-search-forward "\\(.\\)\\(\b\\1\\)+" nil t)
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
714 (replace-match "\\1"))
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
715 (goto-char (point-min))
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
716 (while (re-search-forward "\e\\[[0-9]+m" nil t) (replace-match ""))
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
717 (goto-char (point-min))
9867
57ee6c3a0a3c * man.el (Man-berkeley-sed-script, Man-sysv-sed-script,
Francesco Potortì <pot@gnu.org>
parents: 9838
diff changeset
718 (while (re-search-forward "o\b\\+\\|\\+\bo" nil t) (replace-match "o"))
9620
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
719 ))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
720 (goto-char (point-min))
9620
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
721 (while (re-search-forward "[-|]\\(\b[-|]\\)+" nil t) (replace-match "+"))
20154
d0550e30957c (Man-getpage-in-background): Bind inhibit-eol-conversion
Kenichi Handa <handa@m17n.org>
parents: 17436
diff changeset
722 (Man-softhyphen-to-minus)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
723 (message "%s man page cleaned up" Man-arguments))
3909
192e7aa8389a (Man-auto-section-alist): Default value nil.
Richard M. Stallman <rms@gnu.org>
parents: 3833
diff changeset
724
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
725 (defun Man-bgproc-sentinel (process msg)
16973
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
726 "Manpage background process sentinel.
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
727 When manpage command is run asynchronously, PROCESS is the process
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
728 object for the manpage command; when manpage command is run
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
729 synchronously, PROCESS is the name of the buffer where the manpage
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
730 command is run. Second argument MSG is the exit message of the
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
731 manpage command."
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
732 (let ((Man-buffer (if (stringp process) (get-buffer process)
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
733 (process-buffer process)))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
734 (delete-buff nil)
8190
04aa77218846 (Man-bgproc-sentinel): Bind case-fold-search for just the
Richard M. Stallman <rms@gnu.org>
parents: 7518
diff changeset
735 (err-mess nil))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
736
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
737 (if (null (buffer-name Man-buffer)) ;; deleted buffer
16973
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
738 (or (stringp process)
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
739 (set-process-buffer process nil))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
740
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
741 (save-excursion
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
742 (set-buffer Man-buffer)
10040
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
743 (let ((case-fold-search nil))
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
744 (goto-char (point-min))
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
745 (cond ((or (looking-at "No \\(manual \\)*entry for")
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
746 (looking-at "[^\n]*: nothing appropriate$"))
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
747 (setq err-mess (buffer-substring (point)
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
748 (progn
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
749 (end-of-line) (point)))
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
750 delete-buff t))
16973
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
751 ((or (stringp process)
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
752 (not (and (eq (process-status process) 'exit)
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
753 (= (process-exit-status process) 0))))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
754 (or (zerop (length msg))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
755 (progn
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
756 (setq err-mess
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
757 (concat (buffer-name Man-buffer)
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
758 ": process "
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
759 (let ((eos (1- (length msg))))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
760 (if (= (aref msg eos) ?\n)
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
761 (substring msg 0 eos) msg))))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
762 (goto-char (point-max))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
763 (insert (format "\nprocess %s" msg))))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
764 ))
16509
75d463b202b5 (Man-bgproc-sentinel): Move the buffer creation
Richard M. Stallman <rms@gnu.org>
parents: 14733
diff changeset
765 (if delete-buff
75d463b202b5 (Man-bgproc-sentinel): Move the buffer creation
Richard M. Stallman <rms@gnu.org>
parents: 14733
diff changeset
766 (kill-buffer Man-buffer)
75d463b202b5 (Man-bgproc-sentinel): Move the buffer creation
Richard M. Stallman <rms@gnu.org>
parents: 14733
diff changeset
767 (if Man-fontify-manpage-flag
75d463b202b5 (Man-bgproc-sentinel): Move the buffer creation
Richard M. Stallman <rms@gnu.org>
parents: 14733
diff changeset
768 (Man-fontify-manpage)
75d463b202b5 (Man-bgproc-sentinel): Move the buffer creation
Richard M. Stallman <rms@gnu.org>
parents: 14733
diff changeset
769 (Man-cleanup-manpage))
75d463b202b5 (Man-bgproc-sentinel): Move the buffer creation
Richard M. Stallman <rms@gnu.org>
parents: 14733
diff changeset
770 (run-hooks 'Man-cooked-hook)
75d463b202b5 (Man-bgproc-sentinel): Move the buffer creation
Richard M. Stallman <rms@gnu.org>
parents: 14733
diff changeset
771 (Man-mode)
75d463b202b5 (Man-bgproc-sentinel): Move the buffer creation
Richard M. Stallman <rms@gnu.org>
parents: 14733
diff changeset
772 (set-buffer-modified-p nil)
16973
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
773 ))
10040
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
774 ;; Restore case-fold-search before calling
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
775 ;; Man-notify-when-ready because it may switch buffers.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
776
10040
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
777 (if (not delete-buff)
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
778 (Man-notify-when-ready Man-buffer))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
779
10040
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
780 (if err-mess
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
781 (error err-mess))
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
782 ))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
783
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
784
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
785 ;; ======================================================================
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
786 ;; set up manual mode in buffer and build alists
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
787
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
788 (defun Man-mode ()
3909
192e7aa8389a (Man-auto-section-alist): Default value nil.
Richard M. Stallman <rms@gnu.org>
parents: 3833
diff changeset
789 "A mode for browsing Un*x manual pages.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
790
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
791 The following man commands are available in the buffer. Try
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
792 \"\\[describe-key] <key> RET\" for more information:
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
793
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
794 \\[man] Prompt to retrieve a new manpage.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
795 \\[Man-follow-manual-reference] Retrieve reference in SEE ALSO section.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
796 \\[Man-next-manpage] Jump to next manpage in circular list.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
797 \\[Man-previous-manpage] Jump to previous manpage in circular list.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
798 \\[Man-next-section] Jump to next manpage section.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
799 \\[Man-previous-section] Jump to previous manpage section.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
800 \\[Man-goto-section] Go to a manpage section.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
801 \\[Man-goto-see-also-section] Jumps to the SEE ALSO manpage section.
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
802 \\[Man-quit] Deletes the manpage window, bury its buffer.
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
803 \\[Man-kill] Deletes the manpage window, kill its buffer.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
804 \\[describe-mode] Prints this help text.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
805
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
806 The following variables may be of some use. Try
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
807 \"\\[describe-variable] <variable-name> RET\" for more information:
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
808
9003
bfe446409b77 User option Man-notify-flag renamed to Man-notify-method.
Francesco Potortì <pot@gnu.org>
parents: 8970
diff changeset
809 Man-notify-method What happens when manpage formatting is done.
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
810 Man-downcase-section-letters-flag Force section letters to lower case.
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
811 Man-circular-pages-flag Treat multiple manpage list as circular.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
812 Man-auto-section-alist List of major modes and their section numbers.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
813 Man-section-translations-alist List of section numbers and their Un*x equiv.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
814 Man-filter-list Background manpage filter command.
5269
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
815 Man-mode-line-format Mode line format for Man mode buffers.
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
816 Man-mode-map Keymap bindings for Man mode buffers.
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
817 Man-mode-hook Normal hook run on entry to Man mode.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
818 Man-section-regexp Regexp describing manpage section letters.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
819 Man-heading-regexp Regexp describing section headers.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
820 Man-see-also-regexp Regexp for SEE ALSO section (or your equiv).
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
821 Man-first-heading-regexp Regexp for first heading on a manpage.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
822 Man-reference-regexp Regexp matching a references in SEE ALSO.
3833
70551a213fae * man.el (Man-switches): New variable.
Jim Blandy <jimb@redhat.com>
parents: 3714
diff changeset
823 Man-switches Background `man' command switches.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
824
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
825 The following key bindings are currently in effect in the buffer:
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
826 \\{Man-mode-map}"
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
827 (interactive)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
828 (setq major-mode 'Man-mode
3909
192e7aa8389a (Man-auto-section-alist): Default value nil.
Richard M. Stallman <rms@gnu.org>
parents: 3833
diff changeset
829 mode-name "Man"
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
830 buffer-auto-save-file-name nil
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
831 mode-line-format Man-mode-line-format
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
832 truncate-lines t
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
833 buffer-read-only t)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
834 (buffer-disable-undo (current-buffer))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
835 (auto-fill-mode -1)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
836 (use-local-map Man-mode-map)
17132
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
837 (set-syntax-table man-mode-syntax-table)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
838 (Man-build-page-list)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
839 (Man-strip-page-headers)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
840 (Man-unindent)
3619
062dbb10173d (Man-mode): Run Man-mode-hook.
Richard M. Stallman <rms@gnu.org>
parents: 3591
diff changeset
841 (Man-goto-page 1)
062dbb10173d (Man-mode): Run Man-mode-hook.
Richard M. Stallman <rms@gnu.org>
parents: 3591
diff changeset
842 (run-hooks 'Man-mode-hook))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
843
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
844 (defsubst Man-build-section-alist ()
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
845 "Build the association list of manpage sections."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
846 (setq Man-sections-alist nil)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
847 (goto-char (point-min))
7450
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
848 (let ((case-fold-search nil))
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
849 (while (re-search-forward Man-heading-regexp (point-max) t)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
850 (aput 'Man-sections-alist (Man-match-substring 1))
7450
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
851 (forward-line 1))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
852
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
853 (defsubst Man-build-references-alist ()
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
854 "Build the association list of references (in the SEE ALSO section)."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
855 (setq Man-refpages-alist nil)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
856 (save-excursion
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
857 (if (Man-find-section Man-see-also-regexp)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
858 (let ((start (progn (forward-line 1) (point)))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
859 (end (progn
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
860 (Man-next-section 1)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
861 (point)))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
862 hyphenated
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
863 (runningpoint -1))
7450
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
864 (save-restriction
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
865 (narrow-to-region start end)
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
866 (goto-char (point-min))
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
867 (back-to-indentation)
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
868 (while (and (not (eobp)) (/= (point) runningpoint))
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
869 (setq runningpoint (point))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
870 (if (re-search-forward Man-reference-regexp end t)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
871 (let* ((word (Man-match-substring 0))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
872 (len (1- (length word))))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
873 (if hyphenated
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
874 (setq word (concat hyphenated word)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
875 hyphenated nil))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
876 (if (= (aref word len) ?-)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
877 (setq hyphenated (substring word 0 len))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
878 (aput 'Man-refpages-alist word))))
7450
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
879 (skip-chars-forward " \t\n,")))))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
880
9354
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
881 (defun Man-build-page-list ()
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
882 "Build the list of separate manpages in the buffer."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
883 (setq Man-page-list nil)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
884 (let ((page-start (point-min))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
885 (page-end (point-max))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
886 (header ""))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
887 (goto-char page-start)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
888 ;; (switch-to-buffer (current-buffer))(debug)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
889 (while (not (eobp))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
890 (setq header
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
891 (if (looking-at Man-page-header-regexp)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
892 (Man-match-substring 1)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
893 nil))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
894 ;; Go past both the current and the next Man-first-heading-regexp
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
895 (if (re-search-forward Man-first-heading-regexp nil 'move 2)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
896 (let ((p (progn (beginning-of-line) (point))))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
897 ;; We assume that the page header is delimited by blank
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
898 ;; lines and that it contains at most one blank line. So
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
899 ;; if we back by three blank lines we will be sure to be
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
900 ;; before the page header but not before the possible
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
901 ;; previous page header.
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
902 (search-backward "\n\n" nil t 3)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
903 (if (re-search-forward Man-page-header-regexp p 'move)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
904 (beginning-of-line))))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
905 (setq page-end (point))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
906 (setq Man-page-list (append Man-page-list
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
907 (list (list (copy-marker page-start)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
908 (copy-marker page-end)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
909 header))))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
910 (setq page-start page-end)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
911 )))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
912
9354
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
913 (defun Man-strip-page-headers ()
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
914 "Strip all the page headers but the first from the manpage."
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
915 (let ((buffer-read-only nil)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
916 (case-fold-search nil)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
917 (page-list Man-page-list)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
918 (page ())
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
919 (header ""))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
920 (while page-list
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
921 (setq page (car page-list))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
922 (and (nth 2 page)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
923 (goto-char (car page))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
924 (re-search-forward Man-first-heading-regexp nil t)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
925 (setq header (buffer-substring (car page) (match-beginning 0)))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
926 ;; Since the awk script collapses all successive blank
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
927 ;; lines into one, and since we don't want to get rid of
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
928 ;; the fast awk script, one must choose between adding
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
929 ;; spare blank lines between pages when there were none and
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
930 ;; deleting blank lines at page boundaries when there were
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
931 ;; some. We choose the first, so we comment the following
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
932 ;; line.
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
933 ;; (setq header (concat "\n" header)))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
934 (while (search-forward header (nth 1 page) t)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
935 (replace-match "")))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
936 (setq page-list (cdr page-list)))))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
937
9354
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
938 (defun Man-unindent ()
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
939 "Delete the leading spaces that indent the manpage."
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
940 (let ((buffer-read-only nil)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
941 (case-fold-search nil)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
942 (page-list Man-page-list))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
943 (while page-list
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
944 (let ((page (car page-list))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
945 (indent "")
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
946 (nindent 0))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
947 (narrow-to-region (car page) (car (cdr page)))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
948 (if Man-uses-untabify-flag
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
949 (untabify (point-min) (point-max)))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
950 (if (catch 'unindent
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
951 (goto-char (point-min))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
952 (if (not (re-search-forward Man-first-heading-regexp nil t))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
953 (throw 'unindent nil))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
954 (beginning-of-line)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
955 (setq indent (buffer-substring (point)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
956 (progn
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
957 (skip-chars-forward " ")
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
958 (point))))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
959 (setq nindent (length indent))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
960 (if (zerop nindent)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
961 (throw 'unindent nil))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
962 (setq indent (concat indent "\\|$"))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
963 (goto-char (point-min))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
964 (while (not (eobp))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
965 (if (looking-at indent)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
966 (forward-line 1)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
967 (throw 'unindent nil)))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
968 (goto-char (point-min)))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
969 (while (not (eobp))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
970 (or (eolp)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
971 (delete-char nindent))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
972 (forward-line 1)))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
973 (setq page-list (cdr page-list))
7450
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
974 ))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
975
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
976
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
977 ;; ======================================================================
5269
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
978 ;; Man mode commands
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
979
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
980 (defun Man-next-section (n)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
981 "Move point to Nth next section (default 1)."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
982 (interactive "p")
7450
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
983 (let ((case-fold-search nil))
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
984 (if (looking-at Man-heading-regexp)
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
985 (forward-line 1))
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
986 (if (re-search-forward Man-heading-regexp (point-max) t n)
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
987 (beginning-of-line)
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
988 (goto-char (point-max)))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
989
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
990 (defun Man-previous-section (n)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
991 "Move point to Nth previous section (default 1)."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
992 (interactive "p")
7450
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
993 (let ((case-fold-search nil))
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
994 (if (looking-at Man-heading-regexp)
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
995 (forward-line -1))
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
996 (if (re-search-backward Man-heading-regexp (point-min) t n)
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
997 (beginning-of-line)
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
998 (goto-char (point-min)))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
999
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1000 (defun Man-find-section (section)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1001 "Move point to SECTION if it exists, otherwise don't move point.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1002 Returns t if section is found, nil otherwise."
7450
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1003 (let ((curpos (point))
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1004 (case-fold-search nil))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1005 (goto-char (point-min))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1006 (if (re-search-forward (concat "^" section) (point-max) t)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1007 (progn (beginning-of-line) t)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1008 (goto-char curpos)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1009 nil)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1010 ))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1011
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1012 (defun Man-goto-section ()
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1013 "Query for section to move point to."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1014 (interactive)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1015 (aput 'Man-sections-alist
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1016 (let* ((default (aheadsym Man-sections-alist))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1017 (completion-ignore-case t)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1018 chosen
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1019 (prompt (concat "Go to section: (default " default ") ")))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1020 (setq chosen (completing-read prompt Man-sections-alist))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1021 (if (or (not chosen)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1022 (string= chosen ""))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1023 default
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1024 chosen)))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1025 (Man-find-section (aheadsym Man-sections-alist)))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1026
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1027 (defun Man-goto-see-also-section ()
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1028 "Move point the the \"SEE ALSO\" section.
3909
192e7aa8389a (Man-auto-section-alist): Default value nil.
Richard M. Stallman <rms@gnu.org>
parents: 3833
diff changeset
1029 Actually the section moved to is described by `Man-see-also-regexp'."
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1030 (interactive)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1031 (if (not (Man-find-section Man-see-also-regexp))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1032 (error (concat "No " Man-see-also-regexp
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1033 " section found in the current manpage"))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1034
9838
5fbd6165b408 (Man-follow-manual-reference): First arg deleted. Call
Karl Heuer <kwzh@gnu.org>
parents: 9828
diff changeset
1035 (defun Man-follow-manual-reference (reference)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1036 "Get one of the manpages referred to in the \"SEE ALSO\" section.
9838
5fbd6165b408 (Man-follow-manual-reference): First arg deleted. Call
Karl Heuer <kwzh@gnu.org>
parents: 9828
diff changeset
1037 Specify which reference to use; default is based on word at point."
5269
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1038 (interactive
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1039 (if (not Man-refpages-alist)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1040 (error "There are no references in the current man page")
9838
5fbd6165b408 (Man-follow-manual-reference): First arg deleted. Call
Karl Heuer <kwzh@gnu.org>
parents: 9828
diff changeset
1041 (list (let* ((default (or
5269
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1042 (car (all-completions
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1043 (save-excursion
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1044 (skip-syntax-backward "w()")
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1045 (skip-chars-forward " \t")
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1046 (let ((word (current-word)))
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1047 ;; strip a trailing '-':
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1048 (if (string-match "-$" word)
7450
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1049 (substring word 0
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1050 (match-beginning 0))
5269
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1051 word)))
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1052 Man-refpages-alist))
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1053 (aheadsym Man-refpages-alist)))
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1054 chosen
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1055 (prompt (concat "Refer to: (default " default ") ")))
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1056 (setq chosen (completing-read prompt Man-refpages-alist nil t))
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1057 (if (or (not chosen)
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1058 (string= chosen ""))
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1059 default
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1060 chosen)))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1061 (if (not Man-refpages-alist)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1062 (error "Can't find any references in the current manpage")
5269
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1063 (aput 'Man-refpages-alist reference)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1064 (Man-getpage-in-background
9838
5fbd6165b408 (Man-follow-manual-reference): First arg deleted. Call
Karl Heuer <kwzh@gnu.org>
parents: 9828
diff changeset
1065 (Man-translate-references (aheadsym Man-refpages-alist)))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1066
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1067 (defun Man-kill ()
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1068 "Kill the buffer containing the manpage."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1069 (interactive)
22368
c3a15ab5924f (Man-kill, Man-quit): Use quit-window.
Richard M. Stallman <rms@gnu.org>
parents: 22217
diff changeset
1070 (quit-window t))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1071
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1072 (defun Man-quit ()
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1073 "Bury the buffer containing the manpage."
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1074 (interactive)
22368
c3a15ab5924f (Man-kill, Man-quit): Use quit-window.
Richard M. Stallman <rms@gnu.org>
parents: 22217
diff changeset
1075 (quit-window))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1076
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1077 (defun Man-goto-page (page)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1078 "Go to the manual page on page PAGE."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1079 (interactive
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1080 (if (not Man-page-list)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1081 (let ((args Man-arguments))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1082 (kill-buffer (current-buffer))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1083 (error "Can't find the %s manpage" args))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1084 (if (= (length Man-page-list) 1)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1085 (error "You're looking at the only manpage in the buffer")
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1086 (list (read-minibuffer (format "Go to manpage [1-%d]: "
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1087 (length Man-page-list)))))))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1088 (if (not Man-page-list)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1089 (let ((args Man-arguments))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1090 (kill-buffer (current-buffer))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1091 (error "Can't find the %s manpage" args)))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1092 (if (or (< page 1)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1093 (> page (length Man-page-list)))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1094 (error "No manpage %d found" page))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1095 (let* ((page-range (nth (1- page) Man-page-list))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1096 (page-start (car page-range))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1097 (page-end (car (cdr page-range))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1098 (setq Man-current-page page
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1099 Man-page-mode-string (Man-make-page-mode-string))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1100 (widen)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1101 (goto-char page-start)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1102 (narrow-to-region page-start page-end)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1103 (Man-build-section-alist)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1104 (Man-build-references-alist)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1105 (goto-char (point-min))))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1106
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1107
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1108 (defun Man-next-manpage ()
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1109 "Find the next manpage entry in the buffer."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1110 (interactive)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1111 (if (= (length Man-page-list) 1)
7499
b3cacdf7bbfa Remove periods from messages.
Richard M. Stallman <rms@gnu.org>
parents: 7453
diff changeset
1112 (error "This is the only manpage in the buffer"))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1113 (if (< Man-current-page (length Man-page-list))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1114 (Man-goto-page (1+ Man-current-page))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1115 (if Man-circular-pages-flag
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1116 (Man-goto-page 1)
7499
b3cacdf7bbfa Remove periods from messages.
Richard M. Stallman <rms@gnu.org>
parents: 7453
diff changeset
1117 (error "You're looking at the last manpage in the buffer"))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1118
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1119 (defun Man-previous-manpage ()
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1120 "Find the previous manpage entry in the buffer."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1121 (interactive)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1122 (if (= (length Man-page-list) 1)
7499
b3cacdf7bbfa Remove periods from messages.
Richard M. Stallman <rms@gnu.org>
parents: 7453
diff changeset
1123 (error "This is the only manpage in the buffer"))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1124 (if (> Man-current-page 1)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1125 (Man-goto-page (1- Man-current-page))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1126 (if Man-circular-pages-flag
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1127 (Man-goto-page (length Man-page-list))
7499
b3cacdf7bbfa Remove periods from messages.
Richard M. Stallman <rms@gnu.org>
parents: 7453
diff changeset
1128 (error "You're looking at the first manpage in the buffer"))))
3833
70551a213fae * man.el (Man-switches): New variable.
Jim Blandy <jimb@redhat.com>
parents: 3714
diff changeset
1129
14672
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
1130 ;; Init the man package variables, if not already done.
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
1131 (Man-init-defvars)
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
1132
3833
70551a213fae * man.el (Man-switches): New variable.
Jim Blandy <jimb@redhat.com>
parents: 3714
diff changeset
1133 (provide 'man)
70551a213fae * man.el (Man-switches): New variable.
Jim Blandy <jimb@redhat.com>
parents: 3714
diff changeset
1134
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1135 ;;; man.el ends here