.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .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. | will give a .\" real vertical bar. \*(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-|\(bv\*(Tr .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" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" 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 "CMAIL 1" .TH CMAIL 1 "2002-09-04" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" \&\fBcmail\fR \- a simple and modular mail counter .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBcmail\fR [\fB\-\-verbose\fR] [\fB\-\-config=\fR\fIconfig\fR] [\fB\-\-output=\fR\fIoutput\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" cmail reads in ~/.cmailrc for a list of mailboxes and reads each box to get a count of the mail in it. It then displays this information to the user, usually as a name, total mail count, and new mail count. .PP Command line options are: .IP "\fB\-\-verbose\fR" 4 .IX Item "--verbose" increases the verbosity of cmail, can be specified multiple times to increase verbosity even more. .IP "\fB\-\-config=\fR\fIconfig\fR" 4 .IX Item "--config=config" specify a config file other than ~/.cmailrc .IP "\fB\-\-output=\fR\fIoutput\fR" 4 .IX Item "--output=output" specify an output module on the command line. defaults to plain, and can also be set in the config file. .PP All options can be shortened to the shortest unique string. (For example, \&'\-v' instead of '\-\-verbose'.) .SH "CONFIGURATION FILE" .IX Header "CONFIGURATION FILE" The cmail configuration file contains a number of lines, each describing either a mailbox, or an option setting. For options, the format is: .PP .Vb 1 \& set variable value .Ve .PP This can be used to set the output module, for instance: .PP .Vb 1 \& set output color .Ve .PP Mailbox lines are only slightly more complicated. They are a series of 3 fields, seperated by 1 or more tabs. The fields are mailbox \s-1URI\s0, descriptive name, and output options. For example, the folling is an entry for /var/mail/chip: .PP .Vb 1 \& mbox:///var/mail/chip Inbox green .Ve .PP The default input modules are mbox, maildir, pop3, and imap. For pop3 and imap, you also need to specify a username and password. With imap, you can also specify a mailbox, if none is provided, it will default to \s-1INBOX\s0. .PP .Vb 2 \& pop3://user:pass@host/ \& imap://user:pass@host/INBOX .Ve .PP To use pop3 or imap over \s-1SSL\s0, just add an 's' to the end, so the above example would become; .PP .Vb 2 \& pop3s://user:pass@host/ \& imaps://user:pass@host/INBOX .Ve .PP For information on the options field, consult the documentation of the output module you are using, such as CMail::Out::color. .SH "MODULES" .IX Header "MODULES" There are two types of modules in cmail4, input modules and output modules. .PP Input modules are stored in the CMail::In hierarchy and are used for reading from mailboxes. They are responsible for counting the mail. For information on writing an Input modules, read CMail::In::Base. .PP Output modules are stored in the CMail::Out hierarchy and are used for displaying the mail count. The base distribution only contains two output modules, plain and color, which both print to the console, but color uses Term::ANSIColor to produce color codes. For information on writing an Output modules, read CMail::Out::Base. .SH "FILES" .IX Header "FILES" .IP "\fI~/.cmailrc\fR" 4 .IX Item "~/.cmailrc" cmail configuration file .SH "AUTHOR" .IX Header "AUTHOR" Chip Marshall http://www.chocobo.cx/chip/ .SH "CONTRIBUTORS" .IX Header "CONTRIBUTORS" .RE .IP "Ben April " .IX Item "Ben April " Contributed the original color code. .RE .IP "David McNett " .IX Item "David McNett " Contributed the atime preservation code for mbox mailfiles. This keeps the new mail detection in mailreaders like mutt happy.