<HTML>
<HEAD>
<TITLE>MHonArc Reference -- Installation</TITLE>
<link rel="stylesheet" type="text/css" href="docstyles.css">
</HEAD>
<BODY>
<!--X-NavButtons-Start-->
<table width="100%">
<tr valign="top">
<td align="left"><nobr><a href="relnotes.html"><img src="prev.png"border=0 alt="[Prev]"></a> </nobr></td><td align="center" width="99%"><a href="mhonarc.html"><img src="up.png" border=0 alt="[TOC]"></a><a href="faq/faq.html"><img src="faq.png" border=0 alt="[FAQ]"></a><a href="app-bugs.html"><img src="bug.png" border=0 alt="[Bugs]"></a><a href="http://www.mhonarc.org/"><img src="home.png" border=0 alt="[Home]"></a></td><td align="right"><nobr> <a href="quickstart.html"><img src="next.png" border=0 alt="[Next]"></a></nobr></td></tr></table>
<!--X-NavButtons-End-->
<HR>
<H1><a name="installation">Installation</a></H1>
<p>The following section describes how to install MHonArc on your
system.
</p>
<table class="note" width="100%">
<tr valign="baseline">
<td><strong>NOTE:</strong></td>
<td width="100%"><p>Make sure to read the
<a href="relnotes.html">release notes</a> before installing MHonArc,
especially if you are upgrading from a previous release. If you
are reading the text version of this installation document, a text
version of the release notes, <tt>RELNOTES</tt>,
exists within the root of the MHonArc distribution.
</p>
</td>
</tr>
</table>
<!--X-TOC-Start-->
<ul>
<li><a href="#impatient">For the Impatient</a>
<li><a href="#sysreqs">System Requirements</a>
<li><a href="#download">Downloading MHonArc</a>
<li><a href="#extraction">Extracting the MHonArc Distribution</a>
<li><a href="#installingviainstallme">Installing with <tt>install.me</tt></a>
<ul>
<li><small><a href="#installmenotes"><tt>install.me</tt> Notes</a></small>
</ul>
<li><a href="#p5install">The Perl 5 Way</a>
<li><a href="#win32">Win32 Notes</a>
<li><a href="#altos">Alternate Operating Systems</a>
<li><a href="#manual">Manual Installation</a>
<li><a href="#postinstall">Post Installation Configuration</a>
<ul>
<li><small><a href="#siterc">Default Resource File</a></small>
<li><small><a href="#sitelib">Site Initialization Library</a></small>
</ul>
<li><a href="#rcfileedit">Resource File Editing</a>
</ul>
<!--X-TOC-End-->
<!-- *************************************************************** -->
<hr>
<h2><a name="impatient">For the Impatient</a></h2>
<p>If you cannot wait to get going, try the following:
</p>
<table border="1" width="100%"><tr><td><pre class="shell">
prompt> <b>wget 'http://www.mhonarc.org/release/MHonArc/MHonArc<var>X.X.X</var>'</b>
prompt> <b>gzip -dc MHonArc<var>X.X.X</var> | tar xvf -</b>
prompt> <b>cd MHonArc<var>X.X.X</var></b>
prompt> <b>perl install.me</b>
</pre></td></tr></table>
<p>where <tt><var>X.X.X</var></tt> represents the version number.</p>
<p>If there were problems doing the above, then keep reading.
</p>
<!-- *************************************************************** -->
<hr>
<h2><a name="sysreqs">System Requirements</a></h2>
<p>The following is required to run MHonArc:
</p>
<ul>
<li><p>Perl 5 is installed. If you do not have Perl 5, goto
<a href="http://language.perl.com/"
><http://language.perl.com/></a> for download information.
Perl versions 5.004 and later are recommended.
</p>
</li>
<li><p>The following standard modules are installed:
</p>
<ul>
<li><b>Fcntl</b></li>
<li><b>File::Basename</b></li>
<li><b>Getopt::Long</b></li>
<li><b>Symbol</b></li>
<li><b>Time::Local</b></li>
</ul>
<p> </p>
<table class="note" width="100%">
<tr valign="baseline">
<td><strong>NOTE:</strong></td>
<td width="100%">
<p>The <a href="#installingviainstallme">installation program</a>
will verify that required modules are installed.
</p>
</td>
</tr>
</table>
</li>
<li><p>The following modules are optional:
</p>
<ul>
<li><p><b>Digest::MD5</b>: Used for creating IDs for messages without
message-ids. This module helps MHonArc detect already
archived messages for messages without message-ids.
</p>
</li>
</ul>
<p>MHonArc will still function if the above listed modules are
not available.
</p>
</li>
</ul>
<!-- *************************************************************** -->
<hr>
<h2><a name="download">Downloading MHonArc</a></h2>
<p>The homepage for MHonArc is
<A HREF="http://www.mhonarc.org/"
><http://www.mhonarc.org/></A>. The homepage
list various sites that you can download MHonArc. If you are
familiar with
<a href="http://www.perl.com/CPAN/">Comprehensive Perl Archive Network
(CPAN)</a>, MHonArc can be downloaded from
<a href="http://www.perl.com/CPAN/authors/id/EHOOD/"
><http://www.perl.com/CPAN/authors/id/EHOOD/></a>.
</p>
<p>MHonArc is distributed in the following formats:
</p>
<ul>
<li><b>tar-bz2</b>: <tt>MHonArc<var>X.X.X</var>.tar.bz2</tt>
</li>
<li><b>tar-gzip</b>: <tt>MHonArc<var>X.X.X</var>.tar.gz</tt>
</li>
<li><b>zip</b>: <tt>MHonArc<var>X.X.X</var>.zip</tt>
</li>
</ul>
<p>where <tt><var>X.X.X</var></tt> represents the version number.
</p>
<p>Alternate distribution formats for MHonArc may be available, like
Linux RPM. Alternate distribution formats are not covered in this
document.
</p>
<!-- *************************************************************** -->
<hr>
<h2><a name="extraction">Extracting the MHonArc Distribution</a></h2>
<p>After downloading MHonArc, it is best to move the file to a
temporary location for extraction. To extract the distribution
under Unix-like systems, use one of the following commands based upon the
distribution format you downloaded:
</p>
<dl>
<dt><b>tar-bz2</b></dt>
<dd><table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>bzip2 -dc MHonArc<var>X.X.X</var>.tar.bz2 | tar xvf -</b></pre></td></tr></table>
<dt><b>tar-gzip</b></dt>
<dd><table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>gzip -dc MHonArc<var>X.X.X</var>.tar.gz | tar xvf -</b></pre></td></tr></table>
</dd>
<dt><b>zip</b></dt>
<dd><table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>unzip MHonArc<var>X.X.X</var>.zip</b></pre></td></tr></table>
</dd>
</dl>
<p>For Win32 systems, you can use a program like <em>WinZip</em> to
extract the tar-gzip or zip formats. If using
<a href="http://www.cygwin.com/">Cygwin</a>, you can use
the Unix-based extraction methods.
</p>
<table class="note" width="100%">
<tr valign="baseline">
<td><strong>NOTE:</strong></td>
<td width="100%"><p>If your are using
<a href="http://www.cygwin.com/">Cygwin</a> and the
cygwin build of Perl, then the installation and usage of MHonArc is
the same as a Unix-based environment. MHonArc treats the
cygwin environment as a Unix-type environment.
</p>
</td>
</tr>
</table>
<p>After extraction, the subdirectory <tt>MHonArc<var>X.X.X</var></tt> will
have been created containing all the files comprising MHonArc.
</p>
<table class="note" width="100%">
<tr valign="baseline">
<td><strong>NOTE:</strong></td>
<td width="100%"><p>Please read the <a href="relnotes.html">release notes</a>
before continuing for any news about compatibility
with previous versions and/or important usage information.
</p>
</td>
</tr>
</table>
<p>Now, change your current directory to <tt>MHonArc<var>X.X.X</var></tt>
for the <a href="#installingfiles">next step</a>. On a Unix-type
system, the following command will do it:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>cd MHonArc<var>X.X.X</var></b>
</pre></td></tr></table>
<!-- *************************************************************** -->
<hr>
<h2><a name="installingviainstallme">Installing with <tt>install.me</tt></a></h2>
<p>Provided in the MHonArc distribution is a Perl program,
<b><tt>install.me</tt></b>, for installing MHonArc on your system.
To run the program, type the following command:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>perl install.me</b>
</pre></td></tr></table>
<p> </p>
<table class="note" width="100%">
<tr valign="baseline">
<td><strong>NOTE:</strong></td>
<td width="100%"><p>You must be in the same directory as the <b><tt>install.me</tt></b>
program when you run it.
</p>
</td>
</tr>
</table>
<p>The installation program will ask you a series of questions on where
the perl executable is and where to put MHonArc files. Just hit
<Enter> to accept the default values listed in ()'s.
</p>
<table class="note" width="100%">
<tr valign="baseline">
<td><strong>NOTE:</strong></td>
<td width="100%"><p>The default
values are determined by the configuration of perl on your system.
If you choose the defaults, you may need to possess root/admin privileges.
</p>
</td>
</tr>
</table>
<p><b><tt>install.me</tt></b> can take several options on the
command-line to affect what is done during installation. The following
is the list of options available:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
-afs : Skip permission checks (useful if AFS)
-batch : Run in batch mode (do not ask questions)
-binpath <path> : Directory path to install programs/scripts
-docpath <path> : Directory path to install documentation
-help : A message summarizing options available
-libpath <path> : Directory path to install library files
-filelist <file> : List of files to install (def="FILELIST")
-manpath <path> : Directory path to manpages
-nobin : Do not install programs
-nodep : Skip module dependency check
-nodoc : Do not install documentation
-nolib : Do not install library files
-noman : Do not install manpages
-perl <pathname> : Pathname of perl interpreter
-prefix <path> : Set prefix for installation directories
</pre></td></tr></table>
<p>For example, if you do not want to install the documentation, do
the following:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>perl install.me -nodoc</b>
</pre></td></tr></table>
<p>Later on, if you decide you want to install the documentation, but
not re-install the other files, do the following:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>perl install.me -nobin -nolib -noman</b>
</pre></td></tr></table>
<p>If you want to install files relative to your home directory, do the
following:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>perl install.me -prefix $HOME</b>
</pre></td></tr></table>
<h3><a name="installmenotes"><tt>install.me</tt> Notes</a></h3>
<ul>
<li><p>The "#!" line in the installed programs are set to point to
the perl executable specified in the installation process.
This is convienence for those using systems that support the
"#!" notation.
</p>
</li>
<li><p>The installation lib directory is added to each program's
search path so each program can find the libaries needed for
proper execution. Therefore, you do <b>NOT</b> have to set your
PERL5LIB environment variable if you install the library files
in a non-standard location.
</p>
</li>
<li><p>If you specify paths that do not exist, the <tt>install.me</tt>
program creates the paths for you. If running in
interactive mode, <tt>install.me</tt> prompts you for confirmation
before creating a path.
</p>
</li>
<li><p><tt>install.me</tt> supports environment variable interpolation in
pathnames specified during interactive installation.
For example, if you want to install program files into
your local bin directory, you can enter the following when
prompted for the location to install executables: <tt class="ishell">$HOME/bin</tt>.
Also, if the '<tt>~</tt>' (tilde) character is the first character of the
pathname specified, it will be expanded to the value of the
HOME environment variable. Therefore, the following are
equivalent: <tt>$HOME/bin</tt> and <tt>~/bin</tt>.
</p>
</li>
<li><p>The <b><tt>-afs</tt></b> option should only be needed
if installing MHonArc onto AFS and using an older version of Perl 5.
It should not be needed for Perl 5.005 or later.
</p>
</li>
<li><p>If you want to abort the installation, just enter the
termination character, typically <Ctrl-C> for Unix systems and
<Ctrl-Z> for Win32 systems.
</p>
</li>
</ul>
<!-- *************************************************************** -->
<hr>
<h2><a name="p5install">The Perl 5 Way</a></h2>
<p>Of course, you can install MHonArc the standard way under Perl 5:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>perl Makefile.PL</b>
prompt> <b>make</b>
prompt> <b>make install</b>
</pre></td></tr></table>
<p>If you want to install in a specific directory, try:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>perl Makefile.PL PREFIX=<var>/tmp/myperl5</var></b>
prompt> <b>make</b>
prompt> <b>make install</b>
</pre></td></tr></table>
<p></p>
<table class="note" width="100%">
<tr valign="baseline">
<td><strong>NOTE:</strong></td>
<td width="100%"><p><b><tt>install.me</tt></b> is actually called "behind the scenes"
in batch mode to install the files. Therefore, more unusually invocations
methods of <tt class="ishell"><b>perl Makefile.PL</b></tt> may not be supported.
</p>
</td>
</tr>
</table>
<!-- *************************************************************** -->
<hr>
<h2><a name="win32">Win32 Notes</a></h2>
<ul>
<li><p>The main programs will automatically be converted to DOS batch
files. Hence, if the path location of the main programs is
in your PATH, you should be able to invoke them like any other
program.
</p>
<table class="note" width="100%">
<tr valign="baseline">
<td><strong>NOTE:</strong></td>
<td width="100%"><p>The path to the perl executable must be in
your PATH, also.
</p>
</td>
</tr>
</table>
</li>
<li><p>The main programs will also be copied to "<tt>.pl</tt>" files.
Therefore, if you have <tt>.pl</tt> associated with Perl in the registry, you
can invoke the programs directly (if the path location of the
main programs are in your search path). For example:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>mhonarc.pl ...</b>
</pre></td></tr></table>
<p>This is known to work under WinNT's command shell
and under the Cygwin bash shell.
</p>
<p>This is better than using the batch files since
I/O redirection does not work with batch files.
</p>
</li>
<li><p>In the <b><tt>logo</tt></b> directory of the distribution contain
<b><tt>.ico</tt></b> files for associating the MHonArc logo
with MHonArc <b><tt>.mrc</tt></b> resource files.
</p>
</li>
</ul>
<!-- *************************************************************** -->
<hr>
<h2><a name="altos">Alternate Operating Systems</a></h2>
<p>In many cases, <tt>install.me</tt> works for other operating
systems. Please contact the author on any success stories for
other operating systems, and please send any patches, if required.
</p>
<!-- *************************************************************** -->
<hr>
<h2><a name="manual">Manual Installation</a></h2>
<p>If <tt>install.me</tt> does not work for your system, here is how
to install MHonArc manually:
</p>
<ul>
<li><p>Copy files in the <tt>lib</tt> directory to the
library location you desire.
</p>
</li>
<li><p>Copy the program files to the location you want them
installed. After copying, do the following:
</p>
<ul>
<li><p>Edit the "<tt class="icode">#!/...</tt>" line for each program
file to reference the complete pathname of your perl interpreter. The
line should be the first line of each program file.
</p>
<table class="note" width="100%">
<tr valign="baseline">
<td><strong>NOTE:</strong></td>
<td width="100%"><p>
This step is only needed for systems (Unix)
that support "<tt class="icode">#!</tt>".
</p>
</td>
</tr>
</table>
<li><p>Then do one of the following:
</p>
<ul>
<li><p>Add a new line right after the "<tt class="icode">#!/...</tt>"
line of each program file to contain the following:
</p><pre class="code">
use lib '/path/to/lib/files';</pre>
<p>where "<tt class="icode">/path/to/lib/files/</tt>" is the
path to where copied the library files to.
</p>
<table class="note" width="100%">
<tr valign="baseline">
<td><strong>NOTE:</strong></td>
<td width="100%"><p>If the location you copied the libraries are
already part of Perl's standard library search path,
you do not need to add the "use lib" statement.
</p>
</td>
</tr>
</table>
</li>
<li><p><strong>Or</strong>, set your <b><tt>PERL5LIB</tt></b> environment
to include the path location you copied the library files to.
</p>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<!-- *************************************************************** -->
<hr>
<h2><a name="postinstall">Post Installation Configuration</a></h2>
<p>After installation, you may want to do some site-specific
configuration.
</p>
<h3><a name="siterc">Default Resource File</a></h3>
<p>You have the ability to create a default
<a href="resources/rcfile.html">resource file</a>
to make site-wide defaults for MHonArc. See
the <a href="resources/defrcfile.html">DEFRCFILE</a> resource
on valid pathname locations for the default resource file.
For more information on what can be put in
a resource file, see the
<a href="resources.html">Resources</a> section.
</p>
<table class="note" width="100%">
<tr valign="baseline">
<td><strong>NOTE:</strong></td>
<td width="100%"><p>It is advisable to create some local documentation for
users describing
any settings you place in the site-wide resource file.
This will avoid confusion if site settings vary from default settings
described in the documentation, and it will help avoid invalid bug
reports.
</p>
</td>
</tr>
</table>
<h3><a name="sitelib">Site Initialization Library</a></h3>
<p>If you do not know Perl, ignore this section.
</p>
<p>When MHonArc opens an archive for processing, MHonArc
will attempt to execute the instructions in the file
<b><tt>mhasiteinit.pl</tt></b>. This file allows you
to make site customizations not possible through a
<a href="resources/defrcfile.html">default resource file</a>.
<b><tt>mhasiteinit.pl</tt></b> should be placed in the
MHonArc library directory as specified during installation.
A sample <b><tt>mhasiteinit.pl</tt></b> file is provied in the
<b><tt>examples</tt></b> directory of the distribution to get you
started, which includes comments on some of the things you
can do with <tt>mhasiteinit.pl</tt>.
</p>
<!-- *************************************************************** -->
<hr>
<h2><a name="rcfileedit">Resource File Editing</a></h2>
<p>If you are a Vim user,
<a href="http://www.vim.org/"><http://www.vim.org/></a>, a syntax file
for MHonArc resource files is included in the examples directory:
<b><tt>mhonarc.vim</tt></b>.
Vim is known to run on a variety of operating systems,
and is free software.
</p>
<p>To use <tt>mhonarc.vim</tt>, copy <tt>mhonarc.vim</tt> to an
appropriate location and
add something like the following to your <tt>.vimrc</tt> file:
</p>
<pre class="code">
au BufNewFile,BufRead *.mrc so $HOME/share/vim/syntax/mhonarc.vim
</pre>
<p>Of course, change the pathname to <tt>mhonarc.vim</tt> to wherever
you copied it to.
</p>
<p>Now, any file with <tt>.mrc</tt> extension will put Vim into
MHonArc resource file highlighting mode. The mode is best used with
color-capable terminals.
</p>
<HR>
<!--X-NavButtons-Start-->
<table width="100%">
<tr valign="top">
<td align="left"><nobr><a href="relnotes.html"><img src="prev.png"border=0 alt="[Prev]"></a> </nobr></td><td align="center" width="99%"><a href="mhonarc.html"><img src="up.png" border=0 alt="[TOC]"></a><a href="faq/faq.html"><img src="faq.png" border=0 alt="[FAQ]"></a><a href="app-bugs.html"><img src="bug.png" border=0 alt="[Bugs]"></a><a href="http://www.mhonarc.org/"><img src="home.png" border=0 alt="[Home]"></a></td><td align="right"><nobr> <a href="quickstart.html"><img src="next.png" border=0 alt="[Next]"></a></nobr></td></tr></table>
<!--X-NavButtons-End-->
<!-- *************************************************************** -->
<hr>
<address>
$Date: 2002/12/10 04:08:02 $ <br>
<img align="top" src="monicon.png" alt="">
<a href="http://www.mhonarc.org/"><strong>MHonArc</strong></a><br>
Copyright © 1997-2002, <a href="http://www.mhonarc.org/~ehood/"
>Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org"
>mhonarc@mhonarc.org</a><br>
</address>
</BODY>
</HTML>
