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