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