.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "CHEWMAIL 1" .TH CHEWMAIL 1 "2014-03-23" "perl v5.18.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" chewmail \- mail archiver .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBchewmail\fR [\s-1OPTIONS\s0] <\s-1MAILBOX\s0> ... .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBchewmail\fR is a program for archiving mail. It is inspired by the by the Python-based \fBarchivemail\fR, but with more useful semantics. All mail is archived to the mailbox specified with the \fB\-\-output\-box\fR switch, in mbox format. It can read mailboxes in mbox, Maildir and \s-1MH\s0 formats. .PP Internally, \fBchewmail\fR uses Mail::Box, so it support file names and URLs supported by that module. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-o\fR \fImailbox-format\fR, \fB\-\-output\-box\fR=\fImailbox-format\fR" 4 .IX Item "-o mailbox-format, --output-box=mailbox-format" The mailbox to archive messages to. The mailbox is run through the Date::Format module, so it supports all it's conversion specifiers. The date and time is relative to the messages timestamp, or the current time if the timestamp is impossible to determine. A sample of the conversion specifiers follows: .Sp .Vb 10 \& %% PERCENT \& %b month abbr \& %B month \& %d numeric day of the month, with leading zeros (eg 01..31) \& %e numeric day of the month, without leading zeros (eg 1..31) \& %D MM/DD/YY \& %G GPS week number (weeks since January 6, 1980) \& %h month abbr \& %H hour, 24 hour clock, leading 0\*(Aqs) \& %I hour, 12 hour clock, leading 0\*(Aqs) \& %j day of the year \& %k hour \& %l hour, 12 hour clock \& %L month number, starting with 1 \& %m month number, starting with 01 \& %n NEWLINE \& %o ornate day of month \-\- "1st", "2nd", "25th", etc. \& %t TAB \& %U week number, Sunday as first day of week \& %w day of the week, numerically, Sunday == 0 \& %W week number, Monday as first day of week \& %x date format: 11/19/94 \& %y year (2 digits) \& %Y year (4 digits) .Ve .IP "\fB\-d\fR \fIdays-old\fR, \fB\-\-days\fR=days\-old" 4 .IX Item "-d days-old, --days=days-old" Only archive messages older than than this many days. .IP "\fB\-D\fR \fIdate\fR, \fB\-\-date\fR=\fIdate\fR" 4 .IX Item "-D date, --date=date" Only archive messages old than this date. The \fIdate\fR can be any date understood by Perl's Date::Parse module. .IP "\fB\-R\fR, \fB\-\-only\-read\fR" 4 .IX Item "-R, --only-read" Only archive messages that are marked seen or read. .IP "\fB\-\-delete\-immediately\fR" 4 .IX Item "--delete-immediately" Synchonize the mailboxes after every message is moved. This will be substantially slower but may provide better recovery for some mailbox formats in the event of a crash. .IP "\fB\-\-preserve\-timestamp\fR" 4 .IX Item "--preserve-timestamp" Preserve the atime and mtime of the input mailbox. This only affects file-based mailboxes, such as mbox. .IP "\fB\-n\fR, \fB\-\-dry\-run\fR" 4 .IX Item "-n, --dry-run" Go through all the motions of archiving the mail, but don't actually change any mailboxes. .IP "\fB\-v\fR, \fB\-\-verbose\fR" 4 .IX Item "-v, --verbose" Output more informational messages. Use multiple times for more verbosity. .IP "\fB\-q\fR, \fB\-\-quiet\fR" 4 .IX Item "-q, --quiet" Don't output any messages other than error messages. .IP "\fB\-V\fR, \fB\-\-version\fR" 4 .IX Item "-V, --version" Print the version number then exit. .IP "\fB\-h\fR, \fB\-\-help\fR" 4 .IX Item "-h, --help" Print usage information then exit. .SH "EXAMPLES" .IX Header "EXAMPLES" Archive two day old messages in \fIinbox\fR to \fIinbox-old\fR: .PP .Vb 1 \& chewmail \-\-days 2 \-o inbox\-old inbox .Ve .PP Archive read messages to a mailbox named the year-month of the message: .PP .Vb 1 \& chewmail \-\-only\-read \-o %Y\-%m inbox .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIarchivemail\fR\|(1), Date::Parse, Date::Format, Mail::Box .SH "AUTHOR" .IX Header "AUTHOR" Eric Dorland