Debian Codegraph @

doc/awayrc.5

raw
1 .\" Copyright (C) 1999-2002 Cameron Moore and others
2 .\"
3 .\" This program is free software; you can redistribute it and/or
4 .\" modify it under the terms of the GNU General Public License
5 .\" as published by the Free Software Foundation; either version 2
6 .\" of the License, or (at your option) any later version.
7 .\"
8 .\" This program is distributed in the hope that it will be useful,
9 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
10 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 .\" GNU General Public License for more details.
12 .\"
13 .\" You should have received a copy of the GNU General Public License
14 .\" along with this program; if not, write to the Free Software
15 .\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
16 .\" Or try here: http://www.fsf.org/copyleft/gpl.html
17 .\"
18 .\" $Id: awayrc.5,v 1.3 2002/08/23 03:43:47 hrothgar Exp $
19 .\"
20 .TH awayrc 5 "November 2000" Linux "User Manuals"
21 .SH NAME
22 awayrc \- configuration file for Away
23 .SH DESCRIPTION
24 An away configuration file consists of a series of commands.
25 Each line of the file may contain only one command. Command names are
26 case-insensitive. Commands and arguments are separated by spaces.
27
28 The hash mark, or pound sign ("#"), is used as a comment character.
29 You can use it to annotate your configuration file. All text after
30 the comment character to the end of the line is ignored.
31
32 Take note that if any mailboxes are configured in the rc file, they
33 will be the only mailboxes checked, which means that you must add your
34 inbox--the
35 .B $MAIL
36 environment variable will be ignored.
37 .SH COMMANDS
38 .IP "mail VALUE"
39 This command allows the user to disable or enable the checking of
40 the user's mailboxes. If mail checking is disabled, all
41 .I mailbox
42 and
43 .I maildir
44 commands are ignored. VALUE can be 0, 1, no, or yes. The default
45 value is 'yes'.
46 .IP "mailbox FILENAME"
47 A file that should be checked for "new mail." The filename will be
48 appended to the previous
49 .B maildir
50 declaration. An optional description of the mailbox may be supplied.
51 If the description contains a space, the entire description must be
52 enclosed in braces, "{" and "}".
53 .IP "maildir DIRECTORY"
54 A path where subsequent
55 .B mailbox
56 declarations will be located. The only argument is the path itself.
57 .IP "persist VALUE"
58 This command will set whether to do persistent mail checking. VALUE
59 can be 0, 1, no, or yes. The default value is 'yes'.
60 .IP "time SECONDS"
61 This command will set the number of seconds that away sleeps before
62 performing its background tasks. Presently, the only background task
63 that away will perform is the checking of mailboxes. The SECONDS value
64 must be more than the minimum, which set at compile time. The only
65 argument is the number of seconds. The default value is 300.
66 .SH EXAMPLE
67 .nf
68 # check mailboxes
69 mail yes
70
71 # check mail every 60 seconds
72 time 60
73
74 # do not do persistent checking
75 persist no
76
77 # inbox
78 maildir /var/spool/mail
79 mailbox johndoe {your Inbox}
80
81 # procmail folders
82 maildir /home/johndoe/mail
83 mailbox linux-security {Linux Security}
84 mailbox mutt-announce {Mutt Announce}
85 .SH FILES
86 .I ~/.awayrc
87 .RS
88 Per user configuration file.
89 .RE
90 .SH BUGS
91 Bug reports should be sent to the away mailing list
92 <[email protected]>.
93 .SH SEE ALSO
94 .BR away (1)
95 .SH AUTHORS
96 Cameron Moore <[email protected]>, and others.