X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/c45d327a3054196168d5fe14f2f1c6a659f5704d..871711183b12f81f71f3940db21b8d05fb51af2a:/man/woman.texi diff --git a/man/woman.texi b/man/woman.texi index 3167cd0205..70e7974b16 100644 --- a/man/woman.texi +++ b/man/woman.texi @@ -1,10 +1,9 @@ \input texinfo @c -*-texinfo-*- -@c $Id: woman.texi,v 1.1 2000/08/08 10:38:56 eliz Exp $ @c %**start of header @setfilename ../info/woman -@settitle WoMan: Browse UN*X Manual Pages ``Wo (without) Man'' +@settitle WoMan: Browse Unix Manual Pages ``W.O. (without) Man'' @c Manual last updated: -@set UPDATED Time-stamp: <2000-08-08 12:20:51 eliz> +@set UPDATED Time-stamp: <2006-03-25 14:59:03 karl> @c Software version: @set VERSION 0.54 (beta) @afourpaper @@ -14,48 +13,43 @@ @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 UN*X manual pages `wo +@copying +This file documents WoMan: A program to browse Unix manual pages `W.O. (without) man'. -Copyright @copyright{} 2000 Francis J. Wright +Copyright @copyright{} 2001, 2002, 2003, 2004, +2005, 2006 Free Software Foundation, Inc. -This manual and the software that it describes are subject to the GNU -General Public License that is distributed with GNU Emacs -- see the -file @file{COPYING}. - -Permission is granted to make and distribute verbatim copies of this -manual provided the copyright notice and this permission notice are -preserved on all copies. - -@ignore -Permission is granted to process this file through TeX and print the -results, provided the printed document carries a copying permission -notice identical to this one except for the removal of this paragraph -(this paragraph not being relevant to the printed manual). - -@end ignore -Permission is granted to copy and distribute modified versions of this -manual under the conditions for verbatim copying and provided that the -entire resulting derived work is distributed under the terms of a -permission notice identical to this one. - -Permission is granted to copy and distribute translations of this manual -into another language, under the above conditions for modified versions. -@end ifinfo +@quotation +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. +@end quotation +@end copying -@finalout +@dircategory Emacs +@direntry +* WoMan: (woman). Browse UN*X Manual Pages "W.O. (without) Man". +@end direntry @finalout @titlepage @title WoMan -@subtitle Browse UN*X 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 @@ -71,23 +65,7 @@ into another language, under the above conditions for modified versions. @comment The following two commands start the copyright page. @page @vskip 0pt plus 1filll -Copyright @copyright{} 2000 Francis J. Wright - -This manual and the software that it describes are subject to the GNU -General Public License that is distributed with GNU Emacs -- see the -file @file{COPYING}. - -Permission is granted to make and distribute verbatim copies of this -manual provided the copyright notice and this permission notice are -preserved on all copies. - -Permission is granted to copy and distribute modified versions of this -manual under the conditions for verbatim copying and provided that the -entire resulting derived work is distributed under the terms of a -permission notice identical to this one. - -Permission is granted to copy and distribute translations of this manual -into another language, under the above conditions for modified versions. +@insertcopying @end titlepage @contents @@ -97,7 +75,7 @@ into another language, under the above conditions for modified versions. @ifnottex @node Top, Introduction, (dir), (dir) @comment node-name, next, previous, up -@top WoMan: Browse UN*X Manual Pages ``Wo (without) Man'' +@top WoMan: Browse Unix Manual Pages ``W.O. (without) Man'' @display Software Version @value{VERSION} @@ -138,14 +116,15 @@ 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 Linux. +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 UN*X-style +@code{man} (or @code{manual-entry}) command to format a Unix-style @dfn{manual 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} @@ -168,7 +147,7 @@ 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 -@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 @@ -183,7 +162,7 @@ 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 -@email{F.J.Wright@@qmw.ac.uk, let me know} what doesn't work -- I am +@email{F.J.Wright@@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}. @@ -195,10 +174,10 @@ Reporting Bugs}. @chapter Background @cindex background -WoMan is a browser for traditional UN*X-style manual page documentation. +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 UN*X ``man'' +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 @@ -218,7 +197,7 @@ requests. 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 @@ -231,7 +210,7 @@ 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, UN*X-style manual page documentation is still normally +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 @@ -269,9 +248,9 @@ 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 UN*X programs are ported to other platforms and come -with UN*X-style manual page documentation. This may be difficult to -read because ports of the UN*X-style @code{man} program can be a little +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 @@ -291,17 +270,17 @@ 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''. +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 +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 -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! @@ -320,8 +299,8 @@ WoMan is running byte code whereas most of the formatting done by @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 @@ -350,7 +329,7 @@ the @file{site-lisp} directory in your Emacs file tree, e.g.@: @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") @@ -371,7 +350,7 @@ harm.) @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 @@ -400,9 +379,9 @@ add these autoloads to your @file{.emacs} file: @lisp (autoload 'woman "woman" - "Decode and browse a UN*X man page." t) + "Decode and browse a Unix man page." t) (autoload 'woman-find-file "woman" - "Find, decode and browse a specific UN*X man-page file." t) + "Find, decode and browse a specific Unix man-page file." t) (autoload 'woman-dired-find-file "woman" "In dired, run the WoMan man-page browser on this file." t) @end lisp @@ -459,7 +438,7 @@ loaded, then add the following to your @file{.emacs} file: (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 @@ -494,7 +473,7 @@ file: 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\" ')' ; @} @@ -619,7 +598,7 @@ 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 having two name components separated by a dot and respectively containing -``man'' and beginning with ``conf'', e.g.@: @file{manual.configuration}. +@samp{man} and beginning with @samp{conf}, 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. @@ -693,7 +672,7 @@ 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 -@code{woman-cache-filename} if this variable has a non-nil value. This +@code{woman-cache-filename} if this variable has a non-@code{nil} 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 @@ -745,7 +724,7 @@ 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 -@samp{Help->Options} submenu) -- it is turned on automatically only by +@samp{Help->Options} submenu)---it is turned on automatically only by the @code{woman} topic interface. @findex woman-dired-find-file @@ -788,7 +767,7 @@ primarily used internally by WoMan. 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 @@ -796,7 +775,7 @@ 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 UN*X @code{catman} facility. In the meantime, it exists +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! @@ -809,7 +788,7 @@ by automatic major mode selection.] (autoload 'woman-decode-region "woman") (add-to-list 'format-alist - '(man "UN*X man-page source format" "\\.\\(TH\\|ig\\) " + '(man "Unix man-page source format" "\\.\\(TH\\|ig\\) " woman-decode-region nil nil (lambda (arg) set-visited-file-name @@ -889,12 +868,12 @@ Scroll the man page down the window (@code{scroll-down}). @item n @kindex n @findex Man-next-section -Move point to the Nth next section -- default 1 (@code{Man-next-section}). +Move point to the Nth next section---default 1 (@code{Man-next-section}). @item p @kindex p @findex Man-previous-section -Move point to Nth previous section -- default 1 +Move point to Nth previous section---default 1 (@code{Man-previous-section}). @item g @@ -922,19 +901,19 @@ 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 -@key{mouse-2} will cause WoMan to follow the reference. Alternatively, +@kbd{Mouse-2} 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 -@key{mouse-2} over it provided the Meta key is also used (although in +@kbd{Mouse-2} 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. @table @kbd -@item @key{mouse-2} -@kindex mouse-2 +@item @kbd{Mouse-2} +@kindex Mouse-2 @findex 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 @@ -1109,7 +1088,7 @@ customization should be possible via existing user options. @vtable @code @item woman-show-log -A boolean value that defaults to nil. If non-nil then show the +A boolean value that defaults to @code{nil}. If non-@code{nil} then show the @code{*WoMan-Log*} buffer if appropriate, i.e.@: if any warning messages are written to it. @xref{Log, , The *WoMan-Log* Buffer}. @@ -1173,7 +1152,7 @@ set but a configuration file is found then it is parsed instead (or as well) to provide a default value for @code{woman-manpath}. @item woman-manpath -A list of strings representing @emph{directory trees} to search for UN*X +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}. @@ -1193,7 +1172,7 @@ is ("/usr/man" "/usr/local/man") @end lisp -Any environment variables (names of which must have the UN*X-style form +Any environment variables (names of which must have the Unix-style form @code{$NAME}, 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 @@ -1209,7 +1188,7 @@ e.g. @cindex directory separator character @cindex @code{MANPATH}, directory separator The @code{MANPATH} environment variable may be set using DOS -semi-colon-separated or UN*X / Cygwin colon-separated syntax (but not +semi-colon-separated or Unix-style colon-separated syntax (but not mixed). @item woman-manpath-man-regexp @@ -1222,7 +1201,7 @@ purpose is to avoid directories such as @file{cat?}, @file{.}, @item woman-path A list of strings representing @emph{specific directories} to search for -UN*X manual files. For example +Unix manual files. For example @lisp ("/emacs/etc") @@ -1243,7 +1222,7 @@ and unreadable files are ignored. The default value on MS-DOS is @noindent and on other platforms is @code{nil}. -Any environment variables (names of which must have the UN*X-style form +Any environment variables (names of which must have the Unix-style form @code{$NAME}, 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 @@ -1292,19 +1271,19 @@ 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'' non-nil filename is +suppresses this action. The ``standard'' non-@code{nil} filename is @file{~/.wmncach.el}. Remember that a prefix argument forces the @code{woman} command to update and re-write the cache. @item 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 non-nil atom to +current file, e.g.@: @code{("w" "W")} or any non-@code{nil} atom to automatically define @kbd{w} and @kbd{W} if they are unbound, or @code{nil} to do nothing. Default is @code{t}. @item 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 +the form @code{(MENU-TITLE REGEXP INDEX)}---see the documentation for @code{imenu-generic-expression}. Default value is @lisp @@ -1313,7 +1292,7 @@ the form @code{(MENU-TITLE REGEXP INDEX)} -- see the documentation for @end lisp @item woman-imenu -A boolean value that defaults to @code{nil}. If non-nil then WoMan adds +A boolean value that defaults to @code{nil}. If non-@code{nil} then WoMan adds a Contents menu to the menubar by calling @code{imenu-add-to-menubar}. @item woman-imenu-title @@ -1323,7 +1302,7 @@ the menubar. Default is @code{"CONTENTS"}. @item woman-topic-at-point A symbol, which may be either @code{t}, @code{nil} or @code{confirm}, that controls the use by @code{woman} of the ``word at point'' as a -topic suggestion. If it is non-nil then the @code{woman} command uses +topic suggestion. If it is non-@code{nil} then the @code{woman} command uses the word at point as an initial topic suggestion when it reads a topic from the minibuffer; if it is @code{t} then @code{woman} uses the word at point @emph{without interactive confirmation} if it exists as a @@ -1351,9 +1330,9 @@ 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. -@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 @@ -1371,10 +1350,10 @@ complicated, includes an inappropriate extension (@file{.tgz}) and is not loaded by default!] @item woman-use-own-frame -If non-nil then use a dedicated frame for displaying WoMan windows. +If non-@code{nil} 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 non-nil. +default value is non-@code{nil}. @end vtable @@ -1391,29 +1370,29 @@ An integer specifying the right margin for formatted text. Default is 65. @item woman-fill-frame -A boolean value. If non-nil then most of the frame width is used, -overriding the value of @code{woman-fill-column}. Default is nil. +A boolean value. If non-@code{nil} then most of the frame width is used, +overriding the value of @code{woman-fill-column}. Default is @code{nil}. @item 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 Linux man +macros. Default is 5. Set this variable to 7 to emulate GNU/Linux man formatting. @item woman-bold-headings -A boolean value. If non-nil then embolden section and subsection -headings. Default is t. [Heading emboldening is @emph{not} standard -@code{man} behaviour.] +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} behavior.] @item woman-ignore -A boolean value. If non-nil then unrecognised requests etc. are -ignored. Default is t. This gives the standard @code{ROFF} behaviour. +A boolean value. If non-@code{nil} 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. @item woman-preserve-ascii -A boolean value. If non-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 -saved to a file. Default is nil. +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 WoMan emulation, currently either @code{NROFF} or @code{TROFF}. Default @@ -1432,9 +1411,9 @@ man page. @vtable @code @item woman-fontify -A boolean value. If non-nil then WoMan assumes that face support is -available. It defaults to a non-nil value if the display supports -either colours or different fonts. +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 colors or different fonts. @item woman-italic-face Face for italic font in man pages. Default: italic, underlined, @@ -1467,7 +1446,7 @@ 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 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 @@ -1475,11 +1454,11 @@ work on any other platform. @vtable @code @item woman-use-extended-font -A boolean value. If non-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 -A boolean value. If non-nil then WoMan may use the symbol font. +A boolean value. If non-@code{nil} then WoMan may use the symbol font. Default is @code{nil}, mainly because it may change the line spacing (at least in NTEmacs 20). @@ -1502,10 +1481,10 @@ Under MS-Windows, the default is @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-nil (by default it is @code{nil}) then +@code{woman-show-log} is non-@code{nil} (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 @@ -1556,25 +1535,19 @@ If WoMan fails completely, or formats a file incorrectly (i.e.@: 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 @@ -1670,3 +1643,7 @@ Eli Zaretskii, @email{eliz@@is.elta.co.il} @printindex cp @bye + +@ignore + arch-tag: a1a6b715-396f-4378-9b94-0b2ca0aa5028 +@end ignore