Quick Start

This section will give you a "quick start" on using MHonArc. However, I recommend reading through the entire documentation to take full advantage of all the features of MHonArc.

Before continuing, make sure MHonArc has been installed. See Installation if MHonArc has not been installed on your machine.


Converting MH mail folders, or Mailbox files

Since MHonArc supports MH mail folders and mailbox files, the term "inbox" will represent the MH mail folder or mailbox file you want to process. To convert your inbox to an HTML archive, use one of the following commands:

For an MH mail folder:
% mhonarc <path>/inbox
For a mailbox file:
% mhonarc -mbox <path>/inbox
Where <path> represents the path to the directory that contains inbox. If you are in the directory that contains inbox, then you can leave out the "<path>/".

NOTE
An MH mail folder is actually a directory file, and MHonArc expects the filename arguments you give to be directory files. If -mbox is specified, then the filename arguments should be plain files in mailbox format.
MHonArc prints out messages showing its progress as your e-mail is processed. When MHonArc finishes, the following files will be created:

The format of each converted mail message is as follows:

The following is also done for each mail message processed:

NOTE:
MHonArc allows you to specify more than one MH mail folder, or mailbox, to process on the command-line. However, you may not specify both MH mail folders and mailbox files at the same time.

Example

Here is an example session converting an MH mail folder:

% mhonarc ~/mail/inbox
Requiring MIME filter libraries ...
        mhexternal.pl
        mhtxthtml.pl
        mhtxtplain.pl
        mhtxtsetext.pl
Converting MH mail folder(s) to ./maillist.html
Reading /mnt/ehood/mail/inbox ..........
Writing HTML ...
10 messages


Converting a single message

To convert a single message to HTML use the -single command-line option. The message to process can be specified by a filename in the command-line, or by reading the message from standard input if no file is specified. The filtered message is sent to standard output. All formatting options apply to the single message as with messages being processed for an archive, with the exception of formatting related specificly to archive processing, like index links and mail thread links.

Examples

Input from standard input:
% mhonarc -single < messagefile > file.html
Filename on command-line:
% mhonarc -single messagefile > file.html

[Prev:Operating System Limitations]
[Next:Overview]
[ToC]


mhonarc 1.1.0 -- Quick Start