xref: /netbsd-src/usr.bin/vacation/vacation.1 (revision 3fe138c1461e710931a50b66f08982c5f52c371f)
1.\"	$NetBSD: vacation.1,v 1.8 1997/10/20 02:53:02 lukem Exp $
2.\"
3.\" Copyright (c) 1985, 1987, 1990, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"	@(#)vacation.1	8.2 (Berkeley) 4/28/95
35.\"
36.Dd April 28, 1995
37.Dt VACATION 1
38.Os BSD 4.3
39.Sh NAME
40.Nm vacation
41.Nd return ``I am not here'' indication
42.Sh SYNOPSIS
43.Nm
44.Fl i
45.Op Fl r Ar interval
46.Nm
47.Op Fl a Ar alias
48.Ar login
49.Sh DESCRIPTION
50.Nm
51returns a message to the sender of a message telling them that you
52are currently not reading your mail.  The intended use is in a
53.Pa .forward
54file.  For example, your
55.Pa .forward
56file might have:
57.Bd -literal -offset indent
58\eeric, "|/usr/bin/vacation -a allman eric"
59.Ed
60which would send messages to you (assuming your login name was eric) and
61reply to any messages for
62.Dq eric
63or
64.Dq allman .
65.Pp
66Available options:
67.Bl -tag -width Ds
68.It Fl a Ar alias
69Handle messages for
70.Ar alias
71in the same manner as those received for the user's
72login name.
73.It Fl i
74Initialize the vacation database files.  It should be used
75before you modify your
76.Pa .forward
77file.
78.It Fl r
79Set the reply interval to
80.Ar interval
81days.  The default is one week.  An interval of
82.Dq 0
83means that
84a reply is sent to each message, and an interval of
85.Dq Li infinite
86(actually, any non-numeric character) will never send more than
87one reply.  It should be noted that intervals of
88.Dq Li \&0
89are quite
90dangerous, as it allows mailers to get into
91.Dq I am on vacation
92loops.
93.El
94.Pp
95No message will be sent unless
96.Ar login
97(or an
98.Ar alias
99supplied using the
100.Fl a
101option) is part of either the
102.Dq To:
103or
104.Dq Cc:
105headers of the mail.
106No messages from
107.Dq ???-REQUEST ,
108.Dq Postmaster ,
109.Dq Tn UUCP ,
110.Dq MAILER ,
111or
112.Dq MAILER-DAEMON
113will be replied to (where these strings are
114case insensitive) nor is a notification sent if a
115.Dq Precedence: bulk
116.Dq Precedence: list
117or
118.Dq Precedence: junk
119line is included in the mail headers.
120The people who have sent you messages are maintained as a
121.Xr db 3
122database in the file
123.Pa .vacation.db
124in your home directory.
125.Pp
126.Nm
127expects a file
128.Pa .vacation.msg ,
129in your home directory, containing a message to be sent back to each
130sender.  It should be an entire message (including headers).  For
131example, it might contain:
132.Pp
133.Bd -unfilled -offset indent -compact
134From: eric@CS.Berkeley.EDU (Eric Allman)
135Subject: I am on vacation
136Delivered-By-The-Graces-Of: The Vacation program
137Precedence: bulk
138
139I am on vacation until July 22.  If you have something urgent,
140please contact Keith Bostic <bostic@CS.Berkeley.EDU>.
141--eric
142.Ed
143.Pp
144.Nm
145reads the first line from the standard input for a
146.Ux
147.Dq From
148line to determine the sender.
149.Xr Sendmail 8
150includes this
151.Dq From
152line automatically.
153.Pp
154Fatal errors, such as calling
155.Nm
156with incorrect arguments, or with non-existent
157.Ar login Ns Ar s ,
158are logged in the system log file, using
159.Xr syslog 3 .
160.Sh FILES
161.Bl -tag -width "vacation.dirxxx" -compact
162.It Pa ~/.vacation.db
163database file
164.It Pa ~/.vacation.msg
165message to send
166.El
167.Sh SEE ALSO
168.Xr syslog 3 ,
169.Xr sendmail 8
170.Sh HISTORY
171The
172.Nm
173command appeared in
174.Bx 4.3 .
175