xref: /netbsd/usr.bin/vacation/vacation.1 (revision c4a72b64)
1.\"	$NetBSD: vacation.1,v 1.16 2002/10/13 00:27:40 wiz 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
39.Sh NAME
40.Nm vacation
41.Nd return
42.Dq I am not here
43indication
44.Sh SYNOPSIS
45.Nm
46.Fl i
47.Op Fl r Ar interval
48.Nm ""
49.Op Fl a Ar alias
50.Ar login
51.Sh DESCRIPTION
52.Nm
53returns a message to the sender of a message telling them that you
54are currently not reading your mail.
55The intended use is in a
56.Pa .forward
57file.
58For example, your
59.Pa .forward
60file might have:
61.Bd -literal -offset indent
62\eeric, "|/usr/bin/vacation -a allman eric"
63.Ed
64which would send messages to you (assuming your login name was eric) and
65reply to any messages for
66.Dq eric
67or
68.Dq allman .
69.Pp
70Available options:
71.Bl -tag -width Ds
72.It Fl a Ar alias
73Handle messages for
74.Ar alias
75in the same manner as those received for the user's
76login name.
77.It Fl i
78Initialize the vacation database files.
79It should be used before you modify your
80.Pa .forward
81file.
82.It Fl r
83Set the reply interval to
84.Ar interval
85days.
86The default is one week.
87An interval of
88.Dq 0
89means that
90a reply is sent to each message, and an interval of
91.Dq Li infinite
92(actually, any non-numeric character) will never send more than
93one reply.
94It should be noted that intervals of
95.Dq Li \&0
96are quite
97dangerous, as it allows mailers to get into
98.Dq I am on vacation
99loops.
100.El
101.Pp
102No message will be sent unless
103.Ar login
104(or an
105.Ar alias
106supplied using the
107.Fl a
108option) is part of either the
109.Dq To:
110or
111.Dq Cc:
112headers of the mail.
113No messages from
114.Dq ???-REQUEST ,
115.Dq Postmaster ,
116.Dq Tn UUCP ,
117.Dq MAILER ,
118or
119.Dq MAILER-DAEMON
120will be replied to (where these strings are
121case insensitive) nor is a notification sent if a
122.Dq Precedence: bulk
123.Dq Precedence: list
124or
125.Dq Precedence: junk
126line is included in the mail headers.
127The people who have sent you messages are maintained as a
128.Xr db 3
129database in the file
130.Pa .vacation.db
131in your home directory.
132.Pp
133.Nm
134expects a file
135.Pa .vacation.msg ,
136in your home directory, containing a message to be sent back to each
137sender.
138It should be an entire message (including headers).
139For example, it might contain:
140.Pp
141.Bd -literal -offset indent -compact
142From: eric@CS.Berkeley.EDU (Eric Allman)
143Subject: I am on vacation
144Delivered-By-The-Graces-Of: The Vacation program
145Precedence: bulk
146
147I am on vacation until July 22.  If you have something urgent,
148please contact Keith Bostic \*[Lt]bostic@CS.Berkeley.EDU\*[Gt].
149--eric
150.Ed
151.Pp
152.Nm
153reads the first line from the standard input for a
154.Ux
155.Dq From
156line to determine the sender.
157.Xr sendmail 8
158includes this
159.Dq From
160line automatically.
161.Pp
162Fatal errors, such as calling
163.Nm
164with incorrect arguments, or with non-existent
165.Ar login Ns Ar s ,
166are logged in the system log file, using
167.Xr syslog 3 .
168.Sh FILES
169.Bl -tag -width "vacation.dirxxx" -compact
170.It Pa ~/.vacation.db
171database file
172.It Pa ~/.vacation.msg
173message to send
174.El
175.Sh SEE ALSO
176.Xr syslog 3 ,
177.Xr sendmail 8
178.Sh HISTORY
179The
180.Nm
181command appeared in
182.Bx 4.3 .
183