awayrc(5) [debian man page]
awayrc(5) User Manuals awayrc(5) NAME
awayrc - configuration file for Away DESCRIPTION
An away configuration file consists of a series of commands. Each line of the file may contain only one command. Command names are case- insensitive. Commands and arguments are separated by spaces. The hash mark, or pound sign ("#"), is used as a comment character. You can use it to annotate your configuration file. All text after the comment character to the end of the line is ignored. Take note that if any mailboxes are configured in the rc file, they will be the only mailboxes checked, which means that you must add your inbox--the $MAIL environment variable will be ignored. COMMANDS
mail VALUE This command allows the user to disable or enable the checking of the user's mailboxes. If mail checking is disabled, all mailbox and maildir commands are ignored. VALUE can be 0, 1, no, or yes. The default value is 'yes'. mailbox FILENAME A file that should be checked for "new mail." The filename will be appended to the previous maildir declaration. An optional description of the mailbox may be supplied. If the description contains a space, the entire description must be enclosed in braces, "{" and "}". maildir DIRECTORY A path where subsequent mailbox declarations will be located. The only argument is the path itself. persist VALUE This command will set whether to do persistent mail checking. VALUE can be 0, 1, no, or yes. The default value is 'yes'. time SECONDS This command will set the number of seconds that away sleeps before performing its background tasks. Presently, the only background task that away will perform is the checking of mailboxes. The SECONDS value must be more than the minimum, which set at compile time. The only argument is the number of seconds. The default value is 300. EXAMPLE
# check mailboxes mail yes # check mail every 60 seconds time 60 # do not do persistent checking persist no # inbox maildir /var/spool/mail mailbox johndoe {your Inbox} # procmail folders maildir /home/johndoe/mail mailbox linux-security {Linux Security} mailbox mutt-announce {Mutt Announce} FILES
~/.awayrc Per user configuration file. BUGS
Bug reports should be sent to the away mailing list <away@unbeatenpath.net>. SEE ALSO
away(1) AUTHORS
Cameron Moore <cameron@unbeatenpath.net>, and others. Linux November 2000 awayrc(5)
Check Out this Related Man Page
mswatch(1) General Commands Manual mswatch(1) NAME
mswatch - watch mailstores for changes and initiate mailbox syncs SYNOPSIS
mswatch [options ...] DESCRIPTION
mswatch is a command line program that makes keeping two mailboxes synchronized faster and more efficient than periodically synchronizing the two mailboxes. mswatch watches mailboxes to know when to initiate mailbox syncs. Using mswatch, your mail synchronization program can be called on demand instead of through polling, resulting in prompter mail delivery and lower bandwidth usage and server load. OPTIONS
-c file, --config=file Read configuration from file. By default, the configuration is read from ~/.mswatchrc. -d, --dry Watch mailstores for changes but do not initiate syncs. -q, --quiet Do not print success status messages. -V, --version Display version information. -?, --help Display a summary of command line options. SIGNALS
SIGUSR1 Print names of mailboxes with pending syncs. SIGINT and SIGTERM Gracefully exit. CONFIGURATION
The configuration file is mandatory; mswatch will not run without it. Text starting with a hash mark (#) through the end of the current line are comments and are ignored. Spaces and tabs delimit. base_delay time Default: 10 seconds Minimum time after first queued mailbox change to synchronization. inter_delay time Default: 60 seconds Minimum time between two synchronizations or failed attempts (this is the default inter_delay setting for mailboxes). inter_delay time mailboxes ... Default: inter_delay Minimum time between two synchronizations or failed attempts for the list mailboxes. max_delay time Default: 600 seconds Maximum waiting time between failed attempts. poll_period time Default: 86400 seconds (1 day) Period at which to poll all mailboxes. This option is for use with sync programs that can error without returning a failed sta- tus---it ensures that the mailboxes are at least this fresh. To disable polling, set the period to 0. ignore mailboxes ... Optional Do not initiate explicit synchronizations for these mailboxes. mswatch will ignore changes made to these mailboxes while it is run- ning, but will still synchronize them at start when all mailboxes are synchronized. sync program arguments ... Required Program and arguments to run to synchronize mail stores. Mailbox names are appended to arguments ... when program is run. mailbox_prefix prefix separator Optional Prefix these strings to mailbox names passed to sync; useful when using mbsync for sync, as the mbsync channel. If present, prefix is always prefixed to mailbox names. When synchronizing a particular mailbox, separator is inserted between prefix and the mailbox name (separator is not inserted when synchronizing all mailboxes). Examples: Given prefix = "mydomain" and separator = ":" and that the mailbox "INBOX" is to be synchronized, "mydomain:INBOX" is passed to sync. Given prefix = "mydomain" and separator = ":" and that all mailboxes are to be synchronized, "mydomain" is passed to sync. store name { watch program arguments ... } Required (two stores) A mailstore to watch. Call it name when reporting status information to the user. watch sets the program and arguments to run the mailstore watcher. watch_maildirs(1) is a Maildir mailstore watcher. FILES
~/.mswatchrc Default configuration file SEE ALSO
inputkill(1), watch_maildirs(1), socketwatch(1), mbsync(1), mswatch website: http://mswatch.sf.net/ AUTHOR
Written by Chris Frost <chris@frostnet.net>. mswatch(1)