* INTRODUCTION

This is the documentation for MH-E, a GNU Emacs interface to the MH
mail system.

Emacs comes prepackaged with MH-E; the files in this package may be
more recent however. To ascertain the version of MH-E in your version
of Emacs and to determine whether it is necessary to install these
files, run the command "C-h i m mh-e RET" within Emacs. This should
bring you to the top of the MH-E documentation which shows the version
of the documentation which is the same as the version of the software
for which it was written. Use the command "M-x mh-version" within
Emacs to see which version of the software you are running. If this
package contains a more recent version of the MH-E documentation which
is compatible with the version of the software that you're running,
read on.

The CVS MH-E manual is built into CVS Emacs, so if you use CVS Emacs,
then you have no need of this release. You are already have the latest
version of the manual.

This version of the MH-E documentation will appear in GNU Emacs 22.1.



* INSTALL

** Extract the tarball.

If you don't have GNU tar, use gzip to uncompress the tarball and drop
the `z' option.

	tar xzf mh-e-doc-8.0.3.tgz

** Build the desired documentation.

The Texinfo source can produce documentation in Emacs' info format,
HTML format for viewing via a browser, and PDF formats for printing.

First, go into the mh-e-doc-8.0.3 directory and then follow the
appropriate directions below.

*** info

Run `make info'. This creates a sub-directory called `info', builds
the info version of the documentation, and deposits it in that
directory. You need the program `makeinfo' to do this.

To view the Info node `mh-e', Find out where your existing info files
are located. Assuming your existing info files are in
`/usr/share/info', set the INFOPATH environment variable to:

	/path/to/mh-e-doc-8.0.3/info:/usr/share/info

Then run "C-h i g (mh-e) RET" (in Emacs).

*** HTML

Run `make html'. This creates a sub-directory called `html', builds
the HTML version of the documentation, and deposits it in that
directory. You need the programs `makeinfo' to do this.

Use a browser and point it at "/path/to/mh-e-doc-8.0.3/html/index.html"
to view the documentation.

*** PDF

Run `make pdf'. This builds the PDF version of the documentation, and
names it `mh-e.pdf'. You need the program `texi2pdf', `makeinfo', and
`pdftex' or `pdfetex' to do this.

You can then either view the documentation with a tool such as `gv',
`gpdf', `ggv', `xpdf', or print it. The file is
"/path/to/mh-e-doc-8.0.3/pdf/mh-e.pdf".

*** Everything

Run `make all' or just `make'.



* CVS MH-E MANUAL INSTALL

After checking out the doc module, you must run `make man/mh-e.texi'
or just `make' to check out the rest of the module from Savannah. Then
follow the steps that apply to you in INSTALL above.

Developers can run `make CVSMETHOD=ext CVSLOGIN=$USER man/mh-e.texi'
assuming the $USER environment variable is the same as their Savannah
login.



* ADDITIONAL INFORMATION

** This documentation is also available in the following forms:

*** HTML & PDF

An online version of the documentation is available here:

	http://mh-e.sourceforge.net/manual/

*** Source

The source for the documentation can be obtained here:

	https://sourceforge.net/project/showfiles.php?group_id=13357

** Mailing Lists, Bug Reports and other Support

Please see http://mh-e.sourceforge.net/.


Local variables:
mode: outline
paragraph-separate: "[ 	]*$"
end:

$Id: README,v 1.10 2006/11/13 05:26:12 wohler Exp $
