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