Debian Codegraph @

doc/away.1

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: away.1,v 1.3 2002/08/23 03:43:46 hrothgar Exp $
19 .\"
20 .TH away 1 "November 2000" Linux "User Manuals"
21 .SH NAME
22 away \- terminal locking program
23 .SH SYNOPSIS
24 .B away [OPTIONS]
25 .I message
26 .B [...]
27 .SH DESCRIPTION
28 .B away
29 is a simple program that locks your terminal, checks for new mail
30 in any given number of mailboxes, and lets other users know why
31 you are inactive.
32 .SH OPTIONS
33 .IP "-c, --mail"
34 Enable checking of mail.
35 .IP "-C, --nomail"
36 Disable checking of mail.
37 .IP "-f, --rcfile=FILE"
38 Specify an alternative configuration file instead of the default
39 ~/.awayrc file.
40 .IP "-F, --norcfile"
41 Ignore user configuration file.
42 .IP "-h, --help"
43 Display help.
44 .IP "-m, --message"
45 Execute as the remainder of the command line, effectively stripping
46 off the executable name and additional switches.
47 .IP "-p, --persist"
48 Continue checking for new mail as long as there is at least one mailbox
49 that has not received new mail.
50 .IP "-P, --nopersist"
51 Stop checking mail if any mailbox is found to have new mail.
52 .IP "-t, --time=SECONDS"
53 Set the number of second that away sleeps before performing its
54 background tasks. Presently, the only background task that away will
55 perform is the checking of mailboxes.
56 .IP "-T, --notime"
57 Ignore any options to set the time interval and use the default number
58 of seconds.
59 .IP "-v, --version"
60 Display version information.
61 .SH FILES
62 .I ~/.awayrc
63 .RS
64 Per user configuration file. See
65 .BR awayrc (5)
66 for further details.
67 .RE
68
69 .I /etc/pam.d/away
70 .RS
71 The
72 .B Linux-PAM
73 configuration file.
74 .RE
75 .SH BUGS
76 Bug reports should be sent to the away mailing list
77 <[email protected]>.
78 .SH SEE ALSO
79 .BR awayrc (5)
80 .SH AUTHORS
81 Cameron Moore <[email protected]>, and others.