annotate man/woman.texi @ 30698:75ff6aa32bf0

(face_at_buffer_position): Update call to overlays_at.
author Miles Bader <miles@gnu.org>
date Tue, 08 Aug 2000 23:51:50 +0000
parents e13ae0b7fc50
children 2e1c439e7b1b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
30659
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1 \input texinfo @c -*-texinfo-*-
30660
e13ae0b7fc50 Fix @dircategory. Add @finalout.
Eli Zaretskii <eliz@gnu.org>
parents: 30659
diff changeset
2 @c $Id: woman.texi,v 1.1 2000/08/08 10:38:56 eliz Exp $
30659
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
3 @c %**start of header
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
4 @setfilename ../info/woman
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
5 @settitle WoMan: Browse UN*X Manual Pages ``Wo (without) Man''
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
6 @c Manual last updated:
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
7 @set UPDATED Time-stamp: <2000-08-08 12:20:51 eliz>
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
8 @c Software version:
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
9 @set VERSION 0.54 (beta)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
10 @afourpaper
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
11 @c With different size paper the printed page breaks will need attention!
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
12 @c Look for @page and @need commands.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
13 @setchapternewpage off
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
14 @paragraphindent 0
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
15 @c %**end of header
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
16
30660
e13ae0b7fc50 Fix @dircategory. Add @finalout.
Eli Zaretskii <eliz@gnu.org>
parents: 30659
diff changeset
17 @dircategory Emacs
30659
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
18 @direntry
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
19 * WoMan: (woman). Browse UN*X Manual Pages `Wo (without) Man'.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
20 @end direntry
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
21
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
22 @ifinfo
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
23 This file documents WoMan: A program to browse UN*X manual pages `wo
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
24 (without) man'.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
25
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
26 Copyright @copyright{} 2000 Francis J. Wright
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
27
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
28 This manual and the software that it describes are subject to the GNU
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
29 General Public License that is distributed with GNU Emacs -- see the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
30 file @file{COPYING}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
31
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
32 Permission is granted to make and distribute verbatim copies of this
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
33 manual provided the copyright notice and this permission notice are
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
34 preserved on all copies.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
35
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
36 @ignore
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
37 Permission is granted to process this file through TeX and print the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
38 results, provided the printed document carries a copying permission
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
39 notice identical to this one except for the removal of this paragraph
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
40 (this paragraph not being relevant to the printed manual).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
41
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
42 @end ignore
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
43 Permission is granted to copy and distribute modified versions of this
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
44 manual under the conditions for verbatim copying and provided that the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
45 entire resulting derived work is distributed under the terms of a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
46 permission notice identical to this one.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
47
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
48 Permission is granted to copy and distribute translations of this manual
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
49 into another language, under the above conditions for modified versions.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
50 @end ifinfo
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
51
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
52 @finalout
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
53
30660
e13ae0b7fc50 Fix @dircategory. Add @finalout.
Eli Zaretskii <eliz@gnu.org>
parents: 30659
diff changeset
54 @finalout
e13ae0b7fc50 Fix @dircategory. Add @finalout.
Eli Zaretskii <eliz@gnu.org>
parents: 30659
diff changeset
55
30659
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
56 @titlepage
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
57 @title WoMan
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
58 @subtitle Browse UN*X Manual Pages ``Wo (without) Man''
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
59 @subtitle Software Version @value{VERSION}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
60 @author Francis J. Wright
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
61 @sp 2
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
62 @author School of Mathematical Sciences
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
63 @author Queen Mary and Westfield College
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
64 @author (University of London)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
65 @author Mile End Road, London E1 4NS, UK
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
66 @author @email{F.J.Wright@@qmw.ac.uk}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
67 @author @uref{http://centaur.maths.qmw.ac.uk/}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
68 @sp 2
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
69 @author Manual Last Updated @value{UPDATED}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
70
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
71 @comment The following two commands start the copyright page.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
72 @page
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
73 @vskip 0pt plus 1filll
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
74 Copyright @copyright{} 2000 Francis J. Wright
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
75
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
76 This manual and the software that it describes are subject to the GNU
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
77 General Public License that is distributed with GNU Emacs -- see the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
78 file @file{COPYING}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
79
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
80 Permission is granted to make and distribute verbatim copies of this
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
81 manual provided the copyright notice and this permission notice are
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
82 preserved on all copies.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
83
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
84 Permission is granted to copy and distribute modified versions of this
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
85 manual under the conditions for verbatim copying and provided that the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
86 entire resulting derived work is distributed under the terms of a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
87 permission notice identical to this one.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
88
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
89 Permission is granted to copy and distribute translations of this manual
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
90 into another language, under the above conditions for modified versions.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
91 @end titlepage
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
92
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
93 @contents
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
94
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
95 @c ===================================================================
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
96
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
97 @ifnottex
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
98 @node Top, Introduction, (dir), (dir)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
99 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
100 @top WoMan: Browse UN*X Manual Pages ``Wo (without) Man''
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
101
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
102 @display
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
103 Software Version @value{VERSION}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
104 Manual Last Updated @value{UPDATED}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
105
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
106 @email{F.J.Wright@@qmw.ac.uk, Francis J. Wright}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
107 @uref{http://centaur.maths.qmw.ac.uk/, School of Mathematical Sciences}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
108 Queen Mary and Westfield College (University of London)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
109 Mile End Road, London E1 4NS, UK
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
110 @end display
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
111 @end ifnottex
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
112
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
113 @menu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
114 * Introduction:: Introduction
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
115 * Background:: Background
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
116 * Installation:: Installation and Setup
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
117 * Finding:: Finding and Formatting Man Pages
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
118 * Browsing:: Browsing Man Pages
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
119 * Customization:: Customization
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
120 * Log:: The *WoMan-Log* Buffer
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
121 * Technical:: Technical Details
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
122 * Bugs:: Reporting Bugs
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
123 * Acknowledgements:: Acknowledgements
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
124 * Command Index:: Command Index
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
125 * Variable Index:: Variable Index
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
126 * Keystroke Index:: Keystroke Index
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
127 * Concept Index:: Concept Index
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
128 @end menu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
129
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
130 @c ===================================================================
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
131
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
132 @node Introduction, Background, Top, Top
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
133 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
134 @chapter Introduction
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
135 @cindex introduction
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
136
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
137 This version of WoMan should run with GNU Emacs 20.3 or later on any
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
138 platform. It has not been tested, and may not run, with any other
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
139 version of Emacs. It was developed primarily on various versions of
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
140 Microsoft Windows, but has also been tested on MS-DOS, and various
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
141 versions of UNIX and Linux.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
142
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
143 WoMan is distributed with GNU Emacs 21, and the current source code and
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
144 documentation files are available from
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
145 @uref{http://centaur.maths.qmw.ac.uk/Emacs/WoMan/, my web server}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
146
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
147 WoMan implements a subset of the formatting performed by the Emacs
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
148 @code{man} (or @code{manual-entry}) command to format a UN*X-style
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
149 @dfn{manual page} (usually abbreviated to @dfn{man page}) for display,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
150 but without calling any external programs. It is intended to emulate
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
151 the whole of the @code{ROFF -man} macro package, plus those @code{ROFF}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
152 requests (@pxref{Background, , Background}) that are most commonly used
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
153 in man pages. However, the emulation is modified to include the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
154 reformatting done by the Emacs @code{man} command. No hyphenation is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
155 performed.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
156
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
157 @table @b
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
158 @item Advantages
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
159 Much more direct, does not require any external programs. Supports
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
160 completion on man page names.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
161 @item Disadvantages
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
162 Not a complete emulation. Currently no support for @code{eqn} or
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
163 @code{tbl}. Slightly slower for large man pages (but usually faster for
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
164 small- and medium-size pages).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
165 @end table
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
166
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
167 This browser works quite well on simple well-written man files. It
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
168 works less well on idiosyncratic files that ``break the rules'' or use
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
169 the more obscure @code{ROFF} requests directly. Current test results
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
170 are available in the file
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
171 @uref{http://centaur.maths.qmw.ac.uk/Emacs/WoMan/woman.status,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
172 @file{woman.status}}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
173
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
174 WoMan supports the use of compressed man files via
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
175 @code{auto-compression-mode} by turning it on if necessary. But you may
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
176 need to adjust the user option @code{woman-file-compression-regexp}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
177 @xref{Interface Options, , Interface Options}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
178
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
179 Brief help on the WoMan interactive commands and user options, all of
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
180 which begin with the prefix @code{woman-} (or occasionally
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
181 @code{WoMan-}), is available most easily by loading WoMan and then
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
182 either running the command @code{woman-mini-help} or selecting the WoMan
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
183 menu option @samp{Mini Help}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
184
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
185 WoMan is (of course) still under development! Please
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
186 @email{F.J.Wright@@qmw.ac.uk, let me know} what doesn't work -- I am
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
187 adding and improving functionality as testing shows that it is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
188 necessary. Guidance on reporting bugs is given below. @xref{Bugs, ,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
189 Reporting Bugs}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
190
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
191 @c ===================================================================
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
192
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
193 @node Background, Installation, Introduction, Top
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
194 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
195 @chapter Background
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
196 @cindex background
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
197
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
198 WoMan is a browser for traditional UN*X-style manual page documentation.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
199 Each such document is conventionally referred to as a @dfn{manual page},
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
200 or @dfn{man page} for short, even though some are very much longer than
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
201 one page. A man page is a document written using the UN*X ``man''
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
202 macros, which are themselves written in the NROFF/TROFF text processing
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
203 markup language. @code{NROFF} and @code{TROFF} are text processors
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
204 originally written for the UNIX operating system by Joseph F. Ossanna at
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
205 Bell Laboratories, Murray Hill, New Jersey, USA@. They are closely
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
206 related, and except in the few cases where the distinction between them
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
207 is important I will refer to them both ambiguously as @dfn{ROFF}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
208
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
209 @code{ROFF} markup consists of @dfn{requests} and @dfn{escape
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
210 sequences}. A request occupies a complete line and begins with either a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
211 period or a single forward quote. An escape sequences is embedded
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
212 within the input text and begins (by default) with a backslash. The
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
213 original man macro package defines 20 new @code{ROFF} requests
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
214 implemented as macros, which were considered to be sufficient for
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
215 writing man pages. But whilst in principle man pages use only the man
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
216 macros, in practice a significant number use many other @code{ROFF}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
217 requests.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
218
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
219 The distinction between @code{TROFF} and @code{NROFF} is that
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
220 @code{TROFF} was designed to drive a phototypesetter whereas
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
221 @code{NROFF} was designed to produce essentially @sc{ascii} output for a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
222 character-based device similar to a teletypewriter (usually abbreviated
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
223 to ``teletype'' or ``tty''). Hence, @code{TROFF} supports much finer
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
224 control over output positioning than does @code{NROFF} and can be seen
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
225 as a forerunner of @TeX{}. Traditionally, man pages are either
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
226 formatted by @code{TROFF} for typesetting or by @code{NROFF} for
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
227 printing on a character printer or displaying on a screen. Of course,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
228 over the last 25 years or so, the distinction between typeset output on
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
229 paper and characters on a screen has become blurred by the fact that
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
230 most screens now support bit-mapped displays, so that any information
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
231 that can be printed can also be rendered on screen, the only difference
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
232 being the resolution.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
233
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
234 Nevertheless, UN*X-style manual page documentation is still normally
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
235 browsed on screen by running a program called @code{man}. This program
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
236 looks in a predefined set of directories for the man page matching a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
237 specified topic, then either formats the source file by running
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
238 @code{NROFF} or recovers a pre-formatted file, and displays it via a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
239 pager such as @code{more}. @code{NROFF} normally formats for a printer,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
240 so it paginates the output, numbers the pages, etc., most of which is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
241 irrelevant when the document is browsed as a continuous scrollable
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
242 document on screen. The only concession to on-screen browsing normally
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
243 implemented by the @code{man} program is to squeeze consecutive blank
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
244 lines into a single blank line.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
245
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
246 For some time, Emacs has offered an improved interface for browsing man
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
247 pages in the form of the Emacs @code{man} (or @code{manual-entry})
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
248 command, see @ref{Documentation, man, Documentation Commands, emacs, GNU
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
249 Emacs Manual}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
250 This command runs @code{man} as described above, perhaps in
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
251 the background, and then post-processes the output to remove much of the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
252 @code{NROFF} pagination such as page headers and footers, and places the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
253 result into an Emacs buffer. It puts this buffer into a special major
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
254 mode, which is tailored for man page browsing, and provides a number of
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
255 useful navigation commands, support for following references, etc. It
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
256 provides some support for special display faces (fonts), but no special
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
257 menu or mouse support. The Emacs man package appears to have been
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
258 developed over about 10 years, from the late 1980s to the late 1990s.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
259
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
260 There is considerable inefficiency in having @code{NROFF} paginate a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
261 document and then removing most of the pagination!
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
262
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
263 WoMan is an Emacs Lisp library that provides an emulation of the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
264 functionality of the Emacs @code{man} command, the main difference being
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
265 that WoMan does not use any external programs. The only situation in
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
266 which WoMan might use an external program is when the source file is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
267 compressed, when WoMan will use the standard Emacs automatic
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
268 decompression facility, which does call an external program.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
269
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
270 I began developing WoMan in the Spring of 1997 and the first version was
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
271 released in May 1997. The original motivation for WoMan was the fact
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
272 that many GNU and UN*X programs are ported to other platforms and come
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
273 with UN*X-style manual page documentation. This may be difficult to
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
274 read because ports of the UN*X-style @code{man} program can be a little
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
275 awkward to set up. I decided that it should not be too hard to emulate
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
276 the 20 @code{man} macros directly, without treating them as macros and
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
277 largely ignoring the underlying @code{ROFF} requests, given the text
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
278 processing capabilities of Emacs. This proved to be essentially true,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
279 and it did not take a great deal of work to be able to format simple man
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
280 pages acceptably.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
281
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
282 One problem arose with the significant number of man pages that use
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
283 @code{ROFF} requests in addition to the @code{man} macros, and since
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
284 releasing the first version of WoMan I have been continually extending
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
285 it to support more @code{ROFF} requests. WoMan can now format a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
286 significant proportion of the man pages that I have tested, either well
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
287 or at least readably. However, I have added capabilities partly by
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
288 making additional passes through the document, a design that is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
289 fundamentally flawed. This can only be solved by a major re-design of
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
290 WoMan to handle the major formatting within a single recursive pass,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
291 rather than the present multiple passes without any significant
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
292 recursion. There are some @code{ROFF} requests that cannot be handled
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
293 satisfactorily within the present design. Some of these are currently
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
294 handled by kludges that ``usually more or less work''.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
295
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
296 The principle advantage of WoMan is that it does not require @code{man},
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
297 and indeed the name WoMan is a contraction of ``without man''. But it
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
298 has other advantages. It does not paginate the document, so it does not
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
299 need to un-paginate it again, thereby saving time. It could take full
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
300 advantage of the display capabilities available to it, and I hope to
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
301 develop WoMan to take advantage of developments in Emacs itself. At
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
302 present, WoMan uses several display faces to support bold and italic
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
303 text, to indicate other fonts, etc. The default faces are also
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
304 coloured, but the choice of faces is customizable. WoMan provides menu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
305 support for navigation and mouse support for following references, in
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
306 addition to the navigation facilities provided by @code{man} mode.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
307 WoMan has (this) texinfo documentation!
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
308
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
309 WoMan @emph{does not} replace @code{man}, although it does use a number
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
310 of the facilities implemented in the Emacs @code{man} library. WoMan
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
311 and man can happily co-exist, which is very useful for comparison and
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
312 debugging purposes. The only way in which WoMan affects @code{man} is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
313 that it adds a timer to indicate how long @code{man} has taken to format
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
314 a man page. The timing is as compatible as possible with the timing
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
315 built into WoMan, for as fair a comparison as possible. The time
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
316 comparison seems to depend on the details of the platform, the version
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
317 of @code{man} in use, etc, but times are similar and WoMan is never
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
318 significantly slower than @code{man}. This is despite the fact that
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
319 WoMan is running byte code whereas most of the formatting done by
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
320 @code{man} uses machine code, and is a testimony to the quality of the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
321 Emacs Lisp system.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
322
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
323 @code{NROFF} simulates non-@sc{ascii} characters by using one or more
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
324 @sc{ascii} characters. WoMan should be able to do much better than
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
325 this. I have recently begun to add support for WoMan to use more of the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
326 characters in its default font and to use a symbol font, and it is an
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
327 aspect that I intend to develop further in the near future. It should
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
328 be possible to move WoMan from an emulation of @code{NROFF} to an
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
329 emulation of @code{TROFF} as GNU Emacs moves to providing bit-mapped
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
330 display facilities.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
331
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
332 @c ===================================================================
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
333
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
334 @node Installation, Finding, Background, Top
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
335 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
336 @chapter Installation and Setup
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
337 @cindex installation
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
338 @cindex setup
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
339
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
340 No installation is necessary if you just want to run the version of
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
341 WoMan distributed with GNU Emacs 21 or later, although some additional
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
342 setup may still be desirable.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
343
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
344 If you are installing @file{woman.el}, either to update the version
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
345 distributed with GNU Emacs or because WoMan was not distributed with
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
346 your version of Emacs, then you need to put the file in a directory in
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
347 your Emacs load path and byte compile it. A good directory to use is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
348 the @file{site-lisp} directory in your Emacs file tree, e.g.@:
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
349 @file{/usr/local/share/emacs/@var{version}/site-lisp/} (where
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
350 @var{version} is your Emacs version), provided you have write access to
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
351 it. If you use a directory that is not included by default in your
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
352 Emacs load path then you need to add something like this to your
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
353 @file{.emacs} initialisation file:
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
354
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
355 @lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
356 (add-to-list 'load-path "my-lisp")
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
357 @end lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
358
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
359 @noindent
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
360 where @file{my-lisp} is the pathname of the directory. @xref{Init File, ,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
361 The Init File ~/.emacs, emacs, The Emacs Editor}, for further details on
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
362 customizing Emacs in general.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
363
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
364 You can byte-compile the file by using the Emacs command
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
365 @code{byte-compile-file} or by opening the directory containing the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
366 file, putting point on it and pressing the key @kbd{B}. (In fact, if
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
367 the file is compiled then it is only the compiled file that needs to be
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
368 in the Emacs load path, but leaving the source file there will do no
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
369 harm.)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
370
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
371 @heading Setup
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
372
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
373 Setup that is either necessary or desirable consists of adding a small
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
374 amount of Emacs Lisp code to your @file{.emacs} initialisation file. It
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
375 may be necessary (or at least convenient) to make WoMan autoload (if you
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
376 are not running GNU Emacs 21 or later) and to set the search path used
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
377 by the @code{woman} interface. You may also find it convenient to make
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
378 various WoMan menu and key bindings available and to make WoMan
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
379 customizable even before WoMan has been loaded.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
380
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
381 It is possible to run WoMan from a command line (from outside or even
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
382 from inside Emacs) by suitably configuring your command interpreter.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
383
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
384 @menu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
385 * Autoloading:: Autoloading
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
386 * Search Path:: Search Path
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
387 * Auto Bindings:: Preloading Menu and Key Bindings
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
388 * Auto Customization:: Preloading Customization
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
389 * Command Line:: Command Line Access
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
390 @end menu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
391
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
392
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
393 @node Autoloading, Search Path, Installation, Installation
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
394 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
395 @section Autoloading
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
396 @cindex autoloading
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
397
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
398 If you are not running GNU Emacs 21 or later then you are recommended to
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
399 add these autoloads to your @file{.emacs} file:
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
400
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
401 @lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
402 (autoload 'woman "woman"
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
403 "Decode and browse a UN*X man page." t)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
404 (autoload 'woman-find-file "woman"
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
405 "Find, decode and browse a specific UN*X man-page file." t)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
406 (autoload 'woman-dired-find-file "woman"
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
407 "In dired, run the WoMan man-page browser on this file." t)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
408 @end lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
409
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
410 @noindent
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
411 (In GNU Emacs 21 and later these autoloads are predefined.)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
412
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
413
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
414 @node Search Path, Auto Bindings, Autoloading, Installation
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
415 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
416 @section Search Path
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
417 @cindex search path
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
418
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
419 The next step is necessary if you want to use the friendliest WoMan
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
420 interface, which is recommended in general. If the @code{MANPATH}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
421 environment variable is set then WoMan will use it; alternatively (or
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
422 additionally), if your platform uses a man configuration file (as do
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
423 many versions of Linux) then WoMan will use it, provided it can find it.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
424 (This may need configuration. @xref{Interface Options, , Interface
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
425 Options}.) If these mechanisms correctly define the search path for man
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
426 pages then no further action is required.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
427
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
428 Otherwise you may need to customize the user option
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
429 @code{woman-manpath}, and you may also want to customize the user option
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
430 @code{woman-path}. @xref{Customization, , Customization}. Now you can
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
431 execute the extended command @code{woman} and enter or select a manual
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
432 topic using completion, and if necessary select a filename, again using
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
433 completion. By default, WoMan suggests the word nearest to point in the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
434 current buffer as the topic.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
435
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
436
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
437 @node Auto Bindings, Auto Customization, Search Path, Installation
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
438 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
439 @section Preloading Menu and Key Bindings
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
440 @cindex preloading menu and key bindings
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
441 @cindex menu bindings, preloading
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
442 @cindex key bindings, preloading
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
443 @cindex bindings, preloading
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
444
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
445 Once WoMan is loaded it adds an item to the @samp{Help} menu and defines
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
446 one or more keys in dired mode to run WoMan on the current file. If you
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
447 would like these facilities always to be available, even before WoMan is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
448 loaded, then add the following to your @file{.emacs} file:
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
449
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
450 @lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
451 (define-key-after menu-bar-manuals-menu [woman]
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
452 '(menu-item "Read Man Page (WoMan)..." woman
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
453 :help "Man-page documentation Without Man") t)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
454
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
455 (add-hook 'dired-mode-hook
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
456 (lambda ()
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
457 (define-key dired-mode-map "W" 'woman-dired-find-file)))
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
458 @end lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
459
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
460 (By default, WoMan will automatically define the dired keys @kbd{W} and
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
461 @kbd{w} when it loads, but only if they are not already defined. This
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
462 behaviour is controlled by the user option @code{woman-dired-keys}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
463 Note that the @code{dired-x} (dired extra) package binds
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
464 @code{dired-copy-filename-as-kill} to the key @kbd{w}, although @kbd{W}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
465 appears to be unused. The @code{dired-x} package will over-write the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
466 WoMan binding for @kbd{w}, whereas (by default) WoMan will not overwrite
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
467 the @code{dired-x} binding.)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
468
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
469
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
470 @node Auto Customization, Command Line, Auto Bindings, Installation
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
471 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
472 @section Preloading Customization
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
473 @cindex preloading customization
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
474 @cindex customization, preloading
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
475
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
476 WoMan supports the GNU Emacs 20+ customization facility, and puts a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
477 customization group called @code{WoMan} in the @code{Help} group under
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
478 the top-level @code{Emacs} group. In order to be able to customize
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
479 WoMan without first loading it, add the following to your @file{.emacs}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
480 file:
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
481
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
482 @lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
483 (defgroup woman nil
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
484 "Browse UNIX manual pages `wo (without) man'."
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
485 :tag "WoMan" :group 'help :load "woman")
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
486 @end lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
487
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
488
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
489 @node Command Line, , Auto Customization, Installation
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
490 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
491 @section Command Line Access
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
492 @cindex command line access
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
493
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
494 If you really want to square the man-woman circle then you can! If you
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
495 run the GNU command interpreter @code{bash} then you might care to
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
496 define the following @code{bash} function in your @code{bash}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
497 initialisation file @file{.bashrc}:
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
498
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
499 @example
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
500 man() @{ gnudoit -q '(raise-frame (selected-frame)) (woman' \"$1\" ')' ; @}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
501 @end example
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
502
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
503 If you use a Microsoft command interpreter (@file{command.com} or
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
504 @file{cmd.exe}) then you can create a file called @file{man.bat}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
505 somewhere in your path containing the two lines:
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
506
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
507 @example
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
508 @@echo off
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
509 gnudoit -q (raise-frame (selected-frame)) (woman \"%1\")
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
510 @end example
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
511
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
512 and then (e.g.@: from a command prompt or the @samp{Run...} option in the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
513 Windows @samp{Start} menu) just execute
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
514
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
515 @example
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
516 man man_page_name
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
517 @end example
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
518
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
519 (Of course, if you already have a @code{man} command installed then you
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
520 could call these commands @code{woman} instead of @code{man}.)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
521
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
522 The above examples assume that you have the @code{gnuserv} Emacs
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
523 client-server package installed (which I recommend). It would be
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
524 possible to do something similar by calling Emacs directly, but that is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
525 less satisfactory, because you are likely to end up with multiple copies
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
526 of Emacs running, which is generally inelegant, inefficient and
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
527 inconvenient. If you run a different command interpreter then something
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
528 similar to the above suggestions should be possible.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
529
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
530 @c ===================================================================
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
531
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
532 @node Finding, Browsing, Installation, Top
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
533 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
534 @chapter Finding and Formatting Man Pages
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
535 @cindex using, finding man pages
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
536 @cindex using, formatting man pages
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
537 @cindex finding man pages
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
538 @cindex formatting man pages
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
539 @cindex man pages, finding
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
540 @cindex man pages, formatting
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
541
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
542 WoMan provides three user interfaces for finding and formatting man pages:
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
543
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
544 @itemize @bullet
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
545 @item
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
546 a topic interface similar to that provided by the standard Emacs
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
547 @code{man} command;
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
548
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
549 @item
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
550 a family of filename interfaces analogous to the standard Emacs
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
551 @code{view-file} command;
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
552
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
553 @item
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
554 an automatic interface that detects the file type from its contents.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
555 (This is currently neither well tested, well supported nor recommended!)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
556 @end itemize
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
557
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
558 The topic and filename interfaces support completion in the usual way.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
559
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
560 The topic interface is generally the most convenient for regular use,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
561 although it may require some special setup, especially if your machine
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
562 does not already have a conventional @code{man} installation (which
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
563 WoMan tries to detect).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
564
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
565 The simplest filename interface command @code{woman-find-file} can
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
566 always be used with no setup at all (provided WoMan is installed and
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
567 loaded or set up to autoload).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
568
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
569 The automatic interface always requires special setup.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
570
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
571
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
572 @heading Case-Dependence of Filenames
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
573
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
574 @cindex case-sensitivity
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
575 @vindex w32-downcase-file-names
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
576 By default, WoMan ignores case in file pathnames only when it seems
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
577 appropriate. Microsoft Windows users who want complete case
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
578 independence should set the special NTEmacs variable
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
579 @code{w32-downcase-file-names} to @code{t} and use all lower case when
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
580 setting WoMan file paths.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
581
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
582
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
583 @menu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
584 * Topic:: Topic Interface
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
585 * Filename:: Filename Interface
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
586 * Automatic:: Automatic Interface
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
587 @end menu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
588
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
589 @node Topic, Filename, Finding, Finding
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
590 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
591 @section Topic Interface
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
592 @cindex topic interface
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
593
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
594 The topic interface is accessed principally via the command
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
595 @code{woman}. The same command can be accessed via the menu item
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
596 @samp{Help->Manuals->Read Man Page (WoMan)...} either once WoMan has been
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
597 loaded or if it is set up specially. @xref{Installation, , Installation
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
598 and Setup}. The command reads a manual topic in the minibuffer, which
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
599 can be the @dfn{basename} of a man file anywhere in the man file
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
600 structure. The ``basename'' in this context means the filename without
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
601 any directory component and without any extension or suffix components
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
602 that relate to the file type. So, for example, if there is a compressed
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
603 source file in Chapter 5 of the UNIX Programmer's Manual with the full
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
604 pathname @file{/usr/local/man/man5/man.conf.5.gz} then the topic is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
605 @code{man.conf}. Provided WoMan is configured correctly, this topic
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
606 will appear among the completions offered by @code{woman}. If more than
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
607 one file has the same topic name then WoMan will prompt for which file
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
608 to format. Completion of topics is case insensitive.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
609
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
610 Clearly, @code{woman} has to know where to look for man files and there
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
611 are two customizable user options that store this information:
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
612 @code{woman-manpath} and @code{woman-path}. @xref{Interface Options, ,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
613 Interface Options}. If @code{woman-manpath} is not set explicitly then
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
614 WoMan tries to pick up the information that would be used by the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
615 @code{man} command, as follows. If the environment variable
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
616 @code{MANPATH} is set, which seems to be the standard mechanism under
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
617 UNIX, then WoMan parses that. Otherwise, if WoMan can find a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
618 configuration file named (by default) @file{man.conf} (or something very
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
619 similar), which seems to be the standard mechanism under GNU/Linux, then
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
620 it parses that. To be precise, ``something very similar'' means having
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
621 two name components separated by a dot and respectively containing
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
622 ``man'' and beginning with ``conf'', e.g.@: @file{manual.configuration}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
623 The search path and/or precise full path name for this file are set by
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
624 the value of the customizable user option @code{woman-man.conf-path}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
625 If all else fails, WoMan uses a plausible default man search path.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
626
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
627 If the above default configuration does not work correctly for any
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
628 reason then simply customize the value of @code{woman-manpath}. To
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
629 access man files that are not in a conventional man file hierarchy,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
630 customize the value of @code{woman-path} to include the directories
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
631 containing the files. In this way, @code{woman} can access manual files
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
632 @emph{anywhere} in the entire file system.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
633
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
634 There are two differences between @code{woman-manpath} and
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
635 @code{woman-path}. Firstly, the elements of @code{woman-manpath} must
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
636 be directories that contain @emph{directories of} man files, whereas the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
637 elements of @code{woman-path} must be directories that contain man files
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
638 @emph{directly}. Secondly, the last directory component of each element
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
639 of @code{woman-path} is treated as a regular (Emacs) match expression
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
640 rather than a fixed name, which allows collections of related
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
641 directories to be specified succinctly.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
642
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
643 For topic completion to work, WoMan must build a list of all the manual
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
644 files that it can access, which can be very slow, especially if a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
645 network is involved. For this reason, it caches various amounts of
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
646 information, after which retrieving it from the cache is very fast. If
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
647 the cache ever gets out of synchronism with reality, running the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
648 @code{woman} command with a prefix argument (e.g.@: @kbd{C-u M-x woman})
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
649 will force it to rebuild its cache. This is necessary only if the names
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
650 or locations of any man files change; it is not necessary if only their
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
651 contents change. It would always be necessary if such a change occurred
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
652 whilst Emacs were running and after WoMan has been loaded. It may be
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
653 necessary if such a change occurs between Emacs sessions and persistent
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
654 caching is used, although WoMan can detect some changes that invalidate
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
655 its cache and rebuild it automatically.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
656
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
657 Customize the variable @code{woman-cache-filename} to save the cache
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
658 between Emacs sessions. This is recommended only if the @code{woman}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
659 command is too slow the first time it is run in an Emacs session, while
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
660 it builds its cache in main memory, which @emph{may} be @emph{very}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
661 slow. @xref{Cache, , The WoMan Topic Cache}, for further details.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
662
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
663
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
664 @menu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
665 * Cache:: The WoMan Topic Cache
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
666 * Word at point:: Using the ``Word at Point'' as a Topic Suggestion
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
667 @end menu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
668
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
669 @node Cache, Word at point, Topic, Topic
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
670 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
671 @subsection The WoMan Topic Cache
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
672 @cindex topic cache
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
673 @cindex cache, topic
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
674
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
675 The amount of information that WoMan caches (in main memory and,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
676 optionally, saved to disc) is controlled by the user option
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
677 @code{woman-cache-level}. There is a trade-off between the speed with
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
678 which WoMan can find a file and the size of the cache, and the default
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
679 setting gives a reasonable compromise.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
680
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
681 The @code{woman} command always performs a certain amount of caching in
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
682 main memory, but it can also write its cache to the filestore as a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
683 persistent cache under control of the user option
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
684 @code{woman-cache-filename}. If persistent caching is turned on then
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
685 WoMan re-loads its internal cache from the cache file almost
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
686 instantaneously, so that there is never any perceptible start-up delay
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
687 @emph{except} when WoMan rebuilds its cache. Persistent caching is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
688 currently turned off by default. This is because users with persistent
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
689 caching turned on may overlook the need to force WoMan to rebuild its
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
690 cache the first time they run it after they have installed new man
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
691 files; with persistent caching turned off, WoMan automatically rebuilds
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
692 its cache every time it is run in a new Emacs session.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
693
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
694 A prefix argument always causes the @code{woman} command (only) to
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
695 rebuild its topic cache, and to re-save it to
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
696 @code{woman-cache-filename} if this variable has a non-nil value. This
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
697 is necessary if the @emph{names} of any of the directories or files in
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
698 the paths specified by @code{woman-manpath} or @code{woman-path} change.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
699 If WoMan user options that affect the cache are changed then WoMan will
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
700 automatically update its cache file on disc (if one is in use) the next
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
701 time it is run in a new Emacs session.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
702
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
703
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
704 @node Word at point, , Cache, Topic
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
705 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
706 @subsection Using the ``Word at Point'' as a Topic Suggestion
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
707 @cindex word at point
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
708 @cindex point, word at
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
709
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
710 By default, the @code{woman} command uses the word nearest to point in
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
711 the current buffer as a suggestion for the topic to look up. The topic
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
712 must be confirmed or edited in the minibuffer. This suggestion can be
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
713 turned off, or @code{woman} can use the suggested topic without
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
714 confirmation if possible, which is controlled by customizing the user
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
715 option @code{woman-topic-at-point} to @code{nil} or @code{t}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
716 respectively. (Its default value is neither @code{nil} nor @code{t},
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
717 meaning ask for confirmation.)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
718
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
719 The variable @code{woman-topic-at-point} can also be rebound locally
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
720 (using @code{let}), which may be useful to provide special private key
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
721 bindings, e.g.@: this key binding for @kbd{C-c w} runs WoMan on the topic
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
722 at point without seeking confirmation:
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
723
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
724 @lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
725 (global-set-key "\C-cw"
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
726 (lambda ()
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
727 (interactive)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
728 (let ((woman-topic-at-point t))
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
729 (woman))))
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
730 @end lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
731
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
732
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
733 @node Filename, Automatic, Topic, Finding
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
734 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
735 @section Filename Interface
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
736 @cindex filename interface
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
737
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
738 The commands in this family are completely independent of the topic
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
739 interface, caching mechanism, etc.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
740
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
741 @findex woman-find-file
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
742 The filename interface is accessed principally via the extended command
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
743 @code{woman-find-file}, which is available without any configuration at
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
744 all (provided WoMan is installed and loaded or set up to autoload).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
745 This command can be used to browse any accessible man file, regardless
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
746 of its filename or location. If the file is compressed then automatic
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
747 file decompression must already be turned on (e.g.@: see the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
748 @samp{Help->Options} submenu) -- it is turned on automatically only by
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
749 the @code{woman} topic interface.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
750
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
751 @findex woman-dired-find-file
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
752 Once WoMan is loaded (or if specially set up), various additional
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
753 commands in this family are available. In a dired buffer, the command
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
754 @code{woman-dired-find-file} allows the file on the same line as point
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
755 to be formatted and browsed by WoMan. It is bound to the key @kbd{W} in
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
756 the dired mode map and added to the dired major mode menu. It may also
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
757 be bound to @kbd{w}, unless this key is bound by another library, which
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
758 it is by @code{dired-x}, for example. Because it is quite likely that
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
759 other libraries will extend the capabilities of such a commonly used
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
760 mode as dired, the precise key bindings added by WoMan to the dired mode
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
761 map are controlled by the user option @code{woman-dired-keys}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
762
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
763 @findex woman-tar-extract-file
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
764 When a tar (Tape ARchive) file is visited in Emacs, it is opened in tar
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
765 mode, which parses the tar file and shows a dired-like view of its
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
766 contents. The WoMan command @code{woman-tar-extract-file} allows the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
767 file on the same line as point to be formatted and browsed by WoMan. It
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
768 is bound to the key @kbd{w} in the tar mode map and added to the tar
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
769 major mode menu.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
770
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
771 The command @code{woman-reformat-last-file}, which is bound to the key
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
772 @kbd{R} in WoMan mode and available on the major mode menu, reformats
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
773 the last file formatted by WoMan. This may occasionally be useful if
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
774 formatting parameters, such as the fill column, are changed, or perhaps
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
775 if the buffer is somehow corrupted.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
776
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
777 @findex woman-decode-buffer
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
778 The command @code{woman-decode-buffer} can be used to decode and browse
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
779 the current buffer if it is visiting a man file, although it is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
780 primarily used internally by WoMan.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
781
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
782
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
783 @node Automatic, , Filename, Finding
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
784 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
785 @section Automatic Interface
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
786 @cindex automatic interface
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
787
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
788 Emacs provides an interface to detect automatically the format of a file
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
789 and decode it when it is visited. It is used primarily by the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
790 facilities for editing rich (i.e.@: formatted) text, as a way to store
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
791 formatting information transparently as @sc{ascii} markup. WoMan can in
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
792 principle use this interface, but it must be configured explicitly.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
793
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
794 This use of WoMan does not seem to be particularly advantageous, so it
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
795 is not really supported. It originated during early experiments on how
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
796 best to implement WoMan, before I implemented the current topic
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
797 interface, and I subsequently stopped using it. I might revive it as a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
798 mechanism for storing pre-formatted WoMan files, somewhat analogous to
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
799 the standard UN*X @code{catman} facility. In the meantime, it exists
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
800 for anyone who wants to experiment with it. Once it is set up it is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
801 simply a question of visiting the file and there is no WoMan-specific
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
802 user interface!
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
803
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
804 To use it, put something like this in your @file{.emacs} file. [The
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
805 call to @code{set-visited-file-name} is to avoid font-locking triggered
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
806 by automatic major mode selection.]
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
807
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
808 @lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
809 (autoload 'woman-decode-region "woman")
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
810
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
811 (add-to-list 'format-alist
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
812 '(man "UN*X man-page source format" "\\.\\(TH\\|ig\\) "
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
813 woman-decode-region nil nil
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
814 (lambda (arg)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
815 set-visited-file-name
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
816 (file-name-sans-extension buffer-file-name))))
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
817 @end lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
818
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
819 @c ===================================================================
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
820
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
821 @node Browsing, Customization, Finding, Top
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
822 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
823 @chapter Browsing Man Pages
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
824 @cindex using, browsing man pages
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
825 @cindex browsing man pages
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
826 @cindex man pages, browsing
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
827
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
828 Once a man page has been found and formatted, WoMan provides a browsing
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
829 interface that is essentially the same as that provided by the standard
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
830 Emacs @code{man} command (and much of the code is inherited from the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
831 @code{man} library, which WoMan currently requires). Many WoMan
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
832 facilities can be accessed from the WoMan major mode menu as well as via
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
833 key bindings, etc.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
834
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
835 WoMan does not produce any page breaks or page numbers, and in fact does
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
836 not paginate the man page at all, since this is not appropriate for
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
837 continuous online browsing. It produces a document header line that is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
838 constructed from the standard man page header and footer. Apart from
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
839 that, the appearance of the formatted man page should be almost
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
840 identical to what would be produced by @code{man}, with consecutive
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
841 blank lines squeezed to a single blank line.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
842
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
843 @menu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
844 * Fonts:: Fonts and Faces
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
845 * Navigation:: Navigation
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
846 * References:: Following References
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
847 * Changing:: Changing the Current Man Page
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
848 * Convenience:: Convenience Key Bindings
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
849 * Imenu:: Imenu Support; Contents Menu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
850 @end menu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
851
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
852 @node Fonts, Navigation, Browsing, Browsing
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
853 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
854 @section Fonts and Faces
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
855 @cindex fonts
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
856 @cindex faces
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
857
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
858 Fonts used by @code{ROFF} are handled by WoMan as faces, the details of
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
859 which are customizable. @xref{Faces, , Faces}. WoMan supports both the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
860 italic and bold fonts normally used in man pages, together with a single
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
861 face to represent all unknown fonts (which are occasionally used in
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
862 ``non-standard'' man pages, usually to represent a ``typewriter'' font)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
863 and a face to indicate additional symbols introduced by WoMan. This
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
864 currently means the characters ^ and _ used to indicate super- and
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
865 sub-scripts, which are not displayed well by WoMan.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
866
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
867
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
868 @node Navigation, References, Fonts, Browsing
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
869 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
870 @section Navigation
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
871 @cindex navigation
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
872
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
873 Man (and hence WoMan) mode can be thought of as a superset of view mode.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
874 The buffer cannot be edited, so keys that would normally self-insert are
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
875 used for navigation. The WoMan key bindings are a minor modification of
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
876 the @code{man} key bindings.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
877
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
878 @table @kbd
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
879 @item @key{SPC}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
880 @kindex SPC
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
881 @findex scroll-up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
882 Scroll the man page up the window (@code{scroll-up}).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
883
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
884 @item @key{DEL}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
885 @kindex DEL
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
886 @findex scroll-down
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
887 Scroll the man page down the window (@code{scroll-down}).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
888
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
889 @item n
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
890 @kindex n
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
891 @findex Man-next-section
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
892 Move point to the Nth next section -- default 1 (@code{Man-next-section}).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
893
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
894 @item p
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
895 @kindex p
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
896 @findex Man-previous-section
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
897 Move point to Nth previous section -- default 1
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
898 (@code{Man-previous-section}).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
899
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
900 @item g
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
901 @kindex g
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
902 @findex Man-goto-section
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
903 Move point to the specified section (@code{Man-goto-section}).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
904
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
905 @item s
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
906 @kindex s
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
907 @findex Man-goto-see-also-section
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
908 Move point to the ``SEE ALSO'' section
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
909 (@code{Man-goto-see-also-section}). Actually the section moved to is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
910 described by @code{Man-see-also-regexp}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
911 @end table
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
912
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
913
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
914 @node References, Changing, Navigation, Browsing
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
915 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
916 @section Following References
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
917 @cindex following references
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
918 @cindex references
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
919
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
920 Man pages usually contain a ``SEE ALSO'' section containing references
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
921 to other man pages. If these man pages are installed then WoMan can
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
922 easily be directed to follow the reference, i.e.@: to find and format the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
923 man page. When the mouse is passed over a correctly formatted reference
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
924 it is highlighted, in which case clicking the middle button
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
925 @key{mouse-2} will cause WoMan to follow the reference. Alternatively,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
926 when point is over such a reference the key @key{RET} will follow the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
927 reference.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
928
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
929 Any word in the buffer can be used as a reference by clicking
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
930 @key{mouse-2} over it provided the Meta key is also used (although in
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
931 general such a ``reference'' will not lead to a man page).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
932 Alternatively, the key @kbd{r} allows completion to be used to select a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
933 reference to follow, based on the word at point as default.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
934
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
935 @table @kbd
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
936 @item @key{mouse-2}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
937 @kindex mouse-2
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
938 @findex woman-mouse-2
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
939 Run WoMan with word under mouse as topic (@code{woman-mouse-2}). The
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
940 word must be mouse-highlighted unless @code{woman-mouse-2} is used with
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
941 the Meta key.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
942
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
943 @item @key{RET}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
944 @kindex RET
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
945 @findex man-follow
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
946 Get the man page for the topic under (or nearest to) point
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
947 (@code{man-follow}).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
948
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
949 @item r
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
950 @kindex r
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
951 @findex Man-follow-manual-reference
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
952 Get one of the man pages referred to in the ``SEE ALSO'' section
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
953 (@code{Man-follow-manual-reference}). Specify which reference to use;
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
954 default is based on word at point.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
955 @end table
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
956
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
957
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
958 @node Changing, Convenience, References, Browsing
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
959 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
960 @section Changing the Current Man Page
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
961 @cindex changing current man page
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
962 @cindex current man page, changing
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
963
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
964 The man page currently being browsed by WoMan can be changed in several
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
965 ways. The command @code{woman} can be invoked to format another man
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
966 page, or the current WoMan buffer can be buried or killed. WoMan
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
967 maintains a ring of formatted man pages, and it is possible to move
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
968 forwards and backwards in this ring by moving to the next or previous
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
969 man page. It is sometimes useful to reformat the current page, for
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
970 example after the right margin (the wrap column) or some other
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
971 formatting parameter has been changed.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
972
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
973 Buffers formatted by Man and WoMan are completely unrelated, even though
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
974 some of the commands to manipulate them are superficially the same (and
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
975 share code).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
976
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
977 @table @kbd
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
978 @item m
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
979 @kindex m
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
980 @findex man
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
981 Run the command @code{man} to get a Un*x manual page and put it in a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
982 buffer. This command is the top-level command in the man package. It
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
983 runs a Un*x command to retrieve and clean a man page in the background
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
984 and places the results in a Man mode (man page browsing) buffer. If a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
985 man buffer already exists for this man page, it will display
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
986 immediately. This works exactly the same if WoMan is loaded, except
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
987 that the formatting time is displayed in the mini-buffer.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
988
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
989 @item w
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
990 @kindex w
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
991 @findex woman
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
992 Run the command @code{woman} exactly as if the extended command or menu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
993 item had been used.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
994
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
995 @item q
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
996 @kindex q
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
997 @findex Man-quit
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
998 Bury the buffer containing the current man page (@code{Man-quit}),
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
999 i.e.@: move it to the bottom of the buffer stack.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1000
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1001 @item k
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1002 @kindex k
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1003 @findex Man-kill
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1004 Kill the buffer containing the current man page (@code{Man-kill}),
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1005 i.e.@: delete it completely so that it can be retrieved only by formatting
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1006 the page again.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1007
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1008 @item M-p
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1009 @kindex M-p
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1010 @findex WoMan-previous-manpage
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1011 Find the previous WoMan buffer (@code{WoMan-previous-manpage}).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1012
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1013 @item M-n
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1014 @kindex M-n
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1015 @findex WoMan-next-manpage
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1016 Find the next WoMan buffer (@code{WoMan-next-manpage}).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1017
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1018 @item R
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1019 @kindex R
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1020 @findex woman-reformat-last-file
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1021 Call WoMan to reformat the last man page formatted by WoMan
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1022 (@code{woman-reformat-last-file}), e.g.@: after changing the fill column.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1023 @end table
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1024
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1025
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1026 @node Convenience, Imenu, Changing, Browsing
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1027 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1028 @section Convenience Key Bindings
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1029 @cindex convenience key bindings
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1030 @cindex key bindings, convenience
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1031
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1032 @table @kbd
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1033 @item -
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1034 @kindex -
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1035 @findex negative-argument
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1036 Begin a negative numeric argument for the next command
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1037 (@code{negative-argument}).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1038
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1039 @item 0 .. 9
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1040 @kindex 0 .. 9
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1041 @findex digit-argument
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1042 Part of the numeric argument for the next command
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1043 (@code{digit-argument}).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1044
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1045 @item <
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1046 @kindex <
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1047 @itemx .
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1048 @kindex .
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1049 @findex beginning-of-buffer
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1050 Move point to the beginning of the buffer; leave mark at previous
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1051 position (@code{beginning-of-buffer}).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1052
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1053 @item >
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1054 @kindex >
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1055 @findex end-of-buffer
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1056 Move point to the end of the buffer; leave mark at previous position
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1057 (@code{end-of-buffer}).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1058
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1059 @item ?
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1060 @kindex ?
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1061 @findex describe-mode
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1062 Display documentation of current major mode and minor modes
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1063 (@code{describe-mode}). The major mode description comes first,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1064 followed by the minor modes, each on a separate page.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1065 @end table
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1066
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1067
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1068 @node Imenu, , Convenience, Browsing
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1069 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1070 @section Imenu Support; Contents Menu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1071 @cindex imenu support
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1072 @cindex contents menu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1073
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1074 The WoMan menu provides an option to make a contents menu for the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1075 current man page (using @code{imenu}). Alternatively, if you customize
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1076 the option @code{woman-imenu} to @code{t} then WoMan will do it
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1077 automatically for every man page. The menu title is set by the option
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1078 @code{woman-imenu-title}, which is ``CONTENTS'' by default. The menu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1079 shows manual sections and subsections by default, but you can change
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1080 this by customizing @code{woman-imenu-generic-expression}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1081
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1082 WoMan is configured not to replace spaces in an imenu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1083 @code{*Completion*} buffer. For further documentation on the use of
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1084 imenu, such as menu sorting, see the source file @file{imenu.el}, which
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1085 is distributed with GNU Emacs.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1086
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1087 @c ===================================================================
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1088
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1089 @node Customization, Log, Browsing, Top
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1090 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1091 @chapter Customization
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1092 @cindex customization
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1093
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1094 All WoMan user options are customizable, and it is recommended to change
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1095 them only via the standard Emacs customization facilities. WoMan
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1096 defines a top-level customization group called @code{WoMan} under the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1097 parent group @code{Help}. The WoMan customization group is available
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1098 only once WoMan has been loaded unless it is specially set up to be
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1099 automatically available. @xref{Auto Customization, , Preloading
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1100 Customization}. It can be accessed either via the standard Emacs
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1101 facilities, e.g.@: via the @samp{Help->Customize} submenu, or via the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1102 WoMan major mode menu.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1103
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1104 The top-level WoMan group contains only a few general options and three
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1105 subgroups. The hooks are provided only for special purposes that, for
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1106 example, require code to be executed, and should be changed only via
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1107 @code{Customization} or the function @code{add-hook}. Most
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1108 customization should be possible via existing user options.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1109
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1110 @vtable @code
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1111 @item woman-show-log
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1112 A boolean value that defaults to nil. If non-nil then show the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1113 @code{*WoMan-Log*} buffer if appropriate, i.e.@: if any warning messages
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1114 are written to it. @xref{Log, , The *WoMan-Log* Buffer}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1115
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1116 @item woman-pre-format-hook
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1117 A hook run immediately before formatting a buffer. It might, for
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1118 example, be used for face customization. @xref{Faces, , Faces},
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1119 however.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1120
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1121 @item woman-post-format-hook
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1122 A hook run immediately after formatting a buffer. It might, for
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1123 example, be used for installing a dynamic menu using @code{imenu}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1124 (However. in this case it is better to use the built-in WoMan
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1125 @code{imenu} support. @xref{Imenu, , Imenu Support; Contents Menu}.)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1126 @end vtable
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1127
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1128 @heading Customization Subgroups
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1129
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1130 @table @code
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1131 @item WoMan Interface
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1132 These options control the process of locating the appropriate file to
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1133 browse, and the appearance of the browsing interface.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1134
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1135 @item WoMan Formatting
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1136 These options control the layout that WoMan uses to format the man page.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1137
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1138 @item WoMan Faces
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1139 These options control the display faces that WoMan uses to format the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1140 man page.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1141 @end table
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1142
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1143 @menu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1144 * Interface Options::
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1145 * Formatting Options::
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1146 * Faces::
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1147 * Special symbols::
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1148 @end menu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1149
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1150 @node Interface Options, Formatting Options, Customization, Customization
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1151 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1152 @section Interface Options
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1153 @cindex interface options
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1154
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1155 These options control the process of locating the appropriate file to
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1156 browse, and the appearance of the browsing interface.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1157
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1158 @vtable @code
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1159 @item woman-man.conf-path
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1160 A list of strings representing directories to search and/or files to try
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1161 for a man configuration file. The default is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1162
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1163 @lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1164 ("/etc" "/usr/local/lib")
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1165 @end lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1166
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1167 @noindent
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1168 [for GNU/Linux and Cygwin respectively.] A trailing separator (@file{/}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1169 for UNIX etc.) on directories is optional and the filename matched if a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1170 directory is specified is the first to match the regexp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1171 @code{man.*\.conf}. If the environment variable @code{MANPATH} is not
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1172 set but a configuration file is found then it is parsed instead (or as
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1173 well) to provide a default value for @code{woman-manpath}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1174
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1175 @item woman-manpath
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1176 A list of strings representing @emph{directory trees} to search for UN*X
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1177 manual files. Each element should be the name of a directory that
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1178 contains subdirectories of the form @file{man?}, or more precisely
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1179 subdirectories selected by the value of @code{woman-manpath-man-regexp}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1180 Non-directory and unreadable files are ignored.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1181
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1182 @cindex @code{MANPATH}, environment variable
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1183 If not set then the environment variable @code{MANPATH} is used. If no
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1184 such environment variable is found, the default list is determined by
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1185 consulting the man configuration file if found. By default this is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1186 expected to be either @file{/etc/man.config} or
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1187 @file{/usr/local/lib/man.conf}, which is controlled by the user option
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1188 @code{woman-man.conf-path}. An empty substring of @code{MANPATH}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1189 denotes the default list. Otherwise, the default value of this variable
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1190 is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1191
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1192 @lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1193 ("/usr/man" "/usr/local/man")
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1194 @end lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1195
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1196 Any environment variables (names of which must have the UN*X-style form
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1197 @code{$NAME}, e.g.@: @code{$HOME}, @code{$EMACSDATA}, @code{$EMACS_DIR},
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1198 regardless of platform) are evaluated first but each element must
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1199 evaluate to a @emph{single} directory name. Trailing @file{/}s are
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1200 ignored. (Specific directories in @code{woman-path} are also searched.)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1201
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1202 On Microsoft platforms I recommend including drive letters explicitly,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1203 e.g.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1204
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1205 @lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1206 ("C:/Cygwin/usr/man" "C:/usr/man" "C:/usr/local/man")
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1207 @end lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1208
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1209 @cindex directory separator character
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1210 @cindex @code{MANPATH}, directory separator
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1211 The @code{MANPATH} environment variable may be set using DOS
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1212 semi-colon-separated or UN*X / Cygwin colon-separated syntax (but not
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1213 mixed).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1214
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1215 @item woman-manpath-man-regexp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1216 A regular expression to match man directories @emph{under} the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1217 @code{woman-manpath} directories. These normally have names of the form
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1218 @file{man?}. Its default value is @code{"[Mm][Aa][Nn]"}, which is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1219 case-insensitive mainly for the benefit of Microsoft platforms. Its
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1220 purpose is to avoid directories such as @file{cat?}, @file{.},
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1221 @file{..}, etc.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1222
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1223 @item woman-path
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1224 A list of strings representing @emph{specific directories} to search for
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1225 UN*X manual files. For example
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1226
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1227 @lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1228 ("/emacs/etc")
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1229 @end lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1230
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1231 These directories are searched in addition to the directory trees
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1232 specified in @code{woman-manpath}. Each element should be a directory
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1233 string or @code{nil}, which represents the current directory when the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1234 path is expanded and cached. However, the last component (only) of each
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1235 directory string is treated as a regexp (Emacs, not shell) and the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1236 string is expanded into a list of matching directories. Non-directory
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1237 and unreadable files are ignored. The default value on MS-DOS is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1238
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1239 @lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1240 ("$DJDIR/info" "$DJDIR/man/cat[1-9onlp]")
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1241 @end lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1242
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1243 @noindent
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1244 and on other platforms is @code{nil}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1245
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1246 Any environment variables (names of which must have the UN*X-style form
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1247 @code{$NAME}, e.g.@: @code{$HOME}, @code{$EMACSDATA}, @code{$EMACS_DIR},
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1248 regardless of platform) are evaluated first but each element must
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1249 evaluate to a @emph{single} directory name (regexp, see above). For
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1250 example
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1251
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1252 @lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1253 ("$EMACSDATA")
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1254 @end lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1255
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1256 @noindent
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1257 or equivalently
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1258
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1259 @lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1260 ("$EMACS_DIR/etc")
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1261 @end lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1262
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1263 @noindent
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1264 Trailing @file{/}s are discarded. (The directory trees in
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1265 @code{woman-manpath} are also searched.) On Microsoft platforms I
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1266 recommend including drive letters explicitly.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1267
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1268 @item woman-cache-level
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1269 A positive integer representing the level of topic caching:
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1270
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1271 @enumerate
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1272 @item
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1273 cache only the topic and directory lists (uses minimal memory, but not
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1274 recommended);
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1275 @item
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1276 cache also the directories for each topic (faster, without using much
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1277 more memory);
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1278 @item
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1279 cache also the actual filenames for each topic (fastest, but uses twice
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1280 as much memory).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1281 @end enumerate
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1282
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1283 The default value is currently 2, a good general compromise. If the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1284 @code{woman} command is slow to find files then try 3, which may be
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1285 particularly beneficial with large remote-mounted man directories. Run
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1286 the @code{woman} command with a prefix argument or delete the cache file
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1287 @code{woman-cache-filename} for a change to take effect. (Values < 1
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1288 behave like 1; values > 3 behave like 3.)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1289
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1290 @item woman-cache-filename
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1291 Either a string representing the full pathname of the WoMan directory
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1292 and topic cache file, or @code{nil}. It is used to save and restore the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1293 cache between Emacs sessions. This is especially useful with
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1294 remote-mounted man page files! The default value of @code{nil}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1295 suppresses this action. The ``standard'' non-nil filename is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1296 @file{~/.wmncach.el}. Remember that a prefix argument forces the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1297 @code{woman} command to update and re-write the cache.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1298
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1299 @item woman-dired-keys
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1300 A list of @code{dired} mode keys to be defined to run WoMan on the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1301 current file, e.g.@: @code{("w" "W")} or any non-nil atom to
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1302 automatically define @kbd{w} and @kbd{W} if they are unbound, or
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1303 @code{nil} to do nothing. Default is @code{t}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1304
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1305 @item woman-imenu-generic-expression
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1306 Imenu support for Sections and Subsections: an alist with elements of
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1307 the form @code{(MENU-TITLE REGEXP INDEX)} -- see the documentation for
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1308 @code{imenu-generic-expression}. Default value is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1309
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1310 @lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1311 ((nil "\n\\([A-Z].*\\)" 1) ; SECTION, but not TITLE
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1312 ("*Subsections*" "^ \\([A-Z].*\\)" 1))
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1313 @end lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1314
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1315 @item woman-imenu
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1316 A boolean value that defaults to @code{nil}. If non-nil then WoMan adds
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1317 a Contents menu to the menubar by calling @code{imenu-add-to-menubar}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1318
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1319 @item woman-imenu-title
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1320 A string representing the title to use if WoMan adds a Contents menu to
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1321 the menubar. Default is @code{"CONTENTS"}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1322
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1323 @item woman-topic-at-point
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1324 A symbol, which may be either @code{t}, @code{nil} or @code{confirm},
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1325 that controls the use by @code{woman} of the ``word at point'' as a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1326 topic suggestion. If it is non-nil then the @code{woman} command uses
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1327 the word at point as an initial topic suggestion when it reads a topic
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1328 from the minibuffer; if it is @code{t} then @code{woman} uses the word
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1329 at point @emph{without interactive confirmation} if it exists as a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1330 topic. The value @code{confirm} means suggest a topic and ask for
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1331 confirmation. The default value is that of
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1332 @code{woman-topic-at-point-default}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1333
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1334 @item woman-topic-at-point-default
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1335 A symbol, which may be either @code{t}, @code{nil} or @code{confirm},
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1336 representing the default value for @code{woman-topic-at-point}. The
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1337 default value is @code{confirm}. [The variable
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1338 @code{woman-topic-at-point} may be @code{let}-bound when @code{woman} is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1339 loaded, in which case its global value does not get defined. The
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1340 function @code{woman-file-name} sets it to this value if it is unbound.]
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1341
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1342 @item woman-uncompressed-file-regexp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1343 A regular match expression used to select man source files (ignoring any
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1344 compression extension). The default value is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1345 @code{"\\.\\([0-9lmnt]\\w*\\)"} [which means a filename extension is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1346 required].
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1347
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1348 @emph{Do not change this unless you are sure you know what you are doing!}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1349
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1350 The SysV standard man pages use two character suffixes, and this is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1351 becoming more common in the GNU world. For example, the man pages in
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1352 the @code{ncurses} package include @file{toe.1m}, @file{form.3x}, etc.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1353
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1354 @strong{Note:} an optional compression regexp will be appended, so this
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1355 regexp @emph{must not} end with any kind of string terminator such as
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1356 @code{$} or @code{\\'}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1357
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1358 @item woman-file-compression-regexp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1359 A regular match expression used to match compressed man file extensions
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1360 for which decompressors are available and handled by auto-compression
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1361 mode. It should begin with @code{\\.} and end with @code{\\'} and
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1362 @emph{must not} be optional. The default value is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1363 @code{"\\.\\(g?z\\|bz2\\)\\'"}, which matches the @code{gzip} and
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1364 @code{bzip2} compression extensions.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1365
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1366 @emph{Do not change this unless you are sure you know what you are doing!}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1367
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1368 [It should be compatible with the @code{car} of
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1369 @code{jka-compr-file-name-handler-entry}, but that is unduly
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1370 complicated, includes an inappropriate extension (@file{.tgz}) and is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1371 not loaded by default!]
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1372
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1373 @item woman-use-own-frame
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1374 If non-nil then use a dedicated frame for displaying WoMan windows.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1375 This is useful only when WoMan is run under a window system such as X or
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1376 Microsoft Windows that supports real multiple frames, in which case the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1377 default value is non-nil.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1378 @end vtable
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1379
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1380
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1381 @node Formatting Options, Faces, Interface Options, Customization
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1382 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1383 @section Formatting Options
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1384 @cindex formatting options
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1385
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1386 These options control the layout that WoMan uses to format the man page.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1387
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1388 @vtable @code
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1389 @item woman-fill-column
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1390 An integer specifying the right margin for formatted text. Default is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1391 65.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1392
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1393 @item woman-fill-frame
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1394 A boolean value. If non-nil then most of the frame width is used,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1395 overriding the value of @code{woman-fill-column}. Default is nil.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1396
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1397 @item woman-default-indent
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1398 An integer specifying the default prevailing indent for the @code{-man}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1399 macros. Default is 5. Set this variable to 7 to emulate Linux man
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1400 formatting.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1401
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1402 @item woman-bold-headings
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1403 A boolean value. If non-nil then embolden section and subsection
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1404 headings. Default is t. [Heading emboldening is @emph{not} standard
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1405 @code{man} behaviour.]
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1406
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1407 @item woman-ignore
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1408 A boolean value. If non-nil then unrecognised requests etc. are
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1409 ignored. Default is t. This gives the standard @code{ROFF} behaviour.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1410 If @code{nil} then they are left in the buffer, which may aid debugging.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1411
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1412 @item woman-preserve-ascii
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1413 A boolean value. If non-nil then preserve @sc{ascii} characters in the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1414 WoMan buffer. Otherwise, non-@sc{ascii} characters (that display as
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1415 @sc{ascii}) may remain, which is irrelevant unless the buffer is to be
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1416 saved to a file. Default is nil.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1417
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1418 @item woman-emulation
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1419 WoMan emulation, currently either @code{NROFF} or @code{TROFF}. Default
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1420 is @code{NROFF}. @code{TROFF} emulation is experimental and largely
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1421 untested.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1422 @end vtable
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1423
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1424
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1425 @node Faces, Special symbols, Formatting Options, Customization
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1426 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1427 @section Faces
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1428 @cindex faces
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1429
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1430 These options control the display faces that WoMan uses to format the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1431 man page.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1432
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1433 @vtable @code
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1434 @item woman-fontify
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1435 A boolean value. If non-nil then WoMan assumes that face support is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1436 available. It defaults to a non-nil value if the display supports
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1437 either colours or different fonts.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1438
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1439 @item woman-italic-face
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1440 Face for italic font in man pages. Default: italic, underlined,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1441 foreground red. This is overkill! @code{TROFF} uses just italic;
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1442 @code{NROFF} uses just underline. You should probably select either
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1443 italic or underline as you prefer, but not both, although italic and
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1444 underline work together perfectly well!
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1445
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1446 @item woman-bold-face
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1447 Face for bold font in man pages. Default: bold, foreground blue.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1448
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1449 @item woman-unknown-face
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1450 Face for all unknown fonts in man pages. Default: foreground brown.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1451 Brown is a good compromise: it is distinguishable from the default but
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1452 not enough so as to make font errors look terrible. (Files that use
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1453 non-standard fonts seem to do so badly or in idiosyncratic ways!)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1454
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1455 @item woman-addition-face
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1456 Face for all additions made by WoMan to man pages.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1457 Default: foreground orange.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1458 @end vtable
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1459
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1460
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1461 @node Special symbols, , Faces, Customization
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1462 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1463 @section Special symbols
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1464 @cindex special symbols
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1465
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1466 This section currently applies @emph{only} to Microsoft Windows.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1467
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1468 WoMan provides partial experimental support for special symbols,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1469 initially only for MS-Windows and only for MS-Windows fonts. This
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1470 includes both non-@sc{ascii} characters from the main text font and use
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1471 of a separate symbol font. Later, support will be added for other font
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1472 types (e.g.@: @code{bdf} fonts) and for the X Window System. In Emacs
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1473 20.7, the current support works partially under Windows 9x but may not
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1474 work on any other platform.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1475
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1476 @vtable @code
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1477 @item woman-use-extended-font
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1478 A boolean value. If non-nil then WoMan may use non-@sc{ascii} characters
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1479 from the default font. Default is @code{t}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1480
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1481 @item woman-use-symbol-font
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1482 A boolean value. If non-nil then WoMan may use the symbol font.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1483 Default is @code{nil}, mainly because it may change the line spacing (at
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1484 least in NTEmacs 20).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1485
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1486 @item woman-symbol-font
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1487 A string describing the symbol font to use for special characters.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1488 It should be compatible with, and the same size as, the default text font.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1489 Under MS-Windows, the default is
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1490
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1491 @lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1492 "-*-Symbol-normal-r-*-*-*-*-96-96-p-*-ms-symbol"
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1493 @end lisp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1494 @end vtable
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1495
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1496
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1497 @c ===================================================================
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1498
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1499 @node Log, Technical, Customization, Top
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1500 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1501 @chapter The *WoMan-Log* Buffer
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1502 @cindex log buffer
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1503 @cindex buffer, log
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1504
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1505 This is modelled on the Emacs byte-compiler. It logs all files
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1506 formatted by WoMan and the time taken. If WoMan finds anything that it
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1507 cannot handle then it writes a warning to this buffer. If the variable
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1508 @code{woman-show-log} is non-nil (by default it is @code{nil}) then
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1509 WoMan automatically displays this buffer. @xref{Interface Options, ,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1510 Interface Options}. Many WoMan warnings can be completely ignored,
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1511 because they are reporting the fact that WoMan has ignored requests that
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1512 it is correct for WoMan to ignore. In some future version this level of
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1513 paranoia may be reduced, but not until WoMan is deemed more reliable.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1514 At present, all warnings should be treated with some suspicion.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1515 Uninterpreted escape sequences are also logged (in some cases).
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1516
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1517 By resetting the variable @code{woman-ignore} to @code{nil} (by default
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1518 it is @code{t}), uninterpreted @code{ROFF} requests can optionally be
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1519 left in the formatted buffer to indicate precisely where they occurred.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1520 @xref{Interface Options, , Interface Options}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1521
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1522 @c ===================================================================
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1523
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1524 @node Technical, Bugs, Log, Top
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1525 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1526 @chapter Technical Details
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1527 @cindex technical details
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1528 @cindex horizontal spacing
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1529 @cindex spacing, horizontal and vertical
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1530 @cindex vertical spacing
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1531 @cindex resolution
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1532
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1533 @heading Horizontal and vertical spacing and resolution
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1534
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1535 WoMan currently assumes 10 characters per inch horizontally, hence a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1536 horizontal resolution of 24 basic units, and 5 lines per inch
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1537 vertically, hence a vertical resolution of 48 basic units.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1538 (@code{NROFF} uses 240 per inch.)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1539
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1540 @heading Vertical spacing and blank lines
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1541
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1542 The number of consecutive blank lines in the formatted buffer should be
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1543 either 0 or 1. A blank line should leave a space like .sp 1.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1544 Current policy is to output vertical space only immediately before text
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1545 is output.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1546
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1547 @c ===================================================================
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1548
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1549 @node Bugs, Acknowledgements, Technical, Top
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1550 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1551 @chapter Reporting Bugs
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1552 @cindex reporting bugs
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1553 @cindex bugs, reporting
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1554
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1555 If WoMan fails completely, or formats a file incorrectly (i.e.@:
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1556 obviously wrongly or significantly differently from @code{man}) or
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1557 inelegantly, then please
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1558
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1559 @enumerate a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1560 @item
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1561 check that you are running the latest version of @file{woman.el}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1562 available from @uref{http://centaur.maths.qmw.ac.uk/Emacs/WoMan/, my web
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1563 site}, and
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1564
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1565 @item
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1566 check that the problem is not already described in the file
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1567 @file{woman.status}, also available from
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1568 @uref{http://centaur.maths.qmw.ac.uk/Emacs/WoMan/, my web site}.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1569 @end enumerate
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1570
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1571 If both of the above are true then please
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1572 @email{F.J.Wright@@qmw.ac.uk,email me} the entry from the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1573 @code{*WoMan-Log*} buffer relating to the problem file, together with a
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1574 brief description of the problem. Please indicate where you got the man
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1575 source file from, but do not send it to me unless I ask you to! Thanks.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1576 (At present WoMan has no automated bug-reporting facility.)
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1577
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1578 @c ===================================================================
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1579
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1580 @node Acknowledgements, Command Index, Bugs, Top
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1581 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1582 @chapter Acknowledgements
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1583 @cindex acknowledgements
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1584
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1585 For Heather, Kathryn and Madelyn, the women in my life (although they
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1586 will probably never use it)!
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1587
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1588 I also thank the following for helpful suggestions, bug reports, code
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1589 fragments, general interest, etc.:
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1590
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1591 @quotation
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1592 Jari Aalto, @email{jari.aalto@@cs.tpu.fi}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1593 Dean Andrews, @email{dean@@dra.com}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1594 Juanma Barranquero, @email{barranquero@@laley-actualidad.es}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1595 Karl Berry, @email{kb@@cs.umb.edu}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1596 Jim Chapman, @email{jchapman@@netcomuk.co.uk}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1597 Frederic Corne, @email{frederic.corne@@erli.fr}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1598 Peter Craft, @email{craft@@alacritech.com}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1599 Charles Curley, @email{ccurley@@trib.com}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1600 Jim Davidson, @email{jdavidso@@teknowledge.com}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1601 Kevin D'Elia, @email{Kevin.DElia@@mci.com}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1602 John Fitch, @email{jpff@@maths.bath.ac.uk}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1603 Hans Frosch, @email{jwfrosch@@rish.b17c.ingr.com}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1604 Guy Gascoigne-Piggford, @email{ggp@@informix.com}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1605 Brian Gorka, @email{gorkab@@sanchez.com}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1606 Nicolai Henriksen, @email{nhe@@lyngso-industri.dk}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1607 Thomas Herchenroeder, @email{the@@software-ag.de}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1608 Alexander Hinds, @email{ahinds@@thegrid.net}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1609 Stefan Hornburg, @email{sth@@hacon.de}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1610 Theodore Jump, @email{tjump@@cais.com}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1611 Paul Kinnucan, @email{paulk@@mathworks.com}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1612 Jonas Linde, @email{jonas@@init.se}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1613 Andrew McRae, @email{andrewm@@optimation.co.nz}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1614 Howard Melman, @email{howard@@silverstream.com}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1615 Dennis Pixton, @email{dennis@@math.binghamton.edu}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1616 T. V. Raman, @email{raman@@Adobe.com}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1617 Bruce Ravel, @email{bruce.ravel@@nist.gov}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1618 Benjamin Riefenstahl, @email{benny@@crocodial.de}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1619 Kevin Ruland, @email{kruland@@seistl.com}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1620 Tom Schutter, @email{tom@@platte.com}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1621 Wei-Xue Shi, @email{wxshi@@ma.neweb.ne.jp}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1622 Fabio Somenzi, @email{fabio@@joplin.colorado.edu}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1623 Karel Sprenger, @email{ks@@ic.uva.nl}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1624 Chris Szurgot, @email{szurgot@@itribe.net}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1625 Paul A. Thompson, @email{pat@@po.cwru.edu}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1626 Arrigo Triulzi, @email{arrigo@@maths.qmw.ac.uk}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1627 Geoff Voelker, @email{voelker@@cs.washington.edu}@*
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1628 Eli Zaretskii, @email{eliz@@is.elta.co.il}
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1629 @end quotation
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1630
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1631 @c ===================================================================
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1632
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1633 @comment END OF MANUAL TEXT
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1634 @page
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1635
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1636 @node Command Index, Variable Index, Acknowledgements, Top
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1637 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1638 @unnumbered Command Index
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1639
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1640 @printindex fn
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1641
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1642 @node Variable Index, Keystroke Index, Command Index, Top
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1643 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1644 @unnumbered Variable Index
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1645
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1646 @printindex vr
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1647
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1648 @c Without a page throw here, the page length seems to get reset to the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1649 @c depth of the index that fits on the page after the previous index.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1650 @c This must be a bug!
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1651
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1652 @page
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1653
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1654 @node Keystroke Index, Concept Index, Variable Index, Top
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1655 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1656 @unnumbered Keystroke Index
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1657
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1658 @printindex ky
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1659
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1660 @c Without a page throw here, the page length seems to get reset to the
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1661 @c depth of the index that fits on the page after the previous index.
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1662 @c This must be a bug!
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1663
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1664 @page
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1665
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1666 @node Concept Index, , Keystroke Index, Top
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1667 @comment node-name, next, previous, up
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1668 @unnumbered Concept Index
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1669
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1670 @printindex cp
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1671
ebfc33859f55 File added to the Emacs distribution.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1672 @bye