README for MHonArc

---------------------------------------------------------------------------
Table of Contents:
        CONTENTS
        DOCUMENTATION
        INSTALLATION
        BUGS/COMMENTS/SUGGESTIONS?

---------------------------------------------------------------------------
    MHonArc -- Internet mail-to-HTML converter
    Copyright (C) 1995	Earl Hood, ehood@convex.com

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
---------------------------------------------------------------------------
CONTENTS

ACKNOWLG	  Thanks to people
CHANGES		  Revision history of MHonArc
COPYING		  GNU General Public License
README		  The file you are reading
README.DOS	  MS-DOS equivalent to README
RELNOTES	  Release notes for MHonArc (*READ*)
TODO		  MHonArc "to do" list
bat/		  Batch files for MS-DOS users
doc/		  Documentation for MHonArc
examples/	  Example resource files for MHonArc
extras/		  Extra programs for use with MHonArc (See extras/README)
install.me	  Installation program for MHonArc
lib/		  Libraries/MIME filters used by MHonArc
logo/		  Gifs of the MHonArc logo
mhonarc*	  The MHonArc Perl program

---------------------------------------------------------------------------
** PLEASE read RELNOTES before running MHonArc.
---------------------------------------------------------------------------
---------------------------------------------------------------------------
DOCUMENTATION

Documentation for MHonArc is located in the doc/ directory.

html:
    The main documentation for MHonArc is in multiple HTML files.  Load
    mhonarc.html in the doc/ directory into your Web browser to get
    started.

ascii:
    A plain text version of the documentation is in the single file
    mhonarc.txt.  This file is created by converting the HTML files
    into ascii.  See the Makefile in doc/ for how the conversion is
    done.

manpage:
    For Unix users, there is a manpage in doc/ called mhonarc.1.  It
    is not very fancy.  It is automatically generated like the
    ascii version.  The manpage does not follow the standard manpage
    style and is not intended to be printed via troff.

    The installation process does not deal with the manpage.  If you
    want to install it, you must do it manually.  The installation
    process does allow you to install the HTML documentation in a
    location of your choice.

---------------------------------------------------------------------------
INSTALLATION

The documentation contains a section on installing MHonArc for Unix
and MS-DOS machines.  I recommend reading the Installation section as
it contains more information then what is included here.

Brief Instructions

    To install MHonArc, run the following command:

	% perl install.me

    The installation process will ask you a series of questions on
    where the Perl executable is and where to put MHonArc files.  Just
    hit <CR> to accept the default values listed in ()'s.

    Notes on installation process:

	o The '#!' line in the installed mhonarc program is set to
	  point to the Perl executable specified in the installation
	  process (this has no meaning under MS-DOS).

	o The installed mhonarc program has code added so it will find
	  its default libraries specified in the installation program.
	  I.e.  The install lib directory is added to mhonarc's search
	  path so it will find its libraries.

	o If you specify paths that do not exist, the install.me
	  program will create the path.


** PLEASE read RELNOTES before running MHonArc.

---------------------------------------------------------------------------
BUGS/COMMENTS/SUGGESTIONS?

    If you have any bugs/comments/suggestions about MHonArc, check the
    Contacts section of the documentation for the proper person to
    contact.

    If it is a bug you are reporting, please include the following in
    your message:

        o  Version of Perl (can be retrievied by "perl -v").
        o  Version of the program in question.
        o  The exact command-line used to invoke the program.
        o  Error/diagnostic messages from the program.
        o  Any other information that might prove useful.

    Before sending e-mail, make sure the documentation does not already
    have an answer to your question/problem.

---------------------------------------------------------------------------
Earl Hood, ehood@convex.com