\input texinfo @c -*-texinfo-*-
@c %**start of header
-@setfilename ../../info/woman
+@setfilename ../../info/woman.info
@settitle WoMan: Browse Unix Manual Pages ``W.O. (without) Man''
-@c FIXME
-@c Manual last updated:
-@set UPDATED Time-stamp: <2012-12-31 21:44:20 eggert>
-@c Software version:
-@set VERSION 0.54 (beta)
+@include emacsver.texi
@afourpaper
@c With different size paper the printed page breaks will need attention!
@c Look for @page and @need commands.
@setchapternewpage off
@paragraphindent 0
+@documentencoding UTF-8
@c %**end of header
@copying
This file documents WoMan: A program to browse Unix manual pages `W.O.
(without) man'.
-Copyright @copyright{} 2001--2013 Free Software Foundation, Inc.
+Copyright @copyright{} 2001--2014 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.3 or
any later version published by the Free Software Foundation; with no
-Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
+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.''
@titlepage
@title WoMan
@subtitle Browse Unix Manual Pages ``W.O. (without) Man''
-@subtitle Software Version @value{VERSION}
+@subtitle as distributed with Emacs @value{EMACSVER}
@author Francis J. Wright
@sp 2
@author School of Mathematical Sciences
@author @email{F.J.Wright@@qmul.ac.uk}
@author @uref{http://centaur.maths.qmw.ac.uk/}
@c He no longer maintains this manual.
-@sp 2
-@author Manual Last Updated @value{UPDATED}
@comment The following two commands start the copyright page.
@page
@c ===================================================================
@ifnottex
-@node Top, Introduction, (dir), (dir)
-@comment node-name, next, previous, up
+@node Top
@top WoMan: Browse Unix Manual Pages ``W.O. (without) Man''
@display
-Software Version @value{VERSION}
-Manual Last Updated @value{UPDATED}
+As distributed with Emacs @value{EMACSVER}.
+@ifnothtml
@email{F.J.Wright@@qmw.ac.uk, Francis J. Wright}
+@end ifnothtml
+@ifhtml
+Francis J. Wright
+@end ifhtml
@uref{http://centaur.maths.qmw.ac.uk/, School of Mathematical Sciences}
Queen Mary and Westfield College (University of London)
Mile End Road, London E1 4NS, UK
@c ===================================================================
-@node Introduction, Background, Top, Top
-@comment node-name, next, previous, up
+@node Introduction
@chapter Introduction
@cindex introduction
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
-@uref{http://centaur.maths.qmw.ac.uk/Emacs/WoMan/, the WoMan web
-server}.
+WoMan is distributed with GNU Emacs.
WoMan implements a subset of the formatting performed by the Emacs
@code{man} (or @code{manual-entry}) command to format a Unix-style
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
-adding and improving functionality as testing shows that it is
-necessary. Guidance on reporting bugs is given below. @xref{Bugs, ,
-Reporting Bugs}.
+Guidance on reporting bugs is given below. @xref{Bugs, , Reporting Bugs}.
@c ===================================================================
-@node Background, Finding, Introduction, Top
-@comment node-name, next, previous, up
+@node Background
@chapter Background
@cindex background
and man can happily co-exist, which is very useful for comparison and
debugging purposes.
+@ignore
@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
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.
+@end ignore
-@node Finding, Browsing, Background, Top
-@comment node-name, next, previous, up
+@node Finding
@chapter Finding and Formatting Man Pages
@cindex using, finding man pages
@cindex using, formatting man pages
* Automatic:: Automatic Interface
@end menu
-@node Topic, Filename, Finding, Finding
-@comment node-name, next, previous, up
+@node Topic
@section Topic Interface
@cindex topic interface
* Word at point:: Using the "Word at Point" as a Topic Suggestion
@end menu
-@node Cache, Word at point, Topic, Topic
-@comment node-name, next, previous, up
+@node Cache
@subsection The WoMan Topic Cache
@cindex topic cache
@cindex cache, topic
time it is run in a new Emacs session.
-@node Word at point, , Cache, Topic
-@comment node-name, next, previous, up
+@node Word at point
@subsection Using the "Word at Point" as a Topic Suggestion
@cindex word at point
@cindex point, word at
@end lisp
-@node Filename, Automatic, Topic, Finding
-@comment node-name, next, previous, up
+@node Filename
@section Filename Interface
@cindex filename interface
primarily used internally by WoMan.
-@node Automatic, , Filename, Finding
-@comment node-name, next, previous, up
+@node Automatic
@section Automatic Interface
@cindex automatic interface
@c ===================================================================
-@node Browsing, Customization, Finding, Top
-@comment node-name, next, previous, up
+@node Browsing
@chapter Browsing Man Pages
@cindex using, browsing man pages
@cindex browsing man pages
* Imenu:: Imenu Support; Contents Menu
@end menu
-@node Fonts, Navigation, Browsing, Browsing
-@comment node-name, next, previous, up
+@node Fonts
@section Fonts and Faces
@cindex fonts
@cindex faces
sub-scripts, which are not displayed well by WoMan.
-@node Navigation, References, Fonts, Browsing
-@comment node-name, next, previous, up
+@node Navigation
@section Navigation
@cindex navigation
Scroll the man page up the window (@code{scroll-up}).
@item @key{DEL}
+@itemx @kbd{S-@key{SPC}}
@kindex DEL
+@kindex S-SPC
@findex scroll-down
Scroll the man page down the window (@code{scroll-down}).
@end table
-@node References, Changing, Navigation, Browsing
-@comment node-name, next, previous, up
+@node References
@section Following References
@cindex following references
@cindex references
@end table
-@node Changing, Convenience, References, Browsing
-@comment node-name, next, previous, up
+@node Changing
@section Changing the Current Man Page
@cindex changing current man page
@cindex current man page, changing
@end table
-@node Convenience, Imenu, Changing, Browsing
-@comment node-name, next, previous, up
+@node Convenience
@section Convenience Key Bindings
@cindex convenience key bindings
@cindex key bindings, convenience
@end table
-@node Imenu, , Convenience, Browsing
-@comment node-name, next, previous, up
+@node Imenu
@section Imenu Support; Contents Menu
@cindex imenu support
@cindex contents menu
this by customizing @code{woman-imenu-generic-expression}.
WoMan is configured not to replace spaces in an imenu
-@code{*Completion*} buffer. For further documentation on the use of
+@file{*Completion*} 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.
@c ===================================================================
-@node Customization, Log, Browsing, Top
-@comment node-name, next, previous, up
+@node Customization
@chapter Customization
@cindex customization
@vtable @code
@item woman-show-log
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
+@file{*WoMan-Log*} buffer if appropriate, i.e., if any warning messages
are written to it. @xref{Log, , The *WoMan-Log* Buffer}.
@item woman-pre-format-hook
* Special symbols::
@end menu
-@node Interface Options, Formatting Options, Customization, Customization
-@comment node-name, next, previous, up
+@node Interface Options
@section Interface Options
@cindex interface options
@noindent
[for GNU/Linux and Cygwin respectively.] A trailing separator (@file{/}
-for UNIX etc.) on directories is optional and the filename matched if a
+for UNIX etc.)@: on directories is optional and the filename matched if a
directory is specified is the first to match the regexp
@code{man.*\.conf}. If the environment variable @code{MANPATH} is not
set but a configuration file is found then it is parsed instead (or as
@end vtable
-@node Formatting Options, Faces, Interface Options, Customization
-@comment node-name, next, previous, up
+@node Formatting Options
@section Formatting Options
@cindex formatting options
@end vtable
-@node Faces, Special symbols, Formatting Options, Customization
-@comment node-name, next, previous, up
+@node Faces
@section Faces
@cindex faces
@end vtable
-@node Special symbols, , Faces, Customization
-@comment node-name, next, previous, up
+@node Special symbols
@section Special symbols
@cindex special symbols
@c ===================================================================
-@node Log, Technical, Customization, Top
-@comment node-name, next, previous, up
+@node Log
@chapter The *WoMan-Log* Buffer
@cindex log buffer
@cindex buffer, log
@c ===================================================================
-@node Technical, Bugs, Log, Top
-@comment node-name, next, previous, up
+@node Technical
@chapter Technical Details
@cindex technical details
@cindex horizontal spacing
@c ===================================================================
-@node Bugs, Acknowledgments, Technical, Top
-@comment node-name, next, previous, up
+@node Bugs
@chapter Reporting Bugs
@cindex reporting bugs
@cindex bugs, reporting
on @uref{http://savannah.gnu.org/projects/emacs/}. If it still fails, please
@item
-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
+use @kbd{M-x report-emacs-bug} to send a bug report.
+Please include the entry from the
+@file{*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
@c ===================================================================
-@node Acknowledgments, GNU Free Documentation License, Bugs, Top
-@comment node-name, next, previous, up
+@node Acknowledgments
@chapter Acknowledgments
@cindex acknowledgments
fragments, general interest, etc.:
@quotation
-Jari Aalto, @email{jari.aalto@@cs.tpu.fi}@*
-Dean Andrews, @email{dean@@dra.com}@*
-Juanma Barranquero, @email{barranquero@@laley-actualidad.es}@*
-Karl Berry, @email{kb@@cs.umb.edu}@*
-Jim Chapman, @email{jchapman@@netcomuk.co.uk}@*
-Frederic Corne, @email{frederic.corne@@erli.fr}@*
-Peter Craft, @email{craft@@alacritech.com}@*
-Charles Curley, @email{ccurley@@trib.com}@*
-Jim Davidson, @email{jdavidso@@teknowledge.com}@*
-Kevin D'Elia, @email{Kevin.DElia@@mci.com}@*
-John Fitch, @email{jpff@@maths.bath.ac.uk}@*
-Hans Frosch, @email{jwfrosch@@rish.b17c.ingr.com}@*
-Guy Gascoigne-Piggford, @email{ggp@@informix.com}@*
-Brian Gorka, @email{gorkab@@sanchez.com}@*
-Nicolai Henriksen, @email{nhe@@lyngso-industri.dk}@*
-Thomas Herchenroeder, @email{the@@software-ag.de}@*
-Alexander Hinds, @email{ahinds@@thegrid.net}@*
-Stefan Hornburg, @email{sth@@hacon.de}@*
-Theodore Jump, @email{tjump@@cais.com}@*
-Paul Kinnucan, @email{paulk@@mathworks.com}@*
-Jonas Linde, @email{jonas@@init.se}@*
-Andrew McRae, @email{andrewm@@optimation.co.nz}@*
-Howard Melman, @email{howard@@silverstream.com}@*
-Dennis Pixton, @email{dennis@@math.binghamton.edu}@*
-T. V. Raman, @email{raman@@Adobe.com}@*
-Bruce Ravel, @email{bruce.ravel@@nist.gov}@*
-Benjamin Riefenstahl, @email{benny@@crocodial.de}@*
-Kevin Ruland, @email{kruland@@seistl.com}@*
-Tom Schutter, @email{tom@@platte.com}@*
-Wei-Xue Shi, @email{wxshi@@ma.neweb.ne.jp}@*
-Fabio Somenzi, @email{fabio@@joplin.colorado.edu}@*
-Karel Sprenger, @email{ks@@ic.uva.nl}@*
-Chris Szurgot, @email{szurgot@@itribe.net}@*
-Paul A. Thompson, @email{pat@@po.cwru.edu}@*
-Arrigo Triulzi, @email{arrigo@@maths.qmw.ac.uk}@*
-Geoff Voelker, @email{voelker@@cs.washington.edu}@*
-Eli Zaretskii, @email{eliz@@is.elta.co.il}
+@c jari.aalto@@cs.tpu.fi
+Jari Aalto,
+@c dean@@dra.com
+Dean Andrews,
+@c barranquero@@laley-actualidad.es
+Juanma Barranquero,
+@c kb@@cs.umb.edu
+Karl Berry,
+@c jchapman@@netcomuk.co.uk
+Jim Chapman,
+@c frederic.corne@@erli.fr
+Frederic Corne,
+@c craft@@alacritech.com
+Peter Craft,
+@c ccurley@@trib.com
+Charles Curley,
+@c jdavidso@@teknowledge.com
+Jim Davidson,
+@c Kevin.DElia@@mci.com
+Kevin D'Elia,
+@c jpff@@maths.bath.ac.uk
+John Fitch,
+@c jwfrosch@@rish.b17c.ingr.com
+Hans Frosch,
+@c ggp@@informix.com
+Guy Gascoigne-Piggford,
+@c gorkab@@sanchez.com
+Brian Gorka,
+@c nhe@@lyngso-industri.dk
+Nicolai Henriksen,
+@c the@@software-ag.de
+Thomas Herchenroeder,
+@c ahinds@@thegrid.net
+Alexander Hinds,
+@c sth@@hacon.de
+Stefan Hornburg,
+@c tjump@@cais.com
+Theodore Jump,
+@c paulk@@mathworks.com
+Paul Kinnucan,
+@c jonas@@init.se
+Jonas Linde,
+@c andrewm@@optimation.co.nz
+Andrew McRae,
+@c howard@@silverstream.com
+Howard Melman,
+@c dennis@@math.binghamton.edu
+Dennis Pixton,
+@c raman@@Adobe.com
+T. V. Raman,
+@c bruce.ravel@@nist.gov
+Bruce Ravel,
+@c benny@@crocodial.de
+Benjamin Riefenstahl,
+@c kruland@@seistl.com
+Kevin Ruland,
+@c tom@@platte.com
+Tom Schutter,
+@c wxshi@@ma.neweb.ne.jp
+Wei-Xue Shi,
+@c fabio@@joplin.colorado.edu
+Fabio Somenzi,
+@c ks@@ic.uva.nl
+Karel Sprenger,
+@c szurgot@@itribe.net
+Chris Szurgot,
+@c pat@@po.cwru.edu
+Paul A. Thompson,
+@c arrigo@@maths.qmw.ac.uk
+Arrigo Triulzi,
+@c voelker@@cs.washington.edu
+Geoff Voelker,
+@c eliz@@is.elta.co.il
+Eli Zaretskii
@end quotation
@c ===================================================================
@page
-@node GNU Free Documentation License, Command Index, Acknowledgments, Top
+@node GNU Free Documentation License
@appendix GNU Free Documentation License
@include doclicense.texi
-@node Command Index, Variable Index, GNU Free Documentation License, Top
-@comment node-name, next, previous, up
+@node Command Index
@unnumbered Command Index
@printindex fn
-@node Variable Index, Keystroke Index, Command Index, Top
-@comment node-name, next, previous, up
+@node Variable Index
@unnumbered Variable Index
@printindex vr
@page
-@node Keystroke Index, Concept Index, Variable Index, Top
-@comment node-name, next, previous, up
+@node Keystroke Index
@unnumbered Keystroke Index
@printindex ky
@page
-@node Concept Index, , Keystroke Index, Top
-@comment node-name, next, previous, up
+@node Concept Index
@unnumbered Concept Index
@printindex cp