Installation and Setup
**********************
No installation is necessary if you just want to run the version of
WoMan distributed with GNU Emacs 21 or later, although some additional
setup may still be desirable.
If you are installing `woman.el', either to update the version
distributed with GNU Emacs or because WoMan was not distributed with
your version of Emacs, then you need to put the file in a directory in
your Emacs load path and byte compile it. A good directory to use is
the `site-lisp' directory in your Emacs file tree, e.g.
`/usr/local/share/emacs/VERSION/site-lisp/' (where 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 `.emacs' initialisation
file:
(add-to-list 'load-path "my-lisp")
where `my-lisp' is the pathname of the directory. Note:The Init File
~/.emacs, for further details on customizing Emacs in
general.
You can byte-compile the file by using the Emacs command
`byte-compile-file' or by opening the directory containing the file,
putting point on it and pressing the key `B'. (In fact, if the file is
compiled then it is only the compiled file that needs to be in the
Emacs load path, but leaving the source file there will do no harm.)
Setup
=====
Setup that is either necessary or desirable consists of adding a small
amount of Emacs Lisp code to your `.emacs' initialisation 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 `woman' interface. You may also find it convenient to make
various WoMan menu and key bindings available and to make WoMan
customizable even before WoMan has been loaded.
It is possible to run WoMan from a command line (from outside or even
from inside Emacs) by suitably configuring your command interpreter.