\input texinfo @c -*-texinfo-*-
-@c $Id: woman.texi,v 1.7 2001/03/05 15:11:21 eliz Exp $
@c %**start of header
@setfilename ../info/woman
-@settitle WoMan: Browse Unix Manual Pages ``Wo (without) Man''
+@settitle WoMan: Browse Unix Manual Pages ``W.O. (without) Man''
@c Manual last updated:
-@set UPDATED Time-stamp: <2001-03-05 17:10:30 eliz>
+@set UPDATED Time-stamp: <2006-03-25 14:59:03 karl>
@c Software version:
@set VERSION 0.54 (beta)
@afourpaper
@paragraphindent 0
@c %**end of header
-@dircategory Emacs
-@direntry
-* WoMan: (woman). Browse UN*X Manual Pages "Wo (without) Man".
-@end direntry
-
-@ifinfo
-This file documents WoMan: A program to browse Unix manual pages `wo
+@copying
+This file documents WoMan: A program to browse Unix manual pages `W.O.
(without) man'.
-Copyright @copyright{} 2001 Free Software Foundation, Inc.
+Copyright @copyright{} 2001, 2002, 2003, 2004,
+2005, 2006 Free Software Foundation, Inc.
+@quotation
Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1 or
+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
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.
-@end ifinfo
+@end quotation
+@end copying
+
+@dircategory Emacs
+@direntry
+* WoMan: (woman). Browse UN*X Manual Pages "W.O. (without) Man".
+@end direntry
@finalout
@titlepage
@title WoMan
-@subtitle Browse Unix Manual Pages ``Wo (without) Man''
+@subtitle Browse Unix Manual Pages ``W.O. (without) Man''
@subtitle Software Version @value{VERSION}
@author Francis J. Wright
@sp 2
@comment The following two commands start the copyright page.
@page
@vskip 0pt plus 1filll
-@noindent
-Copyright @copyright{} 2001 Free Software Foundation, Inc.
-
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1 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.
+@insertcopying
@end titlepage
@contents
@ifnottex
@node Top, Introduction, (dir), (dir)
@comment node-name, next, previous, up
-@top WoMan: Browse Unix Manual Pages ``Wo (without) Man''
+@top WoMan: Browse Unix Manual Pages ``W.O. (without) Man''
@display
Software Version @value{VERSION}
Microsoft Windows, but has also been tested on MS-DOS, and various
versions of UNIX and GNU/Linux.
-WoMan is distributed with GNU Emacs 21, and the current source code and
-documentation files are available from
-@uref{http://centaur.maths.qmw.ac.uk/Emacs/WoMan/, my web server}.
+WoMan is distributed with GNU Emacs. In addition, the current source
+code and documentation files are available from
+@uref{http://centaur.maths.qmw.ac.uk/Emacs/WoMan/, the WoMan web
+server}.
WoMan implements a subset of the formatting performed by the Emacs
@code{man} (or @code{manual-entry}) command to format a Unix-style
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
-@uref{http://centaur.maths.qmw.ac.uk/Emacs/WoMan/woman.status,
+@uref{http://centaur.maths.qmw.ac.uk/Emacs/WoMan/files/woman.status,
@file{woman.status}}.
WoMan supports the use of compressed man files via
The distinction between @code{TROFF} and @code{NROFF} is that
@code{TROFF} was designed to drive a phototypesetter whereas
-@code{NROFF} was designed to produce essentially @sc{ascii} output for a
+@code{NROFF} 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
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
-coloured, but the choice of faces is customizable. WoMan provides menu
+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!
@code{man} uses machine code, and is a testimony to the quality of the
Emacs Lisp system.
-@code{NROFF} simulates non-@sc{ascii} characters by using one or more
-@sc{ascii} characters. WoMan should be able to do much better than
+@code{NROFF} simulates non-@acronym{ASCII} characters by using one or more
+@acronym{ASCII} 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
@var{version} is your Emacs version), provided you have write access to
it. If you use a directory that is not included by default in your
Emacs load path then you need to add something like this to your
-@file{.emacs} initialisation file:
+@file{.emacs} initialization file:
@lisp
(add-to-list 'load-path "my-lisp")
@heading Setup
Setup that is either necessary or desirable consists of adding a small
-amount of Emacs Lisp code to your @file{.emacs} initialisation file. It
+amount of Emacs Lisp code to your @file{.emacs} initialization file. It
may be necessary (or at least convenient) to make WoMan autoload (if you
are not running GNU Emacs 21 or later) and to set the search path used
by the @code{woman} interface. You may also find it convenient to make
(By default, WoMan will automatically define the dired keys @kbd{W} and
@kbd{w} when it loads, but only if they are not already defined. This
-behaviour is controlled by the user option @code{woman-dired-keys}.
+behavior is controlled by the user option @code{woman-dired-keys}.
Note that the @code{dired-x} (dired extra) package binds
@code{dired-copy-filename-as-kill} to the key @kbd{w}, although @kbd{W}
appears to be unused. The @code{dired-x} package will over-write the
If you really want to square the man-woman circle then you can! If you
run the GNU command interpreter @code{bash} then you might care to
define the following @code{bash} function in your @code{bash}
-initialisation file @file{.bashrc}:
+initialization file @file{.bashrc}:
@example
man() @{ gnudoit -q '(raise-frame (selected-frame)) (woman' \"$1\" ')' ; @}
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 @sc{ascii} markup. WoMan can in
+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
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.
-@strong{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{\\'}.
+@strong{Please 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{\\'}.
@item woman-file-compression-regexp
A regular match expression used to match compressed man file extensions
@item woman-bold-headings
A boolean value. If non-@code{nil} then embolden section and subsection
headings. Default is @code{t}. [Heading emboldening is @emph{not} standard
-@code{man} behaviour.]
+@code{man} behavior.]
@item woman-ignore
A boolean value. If non-@code{nil} then unrecognised requests etc. are
-ignored. Default is @code{t}. This gives the standard @code{ROFF} behaviour.
+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.
@item woman-preserve-ascii
-A boolean value. If non-@code{nil} then preserve @sc{ascii} characters in the
-WoMan buffer. Otherwise, non-@sc{ascii} characters (that display as
-@sc{ascii}) may remain, which is irrelevant unless the buffer is to be
+A boolean value. If non-@code{nil} then preserve @acronym{ASCII} characters in the
+WoMan buffer. Otherwise, non-@acronym{ASCII} characters (that display as
+@acronym{ASCII}) may remain, which is irrelevant unless the buffer is to be
saved to a file. Default is @code{nil}.
@item woman-emulation
@item woman-fontify
A boolean value. If non-@code{nil} then WoMan assumes that face support is
available. It defaults to a non-@code{nil} value if the display supports
-either colours or different fonts.
+either colors or different fonts.
@item woman-italic-face
Face for italic font in man pages. Default: italic, underlined,
WoMan provides partial experimental support for special symbols,
initially only for MS-Windows and only for MS-Windows fonts. This
-includes both non-@sc{ascii} characters from the main text font and use
+includes both non-@acronym{ASCII} 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
@vtable @code
@item woman-use-extended-font
-A boolean value. If non-@code{nil} then WoMan may use non-@sc{ascii} characters
+A boolean value. If non-@code{nil} then WoMan may use non-@acronym{ASCII} characters
from the default font. Default is @code{t}.
@item woman-use-symbol-font
@cindex log buffer
@cindex buffer, log
-This is modelled on the Emacs byte-compiler. It logs all files
+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
@code{woman-show-log} is non-@code{nil} (by default it is @code{nil}) then
obviously wrongly or significantly differently from @code{man}) or
inelegantly, then please
-@enumerate a
+@enumerate
@item
-check that you are running the latest version of @file{woman.el}
-available from @uref{http://centaur.maths.qmw.ac.uk/Emacs/WoMan/, my web
-site}, and
+try the latest version of @file{woman.el} from the Emacs CVS repository
+on @uref{http://savannah.gnu.org/}. If it still fails, please
@item
-check that the problem is not already described in the file
-@file{woman.status}, also available from
-@uref{http://centaur.maths.qmw.ac.uk/Emacs/WoMan/, my web site}.
+send a bug report to @email{bug-gnu-emacs@@gnu.org} and to
+@email{F.J.Wright@@qmw.ac.uk}. Please include the entry from the
+@code{*WoMan-Log*} 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.
@end enumerate
-If both of the above are true then please
-@email{F.J.Wright@@qmw.ac.uk,email me} the entry from the
-@code{*WoMan-Log*} 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 to me unless I ask you to! Thanks.
-(At present WoMan has no automated bug-reporting facility.)
-
@c ===================================================================
@node Acknowledgements, Command Index, Bugs, Top
@printindex cp
@bye
+
+@ignore
+ arch-tag: a1a6b715-396f-4378-9b94-0b2ca0aa5028
+@end ignore