Command-Line Options

Invoke MHonArc from your Unix shell with the following syntax:

% mhonarc [options] mhfolder...
% mhonarc -mbox [options] mailbox ...
% mhonarc -add [options] < message
% mhonarc -add [options] < mhfolder ...
% mhonarc -add -mbox [options] < mailbox
% mhonarc -single [options] < message > message.html
% mhonarc -single [options] message > message.html

MHonArc has many command-line options. If you do not want to specify a ton of command-line options each time you use MHonArc, see Resource File.

The following options are available:

-add
Add new messages to an existing archive. See Adding New Messages to an Archive for more information.
-dbfile name
Use name for 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.
-docurl url
Use url as the URL to MHonArc documentation. The default is "http://www.oac.uci.edu/indiv/ehood/mhonarc.doc.html".
-editidx
This option tells MHonArc to rewite only the index file. This option is useful if you need to reformat the index page without adding new messages. See Index Page Customization on how to format the index page. -editidx takes precedence over -add and -single.

-footer filename
Insert contents of filename at the bottom of the index page. See Include Files in Index Page Customization for more information about the footer file.
-header filename
Insert contents of filename at the beginning of the index page. See Include Files in Index Page Customization for more information about the header file.
-help
Print out a help message about MHonArc.
-idxfname name
Sets the name of the index file to name. The default is "maillist.html".
-mailtourl url
Use url for e-mail address hyperlinks in mail message headers. If the url contains the string, "$TO$", the string will be replaced with the e-mail address being hyperlinked at runtime. The default URL is "mailto:$TO$"

The -mailtourl option has no effect if the -nomailto option is specified.

-mbox
Treat file arguments as mail(1) mailboxes instead of MH mail folders. This option overrides the -mh option.
-msgsep expression
Use the expression as the Perl regular expression that signifies the message separator in mailbox files. The default expression is (without the quotes): "^From " (there is a space character after the From).
-mh
Treat file arguments as mh(1) mail folders. This option is the default unless the program name is mbox2html.
-nomailto
Do not convert e-mail addresses in mail headers to mailto hyperlinks.
-nonews
Do not convert newsgroups in the Newsgroups: mail header field to news hyperlinks.
-noreverse
Do not perform a reverse listing of the mail messages in the index page.
-nosort
Do not sort messages by date. Messages will be in the order they appear in the mailboxes/folders. By default, MHonArc sorts messages by date sent/received. -nosort takes precedence over the -sort option.

-outdir path
Set destination/location of the HTML mail archive to path. By default, the current working directory is used.
-quiet
Suppress processing messages when MHonArc is running.
-rcfile file
Use file as the resource file for MHonArc. See Resource File for more information. There is no default resource file.
-reverse
List messages in reverse order of the sorting option specified. For example, if date sorting is specified, -reverse will cause messages to be listed in reverse chronological order.
-single
Convert a single mail message to HTML. The message can be specified by a filename on the command-line, or read from standard input if no file is given. The filtered message is sent to standard output. The -single option is useful tp convert individual messages to HTML not related to a specific mail archive. Any option related to how message formatting can be used with the -single option.

The -single takes precedence over the -add option.

-sort
Perform chronological date sorting. This is the default.
-subsort
Sort messages by subject. Subject sorting is case-insensitive, and begining "Re:", "A", "An", and "The" words are ignored.
-title string
Set the title of the index page to string. The default is "Mail Index".
-umask umask
Set the umask of the MHonArc process to umask. The value is treated as an octal number.
       
NOTE:
The -no* options always take precedence over their counterparts. For example, if -noreverse and -reverse are both specified on the command-line, the -noreverse will be applied.
Any arguments that are not part of the command-line options are treated as mail folders, or mailboxes, containing e-mail messages.

       

[Prev:Environment Variables]
[Next:Resource File]
[ToC]


MHonArc 1.0.0 -- Command-Line Options