annotate doc/misc/woman.texi @ 97043:9592c50233ab remove-carbon

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