Use the suffix \fINAME\fR to create the filename used for archives.
The default is \fI_archive\fR\&. For example, if you
run \fBarchivemail\fR on a mailbox called
\fIexsouthrock\fR, the archive will be created
with the filename \fIexsouthrock_archive.gz\fR\&.
\fINAME\fR is run through the \fBpython\fR(1) \fBtime.strftime()\fR
function, which means that you can specify any of the following special
directives in \fINAME\fR to make archives named after the archive
cut-off date:
.RS
.TP0.2i
\(bu
\fB%a\fR
Locale's abbreviated weekday name.
.TP0.2i
\(bu
\fB%A\fR
Locale's full weekday name.
.TP0.2i
\(bu
\fB%b\fR
Locale's abbreviated month name.
.TP0.2i
\(bu
\fB%B\fR
Locale's full month name.
.TP0.2i
\(bu
\fB%c\fR
Locale's appropriate date and time representation.
.TP0.2i
\(bu
\fB%d\fR
Day of the month as a decimal number [01,31].
.TP0.2i
\(bu
\fB%H\fR
Hour (24-hour clock) as a decimal number [00,23].
.TP0.2i
\(bu
\fB%I\fR
Hour (12-hour clock) as a decimal number [01,12].
.TP0.2i
\(bu
\fB%j\fR
Day of the year as a decimal number [001,366].
.TP0.2i
\(bu
\fB%m\fR
Month as a decimal number [01,12].
.TP0.2i
\(bu
\fB%M\fR
Minute as a decimal number [00,59].
.TP0.2i
\(bu
\fB%p\fR
Locale's equivalent of either AM or PM.
.TP0.2i
\(bu
\fB%S\fR
Second as a decimal number [00,61]. (1)
.TP0.2i
\(bu
\fB%U\fR
Week number of the year (Sunday as the first day of the week) as a decimal number [00,53]. All days in a new year preceding the first Sunday are considered to be in week 0.
.TP0.2i
\(bu
\fB%w\fR
Weekday as a decimal number [0(Sunday),6].
.TP0.2i
\(bu
\fB%W\fR
Week number of the year (Monday as the first day of the week) as a decimal number [00,53]. All days in a new year preceding the first Sunday are considered to be in week 0.
.TP0.2i
\(bu
\fB%x\fR
Locale's appropriate date representation.
.TP0.2i
\(bu
\fB%X\fR
Locale's appropriate time representation.
.TP0.2i
\(bu
\fB%y\fR
Year without century as a decimal number [00,99].
.TP0.2i
\(bu
\fB%Y\fR
Year with century as a decimal number.
.TP0.2i
\(bu
\fB%Z\fR
Time zone name (or by no characters if no time zone exists).
.TP0.2i
\(bu
\fB%%\fR
A literal "%" character.
.RE
.TP
\fB -S \fINUM\fB, --size=\fINUM\fB\fR
Only archive messages that are \fINUM\fR bytes or
greater.
.TP
\fB -n, --dry-run\fR
Don't write to any files -- just show what would have been done. This is
useful for testing to see how many messages would have been archived.
.TP
\fB -u, --preserve-unread\fR
Do not archive any messages that have not yet been read. \fBarchivemail\fR
determines if a message in a \fBmbox\fR-format or
\fBMH\fR-format mailbox has been read by looking at the
\fBStatus\fR header (if it exists). If the status
header is equal to 'RO' or 'OR' then \fBarchivemail\fR assumes the
message has been read. \fBarchivemail\fR determines if a
\fBmaildir\fR message has
been read by looking at the filename. If the filename contains an 'S' after
\fI:2,\fR then it assumes the message has been read.
.TP
\fB --delete\fR
Delete rather than archive old mail. Use this option with caution!
.TP
\fB --include-flagged\fR
Normally messages that are flagged important are not archived or deleted. If
you specify this option, these messages can be archived or deleted just like
any other message.
.TP
\fB --no-compress\fR
Do not compress any archives using \fBgzip\fR(1)\&.
.TP
\fB --warn-duplicate\fR
Warn about duplicate \fBMessage-ID\fRs that appear in the input
mailbox.
.TP
\fB -v, --verbose\fR
Reports lots of extra debugging information about what is going on.
.TP
\fB -q, --quiet\fR
Turns on quiet mode. Do not print any statistics about how many messages were
archived. This should be used if you are running \fBarchivemail\fR from
cron.
.TP
\fB -V, --version\fR
Display the version of \fBarchivemail\fR and exit.
.TP
\fB -h, --help\fR
Display brief summary information about how to run \fBarchivemail\fR\&.
.SH"NOTES"
.PP
\fBarchivemail\fR requires \fBpython\fR(1) version 2.0 or later.