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