---------------------------------------------------------------------------
                            README for MHonArc
                                 v2.0.0

             http://www.oac.uci.edu/indiv/ehood/mhonarc.html

---------------------------------------------------------------------------
    MHonArc -- Internet mail-to-HTML converter
    Copyright (C) 1995-1997   Earl Hood, ehood@medusa.acs.uci.edu

    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
RELNOTES          Release notes for MHonArc (please read)
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.cfg       Base installation configuration file
install.me        Installation program for MHonArc
lib/              Libraries/MIME filters used by MHonArc
logo/             Gifs of the MHonArc logo
mhonarc*          The MHonArc program

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

    NOTE
        Installation has changed slightly from 1.x releases.  Please
        read the following instructions if you are familiar with
        the 1.x installation process.

This section gives the basic method for installing MHonArc on a Unix or
MS-DOS/Windows system.

Instructions

    Interactive Installing:

        Run the following command:

            perl install.me

        The installation program 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.

    Batch Install:

        1. Edit the file 'install.cfg'.  Knowledge of Perl is helpful.
        2. Run the following command:

            perl install.me batch

        The installation program will output information on what
        is being installed and where it is being installed.

Notes on Installation Program

    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 ONLY if running in interactive
      mode.  If running in batch mode, you must check that all paths
      specified exist.

    o MSDOS/Windows users: You many need to create a batch file
      for easy invocation of MHonArc.  An example batch file
      exists in the bat/ directory of the distribution.

---------------------------------------------------------------------------
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.

    Filenames of the documentation do NOT follow the 8.3 convention.
    Therefore, you will need a filesystem that supports long names
    to read the documentation locally.

    Some tables are used in the documentation.  Therefore, having
    a table-capable viewer is beneficial.  If your viewer does
    not recognize tables, the documentation should still be
    usable.

---------------------------------------------------------------------------
MAILING LIST

    A MHonArc mailing list exists to provide a general discussion
    forum for users and developers.  The list is the main source for
    the latest news about MHonArc.

    To subscribe to the mailing list, send mail to
    mhonarc-request@rosat.mpe-garching.mpg.de with the single word
    "subscribe" (without the quotes) as the message body.

    Mail sent to mhonarc@rosat.mpe-garching.mpg.de will be distributed
    to all subscribers.

    The WWW archive of the mailing list is located at
    <URL:http://www.rosat.mpe-garching.mpg.de/mailing-lists/mhonarc/>,
    and is searchable via a Glimpse search engine.

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

    If you have any bugs/comments/suggestions about MHonArc, you may
    send mail to the MHonArc mailing list,
    mhonarc@rosat.mpe-garching.mpg.de.

    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.
        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 (eg. input
           files, resource files, environment settings, etc.

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

---------------------------------------------------------------------------
USING/COPYING

    MHonArc is free to use, but feel free to send the author a donation
    if you feel guilty on using a program that that cost you nothing,
    but some poor soul sweated over.  The author is more than happy
    to provide address information to prospective donors inorder to
    ease their conscience.

    MHonArc is distributed under the GNU General Public License.
    The rules for using and copying MHonArc are explained in the
    file COPYING.

---------------------------------------------------------------------------
Copyright (C) 1997,     Earl Hood, ehood@medusa.acs.uci.edu
@(#) README 97/02/24 12:26:45 @(#)
