MHonArc supports the use of environment variables. The environment variables
allow you to set default options everytime you invoke MHonArc. The following
environment variables may be used:
-
M2H_DBFILE
- Sets the name of MHonArc database file. The default is "
.mhonarc.db
".
You should not override the default name unless absolutely necessary, and you are
confident about what you are doing.
-
M2H_DOCURL
- Set the URL used to point to MHonArc documentation. The default is,
"
http://www.oac.uci.edu/indiv/ehood/mhonarc.doc.html
".
-
M2H_FOOTER
- Set the HTML footer file to insert at the bottom of the index page. No
default footer file is defined. See Include Files in Index Page
Customization for more information about the footer file.
-
M2H_HEADER
- Set the HTML header file to insert at the top of the index page. No default
header file is defined. See Include Files in Index Page Customization for
more information about the header file.
-
M2H_IDXFNAME
- Set the name of the index file. The default is, "
maillist.html
".
-
M2H_LOCKFILE
- Set the name of the lock file. The default name use is "
.mhonarc.lck
".
You should not change the default unless absolutely necessary.
See Archive Integrity for more information about the lock file.
-
M2H_LOCKTRIES
- Set the number of time MHonArc tries to lock a mail archive before
processing new messages. The default value is
10
. MHonArc waits
approximately 3 seconds before each try.
See Archive Integrity for more information on the M2H_LOCKTRIES
environment variable.
-
M2H_MAILTOURL
- Sets the URL for e-mail address hyperlinks. If the environment variable
contains the string, "
$TO$
", the string is replaced with the e-mail address
being hyperlinked at runtime.
MHonArc uses the following URL by default: mailto:$TO$
-
M2H_OUTDIR
- Set the destination/location of the HTML mail archive. The default is the
current working directory.
-
M2H_RCFILE
- Set the Resource File for MHonArc. No default resource file is defined.
-
M2H_TITLE
- Set the default title of the index page. The default is "Main Index".
Environment variables may be overriden by the Resource File or Command-Line
Options.
[Prev:Quick Start]
[Next:Command-Line Options]
[ToC]
MHonArc 1.0.0 -- Environment Variables