[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] Changes to woman.texi
|
From: |
Glenn Morris |
|
Subject: |
[Emacs-diffs] Changes to woman.texi |
|
Date: |
Thu, 06 Sep 2007 05:03:15 +0000 |
CVSROOT: /sources/emacs
Module name: emacs
Changes by: Glenn Morris <gm> 07/09/06 05:03:15
Index: woman.texi
===================================================================
RCS file: woman.texi
diff -N woman.texi
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ woman.texi 6 Sep 2007 05:03:15 -0000 1.1
@@ -0,0 +1,1439 @@
+\input texinfo @c -*-texinfo-*-
address@hidden %**start of header
address@hidden ../info/woman
address@hidden WoMan: Browse Unix Manual Pages ``W.O. (without) Man''
address@hidden Manual last updated:
address@hidden UPDATED Time-stamp: <2006-03-25 14:59:03 karl>
address@hidden Software version:
address@hidden VERSION 0.54 (beta)
address@hidden
address@hidden With different size paper the printed page breaks will need
attention!
address@hidden Look for @page and @need commands.
address@hidden off
address@hidden 0
address@hidden %**end of header
+
address@hidden
+This file documents WoMan: A program to browse Unix manual pages `W.O.
+(without) man'.
+
+Copyright @copyright{} 2001, 2002, 2003, 2004,
+2005, 2006, 2007 Free Software Foundation, Inc.
+
address@hidden
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.2 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, with the Front-Cover texts being ``A GNU
+Manual,'' and with the Back-Cover Texts as in (a) below. A copy of the
+license is included in the section entitled ``GNU Free Documentation
+License'' in the Emacs manual.
+
+(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
+this GNU Manual, like GNU software. Copies published by the Free
+Software Foundation raise funds for GNU development.''
+
+This document is part of a collection distributed under the GNU Free
+Documentation License. If you want to distribute this document
+separately from the collection, you can do so by adding a copy of the
+license to the document, as described in section 6 of the license.
address@hidden quotation
address@hidden copying
+
address@hidden Emacs
address@hidden
+* WoMan: (woman). Browse UN*X Manual Pages "W.O. (without) Man".
address@hidden direntry
+
address@hidden
+
address@hidden
address@hidden WoMan
address@hidden Browse Unix Manual Pages ``W.O. (without) Man''
address@hidden Software Version @value{VERSION}
address@hidden Francis J. Wright
address@hidden 2
address@hidden School of Mathematical Sciences
address@hidden Queen Mary and Westfield College
address@hidden (University of London)
address@hidden Mile End Road, London E1 4NS, UK
address@hidden @email{F.J.Wright@@qmul.ac.uk}
address@hidden @uref{http://centaur.maths.qmw.ac.uk/}
address@hidden He no longer maintains this manual.
address@hidden 2
address@hidden Manual Last Updated @value{UPDATED}
+
address@hidden The following two commands start the copyright page.
address@hidden
address@hidden 0pt plus 1filll
address@hidden
address@hidden titlepage
+
address@hidden
+
address@hidden
===================================================================
+
address@hidden
address@hidden Top, Introduction, (dir), (dir)
address@hidden node-name, next, previous, up
address@hidden WoMan: Browse Unix Manual Pages ``W.O. (without) Man''
+
address@hidden
+Software Version @value{VERSION}
+Manual Last Updated @value{UPDATED}
+
address@hidden@@qmw.ac.uk, Francis J. Wright}
address@hidden://centaur.maths.qmw.ac.uk/, School of Mathematical Sciences}
+Queen Mary and Westfield College (University of London)
+Mile End Road, London E1 4NS, UK
address@hidden display
address@hidden ifnottex
+
address@hidden
+* Introduction:: Introduction
+* Background:: Background
+* Finding:: Finding and Formatting Man Pages
+* Browsing:: Browsing Man Pages
+* Customization:: Customization
+* Log:: The *WoMan-Log* Buffer
+* Technical:: Technical Details
+* Bugs:: Reporting Bugs
+* Acknowledgements:: Acknowledgements
+* GNU Free Documentation License:: The license for this documentation.
+* Command Index:: Command Index
+* Variable Index:: Variable Index
+* Keystroke Index:: Keystroke Index
+* Concept Index:: Concept Index
address@hidden menu
+
address@hidden
===================================================================
+
address@hidden Introduction, Background, Top, Top
address@hidden node-name, next, previous, up
address@hidden Introduction
address@hidden introduction
+
+This version of WoMan should run with GNU Emacs 20.3 or later on any
+platform. It has not been tested, and may not run, with any other
+version of Emacs. It was developed primarily on various versions of
+Microsoft Windows, but has also been tested on MS-DOS, and various
+versions of UNIX and GNU/Linux.
+
+WoMan is distributed with GNU Emacs. In addition, the current source
+code and documentation files are available from
address@hidden://centaur.maths.qmw.ac.uk/Emacs/WoMan/, the WoMan web
+server}.
+
+WoMan implements a subset of the formatting performed by the Emacs
address@hidden (or @code{manual-entry}) command to format a Unix-style
address@hidden page} (usually abbreviated to @dfn{man page}) for display,
+but without calling any external programs. It is intended to emulate
+the whole of the @code{roff -man} macro package, plus those @code{roff}
+requests (@pxref{Background, , Background}) that are most commonly used
+in man pages. However, the emulation is modified to include the
+reformatting done by the Emacs @code{man} command. No hyphenation is
+performed.
+
address@hidden @b
address@hidden Advantages
+Much more direct, does not require any external programs. Supports
+completion on man page names.
address@hidden Disadvantages
+Not a complete emulation. Currently no support for @code{eqn} or
address@hidden Slightly slower for large man pages (but usually faster for
+small- and medium-size pages).
address@hidden table
+
+This browser works quite well on simple well-written man files. It
+works less well on idiosyncratic files that ``break the rules'' or use
+the more obscure @code{roff} requests directly. Current test results
+are available in the file
address@hidden://centaur.maths.qmw.ac.uk/Emacs/WoMan/files/woman.status,
address@hidden
+
+WoMan supports the use of compressed man files via
address@hidden by turning it on if necessary. But you may
+need to adjust the user option @code{woman-file-compression-regexp}.
address@hidden Options, , Interface Options}.
+
+Brief help on the WoMan interactive commands and user options, all of
+which begin with the prefix @code{woman-} (or occasionally
address@hidden), is available most easily by loading WoMan and then
+either running the command @code{woman-mini-help} or selecting the WoMan
+menu option @samp{Mini Help}.
+
+WoMan is (of course) still under development! Please
address@hidden@@qmw.ac.uk, let me know} what doesn't work---I am
+adding and improving functionality as testing shows that it is
+necessary. Guidance on reporting bugs is given below. @xref{Bugs, ,
+Reporting Bugs}.
+
address@hidden
===================================================================
+
address@hidden Background, Finding, Introduction, Top
address@hidden node-name, next, previous, up
address@hidden Background
address@hidden background
+
+WoMan is a browser for traditional Unix-style manual page documentation.
+Each such document is conventionally referred to as a @dfn{manual page},
+or @dfn{man page} for short, even though some are very much longer than
+one page. A man page is a document written using the Unix ``man''
+macros, which are themselves written in the nroff/troff text processing
+markup language. @code{nroff} and @code{troff} are text processors
+originally written for the UNIX operating system by Joseph F. Ossanna at
+Bell Laboratories, Murray Hill, New Jersey, address@hidden They are closely
+related, and except in the few cases where the distinction between them
+is important I will refer to them both ambiguously as @code{roff}.
+
address@hidden markup consists of @dfn{requests} and @dfn{escape
+sequences}. A request occupies a complete line and begins with either a
+period or a single forward quote. An escape sequences is embedded
+within the input text and begins (by default) with a backslash. The
+original man macro package defines 20 new @code{roff} requests
+implemented as macros, which were considered to be sufficient for
+writing man pages. But whilst in principle man pages use only the man
+macros, in practice a significant number use many other @code{roff}
+requests.
+
+The distinction between @code{troff} and @code{nroff} is that
address@hidden was designed to drive a phototypesetter whereas
address@hidden was designed to produce essentially @acronym{ASCII} output for a
+character-based device similar to a teletypewriter (usually abbreviated
+to ``teletype'' or ``tty''). Hence, @code{troff} supports much finer
+control over output positioning than does @code{nroff} and can be seen
+as a forerunner of @TeX{}. Traditionally, man pages are either
+formatted by @code{troff} for typesetting or by @code{nroff} for
+printing on a character printer or displaying on a screen. Of course,
+over the last 25 years or so, the distinction between typeset output on
+paper and characters on a screen has become blurred by the fact that
+most screens now support bit-mapped displays, so that any information
+that can be printed can also be rendered on screen, the only difference
+being the resolution.
+
+Nevertheless, Unix-style manual page documentation is still normally
+browsed on screen by running a program called @code{man}. This program
+looks in a predefined set of directories for the man page matching a
+specified topic, then either formats the source file by running
address@hidden or recovers a pre-formatted file, and displays it via a
+pager such as @code{more}. @code{nroff} normally formats for a printer,
+so it paginates the output, numbers the pages, etc., most of which is
+irrelevant when the document is browsed as a continuous scrollable
+document on screen. The only concession to on-screen browsing normally
+implemented by the @code{man} program is to squeeze consecutive blank
+lines into a single blank line.
+
+For some time, Emacs has offered an improved interface for browsing man
+pages in the form of the Emacs @code{man} (or @code{manual-entry})
+command, see @ref{Documentation, man, Documentation Commands, emacs, GNU
+Emacs Manual}.
+This command runs @code{man} as described above, perhaps in
+the background, and then post-processes the output to remove much of the
address@hidden pagination such as page headers and footers, and places the
+result into an Emacs buffer. It puts this buffer into a special major
+mode, which is tailored for man page browsing, and provides a number of
+useful navigation commands, support for following references, etc. It
+provides some support for special display faces (fonts), but no special
+menu or mouse support. The Emacs man package appears to have been
+developed over about 10 years, from the late 1980s to the late 1990s.
+
+There is considerable inefficiency in having @code{nroff} paginate a
+document and then removing most of the pagination!
+
+WoMan is an Emacs Lisp library that provides an emulation of the
+functionality of the Emacs @code{man} command, the main difference being
+that WoMan does not use any external programs. The only situation in
+which WoMan might use an external program is when the source file is
+compressed, when WoMan will use the standard Emacs automatic
+decompression facility, which does call an external program.
+
+I began developing WoMan in the Spring of 1997 and the first version was
+released in May 1997. The original motivation for WoMan was the fact
+that many GNU and Unix programs are ported to other platforms and come
+with Unix-style manual page documentation. This may be difficult to
+read because ports of the Unix-style @code{man} program can be a little
+awkward to set up. I decided that it should not be too hard to emulate
+the 20 @code{man} macros directly, without treating them as macros and
+largely ignoring the underlying @code{roff} requests, given the text
+processing capabilities of Emacs. This proved to be essentially true,
+and it did not take a great deal of work to be able to format simple man
+pages acceptably.
+
+One problem arose with the significant number of man pages that use
address@hidden requests in addition to the @code{man} macros, and since
+releasing the first version of WoMan I have been continually extending
+it to support more @code{roff} requests. WoMan can now format a
+significant proportion of the man pages that I have tested, either well
+or at least readably. However, I have added capabilities partly by
+making additional passes through the document, a design that is
+fundamentally flawed. This can only be solved by a major re-design of
+WoMan to handle the major formatting within a single recursive pass,
+rather than the present multiple passes without any significant
+recursion. There are some @code{roff} requests that cannot be handled
+satisfactorily within the present design. Some of these are currently
+handled by kludges that ``usually more or less work.''
+
+The principle advantage of WoMan is that it does not require @code{man},
+and indeed the name WoMan is a contraction of ``without man.'' But it
+has other advantages. It does not paginate the document, so it does not
+need to un-paginate it again, thereby saving time. It could take full
+advantage of the display capabilities available to it, and I hope to
+develop WoMan to take advantage of developments in Emacs itself. At
+present, WoMan uses several display faces to support bold and italic
+text, to indicate other fonts, etc. The default faces are also
+colored, but the choice of faces is customizable. WoMan provides menu
+support for navigation and mouse support for following references, in
+addition to the navigation facilities provided by @code{man} mode.
+WoMan has (this) texinfo documentation!
+
+WoMan @emph{does not} replace @code{man}, although it does use a number
+of the facilities implemented in the Emacs @code{man} library. WoMan
+and man can happily co-exist, which is very useful for comparison and
+debugging purposes.
+
address@hidden simulates address@hidden characters by using one or more
address@hidden characters. WoMan should be able to do much better than
+this. I have recently begun to add support for WoMan to use more of the
+characters in its default font and to use a symbol font, and it is an
+aspect that I intend to develop further in the near future. It should
+be possible to move WoMan from an emulation of @code{nroff} to an
+emulation of @code{troff} as GNU Emacs moves to providing bit-mapped
+display facilities.
+
address@hidden Finding, Browsing, Background, Top
address@hidden node-name, next, previous, up
address@hidden Finding and Formatting Man Pages
address@hidden using, finding man pages
address@hidden using, formatting man pages
address@hidden finding man pages
address@hidden formatting man pages
address@hidden man pages, finding
address@hidden man pages, formatting
+
+WoMan provides three user interfaces for finding and formatting man pages:
+
address@hidden @bullet
address@hidden
+a topic interface similar to that provided by the standard Emacs
address@hidden command;
+
address@hidden
+a family of filename interfaces analogous to the standard Emacs
address@hidden command;
+
address@hidden
+an automatic interface that detects the file type from its contents.
+(This is currently neither well tested, well supported nor recommended!)
address@hidden itemize
+
+The topic and filename interfaces support completion in the usual way.
+
+The topic interface is generally the most convenient for regular use,
+although it may require some special setup, especially if your machine
+does not already have a conventional @code{man} installation (which
+WoMan tries to detect).
+
+The simplest filename interface command @code{woman-find-file} can
+always be used with no setup at all (provided WoMan is installed and
+loaded or set up to autoload).
+
+The automatic interface always requires special setup.
+
+
address@hidden Case-Dependence of Filenames
+
address@hidden case-sensitivity
address@hidden w32-downcase-file-names
+By default, WoMan ignores case in file pathnames only when it seems
+appropriate. Microsoft Windows users who want complete case
+independence should set the special NTEmacs variable
address@hidden to @code{t} and use all lower case when
+setting WoMan file paths.
+
+
address@hidden
+* Topic:: Topic Interface
+* Filename:: Filename Interface
+* Automatic:: Automatic Interface
address@hidden menu
+
address@hidden Topic, Filename, Finding, Finding
address@hidden node-name, next, previous, up
address@hidden Topic Interface
address@hidden topic interface
+
+The topic interface is accessed principally via the command
address@hidden The same command can be accessed via the menu item
address@hidden>Manuals->Read Man Page (WoMan)...} once WoMan has been
+loaded. The command reads a manual topic in the minibuffer, which can
+be the @dfn{basename} of a man file anywhere in the man file
+structure. The ``basename'' in this context means the filename
+without any directory component and without any extension or suffix
+components that relate to the file type. So, for example, if there is
+a compressed source file in Chapter 5 of the UNIX Programmer's Manual
+with the full pathname @file{/usr/local/man/man5/man.conf.5.gz} then
+the topic is @code{man.conf}. Provided WoMan is configured correctly,
+this topic will appear among the completions offered by @code{woman}.
+If more than one file has the same topic name then WoMan will prompt
+for which file to format. Completion of topics is case insensitive.
+
+Clearly, @code{woman} has to know where to look for man files and there
+are two customizable user options that store this information:
address@hidden and @code{woman-path}. @xref{Interface Options, ,
+Interface Options}. If @code{woman-manpath} is not set explicitly then
+WoMan tries to pick up the information that would be used by the
address@hidden command, as follows. If the environment variable
address@hidden is set, which seems to be the standard mechanism under
+UNIX, then WoMan parses that. Otherwise, if WoMan can find a
+configuration file named (by default) @file{man.conf} (or something very
+similar), which seems to be the standard mechanism under GNU/Linux, then
+it parses that. To be precise, ``something very similar'' means
+starting with @samp{man} and ending with @samp{.conf} and possibly more
+lowercase letters, e.g.@: @file{manual.configuration}.
+The search path and/or precise full path name for this file are set by
+the value of the customizable user option @code{woman-man.conf-path}.
+If all else fails, WoMan uses a plausible default man search path.
+
+If the above default configuration does not work correctly for any
+reason then simply customize the value of @code{woman-manpath}. To
+access man files that are not in a conventional man file hierarchy,
+customize the value of @code{woman-path} to include the directories
+containing the files. In this way, @code{woman} can access manual files
address@hidden in the entire file system.
+
+There are two differences between @code{woman-manpath} and
address@hidden Firstly, the elements of @code{woman-manpath} must
+be directories that contain @emph{directories of} man files, whereas the
+elements of @code{woman-path} must be directories that contain man files
address@hidden Secondly, the last directory component of each element
+of @code{woman-path} is treated as a regular (Emacs) match expression
+rather than a fixed name, which allows collections of related
+directories to be specified succinctly. Also, elements of
address@hidden can be conses, indicating a mapping from
address@hidden environment variable components to man directory
+hierarchies.
+
+For topic completion to work, WoMan must build a list of all the manual
+files that it can access, which can be very slow, especially if a
+network is involved. For this reason, it caches various amounts of
+information, after which retrieving it from the cache is very fast. If
+the cache ever gets out of synchronism with reality, running the
address@hidden command with a prefix argument (e.g.@: @kbd{C-u M-x woman})
+will force it to rebuild its cache. This is necessary only if the names
+or locations of any man files change; it is not necessary if only their
+contents change. It would always be necessary if such a change occurred
+whilst Emacs were running and after WoMan has been loaded. It may be
+necessary if such a change occurs between Emacs sessions and persistent
+caching is used, although WoMan can detect some changes that invalidate
+its cache and rebuild it automatically.
+
+Customize the variable @code{woman-cache-filename} to save the cache
+between Emacs sessions. This is recommended only if the @code{woman}
+command is too slow the first time it is run in an Emacs session, while
+it builds its cache in main memory, which @emph{may} be @emph{very}
+slow. @xref{Cache, , The WoMan Topic Cache}, for further details.
+
+
address@hidden
+* Cache:: The WoMan Topic Cache
+* Word at point:: Using the ``Word at Point'' as a Topic Suggestion
address@hidden menu
+
address@hidden Cache, Word at point, Topic, Topic
address@hidden node-name, next, previous, up
address@hidden The WoMan Topic Cache
address@hidden topic cache
address@hidden cache, topic
+
+The amount of information that WoMan caches (in main memory and,
+optionally, saved to disc) is controlled by the user option
address@hidden There is a trade-off between the speed with
+which WoMan can find a file and the size of the cache, and the default
+setting gives a reasonable compromise.
+
+The @code{woman} command always performs a certain amount of caching in
+main memory, but it can also write its cache to the filestore as a
+persistent cache under control of the user option
address@hidden If persistent caching is turned on then
+WoMan re-loads its internal cache from the cache file almost
+instantaneously, so that there is never any perceptible start-up delay
address@hidden when WoMan rebuilds its cache. Persistent caching is
+currently turned off by default. This is because users with persistent
+caching turned on may overlook the need to force WoMan to rebuild its
+cache the first time they run it after they have installed new man
+files; with persistent caching turned off, WoMan automatically rebuilds
+its cache every time it is run in a new Emacs session.
+
+A prefix argument always causes the @code{woman} command (only) to
+rebuild its topic cache, and to re-save it to
address@hidden if this variable has a address@hidden value. This
+is necessary if the @emph{names} of any of the directories or files in
+the paths specified by @code{woman-manpath} or @code{woman-path} change.
+If WoMan user options that affect the cache are changed then WoMan will
+automatically update its cache file on disc (if one is in use) the next
+time it is run in a new Emacs session.
+
+
address@hidden Word at point, , Cache, Topic
address@hidden node-name, next, previous, up
address@hidden Using the ``Word at Point'' as a Topic Suggestion
address@hidden word at point
address@hidden point, word at
+
+By default, the @code{woman} command uses the word nearest to point in
+the current buffer as a suggestion for the topic to look up, if it
+exists as a valid topic. The topic can be confirmed or edited in the
+minibuffer.
+
+You can also bind the variable @code{woman-use-topic-at-point} locally
+to a address@hidden value (using @code{let}), in which case
address@hidden will can use the suggested topic without confirmation if
+possible. This may be useful to provide special private key bindings,
+e.g.@: this key binding for @kbd{C-c w} runs WoMan on the topic at
+point without seeking confirmation:
+
address@hidden
+(global-set-key "\C-cw"
+ (lambda ()
+ (interactive)
+ (let ((woman-use-topic-at-point t))
+ (woman))))
address@hidden lisp
+
+
address@hidden Filename, Automatic, Topic, Finding
address@hidden node-name, next, previous, up
address@hidden Filename Interface
address@hidden filename interface
+
+The commands in this family are completely independent of the topic
+interface, caching mechanism, etc.
+
address@hidden woman-find-file
+The filename interface is accessed principally via the extended command
address@hidden, which is available without any configuration at
+all (provided WoMan is installed and loaded or set up to autoload).
+This command can be used to browse any accessible man file, regardless
+of its filename or location. If the file is compressed then automatic
+file decompression must already be turned on (e.g.@: see the
address@hidden>Options} submenu)---it is turned on automatically only by
+the @code{woman} topic interface.
+
address@hidden woman-dired-find-file
+Once WoMan is loaded (or if specially set up), various additional
+commands in this family are available. In a dired buffer, the command
address@hidden allows the file on the same line as point
+to be formatted and browsed by WoMan. It is bound to the key @kbd{W} in
+the dired mode map and added to the dired major mode menu. It may also
+be bound to @kbd{w}, unless this key is bound by another library, which
+it is by @code{dired-x}, for example. Because it is quite likely that
+other libraries will extend the capabilities of such a commonly used
+mode as dired, the precise key bindings added by WoMan to the dired mode
+map are controlled by the user option @code{woman-dired-keys}.
+
address@hidden woman-tar-extract-file
+When a tar (Tape ARchive) file is visited in Emacs, it is opened in tar
+mode, which parses the tar file and shows a dired-like view of its
+contents. The WoMan command @code{woman-tar-extract-file} allows the
+file on the same line as point to be formatted and browsed by WoMan. It
+is bound to the key @kbd{w} in the tar mode map and added to the tar
+major mode menu.
+
+The command @code{woman-reformat-last-file}, which is bound to the key
address@hidden in WoMan mode and available on the major mode menu, reformats
+the last file formatted by WoMan. This may occasionally be useful if
+formatting parameters, such as the fill column, are changed, or perhaps
+if the buffer is somehow corrupted.
+
address@hidden woman-decode-buffer
+The command @code{woman-decode-buffer} can be used to decode and browse
+the current buffer if it is visiting a man file, although it is
+primarily used internally by WoMan.
+
+
address@hidden Automatic, , Filename, Finding
address@hidden node-name, next, previous, up
address@hidden Automatic Interface
address@hidden automatic interface
+
+Emacs provides an interface to detect automatically the format of a file
+and decode it when it is visited. It is used primarily by the
+facilities for editing rich (i.e.@: formatted) text, as a way to store
+formatting information transparently as @acronym{ASCII} markup. WoMan can in
+principle use this interface, but it must be configured explicitly.
+
+This use of WoMan does not seem to be particularly advantageous, so it
+is not really supported. It originated during early experiments on how
+best to implement WoMan, before I implemented the current topic
+interface, and I subsequently stopped using it. I might revive it as a
+mechanism for storing pre-formatted WoMan files, somewhat analogous to
+the standard Unix @code{catman} facility. In the meantime, it exists
+for anyone who wants to experiment with it. Once it is set up it is
+simply a question of visiting the file and there is no WoMan-specific
+user interface!
+
+To use it, put something like this in your @file{.emacs} file. [The
+call to @code{set-visited-file-name} is to avoid font-locking triggered
+by automatic major mode selection.]
+
address@hidden
+(autoload 'woman-decode-region "woman")
+
+(add-to-list 'format-alist
+ '(man "Unix man-page source format" "\\.\\(TH\\|ig\\) "
+ woman-decode-region nil nil
+ (lambda (arg)
+ set-visited-file-name
+ (file-name-sans-extension buffer-file-name))))
address@hidden lisp
+
address@hidden
===================================================================
+
address@hidden Browsing, Customization, Finding, Top
address@hidden node-name, next, previous, up
address@hidden Browsing Man Pages
address@hidden using, browsing man pages
address@hidden browsing man pages
address@hidden man pages, browsing
+
+Once a man page has been found and formatted, WoMan provides a browsing
+interface that is essentially the same as that provided by the standard
+Emacs @code{man} command (and much of the code is inherited from the
address@hidden library, which WoMan currently requires). Many WoMan
+facilities can be accessed from the WoMan major mode menu as well as via
+key bindings, etc.
+
+WoMan does not produce any page breaks or page numbers, and in fact does
+not paginate the man page at all, since this is not appropriate for
+continuous online browsing. It produces a document header line that is
+constructed from the standard man page header and footer. Apart from
+that, the appearance of the formatted man page should be almost
+identical to what would be produced by @code{man}, with consecutive
+blank lines squeezed to a single blank line.
+
address@hidden
+* Fonts:: Fonts and Faces
+* Navigation:: Navigation
+* References:: Following References
+* Changing:: Changing the Current Man Page
+* Convenience:: Convenience Key Bindings
+* Imenu:: Imenu Support; Contents Menu
address@hidden menu
+
address@hidden Fonts, Navigation, Browsing, Browsing
address@hidden node-name, next, previous, up
address@hidden Fonts and Faces
address@hidden fonts
address@hidden faces
+
+Fonts used by @code{roff} are handled by WoMan as faces, the details of
+which are customizable. @xref{Faces, , Faces}. WoMan supports both the
+italic and bold fonts normally used in man pages, together with a single
+face to represent all unknown fonts (which are occasionally used in
+``non-standard'' man pages, usually to represent a ``typewriter'' font)
+and a face to indicate additional symbols introduced by WoMan. This
+currently means the characters ^ and _ used to indicate super- and
+sub-scripts, which are not displayed well by WoMan.
+
+
address@hidden Navigation, References, Fonts, Browsing
address@hidden node-name, next, previous, up
address@hidden Navigation
address@hidden navigation
+
+Man (and hence WoMan) mode can be thought of as a superset of view mode.
+The buffer cannot be edited, so keys that would normally self-insert are
+used for navigation. The WoMan key bindings are a minor modification of
+the @code{man} key bindings.
+
address@hidden @kbd
address@hidden @key{SPC}
address@hidden SPC
address@hidden scroll-up
+Scroll the man page up the window (@code{scroll-up}).
+
address@hidden @key{DEL}
address@hidden DEL
address@hidden scroll-down
+Scroll the man page down the window (@code{scroll-down}).
+
address@hidden n
address@hidden n
address@hidden Man-next-section
+Move point to the Nth next section---default 1 (@code{Man-next-section}).
+
address@hidden p
address@hidden p
address@hidden Man-previous-section
+Move point to Nth previous section---default 1
+(@code{Man-previous-section}).
+
address@hidden g
address@hidden g
address@hidden Man-goto-section
+Move point to the specified section (@code{Man-goto-section}).
+
address@hidden s
address@hidden s
address@hidden Man-goto-see-also-section
+Move point to the ``SEE ALSO'' section
+(@code{Man-goto-see-also-section}). Actually the section moved to is
+described by @code{Man-see-also-regexp}.
address@hidden table
+
+
address@hidden References, Changing, Navigation, Browsing
address@hidden node-name, next, previous, up
address@hidden Following References
address@hidden following references
address@hidden references
+
+Man pages usually contain a ``SEE ALSO'' section containing references
+to other man pages. If these man pages are installed then WoMan can
+easily be directed to follow the reference, i.e.@: to find and format the
+man page. When the mouse is passed over a correctly formatted reference
+it is highlighted, in which case clicking the middle button
address@hidden will cause WoMan to follow the reference. Alternatively,
+when point is over such a reference the key @key{RET} will follow the
+reference.
+
+Any word in the buffer can be used as a reference by clicking
address@hidden over it provided the Meta key is also used (although in
+general such a ``reference'' will not lead to a man page).
+Alternatively, the key @kbd{r} allows completion to be used to select a
+reference to follow, based on the word at point as default.
+
address@hidden @kbd
address@hidden @kbd{Mouse-2}
address@hidden Mouse-2
address@hidden woman-mouse-2
+Run WoMan with word under mouse as topic (@code{woman-mouse-2}). The
+word must be mouse-highlighted unless @code{woman-mouse-2} is used with
+the Meta key.
+
address@hidden @key{RET}
address@hidden RET
address@hidden man-follow
+Get the man page for the topic under (or nearest to) point
+(@code{man-follow}).
+
address@hidden r
address@hidden r
address@hidden Man-follow-manual-reference
+Get one of the man pages referred to in the ``SEE ALSO'' section
+(@code{Man-follow-manual-reference}). Specify which reference to use;
+default is based on word at point.
address@hidden table
+
+
address@hidden Changing, Convenience, References, Browsing
address@hidden node-name, next, previous, up
address@hidden Changing the Current Man Page
address@hidden changing current man page
address@hidden current man page, changing
+
+The man page currently being browsed by WoMan can be changed in several
+ways. The command @code{woman} can be invoked to format another man
+page, or the current WoMan buffer can be buried or killed. WoMan
+maintains a ring of formatted man pages, and it is possible to move
+forwards and backwards in this ring by moving to the next or previous
+man page. It is sometimes useful to reformat the current page, for
+example after the right margin (the wrap column) or some other
+formatting parameter has been changed.
+
+Buffers formatted by Man and WoMan are completely unrelated, even though
+some of the commands to manipulate them are superficially the same (and
+share code).
+
address@hidden @kbd
address@hidden m
address@hidden m
address@hidden man
+Run the command @code{man} to get a Un*x manual page and put it in a
+buffer. This command is the top-level command in the man package. It
+runs a Un*x command to retrieve and clean a man page in the background
+and places the results in a Man mode (man page browsing) buffer. If a
+man buffer already exists for this man page, it will display
+immediately. This works exactly the same if WoMan is loaded, except
+that the formatting time is displayed in the mini-buffer.
+
address@hidden w
address@hidden w
address@hidden woman
+Run the command @code{woman} exactly as if the extended command or menu
+item had been used.
+
address@hidden q
address@hidden q
address@hidden Man-quit
+Bury the buffer containing the current man page (@code{Man-quit}),
+i.e.@: move it to the bottom of the buffer stack.
+
address@hidden k
address@hidden k
address@hidden Man-kill
+Kill the buffer containing the current man page (@code{Man-kill}),
+i.e.@: delete it completely so that it can be retrieved only by formatting
+the page again.
+
address@hidden M-p
address@hidden M-p
address@hidden WoMan-previous-manpage
+Find the previous WoMan buffer (@code{WoMan-previous-manpage}).
+
address@hidden M-n
address@hidden M-n
address@hidden WoMan-next-manpage
+Find the next WoMan buffer (@code{WoMan-next-manpage}).
+
address@hidden R
address@hidden R
address@hidden woman-reformat-last-file
+Call WoMan to reformat the last man page formatted by WoMan
+(@code{woman-reformat-last-file}), e.g.@: after changing the fill column.
address@hidden table
+
+
address@hidden Convenience, Imenu, Changing, Browsing
address@hidden node-name, next, previous, up
address@hidden Convenience Key Bindings
address@hidden convenience key bindings
address@hidden key bindings, convenience
+
address@hidden @kbd
address@hidden -
address@hidden -
address@hidden negative-argument
+Begin a negative numeric argument for the next command
+(@code{negative-argument}).
+
address@hidden 0 .. 9
address@hidden 0 .. 9
address@hidden digit-argument
+Part of the numeric argument for the next command
+(@code{digit-argument}).
+
address@hidden <
address@hidden <
address@hidden .
address@hidden .
address@hidden beginning-of-buffer
+Move point to the beginning of the buffer; leave mark at previous
+position (@code{beginning-of-buffer}).
+
address@hidden >
address@hidden >
address@hidden end-of-buffer
+Move point to the end of the buffer; leave mark at previous position
+(@code{end-of-buffer}).
+
address@hidden ?
address@hidden ?
address@hidden describe-mode
+Display documentation of current major mode and minor modes
+(@code{describe-mode}). The major mode description comes first,
+followed by the minor modes, each on a separate page.
address@hidden table
+
+
address@hidden Imenu, , Convenience, Browsing
address@hidden node-name, next, previous, up
address@hidden Imenu Support; Contents Menu
address@hidden imenu support
address@hidden contents menu
+
+The WoMan menu provides an option to make a contents menu for the
+current man page (using @code{imenu}). Alternatively, if you customize
+the option @code{woman-imenu} to @code{t} then WoMan will do it
+automatically for every man page. The menu title is set by the option
address@hidden, which is ``CONTENTS'' by default. The menu
+shows manual sections and subsections by default, but you can change
+this by customizing @code{woman-imenu-generic-expression}.
+
+WoMan is configured not to replace spaces in an imenu
address@hidden buffer. For further documentation on the use of
+imenu, such as menu sorting, see the source file @file{imenu.el}, which
+is distributed with GNU Emacs.
+
address@hidden
===================================================================
+
address@hidden Customization, Log, Browsing, Top
address@hidden node-name, next, previous, up
address@hidden Customization
address@hidden customization
+
+All WoMan user options are customizable, and it is recommended to
+change them only via the standard Emacs customization facilities.
+WoMan defines a top-level customization group called @code{WoMan}
+under the parent group @code{Help}. It can be accessed either via the
+standard Emacs facilities, e.g.@: via the @samp{Help->Customize}
+submenu, or via the WoMan major mode menu.
+
+The top-level WoMan group contains only a few general options and three
+subgroups. The hooks are provided only for special purposes that, for
+example, require code to be executed, and should be changed only via
address@hidden or the function @code{add-hook}. Most
+customization should be possible via existing user options.
+
address@hidden @code
address@hidden woman-show-log
+A boolean value that defaults to @code{nil}. If address@hidden then show the
address@hidden buffer if appropriate, i.e.@: if any warning messages
+are written to it. @xref{Log, , The *WoMan-Log* Buffer}.
+
address@hidden woman-pre-format-hook
+A hook run immediately before formatting a buffer. It might, for
+example, be used for face customization. @xref{Faces, , Faces},
+however.
+
address@hidden woman-post-format-hook
+A hook run immediately after formatting a buffer. It might, for
+example, be used for installing a dynamic menu using @code{imenu}.
+(However. in this case it is better to use the built-in WoMan
address@hidden support. @xref{Imenu, , Imenu Support; Contents Menu}.)
address@hidden vtable
+
address@hidden Customization Subgroups
+
address@hidden @code
address@hidden WoMan Interface
+These options control the process of locating the appropriate file to
+browse, and the appearance of the browsing interface.
+
address@hidden WoMan Formatting
+These options control the layout that WoMan uses to format the man page.
+
address@hidden WoMan Faces
+These options control the display faces that WoMan uses to format the
+man page.
address@hidden table
+
address@hidden
+* Interface Options::
+* Formatting Options::
+* Faces::
+* Special symbols::
address@hidden menu
+
address@hidden Interface Options, Formatting Options, Customization,
Customization
address@hidden node-name, next, previous, up
address@hidden Interface Options
address@hidden interface options
+
+These options control the process of locating the appropriate file to
+browse, and the appearance of the browsing interface.
+
address@hidden @code
address@hidden woman-man.conf-path
+A list of strings representing directories to search and/or files to try
+for a man configuration file. The default is
+
address@hidden
+("/etc" "/usr/local/lib")
address@hidden lisp
+
address@hidden
+[for GNU/Linux and Cygwin respectively.] A trailing separator (@file{/}
+for UNIX etc.) on directories is optional and the filename matched if a
+directory is specified is the first to match the regexp
address@hidden If the environment variable @code{MANPATH} is not
+set but a configuration file is found then it is parsed instead (or as
+well) to provide a default value for @code{woman-manpath}.
+
address@hidden woman-manpath
+A list of strings representing @emph{directory trees} to search for Unix
+manual files. Each element should be the name of a directory that
+contains subdirectories of the form @file{man?}, or more precisely
+subdirectories selected by the value of @code{woman-manpath-man-regexp}.
+Non-directory and unreadable files are ignored. This can also contain
+conses, with the car indicating a @code{PATH} variable component mapped
+to the directory tree given in the cdr.
+
address@hidden @code{MANPATH}, environment variable
+If not set then the environment variable @code{MANPATH} is used. If no
+such environment variable is found, the default list is determined by
+consulting the man configuration file if found. By default this is
+expected to be either @file{/etc/man.config} or
address@hidden/usr/local/lib/man.conf}, which is controlled by the user option
address@hidden An empty substring of @code{MANPATH}
+denotes the default list. Otherwise, the default value of this variable
+is
+
address@hidden
+("/usr/man" "/usr/local/man")
address@hidden lisp
+
+Any environment variables (names of which must have the Unix-style form
address@hidden, e.g.@: @code{$HOME}, @code{$EMACSDATA}, @code{$EMACS_DIR},
+regardless of platform) are evaluated first but each element must
+evaluate to a @emph{single} directory name. Trailing @file{/}s are
+ignored. (Specific directories in @code{woman-path} are also searched.)
+
+On Microsoft platforms I recommend including drive letters explicitly,
+e.g.
+
address@hidden
+("C:/Cygwin/usr/man" "C:/usr/man" "C:/usr/local/man")
address@hidden lisp
+
address@hidden directory separator character
address@hidden @code{MANPATH}, directory separator
+The @code{MANPATH} environment variable may be set using DOS
+semi-colon-separated or Unix-style colon-separated syntax (but not
+mixed).
+
address@hidden woman-manpath-man-regexp
+A regular expression to match man directories @emph{under} the
address@hidden directories. These normally have names of the form
address@hidden Its default value is @code{"[Mm][Aa][Nn]"}, which is
+case-insensitive mainly for the benefit of Microsoft platforms. Its
+purpose is to avoid directories such as @file{cat?}, @file{.},
address@hidden, etc.
+
address@hidden woman-path
+A list of strings representing @emph{specific directories} to search for
+Unix manual files. For example
+
address@hidden
+("/emacs/etc")
address@hidden lisp
+
+These directories are searched in addition to the directory trees
+specified in @code{woman-manpath}. Each element should be a directory
+string or @code{nil}, which represents the current directory when the
+path is expanded and cached. However, the last component (only) of each
+directory string is treated as a regexp (Emacs, not shell) and the
+string is expanded into a list of matching directories. Non-directory
+and unreadable files are ignored. The default value on MS-DOS is
+
address@hidden
+("$DJDIR/info" "$DJDIR/man/cat[1-9onlp]")
address@hidden lisp
+
address@hidden
+and on other platforms is @code{nil}.
+
+Any environment variables (names of which must have the Unix-style form
address@hidden, e.g.@: @code{$HOME}, @code{$EMACSDATA}, @code{$EMACS_DIR},
+regardless of platform) are evaluated first but each element must
+evaluate to a @emph{single} directory name (regexp, see above). For
+example
+
address@hidden
+("$EMACSDATA")
address@hidden lisp
+
address@hidden
+or equivalently
+
address@hidden
+("$EMACS_DIR/etc")
address@hidden lisp
+
address@hidden
+Trailing @file{/}s are discarded. (The directory trees in
address@hidden are also searched.) On Microsoft platforms I
+recommend including drive letters explicitly.
+
address@hidden woman-cache-level
+A positive integer representing the level of topic caching:
+
address@hidden
address@hidden
+cache only the topic and directory lists (uses minimal memory, but not
+recommended);
address@hidden
+cache also the directories for each topic (faster, without using much
+more memory);
address@hidden
+cache also the actual filenames for each topic (fastest, but uses twice
+as much memory).
address@hidden enumerate
+
+The default value is currently 2, a good general compromise. If the
address@hidden command is slow to find files then try 3, which may be
+particularly beneficial with large remote-mounted man directories. Run
+the @code{woman} command with a prefix argument or delete the cache file
address@hidden for a change to take effect. (Values < 1
+behave like 1; values > 3 behave like 3.)
+
address@hidden woman-cache-filename
+Either a string representing the full pathname of the WoMan directory
+and topic cache file, or @code{nil}. It is used to save and restore the
+cache between Emacs sessions. This is especially useful with
+remote-mounted man page files! The default value of @code{nil}
+suppresses this action. The ``standard'' address@hidden filename is
address@hidden/.wmncach.el}. Remember that a prefix argument forces the
address@hidden command to update and re-write the cache.
+
address@hidden woman-dired-keys
+A list of @code{dired} mode keys to be defined to run WoMan on the
+current file, e.g.@: @code{("w" "W")} or any address@hidden atom to
+automatically define @kbd{w} and @kbd{W} if they are unbound, or
address@hidden to do nothing. Default is @code{t}.
+
address@hidden woman-imenu-generic-expression
+Imenu support for Sections and Subsections: an alist with elements of
+the form @code{(MENU-TITLE REGEXP INDEX)}---see the documentation for
address@hidden Default value is
+
address@hidden
+((nil "\n\\([A-Z].*\\)" 1) ; SECTION, but not TITLE
+ ("*Subsections*" "^ \\([A-Z].*\\)" 1))
address@hidden lisp
+
address@hidden woman-imenu
+A boolean value that defaults to @code{nil}. If address@hidden then WoMan adds
+a Contents menu to the menubar by calling @code{imenu-add-to-menubar}.
+
address@hidden woman-imenu-title
+A string representing the title to use if WoMan adds a Contents menu to
+the menubar. Default is @code{"CONTENTS"}.
+
address@hidden woman-use-topic-at-point
+A boolean value that defaults to @code{nil}. If address@hidden then
+the @code{woman} command uses the word at point as the topic,
address@hidden interactive confirmation}, if it exists as a topic.
+
address@hidden woman-use-topic-at-point-default
+A boolean value representing the default value for
address@hidden The default value is @code{nil}.
+[The variable @code{woman-use-topic-at-point} may be @code{let}-bound
+when @code{woman} is loaded, in which case its global value does not
+get defined. The function @code{woman-file-name} sets it to this
+value if it is unbound.]
+
address@hidden woman-uncompressed-file-regexp
+A regular match expression used to select man source files (ignoring any
+compression extension). The default value is
address@hidden"\\.\\([0-9lmnt]\\w*\\)"} [which means a filename extension is
+required].
+
address@hidden not change this unless you are sure you know what you are doing!}
+
+The SysV standard man pages use two character suffixes, and this is
+becoming more common in the GNU world. For example, the man pages in
+the @code{ncurses} package include @file{toe.1m}, @file{form.3x}, etc.
+
address@hidden note:} an optional compression regexp will be appended,
+so this regexp @emph{must not} end with any kind of string terminator
+such as @code{$} or @code{\\'}.
+
address@hidden woman-file-compression-regexp
+A regular match expression used to match compressed man file extensions
+for which decompressors are available and handled by auto-compression
+mode. It should begin with @code{\\.} and end with @code{\\'} and
address@hidden not} be optional. The default value is
address@hidden"\\.\\(g?z\\|bz2\\)\\'"}, which matches the @code{gzip} and
address@hidden compression extensions.
+
address@hidden not change this unless you are sure you know what you are doing!}
+
+[It should be compatible with the @code{car} of
address@hidden, but that is unduly
+complicated, includes an inappropriate extension (@file{.tgz}) and is
+not loaded by default!]
+
address@hidden woman-use-own-frame
+If address@hidden then use a dedicated frame for displaying WoMan windows.
+This is useful only when WoMan is run under a window system such as X or
+Microsoft Windows that supports real multiple frames, in which case the
+default value is address@hidden
address@hidden vtable
+
+
address@hidden Formatting Options, Faces, Interface Options, Customization
address@hidden node-name, next, previous, up
address@hidden Formatting Options
address@hidden formatting options
+
+These options control the layout that WoMan uses to format the man page.
+
address@hidden @code
address@hidden woman-fill-column
+An integer specifying the right margin for formatted text. Default is
+65.
+
address@hidden woman-fill-frame
+A boolean value. If address@hidden then most of the frame width is used,
+overriding the value of @code{woman-fill-column}. Default is @code{nil}.
+
address@hidden woman-default-indent
+An integer specifying the default prevailing indent for the @code{-man}
+macros. Default is 5. Set this variable to 7 to emulate GNU/Linux man
+formatting.
+
address@hidden woman-bold-headings
+A boolean value. If address@hidden then embolden section and subsection
+headings. Default is @code{t}. [Heading emboldening is @emph{not} standard
address@hidden behavior.]
+
address@hidden woman-ignore
+A boolean value. If address@hidden then unrecognised requests etc. are
+ignored. Default is @code{t}. This gives the standard @code{roff} behavior.
+If @code{nil} then they are left in the buffer, which may aid debugging.
+
address@hidden woman-preserve-ascii
+A boolean value. If address@hidden then preserve @acronym{ASCII} characters
in the
+WoMan buffer. Otherwise, address@hidden characters (that display as
address@hidden) may remain, which is irrelevant unless the buffer is to be
+saved to a file. Default is @code{nil}.
+
address@hidden woman-emulation
+WoMan emulation, currently either @code{nroff} or @code{troff}. Default
+is @code{nroff}. @code{troff} emulation is experimental and largely
+untested.
address@hidden vtable
+
+
address@hidden Faces, Special symbols, Formatting Options, Customization
address@hidden node-name, next, previous, up
address@hidden Faces
address@hidden faces
+
+These options control the display faces that WoMan uses to format the
+man page.
+
address@hidden @code
address@hidden woman-fontify
+A boolean value. If address@hidden then WoMan assumes that face support is
+available. It defaults to a address@hidden value if the display supports
+either colors or different fonts.
+
address@hidden woman-italic-face
+Face for italic font in man pages. Default: italic, underlined,
+foreground red. This is overkill! @code{troff} uses just italic;
address@hidden uses just underline. You should probably select either
+italic or underline as you prefer, but not both, although italic and
+underline work together perfectly well!
+
address@hidden woman-bold-face
+Face for bold font in man pages. Default: bold, foreground blue.
+
address@hidden woman-unknown-face
+Face for all unknown fonts in man pages. Default: foreground brown.
+Brown is a good compromise: it is distinguishable from the default but
+not enough so as to make font errors look terrible. (Files that use
+non-standard fonts seem to do so badly or in idiosyncratic ways!)
+
address@hidden woman-addition-face
+Face for all additions made by WoMan to man pages.
+Default: foreground orange.
address@hidden vtable
+
+
address@hidden Special symbols, , Faces, Customization
address@hidden node-name, next, previous, up
address@hidden Special symbols
address@hidden special symbols
+
+This section currently applies @emph{only} to Microsoft Windows.
+
+WoMan provides partial experimental support for special symbols,
+initially only for MS-Windows and only for MS-Windows fonts. This
+includes both address@hidden characters from the main text font and use
+of a separate symbol font. Later, support will be added for other font
+types (e.g.@: @code{bdf} fonts) and for the X Window System. In Emacs
+20.7, the current support works partially under Windows 9x but may not
+work on any other platform.
+
address@hidden @code
address@hidden woman-use-extended-font
+A boolean value. If address@hidden then WoMan may use address@hidden
characters
+from the default font. Default is @code{t}.
+
address@hidden woman-use-symbol-font
+A boolean value. If address@hidden then WoMan may use the symbol font.
+Default is @code{nil}, mainly because it may change the line spacing (at
+least in NTEmacs 20).
+
address@hidden woman-symbol-font
+A string describing the symbol font to use for special characters.
+It should be compatible with, and the same size as, the default text font.
+Under MS-Windows, the default is
+
address@hidden
+"-*-Symbol-normal-r-*-*-*-*-96-96-p-*-ms-symbol"
address@hidden lisp
address@hidden vtable
+
+
address@hidden
===================================================================
+
address@hidden Log, Technical, Customization, Top
address@hidden node-name, next, previous, up
address@hidden The *WoMan-Log* Buffer
address@hidden log buffer
address@hidden buffer, log
+
+This is modeled on the Emacs byte-compiler. It logs all files
+formatted by WoMan and the time taken. If WoMan finds anything that it
+cannot handle then it writes a warning to this buffer. If the variable
address@hidden is address@hidden (by default it is @code{nil}) then
+WoMan automatically displays this buffer. @xref{Interface Options, ,
+Interface Options}. Many WoMan warnings can be completely ignored,
+because they are reporting the fact that WoMan has ignored requests that
+it is correct for WoMan to ignore. In some future version this level of
+paranoia may be reduced, but not until WoMan is deemed more reliable.
+At present, all warnings should be treated with some suspicion.
+Uninterpreted escape sequences are also logged (in some cases).
+
+By resetting the variable @code{woman-ignore} to @code{nil} (by default
+it is @code{t}), uninterpreted @code{roff} requests can optionally be
+left in the formatted buffer to indicate precisely where they occurred.
address@hidden Options, , Interface Options}.
+
address@hidden
===================================================================
+
address@hidden Technical, Bugs, Log, Top
address@hidden node-name, next, previous, up
address@hidden Technical Details
address@hidden technical details
address@hidden horizontal spacing
address@hidden spacing, horizontal and vertical
address@hidden vertical spacing
address@hidden resolution
+
address@hidden Horizontal and vertical spacing and resolution
+
+WoMan currently assumes 10 characters per inch horizontally, hence a
+horizontal resolution of 24 basic units, and 5 lines per inch
+vertically, hence a vertical resolution of 48 basic units.
+(@code{nroff} uses 240 per inch.)
+
address@hidden Vertical spacing and blank lines
+
+The number of consecutive blank lines in the formatted buffer should be
+either 0 or 1. A blank line should leave a space like .sp 1.
+Current policy is to output vertical space only immediately before text
+is output.
+
address@hidden
===================================================================
+
address@hidden Bugs, Acknowledgements, Technical, Top
address@hidden node-name, next, previous, up
address@hidden Reporting Bugs
address@hidden reporting bugs
address@hidden bugs, reporting
+
+If WoMan fails completely, or formats a file incorrectly (i.e.@:
+obviously wrongly or significantly differently from @code{man}) or
+inelegantly, then please
+
address@hidden
address@hidden
+try the latest version of @file{woman.el} from the Emacs CVS repository
+on @uref{http://savannah.gnu.org/}. If it still fails, please
+
address@hidden
+send a bug report to @email{bug-gnu-emacs@@gnu.org} and to
address@hidden@@qmw.ac.uk}. Please include the entry from the
address@hidden buffer relating to the problem file, together with
+a brief description of the problem. Please indicate where you got the
+man source file from, but do not send it unless asked to send it.
address@hidden enumerate
+
address@hidden
===================================================================
+
address@hidden Acknowledgements, GNU Free Documentation License, Bugs, Top
address@hidden node-name, next, previous, up
address@hidden Acknowledgements
address@hidden acknowledgements
+
+For Heather, Kathryn and Madelyn, the women in my life (although they
+will probably never use it)!
+
+I also thank the following for helpful suggestions, bug reports, code
+fragments, general interest, etc.:
+
address@hidden
+Jari Aalto, @email{jari.aalto@@address@hidden
+Dean Andrews, @email{dean@@address@hidden
+Juanma Barranquero, @email{barranquero@@address@hidden
+Karl Berry, @email{kb@@address@hidden
+Jim Chapman, @email{jchapman@@address@hidden
+Frederic Corne, @email{frederic.corne@@address@hidden
+Peter Craft, @email{craft@@address@hidden
+Charles Curley, @email{ccurley@@address@hidden
+Jim Davidson, @email{jdavidso@@address@hidden
+Kevin D'Elia, @email{Kevin.DElia@@address@hidden
+John Fitch, @email{jpff@@address@hidden
+Hans Frosch, @email{jwfrosch@@address@hidden
+Guy Gascoigne-Piggford, @email{ggp@@address@hidden
+Brian Gorka, @email{gorkab@@address@hidden
+Nicolai Henriksen, @email{nhe@@address@hidden
+Thomas Herchenroeder, @email{the@@address@hidden
+Alexander Hinds, @email{ahinds@@address@hidden
+Stefan Hornburg, @email{sth@@address@hidden
+Theodore Jump, @email{tjump@@address@hidden
+Paul Kinnucan, @email{paulk@@address@hidden
+Jonas Linde, @email{jonas@@address@hidden
+Andrew McRae, @email{andrewm@@address@hidden
+Howard Melman, @email{howard@@address@hidden
+Dennis Pixton, @email{dennis@@address@hidden
+T. V. Raman, @email{raman@@address@hidden
+Bruce Ravel, @email{bruce.ravel@@address@hidden
+Benjamin Riefenstahl, @email{benny@@address@hidden
+Kevin Ruland, @email{kruland@@address@hidden
+Tom Schutter, @email{tom@@address@hidden
+Wei-Xue Shi, @email{wxshi@@address@hidden
+Fabio Somenzi, @email{fabio@@address@hidden
+Karel Sprenger, @email{ks@@address@hidden
+Chris Szurgot, @email{szurgot@@address@hidden
+Paul A. Thompson, @email{pat@@address@hidden
+Arrigo Triulzi, @email{arrigo@@address@hidden
+Geoff Voelker, @email{voelker@@address@hidden
+Eli Zaretskii, @email{eliz@@is.elta.co.il}
address@hidden quotation
+
address@hidden
===================================================================
+
address@hidden END OF MANUAL TEXT
address@hidden
+
+
address@hidden GNU Free Documentation License, Command Index, Acknowledgements,
Top
address@hidden GNU Free Documentation License
address@hidden doclicense.texi
+
address@hidden Command Index, Variable Index, GNU Free Documentation License,
Top
address@hidden node-name, next, previous, up
address@hidden Command Index
+
address@hidden fn
+
address@hidden Variable Index, Keystroke Index, Command Index, Top
address@hidden node-name, next, previous, up
address@hidden Variable Index
+
address@hidden vr
+
address@hidden Without a page throw here, the page length seems to get reset to
the
address@hidden depth of the index that fits on the page after the previous
index.
address@hidden This must be a bug!
+
address@hidden
+
address@hidden Keystroke Index, Concept Index, Variable Index, Top
address@hidden node-name, next, previous, up
address@hidden Keystroke Index
+
address@hidden ky
+
address@hidden Without a page throw here, the page length seems to get reset to
the
address@hidden depth of the index that fits on the page after the previous
index.
address@hidden This must be a bug!
+
address@hidden
+
address@hidden Concept Index, , Keystroke Index, Top
address@hidden node-name, next, previous, up
address@hidden Concept Index
+
address@hidden cp
+
address@hidden
+
address@hidden
+ arch-tag: a1a6b715-396f-4378-9b94-0b2ca0aa5028
address@hidden ignore
- [Emacs-diffs] Changes to woman.texi,
Glenn Morris <=