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