|
0
|
1 ;;; man.el --- browse UNIX manual pages
|
|
8
|
2 ;; Keywords: help
|
|
0
|
3
|
|
8
|
4 ;; Copyright (C) 1985, 1993, 1994 Free Software Foundation, Inc.
|
|
|
5 ;;
|
|
0
|
6 ;; This file is part of XEmacs.
|
|
|
7
|
|
|
8 ;; XEmacs is free software; you can redistribute it and/or modify it
|
|
|
9 ;; under the terms of the GNU General Public License as published by
|
|
|
10 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
|
11 ;; any later version.
|
|
|
12
|
|
|
13 ;; XEmacs is distributed in the hope that it will be useful, but
|
|
|
14 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
16 ;; General Public License for more details.
|
|
|
17
|
|
|
18 ;; You should have received a copy of the GNU General Public License
|
|
16
|
19 ;; along with XEmacs; see the file COPYING. If not, write to the
|
|
|
20 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
21 ;; Boston, MA 02111-1307, USA.
|
|
0
|
22
|
|
8
|
23 ;; Mostly rewritten by Alan K. Stebbens <aks@hub.ucsb.edu> 11-apr-90.
|
|
|
24 ;;
|
|
|
25 ;; o Match multiple man pages using TOPIC as a simple pattern
|
|
|
26 ;; o Search unformatted pages, even when formatted matches are found
|
|
|
27 ;; o Query the user as to which pages are desired
|
|
|
28 ;; o Use of the prefix arg to toggle/bypass the above features
|
|
|
29 ;; o Buffers named by the first topic in the buffer
|
|
|
30 ;; o Automatic uncompress for compressed man pages (.Z, .z, and .gz)
|
|
|
31 ;; o View the resulting buffer using M-x view mode
|
|
|
32 ;;
|
|
|
33 ;; Modified 16-mar-91 by Jamie Zawinski <jwz@lucid.com> to default the
|
|
|
34 ;; manual topic to the symbol at point, just like find-tag does.
|
|
|
35 ;;
|
|
|
36 ;; Modified 22-mar-93 by jwz to use multiple fonts and follow xrefs with mouse.
|
|
|
37 ;;
|
|
|
38 ;; Modified 16-apr-93 by Dave Gillespie <daveg@synaptics.com> to make
|
|
|
39 ;; apropos work nicely; work correctly when bold or italic is unavailable;
|
|
|
40 ;; reuse old buffer if topic is re-selected (in Manual-topic-buffer mode).
|
|
|
41 ;;
|
|
|
42 ;; Modified 4-apr-94 by jwz: merged in Tibor Polgar's code for manpath.conf.
|
|
|
43 ;;
|
|
|
44 ;; Modified 19-apr-94 by Tibor Polgar <tlp00@spg.amdahl.com> to add support for
|
|
|
45 ;; $PAGER variable to be emacsclient and properly process man pages (assuming
|
|
|
46 ;; the man pages were built by man in /tmp. also fixed bug with man list being
|
|
|
47 ;; backwards.
|
|
|
48 ;;
|
|
|
49 ;; Modified 23-aug-94 by Tibor Polgar <tlp00@spg.amdahl.com> to add support for
|
|
|
50 ;; displaying only one instance of a man page (Manual-unique-man-sections-only)
|
|
|
51 ;; Fixed some more man page ordering bugs, bug with Manual-query-multiple-pages.
|
|
|
52 ;;
|
|
|
53 ;; Modified 29-nov-94 by Ben Wing <wing@spg.amdahl.com>: small fixes
|
|
|
54 ;; that should hopefully make things work under HPUX and IRIX.;
|
|
|
55 ;;
|
|
|
56 ;; Modified 15-jul-95 by Dale Atems <atems@physics.wayne.edu>:
|
|
|
57 ;; some extensive rewriting to make things work right (more or less)
|
|
|
58 ;; under IRIX.
|
|
|
59 ;;
|
|
|
60 ;; This file defines "manual-entry", and the remaining definitions all
|
|
|
61 ;; begin with "Manual-". This makes the autocompletion on "M-x man" work.
|
|
|
62 ;;
|
|
|
63 ;; Variables of interest:
|
|
|
64 ;;
|
|
|
65 ;; Manual-program
|
|
|
66 ;; Manual-topic-buffer
|
|
|
67 ;; Manual-buffer-view-mode
|
|
|
68 ;; Manual-directory-list
|
|
|
69 ;; Manual-formatted-directory-list
|
|
|
70 ;; Manual-match-topic-exactly
|
|
|
71 ;; Manual-query-multiple-pages
|
|
|
72 ;; Manual-page-history
|
|
|
73 ;; Manual-subdirectory-list
|
|
|
74 ;; Manual-man-page-section-ids
|
|
|
75 ;; Manual-formatted-page-prefix
|
|
|
76 ;; Manual-unformatted-page-prefix
|
|
|
77 ;; Manual-use-full-section-ids
|
|
0
|
78
|
|
8
|
79 (defvar Manual-program "man" "\
|
|
|
80 *Name of the program to invoke in order to format the source man pages.")
|
|
0
|
81
|
|
8
|
82 (defvar Manual-section-switch (if (eq system-type 'usg-unix-v) "-s" nil)
|
|
|
83 "SysV needs this to work right.")
|
|
0
|
84
|
|
8
|
85 (defvar Manual-topic-buffer t "\
|
|
|
86 *Non-nil means \\[Manual-entry] should output the manual entry for TOPIC into
|
|
|
87 a buffer named *man TOPIC*, otherwise, it should name the buffer
|
|
|
88 *Manual Entry*.")
|
|
4
|
89
|
|
8
|
90 (defvar Manual-buffer-view-mode t "\
|
|
|
91 *Whether manual buffers should be placed in view-mode.
|
|
|
92 nil means leave the buffer in fundamental-mode in another window.
|
|
|
93 t means use `view-buffer' to display the man page in the current window.
|
|
|
94 Any other value means use `view-buffer-other-window'.")
|
|
0
|
95
|
|
8
|
96 (defvar Manual-match-topic-exactly t "\
|
|
|
97 *Non-nil means that \\[manual-entry] will match the given TOPIC exactly, rather
|
|
|
98 apply it as a pattern. When this is nil, and \"Manual-query-multiple-pages\"
|
|
|
99 is non-nil, then \\[manual-entry] will query you for all matching TOPICs.
|
|
|
100 This variable only has affect on the preformatted man pages (the \"cat\" files),
|
|
|
101 since the \"man\" command always does exact topic matches.")
|
|
0
|
102
|
|
8
|
103 (defvar Manual-query-multiple-pages nil "\
|
|
|
104 *Non-nil means that \\[manual-entry] will query the user about multiple man
|
|
|
105 pages which match the given topic. The query is done using the function
|
|
|
106 \"y-or-n-p\". If this variable is nil, all man pages with topics matching the
|
|
|
107 topic given to \\[manual-entry] will be inserted into the temporary buffer.
|
|
|
108 See the variable \"Manual-match-topic-exactly\" to control the matching.")
|
|
0
|
109
|
|
8
|
110 (defvar Manual-unique-man-sections-only nil
|
|
|
111 "*Only present one man page per section. This variable is useful if the same or
|
|
|
112 up/down level man pages for the same entry are present in mulitple man paths.
|
|
|
113 When set to t, only the first entry found in a section is displayed, the others
|
|
|
114 are ignored without any messages or warnings. Note that duplicates can occur if
|
|
|
115 the system has both formatted and unformatted version of the same page.")
|
|
0
|
116
|
|
8
|
117 (defvar Manual-mode-hook nil
|
|
|
118 "Function or functions run on entry to Manual-mode.")
|
|
0
|
119
|
|
8
|
120 (defvar Manual-directory-list nil "\
|
|
|
121 *A list of directories used with the \"man\" command, where each directory
|
|
|
122 contains a set of \"man?\" and \"cat?\" subdirectories. If this variable is nil,
|
|
|
123 it is initialized by \\[Manual-directory-list-init].")
|
|
0
|
124
|
|
8
|
125 (defvar Manual-formatted-directory-list nil "\
|
|
|
126 A list of directories containing formatted man pages. Initialized by
|
|
|
127 \\[Manual-directory-list-init].")
|
|
0
|
128
|
|
8
|
129 (defvar Manual-unformatted-directory-list nil "\
|
|
|
130 A list of directories containing the unformatted (source) man pages.
|
|
|
131 Initialized by \\[Manual-directory-list-init].")
|
|
0
|
132
|
|
8
|
133 (defvar Manual-page-history nil "\
|
|
|
134 A list of names of previously visited man page buffers.")
|
|
0
|
135
|
|
8
|
136 (defvar Manual-manpath-config-file "/usr/lib/manpath.config"
|
|
|
137 "*Location of the manpath.config file, if any.")
|
|
4
|
138
|
|
8
|
139 (defvar Manual-apropos-switch "-k"
|
|
|
140 "*Man apropos switch")
|
|
0
|
141
|
|
8
|
142 ;; New variables.
|
|
0
|
143
|
|
8
|
144 (defvar Manual-subdirectory-list nil "\
|
|
|
145 A list of all the subdirectories in which man pages may be found.
|
|
|
146 Iniialized by Manual-directory-list-init.")
|
|
0
|
147
|
|
8
|
148 ;; This is for SGI systems; don't know what it should be otherwise.
|
|
|
149 (defvar Manual-man-page-section-ids "1nl6823457poD" "\
|
|
|
150 String containing all suffix characters for \"cat\" and \"man\"
|
|
|
151 that identify valid sections of the Un*x manual.")
|
|
0
|
152
|
|
8
|
153 (defvar Manual-formatted-page-prefix "cat" "\
|
|
|
154 Prefix for directories where formatted man pages are to be found.
|
|
|
155 Defaults to \"cat\".")
|
|
0
|
156
|
|
8
|
157 (defvar Manual-unformatted-page-prefix "man" "\
|
|
|
158 Prefix for directories where unformatted man pages are to be found.
|
|
|
159 Defaults to \"man\".")
|
|
0
|
160
|
|
8
|
161 (defvar Manual-leaf-signature "" "\
|
|
|
162 Regexp for identifying \"leaf\" subdirectories in the search path.
|
|
|
163 If empty, initialized by Manual-directory-list-init.")
|
|
|
164
|
|
|
165 (defvar Manual-use-full-section-ids t "\
|
|
|
166 If non-nil, pass full section ids to Manual-program, otherwise pass
|
|
|
167 only the first character. Defaults to 't'.")
|
|
0
|
168
|
|
8
|
169 (defvar Manual-use-subdirectory-list (eq system-type 'irix) "\
|
|
|
170 This makes manual-entry work correctly on SGI machines but it
|
|
|
171 imposes a large startup cost which is why it is not simply on by
|
|
|
172 default on all systems.")
|
|
|
173
|
|
10
|
174 (defvar Manual-use-rosetta-man (not (null (locate-file "rman" exec-path))) "\
|
|
|
175 If non-nil, use RosettaMan (rman) to filter man pages.
|
|
|
176 This makes man-page cleanup virtually instantaneous, instead of
|
|
|
177 potentially taking a long time.
|
|
|
178
|
|
|
179 Here is information on RosettaMan, from Neal.Becker@comsat.com (Neal Becker):
|
|
|
180
|
|
|
181 RosettaMan is a filter for UNIX manual pages. It takes as input man
|
|
|
182 pages formatted for a variety of UNIX flavors (not [tn]roff source)
|
|
|
183 and produces as output a variety of file formats. Currently
|
|
|
184 RosettaMan accepts man pages as formatted by the following flavors of
|
|
|
185 UNIX: Hewlett-Packard HP-UX, AT&T System V, SunOS, Sun Solaris, OSF/1,
|
|
|
186 DEC Ultrix, SGI IRIX, Linux, SCO; and produces output for the following
|
|
|
187 formats: printable ASCII only (stripping page headers and footers),
|
|
|
188 section and subsection headers only, TkMan, [tn]roff, Ensemble, RTF,
|
|
|
189 SGML (soon--I finally found a DTD), HTML, MIME, LaTeX, LaTeX 2e, Perl 5's pod.
|
|
|
190
|
|
|
191 RosettaMan improves on other man page filters in several ways: (1) its
|
|
|
192 analysis recognizes the structural pieces of man pages, enabling high
|
|
|
193 quality output, (2) its modular structure permits easy augmentation of
|
|
|
194 output formats, (3) it accepts man pages formatted with the varient
|
|
|
195 macros of many different flavors of UNIX, and (4) it doesn't require
|
|
|
196 modification or cooperation with any other program.
|
|
|
197
|
|
|
198 RosettaMan is a rewrite of TkMan's man page filter, called bs2tk. (If
|
|
|
199 you haven't heard about TkMan, a hypertext man page browser, you
|
|
|
200 should grab it via anonymous ftp from ftp.cs.berkeley.edu:
|
|
|
201 /ucb/people/phelps/tkman.tar.Z.) Whereas bs2tk generated output only for
|
|
|
202 TkMan, RosettaMan generalizes the process so that the analysis can be
|
|
|
203 leveraged to new output formats. A single analysis engine recognizes
|
|
|
204 section heads, subsection heads, body text, lists, references to other
|
|
|
205 man pages, boldface, italics, bold italics, special characters (like
|
|
|
206 bullets), tables (to a degree) and strips out page headers and
|
|
|
207 footers. The engine sends signals to the selected output functions so
|
|
|
208 that an enhancement in the engine improves the quality of output of
|
|
|
209 all of them. Output format functions are easy to add, and thus far
|
|
|
210 average about about 75 lines of C code each.
|
|
|
211
|
|
|
212
|
|
|
213
|
|
|
214 *** NOTES ON CURRENT VERSION ***
|
|
|
215
|
|
|
216 Help! I'm looking for people to help with the following projects.
|
|
|
217 \(1) Better RTF output format. The current one works, but could be
|
|
|
218 made better. (2) Roff macros that produce text that is easily
|
|
|
219 parsable. RosettaMan handles a great variety, but some things, like
|
|
|
220 H-P's tables, are intractable. If you write an output format or
|
|
|
221 otherwise improve RosettaMan, please send in your code so that I may
|
|
|
222 share the wealth in future releases.
|
|
|
223
|
|
|
224 This version can try to identify tables (turn this on with the -T
|
|
|
225 switch) by looking for lines with a large amount of interword spacing,
|
|
|
226 reasoning that this is space between columns of a table. This
|
|
|
227 heuristic doesn't always work and sometimes misidentifies ordinary
|
|
|
228 text as tables. In general I think it is impossible to perfectly
|
|
|
229 identify tables from nroff formatted text. However, I do think the
|
|
|
230 heuristics can be tuned, so if you have a collection of manual pages
|
|
|
231 with unrecognized tables, send me the lot, in formatted form (i.e.,
|
|
|
232 after formatting with nroff -man), and uuencode them to preserve the
|
|
|
233 control characters. Better, if you can think of heuristics that
|
|
|
234 distinguish tables from ordinary text, I'd like to hear them.
|
|
|
235
|
|
|
236
|
|
|
237 Notes for HTML consumers: This filter does real (heuristic)
|
|
|
238 parsing--no <PRE>! Man page references are turned into hypertext links.")
|
|
|
239
|
|
8
|
240 (make-face 'man-italic)
|
|
|
241 (or (face-differs-from-default-p 'man-italic)
|
|
|
242 (copy-face 'italic 'man-italic))
|
|
|
243 ;; XEmacs (from Darrell Kindred): underlining is annoying due to
|
|
|
244 ;; large blank spaces in this face.
|
|
|
245 ;; (or (face-differs-from-default-p 'man-italic)
|
|
|
246 ;; (set-face-underline-p 'man-italic t))
|
|
0
|
247
|
|
8
|
248 (make-face 'man-bold)
|
|
|
249 (or (face-differs-from-default-p 'man-bold)
|
|
|
250 (copy-face 'bold 'man-bold))
|
|
|
251 (or (face-differs-from-default-p 'man-bold)
|
|
|
252 (copy-face 'man-italic 'man-bold))
|
|
0
|
253
|
|
8
|
254 (make-face 'man-heading)
|
|
|
255 (or (face-differs-from-default-p 'man-heading)
|
|
|
256 (copy-face 'man-bold 'man-heading))
|
|
0
|
257
|
|
8
|
258 (make-face 'man-xref)
|
|
|
259 (or (face-differs-from-default-p 'man-xref)
|
|
|
260 (set-face-underline-p 'man-xref t))
|
|
|
261
|
|
|
262 ;; Manual-directory-list-init
|
|
|
263 ;; Initialize the directory lists.
|
|
0
|
264
|
|
8
|
265 (defun Manual-directory-list-init (&optional arg)
|
|
|
266 "Initialize the Manual-directory-list variable from $MANPATH
|
|
|
267 if it is not already set, or if a prefix argument is provided."
|
|
|
268 (interactive "P")
|
|
|
269 (if arg (setq Manual-directory-list nil))
|
|
|
270 (if (null Manual-directory-list)
|
|
|
271 (let ((manpath (getenv "MANPATH"))
|
|
|
272 (global (Manual-manpath-config-contents))
|
|
|
273 (dirlist nil)
|
|
|
274 dir)
|
|
|
275 (cond ((and manpath global)
|
|
|
276 (setq manpath (concat manpath ":" global)))
|
|
|
277 (global
|
|
|
278 (setq manpath global))
|
|
|
279 ((not manpath)
|
|
|
280 ;; XEmacs - (bpw/stig) Unix-specifix hack for lusers w/ no manpath
|
|
|
281 (setq manpath "/usr/local/man:/usr/share/man:/usr/contrib/man:/usr/X11/man:/usr/man:/usr/catman")))
|
|
|
282 ;; Make sure that any changes we've made internally are seen by man.
|
|
|
283 (setenv "MANPATH" manpath)
|
|
|
284 (while (string-match "\\`:*\\([^:]+\\)" manpath)
|
|
|
285 (setq dir (substring manpath (match-beginning 1) (match-end 1)))
|
|
|
286 (and (not (member dir dirlist))
|
|
|
287 (setq dirlist (cons dir dirlist)))
|
|
|
288 (setq manpath (substring manpath (match-end 0))))
|
|
|
289 (setq dirlist (nreverse dirlist))
|
|
|
290 (setq Manual-directory-list dirlist)
|
|
|
291 (setq Manual-subdirectory-list nil)
|
|
|
292 (setq Manual-formatted-directory-list nil)
|
|
|
293 (setq Manual-unformatted-directory-list nil)))
|
|
|
294 (if (string-equal Manual-leaf-signature "")
|
|
|
295 (setq Manual-leaf-signature
|
|
|
296 (concat "/\\("
|
|
|
297 Manual-formatted-page-prefix
|
|
|
298 "\\|" Manual-unformatted-page-prefix
|
|
|
299 "\\)"
|
|
|
300 "[" Manual-man-page-section-ids
|
|
|
301 "].?/.")))
|
|
|
302 (if Manual-use-subdirectory-list
|
|
|
303 (progn
|
|
|
304 (if (null Manual-subdirectory-list)
|
|
|
305 (setq Manual-subdirectory-list
|
|
|
306 (Manual-all-subdirectories Manual-directory-list
|
|
|
307 Manual-leaf-signature nil)))
|
|
|
308 (if (null Manual-formatted-directory-list)
|
|
|
309 (setq Manual-formatted-directory-list
|
|
|
310 (Manual-filter-subdirectories Manual-subdirectory-list
|
|
|
311 Manual-formatted-page-prefix)))
|
|
|
312 (if (null Manual-unformatted-directory-list)
|
|
|
313 (setq Manual-unformatted-directory-list
|
|
|
314 (Manual-filter-subdirectories Manual-subdirectory-list
|
|
|
315 Manual-unformatted-page-prefix))))
|
|
|
316 (if (null Manual-formatted-directory-list)
|
|
|
317 (setq Manual-formatted-directory-list
|
|
|
318 (Manual-select-subdirectories Manual-directory-list
|
|
|
319 Manual-formatted-page-prefix)))
|
|
|
320 (if (null Manual-unformatted-directory-list)
|
|
|
321 (setq Manual-unformatted-directory-list
|
|
|
322 (Manual-select-subdirectories Manual-directory-list
|
|
|
323 Manual-unformatted-page-prefix)))))
|
|
0
|
324
|
|
|
325
|
|
8
|
326 (defun Manual-manpath-config-contents ()
|
|
|
327 "Parse the `Manual-manpath-config-file' file, if any.
|
|
|
328 Returns a string like in $MANPATH."
|
|
|
329 (if (and Manual-manpath-config-file
|
|
|
330 (file-readable-p Manual-manpath-config-file))
|
|
|
331 (let ((buf (get-buffer-create " *Manual-config*"))
|
|
|
332 path)
|
|
|
333 (set-buffer buf)
|
|
|
334 (buffer-disable-undo buf)
|
|
|
335 (erase-buffer)
|
|
|
336 (insert-file-contents Manual-manpath-config-file)
|
|
|
337 (while (re-search-forward "^\\(MANDATORY_MANPATH\\|MANPATH_MAP\\)"
|
|
|
338 nil t)
|
|
|
339 (and (re-search-forward "\\(/[^ \t\n]+\\)[ \t]*$")
|
|
|
340 (setq path (concat path (buffer-substring (match-beginning 1)
|
|
|
341 (match-end 1))
|
|
|
342 ":"))))
|
|
|
343 (kill-buffer buf)
|
|
|
344 path)))
|
|
|
345 ;;
|
|
|
346 ;; manual-entry -- The "main" user function
|
|
|
347 ;;
|
|
0
|
348
|
|
|
349 ;;;###autoload
|
|
8
|
350 (defun manual-entry (topic &optional arg silent)
|
|
|
351 "Display the Unix manual entry (or entries) for TOPIC.
|
|
|
352 If prefix arg is given, modify the search according to the value:
|
|
|
353 2 = complement default exact matching of the TOPIC name;
|
|
|
354 exact matching default is specified by `Manual-match-topic-exactly'
|
|
|
355 3 = force a search of the unformatted man directories
|
|
|
356 4 = both 2 and 3
|
|
|
357 The manual entries are searched according to the variable
|
|
|
358 Manual-directory-list, which should be a list of directories. If
|
|
|
359 Manual-directory-list is nil, \\[Manual-directory-list-init] is
|
|
|
360 invoked to create this list from the MANPATH environment variable.
|
|
|
361 See the variable Manual-topic-buffer which controls how the buffer
|
|
|
362 is named. See also the variables Manual-match-topic-exactly,
|
|
|
363 Manual-query-multiple-pages, and Manual-buffer-view-mode."
|
|
|
364 (interactive
|
|
|
365 (list (let* ((fmh "-A-Za-z0-9_.")
|
|
|
366 (default (save-excursion
|
|
|
367 (buffer-substring
|
|
|
368 (progn
|
|
|
369 (re-search-backward "\\sw" nil t)
|
|
|
370 (skip-chars-backward fmh) (point))
|
|
|
371 (progn (skip-chars-forward fmh) (point)))))
|
|
|
372 (thing (read-string
|
|
|
373 (if (equal default "") "Manual entry: "
|
|
|
374 (concat "Manual entry: (default " default ") ")))))
|
|
|
375 (if (equal thing "") default thing))
|
|
|
376 (prefix-numeric-value current-prefix-arg)))
|
|
|
377 ;;(interactive "sManual entry (topic): \np")
|
|
|
378 (or arg (setq arg 1))
|
|
|
379 (Manual-directory-list-init nil)
|
|
|
380 (let ((exact (if (or (= arg 2) (= arg 4))
|
|
|
381 (not Manual-match-topic-exactly)
|
|
|
382 Manual-match-topic-exactly))
|
|
|
383 (force (if (>= arg 3)
|
|
|
384 t
|
|
|
385 nil))
|
|
|
386 section fmtlist manlist apropos-mode)
|
|
|
387 (let ((case-fold-search nil))
|
|
|
388 (if (and (null section)
|
|
|
389 (string-match
|
|
|
390 "\\`[ \t]*\\([^( \t]+\\)[ \t]*(\\(.+\\))[ \t]*\\'" topic))
|
|
|
391 (setq section (substring topic (match-beginning 2)
|
|
|
392 (match-end 2))
|
|
|
393 topic (substring topic (match-beginning 1)
|
|
|
394 (match-end 1)))
|
|
|
395 (if (string-match "\\`[ \t]*-k[ \t]+\\([^ \t]+\\)\\'" topic)
|
|
|
396 (setq section "-k"
|
|
|
397 topic (substring topic (match-beginning 1))))))
|
|
|
398 (if (equal section "-k")
|
|
|
399 (setq apropos-mode t)
|
|
|
400 (or silent
|
|
|
401 (message "Looking for formatted entry for %s%s..."
|
|
|
402 topic (if section (concat "(" section ")") "")))
|
|
|
403 (setq fmtlist (Manual-select-man-pages
|
|
|
404 Manual-formatted-directory-list
|
|
|
405 topic section exact '()))
|
|
|
406 (if (or force (not section) (null fmtlist))
|
|
|
407 (progn
|
|
|
408 (or silent
|
|
|
409 (message "%sooking for unformatted entry for %s%s..."
|
|
|
410 (if fmtlist "L" "No formatted entry, l")
|
|
|
411 topic (if section (concat "(" section ")") "")))
|
|
|
412 (setq manlist (Manual-select-man-pages
|
|
|
413 Manual-unformatted-directory-list
|
|
|
414 topic section exact (if force '() fmtlist))))))
|
|
|
415
|
|
|
416 ;; Delete duplicate man pages (a file of the same name in multiple
|
|
|
417 ;; directories.)
|
|
|
418 (or nil ;force
|
|
|
419 (let ((rest (append fmtlist manlist)))
|
|
|
420 (while rest
|
|
|
421 (let ((rest2 (cdr rest)))
|
|
|
422 (while rest2
|
|
|
423 (if (equal (file-name-nondirectory (car rest))
|
|
|
424 (file-name-nondirectory (car rest2)))
|
|
|
425 (setq fmtlist (delq (car rest2) fmtlist)
|
|
|
426 manlist (delq (car rest2) manlist)))
|
|
|
427 (setq rest2 (cdr rest2))))
|
|
|
428 (setq rest (cdr rest)))))
|
|
|
429
|
|
|
430 (if (not (or fmtlist manlist apropos-mode))
|
|
|
431 (progn
|
|
|
432 (message "No entries found for %s%s" topic
|
|
|
433 (if section (concat "(" section ")") ""))
|
|
|
434 nil)
|
|
|
435 (let ((bufname (cond ((not Manual-topic-buffer)
|
|
|
436 ;; What's the point of retaining this?
|
|
|
437 (if apropos-mode
|
|
|
438 "*Manual Apropos*"
|
|
|
439 "*Manual Entry*"))
|
|
|
440 (apropos-mode
|
|
|
441 (concat "*man apropos " topic "*"))
|
|
|
442 (t
|
|
|
443 (concat "*man "
|
|
|
444 (cond (exact
|
|
|
445 (if section
|
|
|
446 (concat topic "." section)
|
|
|
447 topic))
|
|
|
448 ((or (cdr fmtlist) (cdr manlist)
|
|
|
449 (and fmtlist manlist))
|
|
|
450 ;; more than one entry found
|
|
|
451 (concat topic "..."))
|
|
|
452 (t
|
|
|
453 (file-name-nondirectory
|
|
|
454 (car (or fmtlist manlist)))))
|
|
|
455 "*"))))
|
|
|
456 (temp-buffer-show-function
|
|
|
457 (cond ((eq 't Manual-buffer-view-mode) 'view-buffer)
|
|
|
458 ((eq 'nil Manual-buffer-view-mode)
|
|
|
459 temp-buffer-show-function)
|
|
|
460 (t 'view-buffer-other-window))))
|
|
|
461
|
|
|
462 (if apropos-mode
|
|
|
463 (setq manlist (list (format "%s.%s" topic section))))
|
|
|
464
|
|
|
465 (cond
|
|
|
466 ((and Manual-topic-buffer (get-buffer bufname))
|
|
|
467 ;; reselect an old man page buffer if it exists already.
|
|
|
468 (save-excursion
|
|
|
469 (set-buffer (get-buffer bufname))
|
|
|
470 (Manual-mode))
|
|
|
471 (if temp-buffer-show-function
|
|
|
472 (funcall temp-buffer-show-function (get-buffer bufname))
|
|
|
473 (display-buffer bufname)))
|
|
|
474 (t
|
|
|
475 (with-output-to-temp-buffer bufname
|
|
|
476 (buffer-disable-undo standard-output)
|
|
|
477 (save-excursion
|
|
|
478 (set-buffer standard-output)
|
|
|
479 (setq buffer-read-only nil)
|
|
|
480 (erase-buffer)
|
|
|
481 (Manual-insert-pages fmtlist manlist apropos-mode)
|
|
|
482 (set-buffer-modified-p nil)
|
|
|
483 (Manual-mode)
|
|
|
484 ))))
|
|
|
485 (setq Manual-page-history
|
|
|
486 (cons (buffer-name)
|
|
|
487 (delete (buffer-name) Manual-page-history)))
|
|
|
488 (message nil)
|
|
|
489 t))))
|
|
|
490
|
|
|
491 (defun Manpage-apropos (topic &optional arg silent)
|
|
|
492 "Apropos on Unix manual pages for TOPIC.
|
|
|
493 It calls the function `manual-entry'. Look at this function for
|
|
|
494 further description. Look also at the variable `Manual-apropos-switch',
|
|
|
495 if this function doesn't work on your system."
|
|
0
|
496 (interactive
|
|
8
|
497 (list (let* ((fmh "-A-Za-z0-9_.")
|
|
|
498 (default (save-excursion
|
|
|
499 (buffer-substring
|
|
|
500 (progn
|
|
|
501 (re-search-backward "\\sw" nil t)
|
|
|
502 (skip-chars-backward fmh) (point))
|
|
|
503 (progn (skip-chars-forward fmh) (point)))))
|
|
|
504 (thing (read-string
|
|
|
505 (if (equal default "") "Manual entry: "
|
|
|
506 (concat "Manual entry: (default " default ") ")))))
|
|
|
507 (if (equal thing "") default thing))
|
|
|
508 (prefix-numeric-value current-prefix-arg)))
|
|
|
509 (manual-entry (concat Manual-apropos-switch " " topic) arg silent))
|
|
|
510
|
|
|
511 (defun Manual-insert-pages (fmtlist manlist apropos-mode)
|
|
|
512 (let ((sep (make-string 65 ?-))
|
|
|
513 name start end topic section)
|
|
|
514 (while fmtlist ; insert any formatted files
|
|
|
515 (setq name (car fmtlist))
|
|
|
516 (goto-char (point-max))
|
|
|
517 (setq start (point))
|
|
|
518 ;; In case the file can't be read or uncompressed or
|
|
|
519 ;; something like that.
|
|
|
520 (condition-case ()
|
|
|
521 (Manual-insert-man-file name)
|
|
|
522 (file-error nil))
|
|
|
523 (goto-char (point-max))
|
|
|
524 (setq end (point))
|
|
|
525 (save-excursion
|
|
|
526 (save-restriction
|
|
|
527 (message "Cleaning manual entry for %s..."
|
|
|
528 (file-name-nondirectory name))
|
|
|
529 (narrow-to-region start end)
|
|
|
530 (Manual-nuke-nroff-bs)
|
|
|
531 (goto-char (point-min))
|
|
|
532 (insert "File: " name "\n")
|
|
|
533 (goto-char (point-max))
|
|
|
534 ))
|
|
|
535 (if (or (cdr fmtlist) manlist)
|
|
|
536 (insert "\n\n" sep "\n"))
|
|
|
537 (setq fmtlist (cdr fmtlist)))
|
|
0
|
538
|
|
8
|
539 (while manlist ; process any unformatted files
|
|
|
540 (setq name (car manlist))
|
|
|
541 (or (string-match "\\([^/]+\\)\\.\\([^./]+\\)\\(\\.gz\\'\\)" name)
|
|
|
542 (string-match "\\([^/]+\\)\\.\\([^./]+\\)\\'" name))
|
|
|
543 (setq topic (substring name (match-beginning 1) (match-end 1)))
|
|
|
544 (setq section (substring name (match-beginning 2) (match-end 2)))
|
|
|
545 ;; This won't work under IRIX, because SGI man accepts only the
|
|
|
546 ;; "main" (one-character) section id, not full section ids
|
|
|
547 ;; like 1M, 3X, etc. Put (setq Manual-use-full-section-ids nil)
|
|
|
548 ;; in your .emacs to work around this problem.
|
|
|
549 (if (not (or Manual-use-full-section-ids (string-equal section "")))
|
|
|
550 (setq section (substring section 0 1)))
|
|
|
551 (message "Invoking man %s%s %s..."
|
|
|
552 (if Manual-section-switch
|
|
|
553 (concat Manual-section-switch " ")
|
|
|
554 "")
|
|
|
555 section topic)
|
|
|
556 (setq start (point))
|
|
|
557 (Manual-run-formatter name topic section)
|
|
|
558 (setq end (point))
|
|
|
559 (save-excursion
|
|
|
560 (save-restriction
|
|
|
561 (message "Cleaning manual entry for %s(%s)..." topic section)
|
|
|
562 (narrow-to-region start end)
|
|
|
563 (Manual-nuke-nroff-bs apropos-mode)
|
|
|
564 (goto-char (point-min))
|
|
|
565 (insert "File: " name "\n")
|
|
|
566 (goto-char (point-max))
|
|
|
567 ))
|
|
|
568 (if (cdr manlist)
|
|
|
569 (insert "\n\n" sep "\n"))
|
|
|
570 (setq manlist (cdr manlist))))
|
|
|
571 (if (< (buffer-size) 200)
|
|
|
572 (progn
|
|
|
573 (goto-char (point-min))
|
|
|
574 (if (looking-at "^File: ")
|
|
|
575 (forward-line 1))
|
|
|
576 (error (buffer-substring (point) (progn (end-of-line) (point))))))
|
|
|
577 nil)
|
|
|
578
|
|
|
579
|
|
|
580 (defun Manual-run-formatter (name topic section)
|
|
|
581 (cond ((string-match "roff\\'" Manual-program)
|
|
|
582 ;; kludge kludge
|
|
|
583 (call-process Manual-program nil t nil "-Tman" "-man" name))
|
|
|
584 (Manual-section-switch
|
|
|
585 (call-process Manual-program nil t nil Manual-section-switch
|
|
|
586 section topic))
|
|
|
587 (t
|
|
|
588 (call-process Manual-program nil t nil section topic))))
|
|
|
589
|
|
0
|
590
|
|
8
|
591 (defvar Manual-mode-map
|
|
|
592 (let ((m (make-sparse-keymap)))
|
|
|
593 (set-keymap-name m 'Manual-mode-map)
|
|
|
594 (define-key m "l" 'Manual-last-page)
|
|
|
595 (define-key m 'button2 'Manual-follow-xref)
|
|
|
596 (define-key m 'button3 'Manual-popup-menu)
|
|
|
597 m))
|
|
|
598
|
|
|
599 (defun Manual-mode ()
|
|
|
600 (kill-all-local-variables)
|
|
|
601 (setq buffer-read-only t)
|
|
|
602 (use-local-map Manual-mode-map)
|
|
|
603 (setq major-mode 'Manual-mode
|
|
|
604 mode-name "Manual")
|
|
|
605 ;; man pages with long lines are buggy!
|
|
|
606 ;; This looks slightly better if they only
|
|
|
607 ;; overran by a couple of chars.
|
|
|
608 (setq truncate-lines t)
|
|
|
609 ;; turn off horizontal scrollbars in this buffer
|
|
16
|
610 (when (featurep 'scrollbar)
|
|
|
611 (set-specifier scrollbar-height (cons (current-buffer) 0)))
|
|
8
|
612 (run-hooks 'Manual-mode-hook))
|
|
|
613
|
|
|
614 (defun Manual-last-page ()
|
|
|
615 (interactive)
|
|
|
616 (while (or (not (get-buffer (car (or Manual-page-history
|
|
|
617 (error "No more history.")))))
|
|
|
618 (eq (get-buffer (car Manual-page-history)) (current-buffer)))
|
|
|
619 (setq Manual-page-history (cdr Manual-page-history)))
|
|
|
620 (switch-to-buffer (car Manual-page-history)))
|
|
|
621
|
|
|
622
|
|
|
623 ;; Manual-select-subdirectories
|
|
|
624 ;; Given a DIRLIST and a SUBDIR name, return all subdirectories of the former which
|
|
|
625 ;; match the latter.
|
|
|
626
|
|
|
627 (defun Manual-select-subdirectories (dirlist subdir)
|
|
|
628 (let ((dirs '())
|
|
|
629 (case-fold-search nil)
|
|
|
630 (match (concat "\\`" (regexp-quote subdir)))
|
|
|
631 d)
|
|
|
632 (while dirlist
|
|
|
633 (setq d (car dirlist) dirlist (cdr dirlist))
|
|
|
634 (if (file-directory-p d)
|
|
|
635 (let ((files (directory-files d t match nil 'dirs-only))
|
|
|
636 (dir-temp '()))
|
|
|
637 (while files
|
|
|
638 (if (file-executable-p (car files))
|
|
|
639 (setq dir-temp (cons (file-name-as-directory (car files))
|
|
|
640 dir-temp)))
|
|
|
641 (setq files (cdr files)))
|
|
|
642 (and dir-temp
|
|
|
643 (setq dirs (append dirs (nreverse dir-temp)))))))
|
|
|
644 dirs))
|
|
0
|
645
|
|
|
646
|
|
8
|
647 ;; Manual-filter-subdirectories
|
|
|
648 ;; Given a DIRLIST and a SUBDIR name, return all members of the former
|
|
|
649 ;; which match the latter.
|
|
|
650
|
|
|
651 (defun Manual-filter-subdirectories (dirlist subdir)
|
|
|
652 (let ((match (concat
|
|
|
653 "/"
|
|
|
654 (regexp-quote subdir)
|
|
|
655 "[" Manual-man-page-section-ids "]"))
|
|
|
656 slist dir)
|
|
|
657 (while dirlist
|
|
|
658 (setq dir (car dirlist) dirlist (cdr dirlist))
|
|
|
659 (if (and (file-executable-p dir) (string-match match dir))
|
|
|
660 (setq slist (cons dir slist))))
|
|
|
661 (nreverse slist)))
|
|
|
662
|
|
|
663
|
|
|
664 (defun Manual-all-subdirectories (dirlist leaf-signature dirs &optional silent) "\
|
|
|
665 Given a DIRLIST, return a backward-sorted list of all subdirectories
|
|
|
666 thereof, prepended to DIRS if non-nil. This function calls itself
|
|
|
667 recursively until subdirectories matching LEAF-SIGNATURE are reached,
|
|
|
668 or the hierarchy has been thoroughly searched. This code is a modified
|
|
|
669 version of a function written by Tim Bradshaw (tfb@ed.ac.uk)."
|
|
|
670 (Manual-all-subdirectories-noloop dirlist leaf-signature dirs nil silent))
|
|
|
671
|
|
|
672 (defun Manual-all-subdirectories-noloop (dirlist leaf-signature dirs been &optional silent) "\
|
|
|
673 Does the job of manual-all-subdirectories and keeps track of where it
|
|
|
674 has been to avoid loops."
|
|
|
675 (let (dir)
|
|
|
676 (while dirlist
|
|
|
677 (setq dir (car dirlist) dirlist (cdr dirlist))
|
|
|
678 (if (file-directory-p dir)
|
|
|
679 (let ((dir-temp (cons (file-name-as-directory dir) dirs)))
|
|
|
680 ;; Without feedback the user might wonder about the delay!
|
|
|
681 (or silent (message
|
|
|
682 "Building list of search directories... %s"
|
|
|
683 (car dir-temp)))
|
|
|
684 (if (member (file-truename dir) been)
|
|
|
685 () ; Ignore. We have been here before
|
|
|
686 (setq been (cons (file-truename dir) been))
|
|
|
687 (setq dirs
|
|
|
688 (if (string-match leaf-signature dir)
|
|
|
689 dir-temp
|
|
|
690 (Manual-all-subdirectories-noloop
|
|
|
691 (directory-files dir t "[^.]$" nil 'dirs-only)
|
|
|
692 leaf-signature dir-temp been silent))))))))
|
|
|
693 dirs)
|
|
|
694
|
|
|
695
|
|
|
696 (defvar Manual-bogus-file-pattern "\\.\\(lpr\\|ps\\|PS\\)\\'"
|
|
|
697 "Some systems have files in the man/man*/ directories which aren't man pages.
|
|
|
698 This pattern is used to prune those files.")
|
|
|
699
|
|
|
700 ;; Manual-select-man-pages
|
|
|
701 ;;
|
|
|
702 ;; Given a DIRLIST, discover all filenames which complete given the TOPIC
|
|
|
703 ;; and SECTION.
|
|
|
704
|
|
|
705 ;; ## Note: BSD man looks for .../man1/foo.1 and .../man1/$MACHINE/foo.1
|
|
|
706
|
|
|
707 ;; ## Fixed for SGI IRIX 5.x on Sat Jul 15 1995 by Dale Atems
|
|
|
708 ;; (atems@physics.wayne.edu).
|
|
|
709
|
|
|
710 (defun Manual-select-man-pages (dirlist topic section exact shadow)
|
|
|
711 (let ((case-fold-search nil))
|
|
|
712 (and section
|
|
|
713 (let ((l '())
|
|
|
714 ;;(match (concat (substring section 0 1) "/?\\'"))
|
|
|
715 ;; ^^^
|
|
|
716 ;; We'll lose any pages inside subdirectories of the "standard"
|
|
|
717 ;; ones if we insist on this! The following regexp should
|
|
|
718 ;; match any directory ending with the full section id or
|
|
|
719 ;; its first character, or any direct subdirectory thereof:
|
|
|
720 (match (concat "\\("
|
|
|
721 (regexp-quote section)
|
|
|
722 "\\|"
|
|
|
723 (substring section 0 1)
|
|
|
724 "\\)/?"))
|
|
|
725 d)
|
|
|
726 (while dirlist
|
|
|
727 (setq d (car dirlist) dirlist (cdr dirlist))
|
|
|
728 (if (string-match match d)
|
|
|
729 (setq l (cons d l))))
|
|
|
730 (setq dirlist l)))
|
|
|
731 (if shadow
|
|
|
732 (setq shadow (concat "/\\("
|
|
|
733 (mapconcat #'(lambda (n)
|
|
|
734 (regexp-quote
|
|
|
735 (file-name-nondirectory n)))
|
|
|
736 shadow
|
|
|
737 "\\|")
|
|
|
738 "\\)\\'")))
|
|
|
739 (let ((manlist '())
|
|
|
740 (match (concat "\\`"
|
|
|
741 (regexp-quote topic)
|
|
|
742 ;; **Note: on IRIX the preformatted pages
|
|
|
743 ;; are packed, so they end with ".z". This
|
|
|
744 ;; way you miss them if you specify a
|
|
|
745 ;; section. I don't see any point to it here
|
|
|
746 ;; even on BSD systems since we're looking
|
|
|
747 ;; one level down already, but I can't test
|
|
|
748 ;; this. More thought needed (???)
|
|
0
|
749
|
|
8
|
750 (cond ((and section
|
|
|
751 (not Manual-use-subdirectory-list))
|
|
|
752 (concat "\\." (regexp-quote section)))
|
|
|
753 (exact
|
|
|
754 ;; If Manual-match-topic-exactly is
|
|
|
755 ;; set, then we must make sure the
|
|
|
756 ;; completions are exact, except for
|
|
|
757 ;; trailing weird characters after
|
|
|
758 ;; the section.
|
|
|
759 "\\.")
|
|
|
760 (t
|
|
|
761 ""))))
|
|
|
762 dir)
|
|
|
763 (while dirlist
|
|
|
764 (setq dir (car dirlist) dirlist (cdr dirlist))
|
|
|
765 (if (not (file-directory-p dir))
|
|
|
766 (progn
|
|
|
767 (message "warning: %s is not a directory" dir)
|
|
|
768 ;;(sit-for 1)
|
|
|
769 )
|
|
|
770 (let ((files (directory-files dir t match nil t))
|
|
|
771 f)
|
|
|
772 (while files
|
|
|
773 (setq f (car files) files (cdr files))
|
|
|
774 (cond ((string-match Manual-bogus-file-pattern f)
|
|
|
775 ;(message "Bogus fule %s" f) (sit-for 2)
|
|
|
776 )
|
|
|
777 ((and shadow (string-match shadow f))
|
|
|
778 ;(message "Shadowed %s" f) (sit-for 2)
|
|
|
779 )
|
|
|
780 ((not (file-readable-p f))
|
|
|
781 ;(message "Losing with %s" f) (sit-for 2)
|
|
|
782 )
|
|
|
783 (t
|
|
|
784 (setq manlist (cons f manlist))))))))
|
|
|
785 (setq manlist (nreverse manlist))
|
|
|
786 (and Manual-unique-man-sections-only
|
|
|
787 (setq manlist (Manual-clean-to-unique-pages-only manlist)))
|
|
|
788 (if (and manlist Manual-query-multiple-pages)
|
|
|
789 (apply #'append
|
|
|
790 (mapcar #'(lambda (page)
|
|
|
791 (and page
|
|
|
792 (y-or-n-p (format "Read %s? " page))
|
|
|
793 (list page)))
|
|
|
794 manlist))
|
|
|
795 manlist))))
|
|
0
|
796
|
|
8
|
797 (defun Manual-clean-to-unique-pages-only (manlist)
|
|
|
798 "Prune the current list of pages down to a unique set."
|
|
|
799 (let (page-name unique-pages)
|
|
|
800 (apply 'append
|
|
|
801 (mapcar '(lambda (page)
|
|
|
802 (cond (page
|
|
|
803 (and (string-match ".*/\\(.*\\)" page)
|
|
|
804 (setq page-name (substring page (match-beginning 1)
|
|
|
805 (match-end 1)))
|
|
|
806 ;; try to clip off .Z, .gz suffixes
|
|
|
807 (and (string-match "\\(.*\\)\\.\\(.+\\)\\.\\(.+\\)"
|
|
|
808 page-name)
|
|
|
809 (setq page-name
|
|
|
810 (substring page-name (match-beginning 1)
|
|
|
811 (match-end 2)))))
|
|
|
812 ;; add Manual-unique-pages if it isn't there
|
|
|
813 ;; and return file
|
|
|
814 (if (and unique-pages
|
|
|
815 page-name
|
|
|
816 (string-match (concat "\\b" page-name "\\b")
|
|
|
817 unique-pages))
|
|
|
818 nil
|
|
|
819 (setq unique-pages (concat unique-pages
|
|
|
820 page-name
|
|
|
821 " "))
|
|
|
822 (list page)))))
|
|
|
823 manlist))))
|
|
|
824
|
|
|
825
|
|
|
826
|
|
|
827 (defun Manual-insert-man-file (name)
|
|
|
828 ;; Insert manual file (unpacked as necessary) into buffer
|
|
|
829 (cond ((equal (substring name -3) ".gz")
|
|
|
830 (call-process "gunzip" nil t nil "--stdout" name))
|
|
|
831 ((or (equal (substring name -2) ".Z")
|
|
|
832 ;; HPUX uses directory names that end in .Z and compressed
|
|
|
833 ;; files that don't. How gratuitously random.
|
|
|
834 (let ((case-fold-search nil))
|
|
|
835 (string-match "\\.Z/" name)))
|
|
|
836 (call-process "zcat" name t nil)) ;; XEmacs change for HPUX
|
|
|
837 ((equal (substring name -2) ".z")
|
|
|
838 (call-process "pcat" nil t nil name))
|
|
|
839 (t
|
|
|
840 (insert-file-contents name))))
|
|
|
841
|
|
|
842 (defmacro Manual-delete-char (n)
|
|
|
843 ;; in v19, delete-char is compiled as a function call, but delete-region
|
|
|
844 ;; is byte-coded, so it's much faster. (We were spending 40% of our time
|
|
|
845 ;; in delete-char alone.)
|
|
|
846 (list 'delete-region '(point) (list '+ '(point) n)))
|
|
|
847
|
|
|
848 ;; Hint: BS stands form more things than "back space"
|
|
|
849 (defun Manual-nuke-nroff-bs (&optional apropos-mode)
|
|
|
850 (interactive "*")
|
|
10
|
851 (if Manual-use-rosetta-man
|
|
|
852 (call-process-region (point-min) (point-max) "rman" t t nil)
|
|
|
853 ;;
|
|
|
854 ;; turn underlining into italics
|
|
|
855 ;;
|
|
|
856 (goto-char (point-min))
|
|
|
857 (while (search-forward "_\b" nil t)
|
|
|
858 ;; searching for underscore-backspace and then comparing the following
|
|
|
859 ;; chars until the sequence ends turns out to be much faster than searching
|
|
|
860 ;; for a regexp which matches the whole sequence.
|
|
|
861 (let ((s (match-beginning 0)))
|
|
|
862 (goto-char s)
|
|
|
863 (while (and (= (following-char) ?_)
|
|
|
864 (= (char-after (1+ (point))) ?\b))
|
|
|
865 (Manual-delete-char 2)
|
|
|
866 (forward-char 1))
|
|
|
867 (set-extent-face (make-extent s (point)) 'man-italic)))
|
|
|
868 ;;
|
|
|
869 ;; turn overstriking into bold
|
|
|
870 ;;
|
|
|
871 (goto-char (point-min))
|
|
|
872 (while (re-search-forward "\\([^\n]\\)\\(\b\\1\\)" nil t)
|
|
|
873 ;; Surprisingly, searching for the above regexp is faster than searching
|
|
|
874 ;; for a backspace and then comparing the preceding and following chars,
|
|
|
875 ;; I presume because there are many false matches, meaning more funcalls
|
|
|
876 ;; to re-search-forward.
|
|
|
877 (let ((s (match-beginning 0)))
|
|
|
878 (goto-char s)
|
|
|
879 ;; Some systems (SGI) overstrike multiple times, eg, "M\bM\bM\bM".
|
|
|
880 (while (looking-at "\\([^\n]\\)\\(\b\\1\\)+")
|
|
|
881 (delete-region (+ (point) 1) (match-end 0))
|
|
|
882 (forward-char 1))
|
|
|
883 (set-extent-face (make-extent s (point)) 'man-bold)))
|
|
|
884 ;;
|
|
|
885 ;; hack bullets: o^H+ --> +
|
|
|
886 (goto-char (point-min))
|
|
|
887 (while (search-forward "\b" nil t)
|
|
|
888 (Manual-delete-char -2))
|
|
0
|
889
|
|
10
|
890 (if (> (buffer-size) 100) ; minor kludge
|
|
|
891 (Manual-nuke-nroff-bs-footers))
|
|
|
892 ) ;; not Manual-use-rosetta-man
|
|
8
|
893 ;;
|
|
|
894 ;; turn subsection header lines into bold
|
|
|
895 ;;
|
|
|
896 (goto-char (point-min))
|
|
|
897 (if apropos-mode
|
|
|
898 (while (re-search-forward "[a-zA-Z0-9] ([0-9]" nil t)
|
|
|
899 (forward-char -2)
|
|
|
900 (delete-backward-char 1))
|
|
0
|
901
|
|
8
|
902 ;; (while (re-search-forward "^[^ \t\n]" nil t)
|
|
|
903 ;; (set-extent-face (make-extent (match-beginning 0)
|
|
|
904 ;; (progn (end-of-line) (point)))
|
|
|
905 ;; 'man-heading))
|
|
4
|
906
|
|
8
|
907 ;; boldface the first line
|
|
|
908 (if (looking-at "[^ \t\n].*$")
|
|
|
909 (set-extent-face (make-extent (match-beginning 0) (match-end 0))
|
|
|
910 'man-bold))
|
|
0
|
911
|
|
8
|
912 ;; boldface subsequent title lines
|
|
|
913 ;; Regexp to match section headers changed to match a non-indented
|
|
|
914 ;; line preceded by a blank line and followed by an indented line.
|
|
|
915 ;; This seems to work ok for manual pages but gives better results
|
|
|
916 ;; with other nroff'd files
|
|
|
917 (while (re-search-forward "\n\n\\([^ \t\n].*\\)\n[ \t]+[^ \t\n]" nil t)
|
|
|
918 (goto-char (match-end 1))
|
|
|
919 (set-extent-face (make-extent (match-beginning 1) (match-end 1))
|
|
|
920 'man-heading)
|
|
|
921 (forward-line 1))
|
|
|
922 )
|
|
0
|
923
|
|
10
|
924 (if Manual-use-rosetta-man
|
|
|
925 nil
|
|
|
926 ;; Zap ESC7, ESC8, and ESC9
|
|
|
927 ;; This is for Sun man pages like "man 1 csh"
|
|
|
928 (goto-char (point-min))
|
|
|
929 (while (re-search-forward "\e[789]" nil t)
|
|
|
930 (replace-match "")))
|
|
|
931
|
|
8
|
932 ;; Nuke blanks lines at start.
|
|
|
933 ;; (goto-char (point-min))
|
|
|
934 ;; (skip-chars-forward "\n")
|
|
|
935 ;; (delete-region (point-min) (point))
|
|
|
936
|
|
|
937 (Manual-mouseify-xrefs)
|
|
|
938 )
|
|
|
939
|
|
|
940 (fset 'nuke-nroff-bs 'Manual-nuke-nroff-bs) ; use old name
|
|
|
941
|
|
0
|
942
|
|
8
|
943 (defun Manual-nuke-nroff-bs-footers ()
|
|
|
944 ;; Nuke headers and footers.
|
|
|
945 ;;
|
|
|
946 ;; nroff assumes pages are 66 lines high. We assume that, and that the
|
|
|
947 ;; first and last line on each page is expendible. There is no way to
|
|
|
948 ;; tell the difference between a page break in the middle of a paragraph
|
|
|
949 ;; and a page break between paragraphs (the amount of extra whitespace
|
|
|
950 ;; that nroff inserts is the same in both cases) so this might strip out
|
|
|
951 ;; a blank line were one should remain. I think that's better than
|
|
|
952 ;; leaving in a blank line where there shouldn't be one. (Need I say
|
|
|
953 ;; it: FMH.)
|
|
|
954 ;;
|
|
|
955 ;; Note that if nroff spits out error messages, pages will be more than
|
|
|
956 ;; 66 lines high, and we'll lose badly. That's ok because standard
|
|
|
957 ;; nroff doesn't do any diagnostics, and the "gnroff" wrapper for groff
|
|
|
958 ;; turns off error messages for compatibility. (At least, it's supposed
|
|
|
959 ;; to.)
|
|
|
960 ;;
|
|
|
961 (goto-char (point-min))
|
|
|
962 ;; first lose the status output
|
|
|
963 (let ((case-fold-search t))
|
|
|
964 (if (and (not (looking-at "[^\n]*warning"))
|
|
|
965 (looking-at "Reformatting.*\n"))
|
|
|
966 (delete-region (match-beginning 0) (match-end 0))))
|
|
4
|
967
|
|
8
|
968 ;; kludge around a groff bug where it won't keep quiet about some
|
|
|
969 ;; warnings even with -Wall or -Ww.
|
|
|
970 (cond ((looking-at "grotty:")
|
|
|
971 (while (looking-at "grotty:")
|
|
|
972 (delete-region (point) (progn (forward-line 1) (point))))
|
|
|
973 (if (looking-at " *done\n")
|
|
|
974 (delete-region (point) (match-end 0)))))
|
|
0
|
975
|
|
8
|
976 (let ((pages '())
|
|
|
977 p)
|
|
|
978 ;; collect the page boundary markers before we start deleting, to make
|
|
|
979 ;; it easier to strip things out without changing the page sizes.
|
|
|
980 (while (not (eobp))
|
|
|
981 (forward-line 66)
|
|
|
982 (setq pages (cons (point-marker) pages)))
|
|
|
983 (setq pages (nreverse pages))
|
|
|
984 (while pages
|
|
|
985 (goto-char (car pages))
|
|
|
986 (set-marker (car pages) nil)
|
|
|
987 ;;
|
|
|
988 ;; The lines are: 3 blank; footer; 6 blank; header; 3 blank.
|
|
|
989 ;; We're in between the previous footer and the following header,
|
|
|
990 ;;
|
|
|
991 ;; First lose 3 blank lines, the header, and then 3 more.
|
|
|
992 ;;
|
|
|
993 (setq p (point))
|
|
|
994 (skip-chars-forward "\n")
|
|
|
995 (delete-region p (point))
|
|
|
996 (and (looking-at "[^\n]+\n\n?\n?\n?")
|
|
|
997 (delete-region (match-beginning 0) (match-end 0)))
|
|
|
998 ;;
|
|
|
999 ;; Next lose the footer, and the 3 blank lines after, and before it.
|
|
|
1000 ;; But don't lose the last footer of the manual entry; that contains
|
|
|
1001 ;; the "last change" date, so it's not completely uninteresting.
|
|
|
1002 ;; (Actually lose all blank lines before it; sh(1) needs this.)
|
|
|
1003 ;;
|
|
|
1004 (skip-chars-backward "\n")
|
|
|
1005 (beginning-of-line)
|
|
|
1006 (if (null (cdr pages))
|
|
|
1007 nil
|
|
|
1008 (and (looking-at "[^\n]+\n\n?\n?\n?")
|
|
|
1009 (delete-region (match-beginning 0) (match-end 0))))
|
|
|
1010 (setq p (point))
|
|
|
1011 (skip-chars-backward "\n")
|
|
|
1012 (if (> (- p (point)) 4)
|
|
|
1013 (delete-region (+ 2 (point)) p)
|
|
|
1014 (delete-region (1+ (point)) p))
|
|
|
1015 ; (and (looking-at "\n\n?\n?")
|
|
|
1016 ; (delete-region (match-beginning 0) (match-end 0)))
|
|
4
|
1017
|
|
8
|
1018 (setq pages (cdr pages)))
|
|
|
1019 ;;
|
|
|
1020 ;; Now nuke the extra blank lines at the beginning and end.
|
|
4
|
1021 (goto-char (point-min))
|
|
8
|
1022 (if (looking-at "\n+")
|
|
|
1023 (delete-region (match-beginning 0) (match-end 0)))
|
|
|
1024 (forward-line 1)
|
|
|
1025 (if (looking-at "\n\n+")
|
|
|
1026 (delete-region (1+ (match-beginning 0)) (match-end 0)))
|
|
|
1027 (goto-char (point-max))
|
|
|
1028 (skip-chars-backward "\n")
|
|
|
1029 (delete-region (point) (point-max))
|
|
|
1030 (beginning-of-line)
|
|
|
1031 (forward-char -1)
|
|
|
1032 (setq p (point))
|
|
|
1033 (skip-chars-backward "\n")
|
|
|
1034 (if (= ?\n (following-char)) (forward-char 1))
|
|
|
1035 (if (> (point) (1+ p))
|
|
|
1036 (delete-region (point) p))
|
|
4
|
1037 ))
|
|
|
1038
|
|
8
|
1039 ;(defun Manual-nuke-nroff-bs-footers ()
|
|
|
1040 ; ;; Nuke headers: "MORE(1) UNIX Programmer's Manual MORE(1)"
|
|
|
1041 ; (goto-char (point-min))
|
|
|
1042 ; (while (re-search-forward "^ *\\([A-Za-z][-_A-Za-z0-9]*([0-9A-Za-z]+)\\).*\\1$" nil t)
|
|
|
1043 ; (replace-match ""))
|
|
|
1044 ;
|
|
|
1045 ; ;;
|
|
|
1046 ; ;; it would appear that we have a choice between sometimes introducing
|
|
|
1047 ; ;; an extra blank line when a paragraph was broken by a footer, and
|
|
|
1048 ; ;; sometimes not putting in a blank line between two paragraphs when
|
|
|
1049 ; ;; a footer appeared right between them. FMH; I choose the latter.
|
|
|
1050 ; ;;
|
|
|
1051 ;
|
|
|
1052 ; ;; Nuke footers: "Printed 12/3/85 27 April 1981 1"
|
|
|
1053 ; ;; Sun appear to be on drugz:
|
|
|
1054 ; ;; "Sun Release 3.0B Last change: 1 February 1985 1"
|
|
|
1055 ; ;; HP are even worse!
|
|
|
1056 ; ;; " Hewlett-Packard -1- (printed 12/31/99)" FMHWA12ID!!
|
|
|
1057 ; ;; System V (well WICATs anyway):
|
|
|
1058 ; ;; "Page 1 (printed 7/24/85)"
|
|
|
1059 ; ;; Who is administering PCP to these corporate bozos?
|
|
|
1060 ; (goto-char (point-min))
|
|
|
1061 ; (while (re-search-forward
|
|
|
1062 ; (cond
|
|
|
1063 ; ((eq system-type 'hpux)
|
|
|
1064 ; "\n\n?[ \t]*Hewlett-Packard\\(\\| Company\\)[ \t]*- [0-9]* -.*\n")
|
|
|
1065 ; ((eq system-type 'dgux-unix)
|
|
|
1066 ; "\n\n?[ \t]*Licensed material--.*Page [0-9]*\n")
|
|
|
1067 ; ((eq system-type 'usg-unix-v)
|
|
|
1068 ; "\n\n? *Page [0-9]*.*(printed [0-9/]*)\n")
|
|
|
1069 ; (t
|
|
|
1070 ; "\n\n?\\(Printed\\|Sun Release\\) [0-9].*[0-9]\n"))
|
|
|
1071 ; nil t)
|
|
|
1072 ; (replace-match ""))
|
|
|
1073 ;
|
|
|
1074 ; ;; Also, hack X footers:
|
|
|
1075 ; ;; "X Version 11 Last change: Release 5 1"
|
|
|
1076 ; (goto-char (point-min))
|
|
|
1077 ; (while (re-search-forward "\n\n?X Version [^\n]+\n" nil t)
|
|
|
1078 ; (replace-match ""))
|
|
|
1079 ;
|
|
|
1080 ; ;; Crunch blank lines
|
|
|
1081 ; (goto-char (point-min))
|
|
|
1082 ; (while (re-search-forward "\n\n\n\n*" nil t)
|
|
|
1083 ; (replace-match "\n\n"))
|
|
|
1084 ; )
|
|
0
|
1085
|
|
8
|
1086 (defun Manual-mouseify-xrefs ()
|
|
|
1087 (goto-char (point-min))
|
|
|
1088 (forward-line 1)
|
|
|
1089 (let ((case-fold-search nil)
|
|
|
1090 s e name extent)
|
|
|
1091 ;; possibly it would be faster to rewrite this expression to search for
|
|
|
1092 ;; a less common sequence first (like "([0-9]") and then back up to see
|
|
|
1093 ;; if it's really a match. This function is 15% of the total time, 13%
|
|
|
1094 ;; of which is this call to re-search-forward.
|
|
|
1095 (while (re-search-forward "[a-zA-Z_][-a-zA-Z0-9_.]*([0-9][a-zA-Z0-9]*)"
|
|
|
1096 nil t)
|
|
|
1097 (setq s (match-beginning 0)
|
|
|
1098 e (match-end 0)
|
|
|
1099 name (buffer-substring s e))
|
|
|
1100 (goto-char s)
|
|
|
1101 (skip-chars-backward " \t")
|
|
|
1102 (if (and (bolp)
|
|
|
1103 (progn (backward-char 1) (= (preceding-char) ?-)))
|
|
|
1104 (progn
|
|
|
1105 (setq s (point))
|
|
|
1106 (skip-chars-backward "-a-zA-Z0-9_.")
|
|
|
1107 (setq name (concat (buffer-substring (point) (1- s)) name))
|
|
|
1108 (setq s (point))))
|
|
|
1109 ;; if there are upper case letters in the section, downcase them.
|
|
|
1110 (if (string-match "(.*[A-Z]+.*)$" name)
|
|
|
1111 (setq name (concat (substring name 0 (match-beginning 0))
|
|
|
1112 (downcase (substring name (match-beginning 0))))))
|
|
|
1113 ;; (setq already-fontified (extent-at s))
|
|
|
1114 (setq extent (make-extent s e))
|
|
|
1115 (set-extent-property extent 'man (list 'Manual-follow-xref name))
|
|
|
1116 (set-extent-property extent 'highlight t)
|
|
|
1117 ;; (if (not already-fontified)...
|
|
|
1118 (set-extent-face extent 'man-xref)
|
|
|
1119 (goto-char e))))
|
|
4
|
1120
|
|
8
|
1121 (defun Manual-follow-xref (&optional name-or-event)
|
|
|
1122 "Invoke `manual-entry' on the cross-reference under the mouse.
|
|
|
1123 When invoked noninteractively, the arg may be an xref string to parse instead."
|
|
|
1124 (interactive "e")
|
|
|
1125 (if (eventp name-or-event)
|
|
|
1126 (let* ((p (event-point name-or-event))
|
|
|
1127 (extent (and p (extent-at p
|
|
|
1128 (event-buffer name-or-event)
|
|
|
1129 'highlight)))
|
|
|
1130 (data (and extent (extent-property extent 'man))))
|
|
|
1131 (if (eq (car-safe data) 'Manual-follow-xref)
|
|
|
1132 (eval data)
|
|
|
1133 (error "no manual cross-reference there.")))
|
|
|
1134 (let ((Manual-match-topic-exactly t)
|
|
|
1135 (Manual-query-multiple-pages nil))
|
|
|
1136 (or (manual-entry name-or-event)
|
|
|
1137 ;; If that didn't work, maybe it's in a different section than the
|
|
|
1138 ;; man page writer expected. For example, man pages tend assume
|
|
|
1139 ;; that all user programs are in section 1, but X tends to generate
|
|
|
1140 ;; makefiles that put things in section "n" instead...
|
|
|
1141 (and (string-match "[ \t]*([^)]+)\\'" name-or-event)
|
|
|
1142 (progn
|
|
|
1143 (message "No entries found for %s; checking other sections..."
|
|
|
1144 name-or-event)
|
|
|
1145 (manual-entry
|
|
|
1146 (substring name-or-event 0 (match-beginning 0))
|
|
|
1147 nil t)))))))
|
|
4
|
1148
|
|
8
|
1149 (defun Manual-popup-menu (&optional event)
|
|
|
1150 "Pops up a menu of cross-references in this manual page.
|
|
|
1151 If there is a cross-reference under the mouse button which invoked this
|
|
|
1152 command, it will be the first item on the menu. Otherwise, they are
|
|
|
1153 on the menu in the order in which they appear in the buffer."
|
|
|
1154 (interactive "e")
|
|
|
1155 (let ((buffer (current-buffer))
|
|
|
1156 (sep "---")
|
|
|
1157 (prefix "Show Manual Page for ")
|
|
|
1158 xref items)
|
|
|
1159 (cond (event
|
|
|
1160 (setq buffer (event-buffer event))
|
|
|
1161 (let* ((p (event-point event))
|
|
|
1162 (extent (and p (extent-at p buffer 'highlight)))
|
|
|
1163 (data (and extent (extent-property extent 'man))))
|
|
|
1164 (if (eq (car-safe data) 'Manual-follow-xref)
|
|
|
1165 (setq xref (nth 1 data))))))
|
|
|
1166 (if xref (setq items (list sep xref)))
|
|
|
1167 (map-extents #'(lambda (extent ignore)
|
|
|
1168 (let ((data (extent-property extent 'man)))
|
|
|
1169 (if (and (eq (car-safe data) 'Manual-follow-xref)
|
|
|
1170 (not (member (nth 1 data) items)))
|
|
|
1171 (setq items (cons (nth 1 data) items)))
|
|
|
1172 nil))
|
|
|
1173 buffer)
|
|
|
1174 (if (eq sep (car items)) (setq items (cdr items)))
|
|
|
1175 (let ((popup-menu-titles nil))
|
|
|
1176 (popup-menu
|
|
|
1177 (cons "Manual Entry"
|
|
|
1178 (mapcar #'(lambda (item)
|
|
|
1179 (if (eq item sep)
|
|
|
1180 item
|
|
|
1181 (vector (concat prefix item)
|
|
|
1182 (list 'Manual-follow-xref item) t)))
|
|
|
1183 (nreverse items)))))))
|
|
0
|
1184
|
|
8
|
1185 (defun pager-cleanup-hook ()
|
|
|
1186 "cleanup man page if called via $PAGER"
|
|
|
1187 (let ((buf-name (or buffer-file-name (buffer-name))))
|
|
|
1188 (if (and (or (string-match "^/tmp/man[0-9]+" buf-name)
|
|
|
1189 (string-match ".*/man/\\(man\\|cat\\)[1-9a-z]/" buf-name))
|
|
|
1190 (not (string-match Manual-bogus-file-pattern buf-name)))
|
|
|
1191 (let (buffer manpage)
|
|
|
1192 (require 'man)
|
|
|
1193 (goto-char (point-min))
|
|
|
1194 (setq buffer-read-only nil)
|
|
|
1195 (Manual-nuke-nroff-bs)
|
|
|
1196 (goto-char (point-min))
|
|
|
1197 (if (re-search-forward "[^ \t]")
|
|
|
1198 (goto-char (- (point) 1)))
|
|
|
1199 (if (looking-at "\\([a-zA-Z0-9]+\\)[ \t]*(")
|
|
|
1200 (setq manpage (buffer-substring (match-beginning 1) (match-end 1)))
|
|
|
1201 (setq manpage "???"))
|
|
|
1202 (setq buffer
|
|
|
1203 (rename-buffer
|
|
|
1204 (generate-new-buffer-name (concat "*man " manpage "*"))))
|
|
|
1205 (setq buffer-file-name nil)
|
|
|
1206 (goto-char (point-min))
|
|
|
1207 (insert (format "%s\n" buf-name))
|
|
|
1208 (goto-char (point-min))
|
|
|
1209 (buffer-disable-undo buffer)
|
|
|
1210 (set-buffer-modified-p nil)
|
|
|
1211 (Manual-mode)
|
|
|
1212 ))))
|
|
0
|
1213
|
|
8
|
1214 (add-hook 'server-visit-hook 'pager-cleanup-hook)
|
|
4
|
1215 (provide 'man)
|
