/[emacs]/emacs/man/woman.texi
ViewVC logotype

Diff of /emacs/man/woman.texi

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.8 by eliz, Sat Mar 16 19:33:21 2002 UTC revision 1.8.2.1 by miles, Fri Apr 4 06:20:49 2003 UTC
# Line 2  Line 2 
2  @c $Id$  @c $Id$
3  @c %**start of header  @c %**start of header
4  @setfilename ../info/woman  @setfilename ../info/woman
5  @settitle WoMan: Browse Unix Manual Pages ``Wo (without) Man''  @settitle WoMan: Browse Unix Manual Pages ``W.O. (without) Man''
6  @c Manual last updated:  @c Manual last updated:
7  @set UPDATED Time-stamp: <2001-03-05 17:10:30 eliz>  @set UPDATED Time-stamp: <2002-12-10 14:08:15 pavel>
8  @c Software version:  @c Software version:
9  @set VERSION 0.54 (beta)  @set VERSION 0.54 (beta)
10  @afourpaper  @afourpaper
# Line 14  Line 14 
14  @paragraphindent 0  @paragraphindent 0
15  @c %**end of header  @c %**end of header
16    
17  @dircategory Emacs  @copying
18  @direntry  This file documents WoMan: A program to browse Unix manual pages `W.O.
 * 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  
19  (without) man'.  (without) man'.
20    
21  Copyright @copyright{} 2001  Free Software Foundation, Inc.  Copyright @copyright{} 2001, 2002 Free Software Foundation, Inc.
22    
23    @quotation
24  Permission is granted to copy, distribute and/or modify this document  Permission is granted to copy, distribute and/or modify this document
25  under the terms of the GNU Free Documentation License, Version 1.1 or  under the terms of the GNU Free Documentation License, Version 1.1 or
26  any later version published by the Free Software Foundation; with no  any later version published by the Free Software Foundation; with no
# Line 41  This document is part of a collection di Line 37  This document is part of a collection di
37  Documentation License.  If you want to distribute this document  Documentation License.  If you want to distribute this document
38  separately from the collection, you can do so by adding a copy of the  separately from the collection, you can do so by adding a copy of the
39  license to the document, as described in section 6 of the license.  license to the document, as described in section 6 of the license.
40  @end ifinfo  @end quotation
41    @end copying
42    
43    @dircategory Emacs
44    @direntry
45    * WoMan: (woman).       Browse UN*X Manual Pages "W.O. (without) Man".
46    @end direntry
47    
48  @finalout  @finalout
49    
50  @titlepage  @titlepage
51  @title WoMan  @title WoMan
52  @subtitle Browse Unix Manual Pages ``Wo (without) Man''  @subtitle Browse Unix Manual Pages ``W.O. (without) Man''
53  @subtitle Software Version @value{VERSION}  @subtitle Software Version @value{VERSION}
54  @author Francis J. Wright  @author Francis J. Wright
55  @sp 2  @sp 2
# Line 63  license to the document, as described in Line 65  license to the document, as described in
65  @comment  The following two commands start the copyright page.  @comment  The following two commands start the copyright page.
66  @page  @page
67  @vskip 0pt plus 1filll  @vskip 0pt plus 1filll
68  @noindent  @insertcopying
 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.  
69  @end titlepage  @end titlepage
70    
71  @contents  @contents
# Line 91  license to the document, as described in Line 75  license to the document, as described in
75  @ifnottex  @ifnottex
76  @node Top, Introduction, (dir), (dir)  @node Top, Introduction, (dir), (dir)
77  @comment  node-name,  next,  previous,  up  @comment  node-name,  next,  previous,  up
78  @top WoMan: Browse Unix Manual Pages ``Wo (without) Man''  @top WoMan: Browse Unix Manual Pages ``W.O. (without) Man''
79    
80  @display  @display
81  Software Version @value{VERSION}  Software Version @value{VERSION}
# Line 162  This browser works quite well on simple Line 146  This browser works quite well on simple
146  works less well on idiosyncratic files that ``break the rules'' or use  works less well on idiosyncratic files that ``break the rules'' or use
147  the more obscure @code{ROFF} requests directly.  Current test results  the more obscure @code{ROFF} requests directly.  Current test results
148  are available in the file  are available in the file
149  @uref{http://centaur.maths.qmw.ac.uk/Emacs/WoMan/woman.status,  @uref{http://centaur.maths.qmw.ac.uk/Emacs/WoMan/files/woman.status,
150  @file{woman.status}}.  @file{woman.status}}.
151    
152  WoMan supports the use of compressed man files via  WoMan supports the use of compressed man files via
# Line 295  advantage of the display capabilities av Line 279  advantage of the display capabilities av
279  develop WoMan to take advantage of developments in Emacs itself.  At  develop WoMan to take advantage of developments in Emacs itself.  At
280  present, WoMan uses several display faces to support bold and italic  present, WoMan uses several display faces to support bold and italic
281  text, to indicate other fonts, etc.  The default faces are also  text, to indicate other fonts, etc.  The default faces are also
282  coloured, but the choice of faces is customizable.  WoMan provides menu  colored, but the choice of faces is customizable.  WoMan provides menu
283  support for navigation and mouse support for following references, in  support for navigation and mouse support for following references, in
284  addition to the navigation facilities provided by @code{man} mode.  addition to the navigation facilities provided by @code{man} mode.
285  WoMan has (this) texinfo documentation!  WoMan has (this) texinfo documentation!
# Line 344  the @file{site-lisp} directory in your E Line 328  the @file{site-lisp} directory in your E
328  @var{version} is your Emacs version), provided you have write access to  @var{version} is your Emacs version), provided you have write access to
329  it.  If you use a directory that is not included by default in your  it.  If you use a directory that is not included by default in your
330  Emacs load path then you need to add something like this to your  Emacs load path then you need to add something like this to your
331  @file{.emacs} initialisation file:  @file{.emacs} initialization file:
332    
333  @lisp  @lisp
334  (add-to-list 'load-path "my-lisp")  (add-to-list 'load-path "my-lisp")
# Line 365  harm.) Line 349  harm.)
349  @heading Setup  @heading Setup
350    
351  Setup that is either necessary or desirable consists of adding a small  Setup that is either necessary or desirable consists of adding a small
352  amount of Emacs Lisp code to your @file{.emacs} initialisation file.  It  amount of Emacs Lisp code to your @file{.emacs} initialization file.  It
353  may be necessary (or at least convenient) to make WoMan autoload (if you  may be necessary (or at least convenient) to make WoMan autoload (if you
354  are not running GNU Emacs 21 or later) and to set the search path used  are not running GNU Emacs 21 or later) and to set the search path used
355  by the @code{woman} interface.  You may also find it convenient to make  by the @code{woman} interface.  You may also find it convenient to make
# Line 453  loaded, then add the following to your @ Line 437  loaded, then add the following to your @
437    
438  (By default, WoMan will automatically define the dired keys @kbd{W} and  (By default, WoMan will automatically define the dired keys @kbd{W} and
439  @kbd{w} when it loads, but only if they are not already defined.  This  @kbd{w} when it loads, but only if they are not already defined.  This
440  behaviour is controlled by the user option @code{woman-dired-keys}.  behavior is controlled by the user option @code{woman-dired-keys}.
441  Note that the @code{dired-x} (dired extra) package binds  Note that the @code{dired-x} (dired extra) package binds
442  @code{dired-copy-filename-as-kill} to the key @kbd{w}, although @kbd{W}  @code{dired-copy-filename-as-kill} to the key @kbd{w}, although @kbd{W}
443  appears to be unused.  The @code{dired-x} package will over-write the  appears to be unused.  The @code{dired-x} package will over-write the
# Line 488  file: Line 472  file:
472  If you really want to square the man-woman circle then you can!  If you  If you really want to square the man-woman circle then you can!  If you
473  run the GNU command interpreter @code{bash} then you might care to  run the GNU command interpreter @code{bash} then you might care to
474  define the following @code{bash} function in your @code{bash}  define the following @code{bash} function in your @code{bash}
475  initialisation file @file{.bashrc}:  initialization file @file{.bashrc}:
476    
477  @example  @example
478  man() @{ gnudoit -q '(raise-frame (selected-frame)) (woman' \"$1\" ')' ; @}  man() @{ gnudoit -q '(raise-frame (selected-frame)) (woman' \"$1\" ')' ; @}
# Line 1396  formatting. Line 1380  formatting.
1380  @item woman-bold-headings  @item woman-bold-headings
1381  A boolean value.  If non-@code{nil} then embolden section and subsection  A boolean value.  If non-@code{nil} then embolden section and subsection
1382  headings.  Default is @code{t}.  [Heading emboldening is @emph{not} standard  headings.  Default is @code{t}.  [Heading emboldening is @emph{not} standard
1383  @code{man} behaviour.]  @code{man} behavior.]
1384    
1385  @item woman-ignore  @item woman-ignore
1386  A boolean value.  If non-@code{nil} then unrecognised requests etc. are  A boolean value.  If non-@code{nil} then unrecognised requests etc. are
1387  ignored.  Default is @code{t}.  This gives the standard @code{ROFF} behaviour.  ignored.  Default is @code{t}.  This gives the standard @code{ROFF} behavior.
1388  If @code{nil} then they are left in the buffer, which may aid debugging.  If @code{nil} then they are left in the buffer, which may aid debugging.
1389    
1390  @item woman-preserve-ascii  @item woman-preserve-ascii
# Line 1428  man page. Line 1412  man page.
1412  @item woman-fontify  @item woman-fontify
1413  A boolean value.  If non-@code{nil} then WoMan assumes that face support is  A boolean value.  If non-@code{nil} then WoMan assumes that face support is
1414  available.  It defaults to a non-@code{nil} value if the display supports  available.  It defaults to a non-@code{nil} value if the display supports
1415  either colours or different fonts.  either colors or different fonts.
1416    
1417  @item woman-italic-face  @item woman-italic-face
1418  Face for italic font in man pages.  Default: italic, underlined,  Face for italic font in man pages.  Default: italic, underlined,
# Line 1496  Under MS-Windows, the default is Line 1480  Under MS-Windows, the default is
1480  @cindex log buffer  @cindex log buffer
1481  @cindex buffer, log  @cindex buffer, log
1482    
1483  This is modelled on the Emacs byte-compiler.  It logs all files  This is modeled on the Emacs byte-compiler.  It logs all files
1484  formatted by WoMan and the time taken.  If WoMan finds anything that it  formatted by WoMan and the time taken.  If WoMan finds anything that it
1485  cannot handle then it writes a warning to this buffer.  If the variable  cannot handle then it writes a warning to this buffer.  If the variable
1486  @code{woman-show-log} is non-@code{nil} (by default it is @code{nil}) then  @code{woman-show-log} is non-@code{nil} (by default it is @code{nil}) then
# Line 1550  If WoMan fails completely, or formats a Line 1534  If WoMan fails completely, or formats a
1534  obviously wrongly or significantly differently from @code{man}) or  obviously wrongly or significantly differently from @code{man}) or
1535  inelegantly, then please  inelegantly, then please
1536    
1537  @enumerate a  @enumerate
1538  @item  @item
1539  check that you are running the latest version of @file{woman.el}  try the latest version of @file{woman.el} from the Emacs CVS repository
1540  available from @uref{http://centaur.maths.qmw.ac.uk/Emacs/WoMan/, my web  on @uref{http://savannah.gnu.org/}.  If it still fails, please
 site}, and  
1541    
1542  @item  @item
1543  check that the problem is not already described in the file  send a bug report to @email{bug-gnu-emacs@@gnu.org} and to
1544  @file{woman.status}, also available from  @email{F.J.Wright@@qmw.ac.uk}.  Please include the entry from the
1545  @uref{http://centaur.maths.qmw.ac.uk/Emacs/WoMan/, my web site}.  @code{*WoMan-Log*} buffer relating to the problem file, together with
1546    a brief description of the problem.  Please indicate where you got the
1547    man source file from, but do not send it unless asked to send it.
1548  @end enumerate  @end enumerate
1549    
 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.)  
   
1550  @c ===================================================================  @c ===================================================================
1551    
1552  @node Acknowledgements, Command Index, Bugs, Top  @node Acknowledgements, Command Index, Bugs, Top

Legend:
Removed from v.1.8  
changed lines
  Added in v.1.8.2.1

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26