annotate lisp/man.el @ 90601:a1a25ac6c88a

Merge from emacs--devo--0 Patches applied: * emacs--devo--0 (patch 427-436) - Update from CVS - Merge from gnus--rel--5.10 * gnus--rel--5.10 (patch 134-136) - Merge from emacs--devo--0 - Update from CVS Revision: emacs@sv.gnu.org/emacs--unicode--0--patch-110
author Miles Bader <miles@gnu.org>
date Thu, 14 Sep 2006 09:24:00 +0000
parents c358d0861b16
children 6588c6259dfb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
51376
ec20af5e04b3 (Man-name-regexp): Also match Latin-1 soft hyphen.
Andreas Schwab <schwab@suse.de>
parents: 50602
diff changeset
1 ;;; man.el --- browse UNIX manual pages -*- coding: iso-8859-1 -*-
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2
64762
41bb365f41c4 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64622
diff changeset
3 ;; Copyright (C) 1993, 1994, 1996, 1997, 2001, 2002, 2003,
68651
3bd95f4f2941 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 68222
diff changeset
4 ;; 2004, 2005, 2006 Free Software Foundation, Inc.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5
38412
253f761ad37b Some fixes to follow coding conventions in files maintained by FSF.
Pavel Janík <Pavel@Janik.cz>
parents: 36575
diff changeset
6 ;; Author: Barry A. Warsaw <bwarsaw@cen.com>
28102
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
7 ;; Maintainer: FSF
38412
253f761ad37b Some fixes to follow coding conventions in files maintained by FSF.
Pavel Janík <Pavel@Janik.cz>
parents: 36575
diff changeset
8 ;; Keywords: help
253f761ad37b Some fixes to follow coding conventions in files maintained by FSF.
Pavel Janík <Pavel@Janik.cz>
parents: 36575
diff changeset
9 ;; Adapted-By: ESR, pot
3235
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 ;; This file is part of GNU Emacs.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 ;; 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
14 ;; 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
15 ;; the Free Software Foundation; either version 2, or (at your option)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 ;; any later version.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 ;; 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
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 ;; GNU General Public License for more details.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23 ;; 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
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
64091
6fb026ad601f Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 63336
diff changeset
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
6fb026ad601f Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 63336
diff changeset
26 ;; Boston, MA 02110-1301, USA.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28 ;;; Commentary:
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
30 ;; 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
31 ;; 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
32 ;; 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
33 ;;
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 ;; The mode also supports hypertext-like following of manual page SEE
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35 ;; ALSO references, and other features. See below or do `?' in a
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 ;; manual page buffer for details.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37
28102
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
38 ;; ========== Credits and History ==========
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39 ;; In mid 1991, several people posted some interesting improvements to
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40 ;; 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
41 ;; 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
42 ;; to incorporate them into a single manual browsing mode. While
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
43 ;; 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
44 ;; these folks deserve lots of credit for providing the initial
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 ;; excellent packages on which this one is based.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47 ;; Nick Duffek <duffek@chaos.cs.brandeis.edu>, posted a very nice
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
48 ;; improvement which retrieved and cleaned the manpages in a
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49 ;; background process, and which correctly deciphered such options as
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50 ;; man -k.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52 ;; Eric Rose <erose@jessica.stanford.edu>, submitted manual.el which
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53 ;; provided a very nice manual browsing mode.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
54
3591
507f64624555 Apply typo patches from Paul Eggert.
Jim Blandy <jimb@redhat.com>
parents: 3307
diff changeset
55 ;; 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
56 ;; 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
57 ;; 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
58 ;; replacement for the old man.el package.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
60 ;; 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
61 ;; making it faster, more robust and more tolerant of different
14040
187735b53d52 Comment fixes.
Karl Heuer <kwzh@gnu.org>
parents: 13921
diff changeset
62 ;; systems' man idiosyncrasies.
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
63
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64 ;; ========== Features ==========
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65 ;; + Runs "man" in the background and pipes the results through a
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66 ;; 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
67 ;; is done in the background. The cleaning commands are configurable.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
68 ;; + Syntax is the same as Un*x man
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
69 ;; + 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
70 ;; "man <section>", etc.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71 ;; + Provides a manual browsing mode with keybindings for traversing
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72 ;; the sections of a manpage, following references in the SEE ALSO
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73 ;; section, and more.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74 ;; + Multiple manpages created with the same man command are put into
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75 ;; a narrowed buffer circular list.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
77 ;; ============= TODO ===========
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
78 ;; - 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
79 ;; - 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
80 ;; 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
81 ;; 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
82 ;; 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
83 ;; 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
84 ;; headers, and after the page footer. But it is possible to compute
41698
722fe545e535 (man-follow-mouse): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38970
diff changeset
85 ;; the number of blank lines before the page footer by heuristics
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
86 ;; only. Is it worth doing?
9828
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
87 ;; - 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
88 ;; 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
89 ;; - 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
90 ;; 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
91 ;; 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
92 ;; 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
93 ;; not exist.
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
94
9354
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
95
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
96 ;;; Code:
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
97
58690
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
98 (eval-when-compile (require 'cl))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
99 (require 'assoc)
50403
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
100 (require 'button)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
101
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
102 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
9354
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
103 ;; 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
104
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
105 (defgroup man nil
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
106 "Browse UNIX manual pages."
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
107 :prefix "Man-"
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
108 :group 'help)
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
109
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
110
9354
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
111 (defvar Man-notify)
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
112 (defvar Man-current-page)
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
113 (defvar Man-page-list)
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
114 (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
115 "*Manpage cleaning filter command phrases.
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
116 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
117
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
118 '((command-string phrase-string*)*)
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
119
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
120 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
121 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
122 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
123 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
124 the manpage buffer."
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
125 :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
126 (repeat :inline t
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
127 (string :tag "Phrase String"))))
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
128 :group 'man)
14672
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
129
9354
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
130 (defvar Man-original-frame)
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
131 (defvar Man-arguments)
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
132 (defvar Man-sections-alist)
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
133 (defvar Man-refpages-alist)
14672
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
134 (defvar Man-uses-untabify-flag t
28102
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
135 "Non-nil means 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
136 (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
137 (defvar Man-sed-script nil
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
138 "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
139
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
140 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
141 ;; user variables
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
142
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
143 (defcustom Man-fontify-manpage-flag t
28102
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
144 "*Non-nil means make up the manpage with fonts."
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
145 :type 'boolean
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
146 :group 'man)
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
147
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
148 (defcustom Man-overstrike-face 'bold
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
149 "*Face to use when fontifying overstrike."
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
150 :type 'face
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
151 :group 'man)
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
152
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
153 (defcustom Man-underline-face 'underline
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
154 "*Face to use when fontifying underlining."
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
155 :type 'face
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
156 :group 'man)
6676
7251020c1c79 (manual-program): New (actually reintroduced) variable.
Karl Heuer <kwzh@gnu.org>
parents: 6613
diff changeset
157
58742
03ba600130f8 (Man-reverse-face): Change default to `highlight'.
Richard M. Stallman <rms@gnu.org>
parents: 58690
diff changeset
158 (defcustom Man-reverse-face 'highlight
58690
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
159 "*Face to use when fontifying reverse video."
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
160 :type 'face
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
161 :group 'man)
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
162
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
163 ;; 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
164 (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
165 "*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
166 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
167 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
168 where the man command was called from:
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
169
4915
c0523a78e6a5 (Man-frame-parameters): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 4444
diff changeset
170 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
171 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
172 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
173 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
174 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
175 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
176 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
177 meek -- make no indication that the manpage is ready
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
178
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
179 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
180 :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
181 (const aggressive) (const friendly)
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
182 (const polite) (const quiet) (const meek))
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
183 :group 'man)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
184
54515
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
185 (defcustom Man-width nil
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
186 "*Number of columns for which manual pages should be formatted.
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
187 If nil, the width of the window selected at the moment of man
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
188 invocation is used. If non-nil, the width of the frame selected
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
189 at the moment of man invocation is used. The value also can be a
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
190 positive integer."
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
191 :type '(choice (const :tag "Window width" nil)
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
192 (const :tag "Frame width" t)
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
193 (integer :tag "Specific width" :value 65))
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
194 :group 'man)
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
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-frame-parameters nil
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
197 "*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
198 :type 'sexp
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
199 :group 'man)
4915
c0523a78e6a5 (Man-frame-parameters): New variable.
Richard M. Stallman <rms@gnu.org>
parents: 4444
diff changeset
200
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
201 (defcustom Man-downcase-section-letters-flag t
28102
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
202 "*Non-nil means letters in sections are converted to lower case.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
203 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
204 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
205 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
206 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
207 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
208 :type 'boolean
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
209 :group 'man)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
210
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
211 (defcustom Man-circular-pages-flag t
28102
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
212 "*Non-nil means the manpage list is treated as circular for traversal."
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
213 :type 'boolean
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
214 :group 'man)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
215
17436
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
216 (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
217 (list
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
218 '("3C++" . "3")
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
219 ;; 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
220 ;; '("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
221 '("3X11" . "3")
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
222 '("1-UCB" . ""))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
223 "*Association list of bogus sections to real section numbers.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
224 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
225 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
226 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
227 the associated section number."
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
228 :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
229 (string :tag "Real Section")))
2a9fdbfcb993 Add defgroup; use defcustom for user vars.
Richard M. Stallman <rms@gnu.org>
parents: 17132
diff changeset
230 :group 'man)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
231
50403
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
232 (defcustom Man-header-file-path
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
233 '("/usr/include" "/usr/local/include")
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
234 "C Header file search path used in Man."
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
235 :type '(repeat string)
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
236 :group 'man)
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
237
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
238 (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
239 "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
240
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
241 (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
242 "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
243
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
244 (defvar Man-untabify-command-args (list "-t" "-e")
28102
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
245 "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
246
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
247 (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
248 "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
249
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
250 (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
251 "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
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-mode-map nil
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
254 "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
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-mode-hook nil
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
257 "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
258
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
259 (defvar Man-cooked-hook nil
28102
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
260 "Hook run after removing backspaces but before `Man-mode' processing.")
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
261
62878
6ad2cd812985 (Man-name-regexp): Add `:' to accept qualified names.
Juri Linkov <juri@jurta.org>
parents: 62736
diff changeset
262 (defvar Man-name-regexp "[-a-zA-Z0-9_­+][-a-zA-Z0-9_.:­+]*"
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
263 "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
264
67300
d939be43ae67 (Man-section-regexp): Add 0-9 to support "3X11" sections.
Juri Linkov <juri@jurta.org>
parents: 67006
diff changeset
265 (defvar Man-section-regexp "[0-9][a-zA-Z0-9+]*\\|[LNln]"
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
266 "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
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-page-header-regexp
23644
3d09886cb53e (Man-page-header-regexp): Alternate value for Solaris 2.6.
Karl Heuer <kwzh@gnu.org>
parents: 23267
diff changeset
269 (if (and (string-match "-solaris2\\." system-configuration)
3d09886cb53e (Man-page-header-regexp): Alternate value for Solaris 2.6.
Karl Heuer <kwzh@gnu.org>
parents: 23267
diff changeset
270 (not (string-match "-solaris2\\.[123435]$" system-configuration)))
3d09886cb53e (Man-page-header-regexp): Alternate value for Solaris 2.6.
Karl Heuer <kwzh@gnu.org>
parents: 23267
diff changeset
271 (concat "^[-A-Za-z0-9_].*[ \t]\\(" Man-name-regexp
3d09886cb53e (Man-page-header-regexp): Alternate value for Solaris 2.6.
Karl Heuer <kwzh@gnu.org>
parents: 23267
diff changeset
272 "(\\(" Man-section-regexp "\\))\\)$")
3d09886cb53e (Man-page-header-regexp): Alternate value for Solaris 2.6.
Karl Heuer <kwzh@gnu.org>
parents: 23267
diff changeset
273 (concat "^[ \t]*\\(" Man-name-regexp
3d09886cb53e (Man-page-header-regexp): Alternate value for Solaris 2.6.
Karl Heuer <kwzh@gnu.org>
parents: 23267
diff changeset
274 "(\\(" Man-section-regexp "\\))\\).*\\1"))
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
275 "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
276
68222
c18c4be711f4 (Man-heading-regexp): Add `/'.
Juri Linkov <juri@jurta.org>
parents: 68151
diff changeset
277 (defvar Man-heading-regexp "^\\([A-Z][A-Z /-]+\\)$"
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
278 "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
279
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
280 (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
281 "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
282 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
283
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
284 (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
285 "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
286 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
287
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
288 (defvar Man-reference-regexp
66729
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
289 (concat "\\(" Man-name-regexp "\\)[ \t]*(\\(" Man-section-regexp "\\))")
36575
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
290 "Regular expression describing a reference to another manpage.")
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
291
66729
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
292 (defvar Man-apropos-regexp
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
293 (concat "\\\[\\(" Man-name-regexp "\\)\\\][ \t]*(\\(" Man-section-regexp "\\))")
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
294 "Regular expression describing a reference to manpages in \"man -k output\".")
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
295
50403
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
296 (defvar Man-synopsis-regexp "SYNOPSIS"
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
297 "Regular expression for SYNOPSIS heading (or your equivalent).
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
298 This regexp should not start with a `^' character.")
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
299
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
300 (defvar Man-files-regexp "FILES"
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
301 "Regular expression for FILES heading (or your equivalent).
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
302 This regexp should not start with a `^' character.")
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
303
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
304 (defvar Man-include-regexp "#[ \t]*include[ \t]*"
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
305 "Regular expression describing the #include (directive of cpp).")
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
306
68151
8d679b71e742 (Man-file-name-regexp): Adjust for a list of files.
Nick Roberts <nickrob@snap.net.nz>
parents: 67300
diff changeset
307 (defvar Man-file-name-regexp "[^<>\", \t\n]+"
50403
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
308 "Regular expression describing <> in #include line (directive of cpp).")
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
309
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
310 (defvar Man-normal-file-prefix-regexp "[/~$]"
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
311 "Regular expression describing a file path appeared in FILES section.")
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
312
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
313 (defvar Man-header-regexp
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
314 (concat "\\(" Man-include-regexp "\\)"
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
315 "[<\"]"
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
316 "\\(" Man-file-name-regexp "\\)"
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
317 "[>\"]")
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
318 "Regular expression describing references to header files.")
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
319
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
320 (defvar Man-normal-file-regexp
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
321 (concat Man-normal-file-prefix-regexp Man-file-name-regexp)
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
322 "Regular expression describing references to normal files.")
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
323
36575
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
324 ;; This includes the section as an optional part to catch hyphenated
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
325 ;; refernces to manpages.
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
326 (defvar Man-hyphenated-reference-regexp
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
327 (concat "\\(" Man-name-regexp "\\)\\((\\(" Man-section-regexp "\\))\\)?")
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
328 "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
329
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
330 (defvar Man-switches ""
38646
5236fd76fef0 (man): Mention Man-switches in the doc string.
Eli Zaretskii <eliz@gnu.org>
parents: 38412
diff changeset
331 "Switches passed to the man command, as a single string.
5236fd76fef0 (man): Mention Man-switches in the doc string.
Eli Zaretskii <eliz@gnu.org>
parents: 38412
diff changeset
332
5236fd76fef0 (man): Mention Man-switches in the doc string.
Eli Zaretskii <eliz@gnu.org>
parents: 38412
diff changeset
333 If you want to be able to see all the manpages for a subject you type,
5236fd76fef0 (man): Mention Man-switches in the doc string.
Eli Zaretskii <eliz@gnu.org>
parents: 38412
diff changeset
334 make -a one of the switches, if your `man' program supports it.")
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
335
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
336 (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
337 (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
338 "-s"
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
339 "")
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
340 "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
341
54515
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
342 (defvar Man-support-local-filenames 'auto-detect
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
343 "Internal cache for the value of the function `Man-support-local-filenames'.
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
344 `auto-detect' means the value is not yet determined.
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
345 Otherwise, the value is whatever the function
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
346 `Man-support-local-filenames' should return.")
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
347
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
348 ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
349 ;; end user variables
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
350
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
351 ;; 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
352 (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
353 (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
354 (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
355 (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
356 (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
357 (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
358 (make-variable-buffer-local 'Man-arguments)
64620
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
359 (put 'Man-arguments 'permanent-local t)
9726
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
360
51a9e9bc5fda * man.el (Man-fontify-manpage-flag): defvar put at outer level.
Francesco Potortì <pot@gnu.org>
parents: 9679
diff changeset
361 (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
362 (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
363 (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
364 (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
365 (setq-default Man-page-mode-string "1 of 1")
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
366
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
367 (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
368 /\b/ { s/_\b//g
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
369 s/\b_//g
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
370 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
371 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
372 :ovstrk
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
373 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
374 t ovstrk
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
375 }
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
376 /\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
377 "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
378
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
379 (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
380 /\b/ { s/_\b//g\\
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
381 s/\b_//g\\
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
382 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
383 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
384 :ovstrk\\
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
385 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
386 t ovstrk\\
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
387 }\\
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
388 /\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
389 "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
390
72619
5dd4533a9a7e (Man-topic-history): New variable.
Juri Linkov <juri@jurta.org>
parents: 69793
diff changeset
391 (defvar Man-topic-history nil "Topic read history.")
5dd4533a9a7e (Man-topic-history): New variable.
Juri Linkov <juri@jurta.org>
parents: 69793
diff changeset
392
17132
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
393 (defvar man-mode-syntax-table
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
394 (let ((table (copy-syntax-table (standard-syntax-table))))
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
395 (modify-syntax-entry ?. "w" table)
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
396 (modify-syntax-entry ?_ "w" table)
61889
031ee12ed124 (man-mode-syntax-table): Set up `:' to have word-constituent syntax.
Eli Zaretskii <eliz@gnu.org>
parents: 60747
diff changeset
397 (modify-syntax-entry ?: "w" table) ; for PDL::Primitive in Perl man pages
17132
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
398 table)
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
399 "Syntax table used in Man mode buffers.")
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
400
63336
423fcdb144f5 (Man-mode-map): Initialize it properly.
Lute Kamstra <lute@gnu.org>
parents: 62878
diff changeset
401 (unless Man-mode-map
423fcdb144f5 (Man-mode-map): Initialize it properly.
Lute Kamstra <lute@gnu.org>
parents: 62878
diff changeset
402 (setq Man-mode-map (make-sparse-keymap))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
403 (suppress-keymap Man-mode-map)
63336
423fcdb144f5 (Man-mode-map): Initialize it properly.
Lute Kamstra <lute@gnu.org>
parents: 62878
diff changeset
404 (set-keymap-parent Man-mode-map button-buffer-map)
423fcdb144f5 (Man-mode-map): Initialize it properly.
Lute Kamstra <lute@gnu.org>
parents: 62878
diff changeset
405
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
406 (define-key Man-mode-map " " 'scroll-up)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
407 (define-key Man-mode-map "\177" 'scroll-down)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
408 (define-key Man-mode-map "n" 'Man-next-section)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
409 (define-key Man-mode-map "p" 'Man-previous-section)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
410 (define-key Man-mode-map "\en" 'Man-next-manpage)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
411 (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
412 (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
413 (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
414 (define-key Man-mode-map "." 'beginning-of-buffer)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
415 (define-key Man-mode-map "r" 'Man-follow-manual-reference)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
416 (define-key Man-mode-map "g" 'Man-goto-section)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
417 (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
418 (define-key Man-mode-map "k" 'Man-kill)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
419 (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
420 (define-key Man-mode-map "m" 'man)
69793
93d87ad179a4 * man.el (Man-mode-map): Restore the \r binding.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 68651
diff changeset
421 ;; Not all the man references get buttons currently. The text in the
93d87ad179a4 * man.el (Man-mode-map): Restore the \r binding.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 68651
diff changeset
422 ;; manual page can contain references to other man pages
93d87ad179a4 * man.el (Man-mode-map): Restore the \r binding.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 68651
diff changeset
423 (define-key Man-mode-map "\r" 'man-follow)
63336
423fcdb144f5 (Man-mode-map): Initialize it properly.
Lute Kamstra <lute@gnu.org>
parents: 62878
diff changeset
424 (define-key Man-mode-map "?" 'describe-mode))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
425
50403
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
426 ;; buttons
66177
bd98d8a37303 * woman.el (WoMan-xref-man-page): New button type derived
Masatake YAMATO <jet@gyve.org>
parents: 65680
diff changeset
427 (define-button-type 'Man-abstract-xref-man-page
59398
c47c12607f08 (Man-xref-man-page, Man-xref-header-file)
Kim F. Storm <storm@cua.dk>
parents: 59362
diff changeset
428 'follow-link t
66177
bd98d8a37303 * woman.el (WoMan-xref-man-page): New button type derived
Masatake YAMATO <jet@gyve.org>
parents: 65680
diff changeset
429 'help-echo "mouse-2, RET: display this man page"
bd98d8a37303 * woman.el (WoMan-xref-man-page): New button type derived
Masatake YAMATO <jet@gyve.org>
parents: 65680
diff changeset
430 'func nil
69793
93d87ad179a4 * man.el (Man-mode-map): Restore the \r binding.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 68651
diff changeset
431 'action (lambda (button)
93d87ad179a4 * man.el (Man-mode-map): Restore the \r binding.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 68651
diff changeset
432 (funcall
93d87ad179a4 * man.el (Man-mode-map): Restore the \r binding.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 68651
diff changeset
433 (button-get button 'func)
93d87ad179a4 * man.el (Man-mode-map): Restore the \r binding.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 68651
diff changeset
434 (let ((func (button-get button 'Man-target-string)))
93d87ad179a4 * man.el (Man-mode-map): Restore the \r binding.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 68651
diff changeset
435 (if func
93d87ad179a4 * man.el (Man-mode-map): Restore the \r binding.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 68651
diff changeset
436 (if (functionp func) (funcall func) func)
93d87ad179a4 * man.el (Man-mode-map): Restore the \r binding.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 68651
diff changeset
437 (button-label button))))))
66177
bd98d8a37303 * woman.el (WoMan-xref-man-page): New button type derived
Masatake YAMATO <jet@gyve.org>
parents: 65680
diff changeset
438
bd98d8a37303 * woman.el (WoMan-xref-man-page): New button type derived
Masatake YAMATO <jet@gyve.org>
parents: 65680
diff changeset
439 (define-button-type 'Man-xref-man-page
bd98d8a37303 * woman.el (WoMan-xref-man-page): New button type derived
Masatake YAMATO <jet@gyve.org>
parents: 65680
diff changeset
440 :supertype 'Man-abstract-xref-man-page
bd98d8a37303 * woman.el (WoMan-xref-man-page): New button type derived
Masatake YAMATO <jet@gyve.org>
parents: 65680
diff changeset
441 'func 'man-follow)
bd98d8a37303 * woman.el (WoMan-xref-man-page): New button type derived
Masatake YAMATO <jet@gyve.org>
parents: 65680
diff changeset
442
50403
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
443
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
444 (define-button-type 'Man-xref-header-file
50418
b2939c93b5f7 Fix previous change.
Juanma Barranquero <lekktu@gmail.com>
parents: 50403
diff changeset
445 'action (lambda (button)
b2939c93b5f7 Fix previous change.
Juanma Barranquero <lekktu@gmail.com>
parents: 50403
diff changeset
446 (let ((w (button-get button 'Man-target-string)))
b2939c93b5f7 Fix previous change.
Juanma Barranquero <lekktu@gmail.com>
parents: 50403
diff changeset
447 (unless (Man-view-header-file w)
b2939c93b5f7 Fix previous change.
Juanma Barranquero <lekktu@gmail.com>
parents: 50403
diff changeset
448 (error "Cannot find header file: %s" w))))
59398
c47c12607f08 (Man-xref-man-page, Man-xref-header-file)
Kim F. Storm <storm@cua.dk>
parents: 59362
diff changeset
449 'follow-link t
50418
b2939c93b5f7 Fix previous change.
Juanma Barranquero <lekktu@gmail.com>
parents: 50403
diff changeset
450 'help-echo "mouse-2: display this header file")
50403
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
451
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
452 (define-button-type 'Man-xref-normal-file
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
453 'action (lambda (button)
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
454 (let ((f (substitute-in-file-name
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
455 (button-get button 'Man-target-string))))
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
456 (if (file-exists-p f)
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
457 (if (file-readable-p f)
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
458 (view-file f)
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
459 (error "Cannot read a file: %s" f))
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
460 (error "Cannot find a file: %s" f))))
59398
c47c12607f08 (Man-xref-man-page, Man-xref-header-file)
Kim F. Storm <storm@cua.dk>
parents: 59362
diff changeset
461 'follow-link t
57817
78ec31c498b7 *** empty log message ***
Kim F. Storm <storm@cua.dk>
parents: 57699
diff changeset
462 'help-echo "mouse-2: display this file")
50403
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
463
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
464
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 ;; utilities
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
467
14672
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
468 (defun Man-init-defvars ()
65197
df6f7e582a6e (Man-init-defvars, Man-translate-references, Man-support-local-filenames,
Juanma Barranquero <lekktu@gmail.com>
parents: 64762
diff changeset
469 "Used for initializing variables based on display's color support.
28102
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
470 This is necessary if one wants to dump man.el with Emacs."
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
471
20266
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
472 ;; 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
473 (let ((default-directory "/"))
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
474 (setq Man-sed-script
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
475 (cond
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
476 (Man-fontify-manpage-flag
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
477 nil)
53477
79093b308520 * progmodes/idlwave.el (idlwave-make-tags):
Eli Zaretskii <eliz@is.elta.co.il>
parents: 52636
diff changeset
478 ((eq 0 (call-process Man-sed-command nil nil nil Man-sysv-sed-script))
20266
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
479 Man-sysv-sed-script)
53477
79093b308520 * progmodes/idlwave.el (idlwave-make-tags):
Eli Zaretskii <eliz@is.elta.co.il>
parents: 52636
diff changeset
480 ((eq 0 (call-process Man-sed-command nil nil nil Man-berkeley-sed-script))
20266
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
481 Man-berkeley-sed-script)
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
482 (t
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
483 nil))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
484
14672
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
485 (setq Man-filter-list
23267
a804a047b23d (Man-init-defvars): Avoid trailing nil on
Andreas Schwab <schwab@suse.de>
parents: 22368
diff changeset
486 ;; Avoid trailing nil which confuses customize.
a804a047b23d (Man-init-defvars): Avoid trailing nil on
Andreas Schwab <schwab@suse.de>
parents: 22368
diff changeset
487 (apply 'list
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
488 (cons
14672
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
489 Man-sed-command
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
490 (list
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
491 (if Man-sed-script
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
492 (concat "-e '" Man-sed-script "'")
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
493 "")
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
494 "-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
495 "-e '/\e[789]/s///g'"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
496 "-e '/Reformatting page. Wait/d'"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
497 "-e '/Reformatting entry. Wait/d'"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
498 "-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
499 "-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
500 "-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
501 "-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
502 "-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
503 "-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
504 "-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
505 "-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
506 "-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
507 "-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
508 ))
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
509 (cons
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
510 Man-awk-command
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
511 (list
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
512 "'\n"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
513 "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
514 "/^$/ { if (anonblank==0) next; }\n"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
515 "{ anonblank=1; }\n"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
516 "/^$/ { blankline++; next; }\n"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
517 "{ 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
518 "'"
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
519 ))
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
520 (if (not Man-uses-untabify-flag)
23267
a804a047b23d (Man-init-defvars): Avoid trailing nil on
Andreas Schwab <schwab@suse.de>
parents: 22368
diff changeset
521 ;; The outer list will be stripped off by apply.
a804a047b23d (Man-init-defvars): Avoid trailing nil on
Andreas Schwab <schwab@suse.de>
parents: 22368
diff changeset
522 (list (cons
a804a047b23d (Man-init-defvars): Avoid trailing nil on
Andreas Schwab <schwab@suse.de>
parents: 22368
diff changeset
523 Man-untabify-command
a804a047b23d (Man-init-defvars): Avoid trailing nil on
Andreas Schwab <schwab@suse.de>
parents: 22368
diff changeset
524 Man-untabify-command-args))
14672
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
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 )
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
527
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
528 (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
529 "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
530 (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
531 (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
532 "")
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
533 Man-current-page
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
534 (length Man-page-list)))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
535
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
536 (defsubst Man-build-man-command ()
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
537 "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
538 (let ((command (concat manual-program " " Man-switches
54515
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
539 (cond
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
540 ;; Already has %s
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
541 ((string-match "%s" manual-program) "")
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
542 ;; Stock MS-DOS shells cannot redirect stderr;
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
543 ;; `call-process' below sends it to /dev/null,
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
544 ;; so we don't need `2>' even with DOS shells
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
545 ;; which do support stderr redirection.
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
546 ((not (fboundp 'start-process)) " %s")
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
547 ((concat " %s 2>" null-device)))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
548 (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
549 (while (and flist (car flist))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
550 (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
551 (pargs (cdr (car flist))))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
552 (setq command
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
553 (concat command " | " pcom " "
29585
d3e3a9663705 (Man-build-man-command): Don't quote lambda.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 29525
diff changeset
554 (mapconcat (lambda (phrase)
d3e3a9663705 (Man-build-man-command): Don't quote lambda.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 29525
diff changeset
555 (if (not (stringp phrase))
d3e3a9663705 (Man-build-man-command): Don't quote lambda.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 29525
diff changeset
556 (error "Malformed Man-filter-list"))
d3e3a9663705 (Man-build-man-command): Don't quote lambda.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 29525
diff changeset
557 phrase)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
558 pargs " ")))
51892
3146f91c8c99 (Man-translate-cleanup): New.
Juanma Barranquero <lekktu@gmail.com>
parents: 51803
diff changeset
559 (setq flist (cdr flist))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
560 command))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
561
51892
3146f91c8c99 (Man-translate-cleanup): New.
Juanma Barranquero <lekktu@gmail.com>
parents: 51803
diff changeset
562
3146f91c8c99 (Man-translate-cleanup): New.
Juanma Barranquero <lekktu@gmail.com>
parents: 51803
diff changeset
563 (defun Man-translate-cleanup (string)
3146f91c8c99 (Man-translate-cleanup): New.
Juanma Barranquero <lekktu@gmail.com>
parents: 51803
diff changeset
564 "Strip leading, trailing and middle spaces."
3146f91c8c99 (Man-translate-cleanup): New.
Juanma Barranquero <lekktu@gmail.com>
parents: 51803
diff changeset
565 (when (stringp string)
3146f91c8c99 (Man-translate-cleanup): New.
Juanma Barranquero <lekktu@gmail.com>
parents: 51803
diff changeset
566 ;; Strip leading and trailing
3146f91c8c99 (Man-translate-cleanup): New.
Juanma Barranquero <lekktu@gmail.com>
parents: 51803
diff changeset
567 (if (string-match "^[ \t\f\r\n]*\\(.+[^ \t\f\r\n]\\)" string)
3146f91c8c99 (Man-translate-cleanup): New.
Juanma Barranquero <lekktu@gmail.com>
parents: 51803
diff changeset
568 (setq string (match-string 1 string)))
3146f91c8c99 (Man-translate-cleanup): New.
Juanma Barranquero <lekktu@gmail.com>
parents: 51803
diff changeset
569 ;; middle spaces
3146f91c8c99 (Man-translate-cleanup): New.
Juanma Barranquero <lekktu@gmail.com>
parents: 51803
diff changeset
570 (setq string (replace-regexp-in-string "[\t\r\n]" " " string))
3146f91c8c99 (Man-translate-cleanup): New.
Juanma Barranquero <lekktu@gmail.com>
parents: 51803
diff changeset
571 (setq string (replace-regexp-in-string " +" " " string))
3146f91c8c99 (Man-translate-cleanup): New.
Juanma Barranquero <lekktu@gmail.com>
parents: 51803
diff changeset
572 string))
3146f91c8c99 (Man-translate-cleanup): New.
Juanma Barranquero <lekktu@gmail.com>
parents: 51803
diff changeset
573
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
574 (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
575 "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
576 Leave it as is if already in that style. Possibly downcase and
65197
df6f7e582a6e (Man-init-defvars, Man-translate-references, Man-support-local-filenames,
Juanma Barranquero <lekktu@gmail.com>
parents: 64762
diff changeset
577 translate the section (see the `Man-downcase-section-letters-flag'
df6f7e582a6e (Man-init-defvars, Man-translate-references, Man-support-local-filenames,
Juanma Barranquero <lekktu@gmail.com>
parents: 64762
diff changeset
578 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
579 (let ((name "")
51892
3146f91c8c99 (Man-translate-cleanup): New.
Juanma Barranquero <lekktu@gmail.com>
parents: 51803
diff changeset
580 (section "")
3146f91c8c99 (Man-translate-cleanup): New.
Juanma Barranquero <lekktu@gmail.com>
parents: 51803
diff changeset
581 (slist Man-section-translations-alist))
3146f91c8c99 (Man-translate-cleanup): New.
Juanma Barranquero <lekktu@gmail.com>
parents: 51803
diff changeset
582 (setq ref (Man-translate-cleanup ref))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
583 (cond
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
584 ;; "chmod(2V)" case ?
12809
c388f6f7f210 * man.el (Man-translate-references): Anchor the regexps.
Francesco Potortì <pot@gnu.org>
parents: 12457
diff changeset
585 ((string-match (concat "^" Man-reference-regexp "$") ref)
41698
722fe545e535 (man-follow-mouse): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38970
diff changeset
586 (setq name (match-string 1 ref)
722fe545e535 (man-follow-mouse): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38970
diff changeset
587 section (match-string 2 ref)))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
588 ;; "2v chmod" case ?
12809
c388f6f7f210 * man.el (Man-translate-references): Anchor the regexps.
Francesco Potortì <pot@gnu.org>
parents: 12457
diff changeset
589 ((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
590 "\\) +\\(" Man-name-regexp "\\)$") ref)
41698
722fe545e535 (man-follow-mouse): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38970
diff changeset
591 (setq name (match-string 2 ref)
722fe545e535 (man-follow-mouse): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38970
diff changeset
592 section (match-string 1 ref))))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
593 (if (string= name "")
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
594 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
595 (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
596 (setq section (downcase section)))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
597 (while slist
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
598 (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
599 (s2 (cdr (car slist))))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
600 (setq slist (cdr slist))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
601 (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
602 (setq s1 (downcase s1)))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
603 (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
604 (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
605 (downcase s2)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
606 s2)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
607 slist nil))))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
608 (concat Man-specified-section-option section " " name))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
609
54515
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
610 (defun Man-support-local-filenames ()
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
611 "Check the availability of `-l' option of the man command.
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
612 This option allows `man' to interpret command line arguments
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
613 as local filenames.
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
614 Return the value of the variable `Man-support-local-filenames'
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
615 if it was set to nil or t before the call of this function.
65197
df6f7e582a6e (Man-init-defvars, Man-translate-references, Man-support-local-filenames,
Juanma Barranquero <lekktu@gmail.com>
parents: 64762
diff changeset
616 If t, the man command supports `-l' option. If nil, it doesn't.
54515
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
617 Otherwise, if the value of `Man-support-local-filenames'
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
618 is neither t nor nil, then determine a new value, set it
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
619 to the variable `Man-support-local-filenames' and return
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
620 a new value."
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
621 (if (or (not Man-support-local-filenames)
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
622 (eq Man-support-local-filenames t))
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
623 Man-support-local-filenames
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
624 (setq Man-support-local-filenames
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
625 (with-temp-buffer
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
626 (and (equal (condition-case nil
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
627 (call-process manual-program nil t nil "--help")
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
628 (error nil))
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
629 0)
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
630 (progn
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
631 (goto-char (point-min))
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
632 (search-forward "--local-file" nil t))
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
633 t)))))
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
634
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
635
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
636 ;; ======================================================================
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
637 ;; default man entry: get word under point
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
638
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
639 (defsubst Man-default-man-entry ()
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
640 "Make a guess at a default manual entry.
35603
8f8be2a8aed8 (Man-default-man-entry, Man-mode): Doc fix.
Gerd Moellmann <gerd@gnu.org>
parents: 32495
diff changeset
641 This guess is based on the text surrounding the cursor."
17132
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
642 (let (word)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
643 (save-excursion
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
644 ;; 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
645 ;; cursor not on a word, then nearest preceding word.
48012
73c9cc6e8538 (Man-default-man-entry): Don't look for all word chars,
Richard M. Stallman <rms@gnu.org>
parents: 47891
diff changeset
646 (skip-chars-backward "-a-zA-Z0-9._+:")
73c9cc6e8538 (Man-default-man-entry): Don't look for all word chars,
Richard M. Stallman <rms@gnu.org>
parents: 47891
diff changeset
647 (let ((start (point)))
73c9cc6e8538 (Man-default-man-entry): Don't look for all word chars,
Richard M. Stallman <rms@gnu.org>
parents: 47891
diff changeset
648 (skip-chars-forward "-a-zA-Z0-9._+:")
52324
c97fe9557de4 (Man-default-man-entry): Strip text properties when
John Paul Wallington <jpw@pobox.com>
parents: 51892
diff changeset
649 (setq word (buffer-substring-no-properties start (point))))
17132
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
650 (if (string-match "[._]+$" word)
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
651 (setq word (substring word 0 (match-beginning 0))))
52636
87642088b41e (Man-default-man-entry): Remove the leading `*' from the word at point.
Eli Zaretskii <eliz@gnu.org>
parents: 52401
diff changeset
652 ;; If looking at something like *strcat(... , remove the '*'
87642088b41e (Man-default-man-entry): Remove the leading `*' from the word at point.
Eli Zaretskii <eliz@gnu.org>
parents: 52401
diff changeset
653 (if (string-match "^*" word)
87642088b41e (Man-default-man-entry): Remove the leading `*' from the word at point.
Eli Zaretskii <eliz@gnu.org>
parents: 52401
diff changeset
654 (setq word (substring word 1)))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
655 ;; 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
656 ;; section number in the returned value. Remove text properties.
52324
c97fe9557de4 (Man-default-man-entry): Strip text properties when
John Paul Wallington <jpw@pobox.com>
parents: 51892
diff changeset
657 (concat word
17132
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
658 (if (looking-at
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
659 (concat "[ \t]*([ \t]*\\(" Man-section-regexp "\\)[ \t]*)"))
52324
c97fe9557de4 (Man-default-man-entry): Strip text properties when
John Paul Wallington <jpw@pobox.com>
parents: 51892
diff changeset
660 (format "(%s)" (match-string-no-properties 1)))))))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
661
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
662
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
663 ;; ======================================================================
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
664 ;; Top level command and background process sentinel
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
665
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
666 ;; For compatibility with older versions.
4444
0a428f48e71a (man): Define as alias.
Richard M. Stallman <rms@gnu.org>
parents: 4378
diff changeset
667 ;;;###autoload
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
668 (defalias 'manual-entry 'man)
4444
0a428f48e71a (man): Define as alias.
Richard M. Stallman <rms@gnu.org>
parents: 4378
diff changeset
669
51892
3146f91c8c99 (Man-translate-cleanup): New.
Juanma Barranquero <lekktu@gmail.com>
parents: 51803
diff changeset
670
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
671 ;;;###autoload
9828
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
672 (defun man (man-args)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
673 "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
674 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
675 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
676 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
677 `Man-notify-method' for what happens when the buffer is ready.
29838
0544e6edf4ff (man): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 29585
diff changeset
678 If a buffer already exists for this man page, it will display immediately.
0544e6edf4ff (man): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 29585
diff changeset
679
0544e6edf4ff (man): Doc fix.
Eli Zaretskii <eliz@gnu.org>
parents: 29585
diff changeset
680 To specify a man page from a certain section, type SUBJECT(SECTION) or
38646
5236fd76fef0 (man): Mention Man-switches in the doc string.
Eli Zaretskii <eliz@gnu.org>
parents: 38412
diff changeset
681 SECTION SUBJECT when prompted for a manual entry. To see manpages from
5236fd76fef0 (man): Mention Man-switches in the doc string.
Eli Zaretskii <eliz@gnu.org>
parents: 38412
diff changeset
682 all sections related to a subject, put something appropriate into the
5236fd76fef0 (man): Mention Man-switches in the doc string.
Eli Zaretskii <eliz@gnu.org>
parents: 38412
diff changeset
683 `Man-switches' variable, which see."
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
684 (interactive
9828
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
685 (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
686 (input (read-string
65680
ed770a0a7846 2005-09-24 Emilio C. Lopes <eclig@gmx.net>
Romain Francoise <romain@orebokech.com>
parents: 65197
diff changeset
687 (format "Manual entry%s"
9828
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
688 (if (string= default-entry "")
65680
ed770a0a7846 2005-09-24 Emilio C. Lopes <eclig@gmx.net>
Romain Francoise <romain@orebokech.com>
parents: 65197
diff changeset
689 ": "
ed770a0a7846 2005-09-24 Emilio C. Lopes <eclig@gmx.net>
Romain Francoise <romain@orebokech.com>
parents: 65197
diff changeset
690 (format " (default %s): " default-entry)))
72619
5dd4533a9a7e (Man-topic-history): New variable.
Juri Linkov <juri@jurta.org>
parents: 69793
diff changeset
691 nil 'Man-topic-history default-entry)))
9828
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
692 (if (string= input "")
41698
722fe545e535 (man-follow-mouse): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38970
diff changeset
693 (error "No man args given")
9828
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
694 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
695
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
696 ;; 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
697 ;; "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
698 (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
699
9828
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
700 (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
701
17129
79f712c639b7 (man-follow): New function.
Karl Heuer <kwzh@gnu.org>
parents: 16974
diff changeset
702 ;;;###autoload
79f712c639b7 (man-follow): New function.
Karl Heuer <kwzh@gnu.org>
parents: 16974
diff changeset
703 (defun man-follow (man-args)
79f712c639b7 (man-follow): New function.
Karl Heuer <kwzh@gnu.org>
parents: 16974
diff changeset
704 "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
705 (interactive (list (Man-default-man-entry)))
79f712c639b7 (man-follow): New function.
Karl Heuer <kwzh@gnu.org>
parents: 16974
diff changeset
706 (if (or (not man-args)
79f712c639b7 (man-follow): New function.
Karl Heuer <kwzh@gnu.org>
parents: 16974
diff changeset
707 (string= man-args ""))
79f712c639b7 (man-follow): New function.
Karl Heuer <kwzh@gnu.org>
parents: 16974
diff changeset
708 (error "No item under point")
79f712c639b7 (man-follow): New function.
Karl Heuer <kwzh@gnu.org>
parents: 16974
diff changeset
709 (man man-args)))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
710
9828
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
711 (defun Man-getpage-in-background (topic)
28102
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
712 "Use 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
713 (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
714 (bufname (concat "*Man " man-args "*"))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
715 (buffer (get-buffer bufname)))
9828
e78a12b9ef41 * man.el (Man-reuse-okay-flag): Deleted.
Francesco Potortì <pot@gnu.org>
parents: 9726
diff changeset
716 (if buffer
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
717 (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
718 (require 'env)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
719 (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
720 (setq buffer (generate-new-buffer bufname))
6363
e5d9ea7852bf (Man-original-frame): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 6362
diff changeset
721 (save-excursion
e5d9ea7852bf (Man-original-frame): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 6362
diff changeset
722 (set-buffer buffer)
59784
71d8a58f6f27 (Man-getpage-in-background): Disable undo in Man buffer.
Richard M. Stallman <rms@gnu.org>
parents: 59398
diff changeset
723 (setq buffer-undo-list t)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
724 (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
725 (setq Man-arguments man-args))
20266
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
726 (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
727 ;; 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
728 ;; 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
729 (coding-system-for-write 'raw-text-unix)
30995
75f3cd16a9ab (Man-getpage-in-background): Decode the process output by the system
Kenichi Handa <handa@m17n.org>
parents: 29973
diff changeset
730 ;; We must decode the output by a coding system that the
32495
b5e119e4bfcb Fix typo in a comment.
Eli Zaretskii <eliz@gnu.org>
parents: 32396
diff changeset
731 ;; system's locale suggests in multibyte mode.
32396
b68d86c19284 (Man-getpage-in-background): Fix previous change.
Kenichi Handa <handa@m17n.org>
parents: 31005
diff changeset
732 (coding-system-for-read
b68d86c19284 (Man-getpage-in-background): Fix previous change.
Kenichi Handa <handa@m17n.org>
parents: 31005
diff changeset
733 (if default-enable-multibyte-characters
b68d86c19284 (Man-getpage-in-background): Fix previous change.
Kenichi Handa <handa@m17n.org>
parents: 31005
diff changeset
734 locale-coding-system 'raw-text-unix))
20266
450fdcb00733 (Man-init-defvars, Man-build-man-command):
Karl Heuer <kwzh@gnu.org>
parents: 20154
diff changeset
735 ;; Avoid possible error by using a directory that always exists.
50054
a323f25ec045 (Man-getpage-in-background): Only change
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49597
diff changeset
736 (default-directory
a323f25ec045 (Man-getpage-in-background): Only change
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49597
diff changeset
737 (if (and (file-directory-p default-directory)
a323f25ec045 (Man-getpage-in-background): Only change
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49597
diff changeset
738 (not (find-file-name-handler default-directory
a323f25ec045 (Man-getpage-in-background): Only change
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49597
diff changeset
739 'file-directory-p)))
a323f25ec045 (Man-getpage-in-background): Only change
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49597
diff changeset
740 default-directory
a323f25ec045 (Man-getpage-in-background): Only change
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49597
diff changeset
741 "/")))
3713
c77a3da2d08d (Man-getpage-in-background): Use TERM=dumb to prevent
Richard M. Stallman <rms@gnu.org>
parents: 3659
diff changeset
742 ;; 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
743 (setenv "TERM" "dumb")
47891
e7440f7b0700 (Man-getpage-in-background): Set width in environment.
Dave Love <fx@gnu.org>
parents: 42706
diff changeset
744 ;; In Debian Woody, at least, we get overlong lines under X
e7440f7b0700 (Man-getpage-in-background): Set width in environment.
Dave Love <fx@gnu.org>
parents: 42706
diff changeset
745 ;; unless COLUMNS or MANWIDTH is set. This isn't a problem on
e7440f7b0700 (Man-getpage-in-background): Set width in environment.
Dave Love <fx@gnu.org>
parents: 42706
diff changeset
746 ;; a tty. man(1) says:
e7440f7b0700 (Man-getpage-in-background): Set width in environment.
Dave Love <fx@gnu.org>
parents: 42706
diff changeset
747 ;; MANWIDTH
e7440f7b0700 (Man-getpage-in-background): Set width in environment.
Dave Love <fx@gnu.org>
parents: 42706
diff changeset
748 ;; If $MANWIDTH is set, its value is used as the line
e7440f7b0700 (Man-getpage-in-background): Set width in environment.
Dave Love <fx@gnu.org>
parents: 42706
diff changeset
749 ;; length for which manual pages should be formatted.
e7440f7b0700 (Man-getpage-in-background): Set width in environment.
Dave Love <fx@gnu.org>
parents: 42706
diff changeset
750 ;; If it is not set, manual pages will be formatted
e7440f7b0700 (Man-getpage-in-background): Set width in environment.
Dave Love <fx@gnu.org>
parents: 42706
diff changeset
751 ;; with a line length appropriate to the current ter-
e7440f7b0700 (Man-getpage-in-background): Set width in environment.
Dave Love <fx@gnu.org>
parents: 42706
diff changeset
752 ;; minal (using an ioctl(2) if available, the value of
e7440f7b0700 (Man-getpage-in-background): Set width in environment.
Dave Love <fx@gnu.org>
parents: 42706
diff changeset
753 ;; $COLUMNS, or falling back to 80 characters if nei-
e7440f7b0700 (Man-getpage-in-background): Set width in environment.
Dave Love <fx@gnu.org>
parents: 42706
diff changeset
754 ;; ther is available).
e7440f7b0700 (Man-getpage-in-background): Set width in environment.
Dave Love <fx@gnu.org>
parents: 42706
diff changeset
755 (if window-system
e7440f7b0700 (Man-getpage-in-background): Set width in environment.
Dave Love <fx@gnu.org>
parents: 42706
diff changeset
756 (unless (or (getenv "MANWIDTH") (getenv "COLUMNS"))
e7440f7b0700 (Man-getpage-in-background): Set width in environment.
Dave Love <fx@gnu.org>
parents: 42706
diff changeset
757 ;; This isn't strictly correct, since we don't know how
e7440f7b0700 (Man-getpage-in-background): Set width in environment.
Dave Love <fx@gnu.org>
parents: 42706
diff changeset
758 ;; the page will actually be displayed, but it seems
e7440f7b0700 (Man-getpage-in-background): Set width in environment.
Dave Love <fx@gnu.org>
parents: 42706
diff changeset
759 ;; reasonable.
54515
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
760 (setenv "COLUMNS" (number-to-string
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
761 (cond
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
762 ((and (integerp Man-width) (> Man-width 0))
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
763 Man-width)
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
764 (Man-width (frame-width))
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
765 ((window-width)))))))
50476
14e9fad0af6b (Man-getpage-in-background): Set GROFF_NO_SGR env var in
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 50418
diff changeset
766 (setenv "GROFF_NO_SGR" "1")
16973
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
767 (if (fboundp 'start-process)
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
768 (set-process-sentinel
55527
4729059e27b8 (Man-getpage-in-background): Use shell-file-name
Eli Zaretskii <eliz@gnu.org>
parents: 54515
diff changeset
769 (start-process manual-program buffer
56254
060e08bf63fe (Man-getpage-in-background): Add windows-nt to the list
Eli Zaretskii <eliz@gnu.org>
parents: 56159
diff changeset
770 (if (memq system-type '(cygwin windows-nt))
060e08bf63fe (Man-getpage-in-background): Add windows-nt to the list
Eli Zaretskii <eliz@gnu.org>
parents: 56159
diff changeset
771 shell-file-name
060e08bf63fe (Man-getpage-in-background): Add windows-nt to the list
Eli Zaretskii <eliz@gnu.org>
parents: 56159
diff changeset
772 "sh")
56159
8fd93d7de209 (Man-getpage-in-background): Revert previous change but
Nick Roberts <nickrob@snap.net.nz>
parents: 55527
diff changeset
773 shell-command-switch
16973
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
774 (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
775 'Man-bgproc-sentinel)
50062
b43d8c1413de * man.el (Man-getpage-in-background): Always use `setenv' for
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 50054
diff changeset
776 (let ((exit-status
55527
4729059e27b8 (Man-getpage-in-background): Use shell-file-name
Eli Zaretskii <eliz@gnu.org>
parents: 54515
diff changeset
777 (call-process shell-file-name nil (list buffer nil) nil
4729059e27b8 (Man-getpage-in-background): Use shell-file-name
Eli Zaretskii <eliz@gnu.org>
parents: 54515
diff changeset
778 shell-command-switch
50062
b43d8c1413de * man.el (Man-getpage-in-background): Always use `setenv' for
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 50054
diff changeset
779 (format (Man-build-man-command) man-args)))
b43d8c1413de * man.el (Man-getpage-in-background): Always use `setenv' for
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 50054
diff changeset
780 (msg ""))
b43d8c1413de * man.el (Man-getpage-in-background): Always use `setenv' for
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 50054
diff changeset
781 (or (and (numberp exit-status)
b43d8c1413de * man.el (Man-getpage-in-background): Always use `setenv' for
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 50054
diff changeset
782 (= exit-status 0))
b43d8c1413de * man.el (Man-getpage-in-background): Always use `setenv' for
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 50054
diff changeset
783 (and (numberp exit-status)
b43d8c1413de * man.el (Man-getpage-in-background): Always use `setenv' for
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 50054
diff changeset
784 (setq msg
b43d8c1413de * man.el (Man-getpage-in-background): Always use `setenv' for
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 50054
diff changeset
785 (format "exited abnormally with code %d"
b43d8c1413de * man.el (Man-getpage-in-background): Always use `setenv' for
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 50054
diff changeset
786 exit-status)))
b43d8c1413de * man.el (Man-getpage-in-background): Always use `setenv' for
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 50054
diff changeset
787 (setq msg exit-status))
b43d8c1413de * man.el (Man-getpage-in-background): Always use `setenv' for
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 50054
diff changeset
788 (Man-bgproc-sentinel bufname msg)))))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
789
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
790 (defun Man-notify-when-ready (man-buffer)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
791 "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
792 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
793 (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
794 (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
795 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
796 (cond
9003
bfe446409b77 User option Man-notify-flag renamed to Man-notify-method.
Francesco Potortì <pot@gnu.org>
parents: 8970
diff changeset
797 ((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
798 ;; 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
799 ;; 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
800 ;; 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
801 ;; 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
802 (save-excursion
21581
3aad7ffd0cd3 (Man-notify-when-ready) <newframe>:
Richard M. Stallman <rms@gnu.org>
parents: 21433
diff changeset
803 (let ((frame (make-frame Man-frame-parameters)))
3aad7ffd0cd3 (Man-notify-when-ready) <newframe>:
Richard M. Stallman <rms@gnu.org>
parents: 21433
diff changeset
804 (set-window-buffer (frame-selected-window frame) man-buffer)
29973
be9760ddad44 (Man-notify-when-ready): Don't use window-system. If
Eli Zaretskii <eliz@gnu.org>
parents: 29838
diff changeset
805 (set-window-dedicated-p (frame-selected-window frame) t)
be9760ddad44 (Man-notify-when-ready): Don't use window-system. If
Eli Zaretskii <eliz@gnu.org>
parents: 29838
diff changeset
806 (or (display-multi-frame-p frame)
be9760ddad44 (Man-notify-when-ready): Don't use window-system. If
Eli Zaretskii <eliz@gnu.org>
parents: 29838
diff changeset
807 (select-frame frame)))))
9003
bfe446409b77 User option Man-notify-flag renamed to Man-notify-method.
Francesco Potortì <pot@gnu.org>
parents: 8970
diff changeset
808 ((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
809 (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
810 ((eq Man-notify-method 'bully)
29973
be9760ddad44 (Man-notify-when-ready): Don't use window-system. If
Eli Zaretskii <eliz@gnu.org>
parents: 29838
diff changeset
811 (and (frame-live-p saved-frame)
8697
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
812 (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
813 (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
814 (delete-other-windows))
9003
bfe446409b77 User option Man-notify-flag renamed to Man-notify-method.
Francesco Potortì <pot@gnu.org>
parents: 8970
diff changeset
815 ((eq Man-notify-method 'aggressive)
29973
be9760ddad44 (Man-notify-when-ready): Don't use window-system. If
Eli Zaretskii <eliz@gnu.org>
parents: 29838
diff changeset
816 (and (frame-live-p saved-frame)
8697
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
817 (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
818 (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
819 ((eq Man-notify-method 'friendly)
29973
be9760ddad44 (Man-notify-when-ready): Don't use window-system. If
Eli Zaretskii <eliz@gnu.org>
parents: 29838
diff changeset
820 (and (frame-live-p saved-frame)
8697
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
821 (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
822 (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
823 ((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
824 (beep)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
825 (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
826 ((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
827 (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
828 ((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
829 t)
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
830 (message ""))
c75e435af62f (Man-notify-when-ready): Get Man-original-frame from the proper buffer.
Richard M. Stallman <rms@gnu.org>
parents: 8190
diff changeset
831 )))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
832
20154
d0550e30957c (Man-getpage-in-background): Bind inhibit-eol-conversion
Kenichi Handa <handa@m17n.org>
parents: 17436
diff changeset
833 (defun Man-softhyphen-to-minus ()
47891
e7440f7b0700 (Man-getpage-in-background): Set width in environment.
Dave Love <fx@gnu.org>
parents: 42706
diff changeset
834 ;; \255 is SOFT HYPHEN in Latin-N. Versions of Debian man, at
25202
abd64c56891f (Man-softhyphen-to-minus): Revert previous change. Avoid unibyte to
Dave Love <fx@gnu.org>
parents: 25201
diff changeset
835 ;; least, emit it even when not in a Latin-N locale.
abd64c56891f (Man-softhyphen-to-minus): Revert previous change. Avoid unibyte to
Dave Love <fx@gnu.org>
parents: 25201
diff changeset
836 (unless (eq t (compare-strings "latin-" 0 nil
abd64c56891f (Man-softhyphen-to-minus): Revert previous change. Avoid unibyte to
Dave Love <fx@gnu.org>
parents: 25201
diff changeset
837 current-language-environment 0 6 t))
abd64c56891f (Man-softhyphen-to-minus): Revert previous change. Avoid unibyte to
Dave Love <fx@gnu.org>
parents: 25201
diff changeset
838 (goto-char (point-min))
abd64c56891f (Man-softhyphen-to-minus): Revert previous change. Avoid unibyte to
Dave Love <fx@gnu.org>
parents: 25201
diff changeset
839 (let ((str "\255"))
abd64c56891f (Man-softhyphen-to-minus): Revert previous change. Avoid unibyte to
Dave Love <fx@gnu.org>
parents: 25201
diff changeset
840 (if enable-multibyte-characters
abd64c56891f (Man-softhyphen-to-minus): Revert previous change. Avoid unibyte to
Dave Love <fx@gnu.org>
parents: 25201
diff changeset
841 (setq str (string-as-multibyte str)))
abd64c56891f (Man-softhyphen-to-minus): Revert previous change. Avoid unibyte to
Dave Love <fx@gnu.org>
parents: 25201
diff changeset
842 (while (search-forward str nil t) (replace-match "-")))))
20154
d0550e30957c (Man-getpage-in-background): Bind inhibit-eol-conversion
Kenichi Handa <handa@m17n.org>
parents: 17436
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 (defun Man-fontify-manpage ()
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
845 "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
846 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
847 (interactive)
54515
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
848 (message "Please wait: formatting the %s man page..." Man-arguments)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
849 (goto-char (point-min))
58690
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
850 ;; Fontify ANSI escapes.
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
851 (let ((faces nil)
59362
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
852 (buffer-undo-list t)
58690
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
853 (start (point)))
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
854 ;; http://www.isthe.com/chongo/tech/comp/ansi_escapes.html
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
855 ;; suggests many codes, but we only handle:
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
856 ;; ESC [ 00 m reset to normal display
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
857 ;; ESC [ 01 m bold
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
858 ;; ESC [ 04 m underline
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
859 ;; ESC [ 07 m reverse-video
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
860 ;; ESC [ 22 m no-bold
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
861 ;; ESC [ 24 m no-underline
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
862 ;; ESC [ 27 m no-reverse-video
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
863 (while (re-search-forward "\e\\[0?\\([1470]\\|2\\([247]\\)\\)m" nil t)
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
864 (if faces (put-text-property start (match-beginning 0) 'face
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
865 (if (cdr faces) faces (car faces))))
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
866 (setq faces
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
867 (cond
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
868 ((match-beginning 2)
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
869 (delq (case (char-after (match-beginning 2))
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
870 (?2 Man-overstrike-face)
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
871 (?4 Man-underline-face)
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
872 (?7 Man-reverse-face))
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
873 faces))
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
874 ((eq (char-after (match-beginning 1)) ?0) nil)
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
875 (t
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
876 (cons (case (char-after (match-beginning 1))
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
877 (?1 Man-overstrike-face)
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
878 (?4 Man-underline-face)
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
879 (?7 Man-reverse-face))
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
880 faces))))
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
881 (delete-region (match-beginning 0) (match-end 0))
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
882 (setq start (point))))
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
883 ;; Other highlighting.
59362
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
884 (let ((buffer-undo-list t))
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
885 (if (< (buffer-size) (position-bytes (point-max)))
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
886 ;; Multibyte characters exist.
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
887 (progn
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
888 (goto-char (point-min))
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
889 (while (search-forward "__\b\b" nil t)
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
890 (backward-delete-char 4)
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
891 (put-text-property (point) (1+ (point)) 'face Man-underline-face))
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
892 (goto-char (point-min))
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
893 (while (search-forward "\b\b__" nil t)
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
894 (backward-delete-char 4)
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
895 (put-text-property (1- (point)) (point) 'face Man-underline-face))))
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
896 (goto-char (point-min))
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
897 (while (search-forward "_\b" nil t)
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
898 (backward-delete-char 2)
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
899 (put-text-property (point) (1+ (point)) 'face Man-underline-face))
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
900 (goto-char (point-min))
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
901 (while (search-forward "\b_" nil t)
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
902 (backward-delete-char 2)
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
903 (put-text-property (1- (point)) (point) 'face Man-underline-face))
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
904 (goto-char (point-min))
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
905 (while (re-search-forward "\\(.\\)\\(\b+\\1\\)+" nil t)
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
906 (replace-match "\\1")
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
907 (put-text-property (1- (point)) (point) 'face Man-overstrike-face))
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
908 (goto-char (point-min))
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
909 (while (re-search-forward "o\b\\+\\|\\+\bo" nil t)
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
910 (replace-match "o")
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
911 (put-text-property (1- (point)) (point) 'face 'bold))
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
912 (goto-char (point-min))
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
913 (while (re-search-forward "[-|]\\(\b[-|]\\)+" nil t)
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
914 (replace-match "+")
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
915 (put-text-property (1- (point)) (point) 'face 'bold))
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
916 (goto-char (point-min))
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
917 ;; Try to recognize common forms of cross references.
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
918 (Man-highlight-references)
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
919 (Man-softhyphen-to-minus)
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
920 (goto-char (point-min))
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
921 (while (re-search-forward Man-heading-regexp nil t)
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
922 (put-text-property (match-beginning 0)
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
923 (match-end 0)
07f5b835edb6 (Man-fontify-manpage): Turn off undo generation.
Richard M. Stallman <rms@gnu.org>
parents: 58742
diff changeset
924 'face Man-overstrike-face)))
53690
f428900fb582 (Man-fontify-manpage): Clean up message.
Richard M. Stallman <rms@gnu.org>
parents: 53477
diff changeset
925 (message "%s man page formatted" Man-arguments))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
926
66177
bd98d8a37303 * woman.el (WoMan-xref-man-page): New button type derived
Masatake YAMATO <jet@gyve.org>
parents: 65680
diff changeset
927 (defun Man-highlight-references (&optional xref-man-type)
50403
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
928 "Highlight the references on mouse-over.
65197
df6f7e582a6e (Man-init-defvars, Man-translate-references, Man-support-local-filenames,
Juanma Barranquero <lekktu@gmail.com>
parents: 64762
diff changeset
929 References include items in the SEE ALSO section,
67006
a6acb03fe18c (Man-highlight-references): Doc fix. Reformat code in a more Lisp-ish way.
Eli Zaretskii <eliz@gnu.org>
parents: 66792
diff changeset
930 header file (#include <foo.h>), and files in FILES.
a6acb03fe18c (Man-highlight-references): Doc fix. Reformat code in a more Lisp-ish way.
Eli Zaretskii <eliz@gnu.org>
parents: 66792
diff changeset
931 If optional argument XREF-MAN-TYPE is non-nil, it used as the
a6acb03fe18c (Man-highlight-references): Doc fix. Reformat code in a more Lisp-ish way.
Eli Zaretskii <eliz@gnu.org>
parents: 66792
diff changeset
932 button type for items in SEE ALSO section. If it is nil, the
a6acb03fe18c (Man-highlight-references): Doc fix. Reformat code in a more Lisp-ish way.
Eli Zaretskii <eliz@gnu.org>
parents: 66792
diff changeset
933 default type, `Man-xref-man-page' is used for the buttons."
66792
9a04e09eb6c9 (Man-highlight-references): Set an empty
Masatake YAMATO <jet@gyve.org>
parents: 66729
diff changeset
934 ;; `Man-highlight-references' is used from woman.el, too.
9a04e09eb6c9 (Man-highlight-references): Set an empty
Masatake YAMATO <jet@gyve.org>
parents: 66729
diff changeset
935 ;; woman.el doesn't set `Man-arguments'.
9a04e09eb6c9 (Man-highlight-references): Set an empty
Masatake YAMATO <jet@gyve.org>
parents: 66729
diff changeset
936 (unless Man-arguments
9a04e09eb6c9 (Man-highlight-references): Set an empty
Masatake YAMATO <jet@gyve.org>
parents: 66729
diff changeset
937 (setq Man-arguments ""))
66729
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
938 (if (string-match "-k " Man-arguments)
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
939 (progn
69793
93d87ad179a4 * man.el (Man-mode-map): Restore the \r binding.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 68651
diff changeset
940 (Man-highlight-references0 nil Man-reference-regexp 1
93d87ad179a4 * man.el (Man-mode-map): Restore the \r binding.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 68651
diff changeset
941 'Man-default-man-entry
67006
a6acb03fe18c (Man-highlight-references): Doc fix. Reformat code in a more Lisp-ish way.
Eli Zaretskii <eliz@gnu.org>
parents: 66792
diff changeset
942 (or xref-man-type 'Man-xref-man-page))
a6acb03fe18c (Man-highlight-references): Doc fix. Reformat code in a more Lisp-ish way.
Eli Zaretskii <eliz@gnu.org>
parents: 66792
diff changeset
943 (Man-highlight-references0 nil Man-apropos-regexp 1
69793
93d87ad179a4 * man.el (Man-mode-map): Restore the \r binding.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 68651
diff changeset
944 'Man-default-man-entry
67006
a6acb03fe18c (Man-highlight-references): Doc fix. Reformat code in a more Lisp-ish way.
Eli Zaretskii <eliz@gnu.org>
parents: 66792
diff changeset
945 (or xref-man-type 'Man-xref-man-page)))
69793
93d87ad179a4 * man.el (Man-mode-map): Restore the \r binding.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 68651
diff changeset
946 (Man-highlight-references0 Man-see-also-regexp Man-reference-regexp 1
93d87ad179a4 * man.el (Man-mode-map): Restore the \r binding.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 68651
diff changeset
947 'Man-default-man-entry
67006
a6acb03fe18c (Man-highlight-references): Doc fix. Reformat code in a more Lisp-ish way.
Eli Zaretskii <eliz@gnu.org>
parents: 66792
diff changeset
948 (or xref-man-type 'Man-xref-man-page))
a6acb03fe18c (Man-highlight-references): Doc fix. Reformat code in a more Lisp-ish way.
Eli Zaretskii <eliz@gnu.org>
parents: 66792
diff changeset
949 (Man-highlight-references0 Man-synopsis-regexp Man-header-regexp 0 2
a6acb03fe18c (Man-highlight-references): Doc fix. Reformat code in a more Lisp-ish way.
Eli Zaretskii <eliz@gnu.org>
parents: 66792
diff changeset
950 'Man-xref-header-file)
a6acb03fe18c (Man-highlight-references): Doc fix. Reformat code in a more Lisp-ish way.
Eli Zaretskii <eliz@gnu.org>
parents: 66792
diff changeset
951 (Man-highlight-references0 Man-files-regexp Man-normal-file-regexp 0 0
a6acb03fe18c (Man-highlight-references): Doc fix. Reformat code in a more Lisp-ish way.
Eli Zaretskii <eliz@gnu.org>
parents: 66792
diff changeset
952 'Man-xref-normal-file)))
50403
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
953
66729
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
954 (defun Man-highlight-references0 (start-section regexp button-pos target type)
50403
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
955 ;; Based on `Man-build-references-alist'
66729
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
956 (when (or (null start-section)
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
957 (Man-find-section start-section))
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
958 (let ((end (if start-section
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
959 (progn
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
960 (forward-line 1)
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
961 (back-to-indentation)
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
962 (save-excursion
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
963 (Man-next-section 1)
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
964 (point)))
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
965 (goto-char (point-min))
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
966 (point-max))))
50403
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
967 (while (re-search-forward regexp end t)
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
968 (make-text-button
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
969 (match-beginning button-pos)
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
970 (match-end button-pos)
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
971 'type type
66729
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
972 'Man-target-string (cond
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
973 ((numberp target)
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
974 (match-string target))
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
975 ((functionp target)
69793
93d87ad179a4 * man.el (Man-mode-map): Restore the \r binding.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 68651
diff changeset
976 target)
66729
66a34cb7272d Improve man -k support.
Masatake YAMATO <jet@gyve.org>
parents: 66177
diff changeset
977 (t nil)))))))
50403
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
978
57699
f633084f70ae (Man-cleanup-manpage): Instead of interactive-p,
Richard M. Stallman <rms@gnu.org>
parents: 56254
diff changeset
979 (defun Man-cleanup-manpage (&optional interactive)
f633084f70ae (Man-cleanup-manpage): Instead of interactive-p,
Richard M. Stallman <rms@gnu.org>
parents: 56254
diff changeset
980 "Remove overstriking and underlining from the current buffer.
f633084f70ae (Man-cleanup-manpage): Instead of interactive-p,
Richard M. Stallman <rms@gnu.org>
parents: 56254
diff changeset
981 Normally skip any jobs that should have been done by the sed script,
f633084f70ae (Man-cleanup-manpage): Instead of interactive-p,
Richard M. Stallman <rms@gnu.org>
parents: 56254
diff changeset
982 but when called interactively, do those jobs even if the sed
f633084f70ae (Man-cleanup-manpage): Instead of interactive-p,
Richard M. Stallman <rms@gnu.org>
parents: 56254
diff changeset
983 script would have done them."
f633084f70ae (Man-cleanup-manpage): Instead of interactive-p,
Richard M. Stallman <rms@gnu.org>
parents: 56254
diff changeset
984 (interactive "p")
9620
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
985 (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
986 Man-arguments)
57699
f633084f70ae (Man-cleanup-manpage): Instead of interactive-p,
Richard M. Stallman <rms@gnu.org>
parents: 56254
diff changeset
987 (if (or interactive (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
988 (progn
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
989 (goto-char (point-min))
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
990 (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
991 (goto-char (point-min))
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
992 (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
993 (goto-char (point-min))
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
994 (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
995 (replace-match "\\1"))
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
996 (goto-char (point-min))
1f58befcd1f1 * man.el (Man-init-defvars): Corrections to Man-filter-list.
Francesco Potortì <pot@gnu.org>
parents: 9354
diff changeset
997 (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
998 (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
999 (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
1000 ))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1001 (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
1002 (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
1003 (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
1004 (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
1005
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1006 (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
1007 "Manpage background process sentinel.
28102
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1008 When manpage command is run asynchronously, PROCESS is the process
16973
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
1009 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
1010 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
1011 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
1012 manpage command."
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
1013 (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
1014 (process-buffer process)))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1015 (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
1016 (err-mess nil))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1017
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1018 (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
1019 (or (stringp process)
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
1020 (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
1021
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1022 (save-excursion
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1023 (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
1024 (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
1025 (goto-char (point-min))
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
1026 (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
1027 (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
1028 (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
1029 (progn
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
1030 (end-of-line) (point)))
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
1031 delete-buff t))
16973
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
1032 ((or (stringp process)
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
1033 (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
1034 (= (process-exit-status process) 0))))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
1035 (or (zerop (length msg))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
1036 (progn
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
1037 (setq err-mess
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
1038 (concat (buffer-name Man-buffer)
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
1039 ": process "
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
1040 (let ((eos (1- (length msg))))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
1041 (if (= (aref msg eos) ?\n)
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
1042 (substring msg 0 eos) msg))))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
1043 (goto-char (point-max))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
1044 (insert (format "\nprocess %s" msg))))
39569e1b84b2 (Man-build-man-command): When async processes aren't
Eli Zaretskii <eliz@gnu.org>
parents: 16509
diff changeset
1045 ))
16509
75d463b202b5 (Man-bgproc-sentinel): Move the buffer creation
Richard M. Stallman <rms@gnu.org>
parents: 14733
diff changeset
1046 (if delete-buff
75d463b202b5 (Man-bgproc-sentinel): Move the buffer creation
Richard M. Stallman <rms@gnu.org>
parents: 14733
diff changeset
1047 (kill-buffer Man-buffer)
75d463b202b5 (Man-bgproc-sentinel): Move the buffer creation
Richard M. Stallman <rms@gnu.org>
parents: 14733
diff changeset
1048 (if Man-fontify-manpage-flag
75d463b202b5 (Man-bgproc-sentinel): Move the buffer creation
Richard M. Stallman <rms@gnu.org>
parents: 14733
diff changeset
1049 (Man-fontify-manpage)
75d463b202b5 (Man-bgproc-sentinel): Move the buffer creation
Richard M. Stallman <rms@gnu.org>
parents: 14733
diff changeset
1050 (Man-cleanup-manpage))
64620
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1051
16509
75d463b202b5 (Man-bgproc-sentinel): Move the buffer creation
Richard M. Stallman <rms@gnu.org>
parents: 14733
diff changeset
1052 (run-hooks 'Man-cooked-hook)
64620
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1053 (Man-mode)
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1054
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1055 (if (not Man-page-list)
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1056 (let ((args Man-arguments))
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1057 (kill-buffer (current-buffer))
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1058 (error "Can't find the %s manpage" args)))
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1059
16509
75d463b202b5 (Man-bgproc-sentinel): Move the buffer creation
Richard M. Stallman <rms@gnu.org>
parents: 14733
diff changeset
1060 (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
1061 ))
10040
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
1062 ;; 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
1063 ;; Man-notify-when-ready because it may switch buffers.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1064
10040
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
1065 (if (not delete-buff)
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
1066 (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
1067
10040
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
1068 (if err-mess
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
1069 (error err-mess))
c69ddd9fa3a6 (Man-bgproc-sentinel): No need for save-match-data.
Richard M. Stallman <rms@gnu.org>
parents: 9867
diff changeset
1070 ))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1071
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1072
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1073 ;; ======================================================================
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1074 ;; set up manual mode in buffer and build alists
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1075
63336
423fcdb144f5 (Man-mode-map): Initialize it properly.
Lute Kamstra <lute@gnu.org>
parents: 62878
diff changeset
1076 (put 'Man-mode 'mode-class 'special)
423fcdb144f5 (Man-mode-map): Initialize it properly.
Lute Kamstra <lute@gnu.org>
parents: 62878
diff changeset
1077
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1078 (defun Man-mode ()
3909
192e7aa8389a (Man-auto-section-alist): Default value nil.
Richard M. Stallman <rms@gnu.org>
parents: 3833
diff changeset
1079 "A mode for browsing Un*x manual pages.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1080
28102
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1081 The following man commands are available in the buffer. Try
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1082 \"\\[describe-key] <key> RET\" for more information:
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1083
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1084 \\[man] Prompt to retrieve a new manpage.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1085 \\[Man-follow-manual-reference] Retrieve reference in SEE ALSO section.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1086 \\[Man-next-manpage] Jump to next manpage in circular list.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1087 \\[Man-previous-manpage] Jump to previous manpage in circular list.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1088 \\[Man-next-section] Jump to next manpage section.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1089 \\[Man-previous-section] Jump to previous manpage section.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1090 \\[Man-goto-section] Go to a manpage section.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1091 \\[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
1092 \\[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
1093 \\[Man-kill] Deletes the manpage window, kill its buffer.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1094 \\[describe-mode] Prints this help text.
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1095
28102
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1096 The following variables may be of some use. Try
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1097 \"\\[describe-variable] <variable-name> RET\" for more information:
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1098
28102
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1099 `Man-notify-method' What happens when manpage formatting is done.
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1100 `Man-downcase-section-letters-flag' Force section letters to lower case.
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1101 `Man-circular-pages-flag' Treat multiple manpage list as circular.
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1102 `Man-section-translations-alist' List of section numbers and their Un*x equiv.
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1103 `Man-filter-list' Background manpage filter command.
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1104 `Man-mode-map' Keymap bindings for Man mode buffers.
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1105 `Man-mode-hook' Normal hook run on entry to Man mode.
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1106 `Man-section-regexp' Regexp describing manpage section letters.
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1107 `Man-heading-regexp' Regexp describing section headers.
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1108 `Man-see-also-regexp' Regexp for SEE ALSO section (or your equiv).
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1109 `Man-first-heading-regexp' Regexp for first heading on a manpage.
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1110 `Man-reference-regexp' Regexp matching a references in SEE ALSO.
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1111 `Man-switches' Background `man' command switches.
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1112
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1113 The following key bindings are currently in effect in the buffer:
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1114 \\{Man-mode-map}"
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1115 (interactive)
62736
76864fc0acf0 (Man-mode): Use kill-all-local-variables and run-mode-hooks.
Lute Kamstra <lute@gnu.org>
parents: 61889
diff changeset
1116 (kill-all-local-variables)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1117 (setq major-mode 'Man-mode
3909
192e7aa8389a (Man-auto-section-alist): Default value nil.
Richard M. Stallman <rms@gnu.org>
parents: 3833
diff changeset
1118 mode-name "Man"
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1119 buffer-auto-save-file-name nil
38970
e144797b4ece (Man-mode-line-format): Variable removed.
Miles Bader <miles@gnu.org>
parents: 38646
diff changeset
1120 mode-line-buffer-identification
e144797b4ece (Man-mode-line-format): Variable removed.
Miles Bader <miles@gnu.org>
parents: 38646
diff changeset
1121 (list (default-value 'mode-line-buffer-identification)
e144797b4ece (Man-mode-line-format): Variable removed.
Miles Bader <miles@gnu.org>
parents: 38646
diff changeset
1122 " {" 'Man-page-mode-string "}")
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1123 truncate-lines t
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1124 buffer-read-only t)
62736
76864fc0acf0 (Man-mode): Use kill-all-local-variables and run-mode-hooks.
Lute Kamstra <lute@gnu.org>
parents: 61889
diff changeset
1125 (buffer-disable-undo)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1126 (auto-fill-mode -1)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1127 (use-local-map Man-mode-map)
17132
07c01fa1e7fc (man-mode-syntax-table): New variable.
Karl Heuer <kwzh@gnu.org>
parents: 17129
diff changeset
1128 (set-syntax-table man-mode-syntax-table)
54515
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
1129 (setq imenu-generic-expression (list (list nil Man-heading-regexp 0)))
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
1130 (set (make-local-variable 'outline-regexp) Man-heading-regexp)
9172c9ef1dcf (Man-width): New var.
Juri Linkov <juri@jurta.org>
parents: 54005
diff changeset
1131 (set (make-local-variable 'outline-level) (lambda () 1))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1132 (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
1133 (Man-strip-page-headers)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1134 (Man-unindent)
64620
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1135 (Man-goto-page 1 t)
62736
76864fc0acf0 (Man-mode): Use kill-all-local-variables and run-mode-hooks.
Lute Kamstra <lute@gnu.org>
parents: 61889
diff changeset
1136 (run-mode-hooks 'Man-mode-hook))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1137
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1138 (defsubst Man-build-section-alist ()
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1139 "Build the association list of manpage sections."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1140 (setq Man-sections-alist nil)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1141 (goto-char (point-min))
7450
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1142 (let ((case-fold-search nil))
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1143 (while (re-search-forward Man-heading-regexp (point-max) t)
41710
6515e3108ceb (Man-build-section-alist): Remove last Man-match-substring.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 41698
diff changeset
1144 (aput 'Man-sections-alist (match-string 1))
7450
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1145 (forward-line 1))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1146
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1147 (defsubst Man-build-references-alist ()
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1148 "Build the association list of references (in the SEE ALSO section)."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1149 (setq Man-refpages-alist nil)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1150 (save-excursion
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1151 (if (Man-find-section Man-see-also-regexp)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1152 (let ((start (progn (forward-line 1) (point)))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1153 (end (progn
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1154 (Man-next-section 1)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1155 (point)))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1156 hyphenated
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1157 (runningpoint -1))
7450
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1158 (save-restriction
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1159 (narrow-to-region start end)
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1160 (goto-char (point-min))
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1161 (back-to-indentation)
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1162 (while (and (not (eobp)) (/= (point) runningpoint))
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1163 (setq runningpoint (point))
36575
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1164 (if (re-search-forward Man-hyphenated-reference-regexp end t)
41698
722fe545e535 (man-follow-mouse): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38970
diff changeset
1165 (let* ((word (match-string 0))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1166 (len (1- (length word))))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1167 (if hyphenated
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1168 (setq word (concat hyphenated word)
36575
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1169 hyphenated nil
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1170 ;; Update len, in case a reference spans
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1171 ;; more than two lines (paranoia).
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1172 len (1- (length word))))
51376
ec20af5e04b3 (Man-name-regexp): Also match Latin-1 soft hyphen.
Andreas Schwab <schwab@suse.de>
parents: 50602
diff changeset
1173 (if (memq (aref word len) '(?- ?­))
36575
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1174 (setq hyphenated (substring word 0 len)))
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1175 (if (string-match Man-reference-regexp word)
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1176 (aput 'Man-refpages-alist word))))
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1177 (skip-chars-forward " \t\n,"))))))
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1178 (setq Man-refpages-alist (nreverse Man-refpages-alist)))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1179
9354
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
1180 (defun Man-build-page-list ()
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1181 "Build the list of separate manpages in the buffer."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1182 (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
1183 (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
1184 (page-end (point-max))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1185 (header ""))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1186 (goto-char page-start)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1187 ;; (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
1188 (while (not (eobp))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1189 (setq header
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1190 (if (looking-at Man-page-header-regexp)
41698
722fe545e535 (man-follow-mouse): New function.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38970
diff changeset
1191 (match-string 1)
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1192 nil))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1193 ;; 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
1194 (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
1195 (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
1196 ;; 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
1197 ;; 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
1198 ;; 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
1199 ;; 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
1200 ;; previous page header.
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1201 (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
1202 (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
1203 (beginning-of-line))))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1204 (setq page-end (point))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1205 (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
1206 (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
1207 (copy-marker page-end)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1208 header))))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1209 (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
1210 )))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1211
9354
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
1212 (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
1213 "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
1214 (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
1215 (case-fold-search nil)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1216 (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
1217 (page ())
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1218 (header ""))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1219 (while page-list
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1220 (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
1221 (and (nth 2 page)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1222 (goto-char (car page))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1223 (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
1224 (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
1225 ;; 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
1226 ;; 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
1227 ;; 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
1228 ;; 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
1229 ;; 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
1230 ;; 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
1231 ;; line.
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1232 ;; (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
1233 (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
1234 (replace-match "")))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1235 (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
1236
9354
1ce43418547c * man.el (Man-notify, Man-current-page, Man-page-list,
Francesco Potortì <pot@gnu.org>
parents: 9210
diff changeset
1237 (defun Man-unindent ()
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1238 "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
1239 (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
1240 (case-fold-search nil)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1241 (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
1242 (while page-list
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1243 (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
1244 (indent "")
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1245 (nindent 0))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1246 (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
1247 (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
1248 (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
1249 (if (catch 'unindent
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1250 (goto-char (point-min))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1251 (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
1252 (throw 'unindent nil))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1253 (beginning-of-line)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1254 (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
1255 (progn
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1256 (skip-chars-forward " ")
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1257 (point))))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1258 (setq nindent (length indent))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1259 (if (zerop nindent)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1260 (throw 'unindent nil))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1261 (setq indent (concat indent "\\|$"))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1262 (goto-char (point-min))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1263 (while (not (eobp))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1264 (if (looking-at indent)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1265 (forward-line 1)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1266 (throw 'unindent nil)))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1267 (goto-char (point-min)))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1268 (while (not (eobp))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1269 (or (eolp)
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1270 (delete-char nindent))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1271 (forward-line 1)))
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1272 (setq page-list (cdr page-list))
7450
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1273 ))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1274
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1275
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1276 ;; ======================================================================
5269
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1277 ;; Man mode commands
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1278
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1279 (defun Man-next-section (n)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1280 "Move point to Nth next section (default 1)."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1281 (interactive "p")
7450
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1282 (let ((case-fold-search nil))
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1283 (if (looking-at Man-heading-regexp)
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1284 (forward-line 1))
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1285 (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
1286 (beginning-of-line)
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1287 (goto-char (point-max)))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1288
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1289 (defun Man-previous-section (n)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1290 "Move point to Nth previous section (default 1)."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1291 (interactive "p")
7450
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1292 (let ((case-fold-search nil))
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1293 (if (looking-at Man-heading-regexp)
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1294 (forward-line -1))
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1295 (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
1296 (beginning-of-line)
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1297 (goto-char (point-min)))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1298
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1299 (defun Man-find-section (section)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1300 "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
1301 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
1302 (let ((curpos (point))
7ae5ee2ccd7f (Man-reuse-okay-p): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 7364
diff changeset
1303 (case-fold-search nil))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1304 (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
1305 (if (re-search-forward (concat "^" section) (point-max) t)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1306 (progn (beginning-of-line) t)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1307 (goto-char curpos)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1308 nil)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1309 ))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1310
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1311 (defun Man-goto-section ()
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1312 "Query for section to move point to."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1313 (interactive)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1314 (aput 'Man-sections-alist
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1315 (let* ((default (aheadsym Man-sections-alist))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1316 (completion-ignore-case t)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1317 chosen
65680
ed770a0a7846 2005-09-24 Emilio C. Lopes <eclig@gmx.net>
Romain Francoise <romain@orebokech.com>
parents: 65197
diff changeset
1318 (prompt (concat "Go to section (default " default "): ")))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1319 (setq chosen (completing-read prompt Man-sections-alist))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1320 (if (or (not chosen)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1321 (string= chosen ""))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1322 default
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1323 chosen)))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1324 (Man-find-section (aheadsym Man-sections-alist)))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1325
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1326 (defun Man-goto-see-also-section ()
42706
be541feb06cc Fix typo.
Pavel Janík <Pavel@Janik.cz>
parents: 41710
diff changeset
1327 "Move point to the \"SEE ALSO\" section.
3909
192e7aa8389a (Man-auto-section-alist): Default value nil.
Richard M. Stallman <rms@gnu.org>
parents: 3833
diff changeset
1328 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
1329 (interactive)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1330 (if (not (Man-find-section Man-see-also-regexp))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1331 (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
1332 " section found in the current manpage"))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1333
36575
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1334 (defun Man-possibly-hyphenated-word ()
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1335 "Return a possibly hyphenated word at point.
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1336 If the word starts at the first non-whitespace column, and the
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1337 previous line ends with a hyphen, return the last word on the previous
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1338 line instead. Thus, if a reference to \"tcgetpgrp(3V)\" is hyphenated
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1339 as \"tcgetp-grp(3V)\", and point is at \"grp(3V)\", we return
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1340 \"tcgetp-\" instead of \"grp\"."
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1341 (save-excursion
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1342 (skip-syntax-backward "w()")
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1343 (skip-chars-forward " \t")
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1344 (let ((beg (point))
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1345 (word (current-word)))
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1346 (when (eq beg (save-excursion
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1347 (back-to-indentation)
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1348 (point)))
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1349 (end-of-line 0)
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1350 (if (eq (char-before) ?-)
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1351 (setq word (current-word))))
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1352 word)))
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1353
9838
5fbd6165b408 (Man-follow-manual-reference): First arg deleted. Call
Karl Heuer <kwzh@gnu.org>
parents: 9828
diff changeset
1354 (defun Man-follow-manual-reference (reference)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1355 "Get one of the manpages referred to in the \"SEE ALSO\" section.
28102
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1356 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
1357 (interactive
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1358 (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
1359 (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
1360 (list (let* ((default (or
36575
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1361 (car (all-completions
60747
86c528510d44 (Man-follow-manual-reference): If current-word returns nil, use "".
Eli Zaretskii <eliz@gnu.org>
parents: 59784
diff changeset
1362 (let ((word
86c528510d44 (Man-follow-manual-reference): If current-word returns nil, use "".
Eli Zaretskii <eliz@gnu.org>
parents: 59784
diff changeset
1363 (or (Man-possibly-hyphenated-word)
86c528510d44 (Man-follow-manual-reference): If current-word returns nil, use "".
Eli Zaretskii <eliz@gnu.org>
parents: 59784
diff changeset
1364 "")))
36575
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1365 ;; strip a trailing '-':
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1366 (if (string-match "-$" word)
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1367 (substring word 0
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1368 (match-beginning 0))
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1369 word))
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1370 Man-refpages-alist))
5394dc1db9f4 (Man-hyphenated-reference-regexp): New variable.
Eli Zaretskii <eliz@gnu.org>
parents: 35603
diff changeset
1371 (aheadsym Man-refpages-alist)))
5269
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1372 chosen
65680
ed770a0a7846 2005-09-24 Emilio C. Lopes <eclig@gmx.net>
Romain Francoise <romain@orebokech.com>
parents: 65197
diff changeset
1373 (prompt (concat "Refer to (default " default "): ")))
50602
c7575377858f (Man-follow-manual-reference): Don't require match
Richard M. Stallman <rms@gnu.org>
parents: 50519
diff changeset
1374 (setq chosen (completing-read prompt Man-refpages-alist))
5269
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1375 (if (or (not chosen)
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1376 (string= chosen ""))
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1377 default
c6588bd7dd93 (Man-specified-section-option): Test system-configuration.
Richard M. Stallman <rms@gnu.org>
parents: 5108
diff changeset
1378 chosen)))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1379 (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
1380 (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
1381 (aput 'Man-refpages-alist reference)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1382 (Man-getpage-in-background
9838
5fbd6165b408 (Man-follow-manual-reference): First arg deleted. Call
Karl Heuer <kwzh@gnu.org>
parents: 9828
diff changeset
1383 (Man-translate-references (aheadsym Man-refpages-alist)))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1384
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1385 (defun Man-kill ()
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1386 "Kill the buffer containing the manpage."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1387 (interactive)
22368
c3a15ab5924f (Man-kill, Man-quit): Use quit-window.
Richard M. Stallman <rms@gnu.org>
parents: 22217
diff changeset
1388 (quit-window t))
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1389
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1390 (defun Man-quit ()
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1391 "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
1392 (interactive)
22368
c3a15ab5924f (Man-kill, Man-quit): Use quit-window.
Richard M. Stallman <rms@gnu.org>
parents: 22217
diff changeset
1393 (quit-window))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1394
64622
b508a64c1b7e (Man-goto-page): Make second argument NOERROR optional.
Juanma Barranquero <lekktu@gmail.com>
parents: 64620
diff changeset
1395 (defun Man-goto-page (page &optional noerror)
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1396 "Go to the manual page on page PAGE."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1397 (interactive
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1398 (if (not Man-page-list)
64620
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1399 (error "Not a man page buffer")
8970
c0a15f821bd8 * man.el (Man-notify-flag): replaces the old Man-notify
Francesco Potortì <pot@gnu.org>
parents: 8697
diff changeset
1400 (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
1401 (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
1402 (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
1403 (length Man-page-list)))))))
64620
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1404 (if (and (not Man-page-list) (not noerror))
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1405 (error "Not a man page buffer"))
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1406 (when Man-page-list
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1407 (if (or (< page 1)
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1408 (> page (length Man-page-list)))
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1409 (error "No manpage %d found" page))
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1410 (let* ((page-range (nth (1- page) Man-page-list))
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1411 (page-start (car page-range))
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1412 (page-end (car (cdr page-range))))
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1413 (setq Man-current-page page
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1414 Man-page-mode-string (Man-make-page-mode-string))
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1415 (widen)
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1416 (goto-char page-start)
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1417 (narrow-to-region page-start page-end)
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1418 (Man-build-section-alist)
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1419 (Man-build-references-alist)
93523fb80568 (Man-bgproc-sentinel): Check here for failure to find
Richard M. Stallman <rms@gnu.org>
parents: 64091
diff changeset
1420 (goto-char (point-min)))))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1421
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1422
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1423 (defun Man-next-manpage ()
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1424 "Find the next manpage entry in the buffer."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1425 (interactive)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1426 (if (= (length Man-page-list) 1)
7499
b3cacdf7bbfa Remove periods from messages.
Richard M. Stallman <rms@gnu.org>
parents: 7453
diff changeset
1427 (error "This is the only manpage in the buffer"))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1428 (if (< Man-current-page (length Man-page-list))
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1429 (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
1430 (if Man-circular-pages-flag
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1431 (Man-goto-page 1)
7499
b3cacdf7bbfa Remove periods from messages.
Richard M. Stallman <rms@gnu.org>
parents: 7453
diff changeset
1432 (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
1433
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1434 (defun Man-previous-manpage ()
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1435 "Find the previous manpage entry in the buffer."
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1436 (interactive)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1437 (if (= (length Man-page-list) 1)
7499
b3cacdf7bbfa Remove periods from messages.
Richard M. Stallman <rms@gnu.org>
parents: 7453
diff changeset
1438 (error "This is the only manpage in the buffer"))
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1439 (if (> Man-current-page 1)
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1440 (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
1441 (if Man-circular-pages-flag
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1442 (Man-goto-page (length Man-page-list))
7499
b3cacdf7bbfa Remove periods from messages.
Richard M. Stallman <rms@gnu.org>
parents: 7453
diff changeset
1443 (error "You're looking at the first manpage in the buffer"))))
50403
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
1444
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
1445 ;; Header file support
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
1446 (defun Man-view-header-file (file)
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
1447 "View a header file specified by FILE from `Man-header-file-path'."
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
1448 (let ((path Man-header-file-path)
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
1449 complete-path)
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
1450 (while path
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
1451 (setq complete-path (concat (car path) "/" file)
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
1452 path (cdr path))
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
1453 (if (file-readable-p complete-path)
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
1454 (progn (view-file complete-path)
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
1455 (setq path nil))
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
1456 (setq complete-path nil)))
7dc2f9f7086b (toplevel): Require button.
Juanma Barranquero <lekktu@gmail.com>
parents: 50062
diff changeset
1457 complete-path))
3833
70551a213fae * man.el (Man-switches): New variable.
Jim Blandy <jimb@redhat.com>
parents: 3714
diff changeset
1458
14672
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
1459 ;; 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
1460 (Man-init-defvars)
9556c7cfabe4 (man): Don't call Man-init-defvars here.
Richard M. Stallman <rms@gnu.org>
parents: 14169
diff changeset
1461
28102
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1462 (add-to-list 'debug-ignored-errors "^No manpage [0-9]* found$")
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1463 (add-to-list 'debug-ignored-errors "^Can't find the .* manpage$")
91100e40e6ee Doc fixes.
Dave Love <fx@gnu.org>
parents: 25202
diff changeset
1464
3833
70551a213fae * man.el (Man-switches): New variable.
Jim Blandy <jimb@redhat.com>
parents: 3714
diff changeset
1465 (provide 'man)
70551a213fae * man.el (Man-switches): New variable.
Jim Blandy <jimb@redhat.com>
parents: 3714
diff changeset
1466
58690
98e0ecc13fc5 (Man-fontify-manpage): Improve handling of ANSI escapes.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 57817
diff changeset
1467 ;; arch-tag: 587cda76-8e23-4594-b1f3-89b6b09a0d47
3235
82c4b81ce570 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1468 ;;; man.el ends here