xref: /original-bsd/usr.bin/vacation/vacation.1 (revision 0842ddeb)
1.\" Copyright (c) 1985, 1987, 1990, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" %sccs.include.redist.roff%
5.\"
6.\"	@(#)vacation.1	8.2 (Berkeley) 04/28/95
7.\"
8.Dd
9.Dt VACATION 1
10.Os BSD 4.3
11.Sh NAME
12.Nm vacation
13.Nd return ``I am not here'' indication
14.Sh SYNOPSIS
15.Nm vacation
16.Fl i
17.Op Fl r Ar interval
18.Nm vacation
19.Op Fl a Ar alias
20.Ar login
21.Sh DESCRIPTION
22.Nm Vacation
23returns a message to the sender of a message telling them that you
24are currently not reading your mail.  The intended use is in a
25.Pa .forward
26file.  For example, your
27.Pa .forward
28file might have:
29.Bd -literal -offset indent
30\eeric, "|/usr/bin/vacation -a allman eric"
31.Ed
32which would send messages to you (assuming your login name was eric) and
33reply to any messages for
34.Dq eric
35or
36.Dq allman .
37.Pp
38Available options:
39.Bl -tag -width Ds
40.It Fl a Ar alias
41Handle messages for
42.Ar alias
43in the same manner as those received for the user's
44login name.
45.It Fl i
46Initialize the vacation database files.  It should be used
47before you modify your
48.Pa .forward
49file.
50.It Fl r
51Set the reply interval to
52.Ar interval
53days.  The default is one week.  An interval of
54.Dq 0
55means that
56a reply is sent to each message, and an interval of
57.Dq Li infinite
58(actually, any non-numeric character) will never send more than
59one reply.  It should be noted that intervals of
60.Dq Li \&0
61are quite
62dangerous, as it allows mailers to get into
63.Dq I am on vacation
64loops.
65.El
66.Pp
67No message will be sent unless
68.Ar login
69(or an
70.Ar alias
71supplied using the
72.Fl a
73option) is part of either the
74.Dq To:
75or
76.Dq Cc:
77headers of the mail.
78No messages from
79.Dq ???-REQUEST ,
80.Dq Postmaster ,
81.Dq Tn UUCP ,
82.Dq MAILER ,
83or
84.Dq MAILER-DAEMON
85will be replied to (where these strings are
86case insensitive) nor is a notification sent if a
87.Dq Precedence: bulk
88or
89.Dq Precedence: junk
90line is included in the mail headers.
91The people who have sent you messages are maintained as a
92.Xr db 3
93database in the file
94.Pa .vacation.db
95in your home directory.
96.Pp
97.Nm Vacation
98expects a file
99.Pa .vacation.msg ,
100in your home directory, containing a message to be sent back to each
101sender.  It should be an entire message (including headers).  For
102example, it might contain:
103.Pp
104.Bd -unfilled -offset indent -compact
105From: eric@CS.Berkeley.EDU (Eric Allman)
106Subject: I am on vacation
107Delivered-By-The-Graces-Of: The Vacation program
108Precedence: bulk
109
110I am on vacation until July 22.  If you have something urgent,
111please contact Keith Bostic <bostic@CS.Berkeley.EDU>.
112--eric
113.Ed
114.Pp
115.Nm Vacation
116reads the first line from the standard input for a
117.Ux
118.Dq From
119line to determine the sender.
120.Xr Sendmail 8
121includes this
122.Dq From
123line automatically.
124.Pp
125Fatal errors, such as calling
126.Nm vacation
127with incorrect arguments, or with non-existent
128.Ar login Ns Ar s ,
129are logged in the system log file, using
130.Xr syslog 8 .
131.Sh FILES
132.Bl -tag -width "vacation.dirxxx" -compact
133.It Pa ~/.vacation.db
134database file
135.It Pa ~/.vacation.msg
136message to send
137.El
138.Sh SEE ALSO
139.Xr sendmail 8 ,
140.Xr syslog 8
141.Sh HISTORY
142The
143.Nm vacation
144command appeared in
145.Bx 4.3 .
146