1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
|
* 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 d 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, as well 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.
This version of the MH-E documentation will appear in GNU Emacs 21.2.
* 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-2.0.tgz
** Build the desired documentation.
The Texinfo source can produce documentation in Emacs' info format,
HTML format for viewing via a browser, and DVI and PostScript formats
for printing.
First, go into the mh-e-doc-2.0 directory and then follow the
appropriate directions below.
*** info
Run `make mh-e.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.
Go into Emacs and run "C-u C-h i /path/to/mh-e-doc-2.0/info/mh-e RET"
to view the documentation.
*** HTML
Run `make mh-e.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 `texi2html' and `perl' to do this.
Use a browser and point it at "/path/to/mh-e-doc-2.0/html/index.html"
to view the documentation.
*** DVI
Run `make mh-e.dvi'. This creates a sub-directory called `dvi', builds
the DVI version of the documentation, and deposits it in that
directory. You need the program `texi2dvi' to do this.
You can then either view the documentation with a tool such as `xdvi'
or print it. The file is "/path/to/mh-e-doc-2.0/dvi/mh-e.dvi".
*** PostScript
Run `make mh-e.dvi'. This creates a sub-directory called `dvi', builds
the DVI version of the documentation, and deposits it in that
directory. You need the programs `texi2dvi' and `dvips' to do this.
You can then either view the documentation with a tool such as `gv'
or print it. The file is "/path/to/mh-e-doc-2.0/dvi/mh-e.ps".
*** Everything
Run `make', without any arguments.
* ADDITIONAL INFORMATION
** This documentation is also available in the following forms:
*** info
The info pages can be found by running the following command within
Emacs:
C-h i d m mh-e RET
*** HTML
An online version of the documentation is available here:
http://www.ics.uci.edu/~mh/book/mh-e/
*** 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:
https://mh-e.sourceforge.net/.
Local variables:
mode: outline
paragraph-separate: "[ ]*$"
end:
$Id: README,v 1.2 2002/11/01 22:12:22 wohler Exp $
|