Annotation of src/usr.bin/vacation/vacation.1, Revision 1.4
1.4 ! aaron 1: .\" $OpenBSD: vacation.1,v 1.3 1997/09/20 07:33:09 deraadt 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
39: .Os BSD 4.3
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
116: .Dq Precedence: bulk
117: or
118: .Dq Precedence: junk
119: line is included in the mail headers.
120: The people who have sent you messages are maintained as a
121: .Xr db 3
122: database in the file
123: .Pa .vacation.db
124: in your home directory.
125: .Pp
1.4 ! aaron 126: .Nm vacation
1.1 deraadt 127: expects a file
128: .Pa .vacation.msg ,
129: in your home directory, containing a message to be sent back to each
130: sender. It should be an entire message (including headers). For
131: example, it might contain:
132: .Pp
133: .Bd -unfilled -offset indent -compact
134: From: eric@CS.Berkeley.EDU (Eric Allman)
135: Subject: I am on vacation
136: Delivered-By-The-Graces-Of: The Vacation program
137: Precedence: bulk
138:
139: I am on vacation until July 22. If you have something urgent,
140: please contact Keith Bostic <bostic@CS.Berkeley.EDU>.
141: --eric
142: .Ed
143: .Pp
1.4 ! aaron 144: .Nm vacation
1.1 deraadt 145: reads the first line from the standard input for a
146: .Ux
147: .Dq From
148: line to determine the sender.
149: .Xr Sendmail 8
150: includes this
151: .Dq From
152: line automatically.
153: .Pp
154: Fatal errors, such as calling
155: .Nm vacation
156: with incorrect arguments, or with non-existent
157: .Ar login Ns Ar s ,
158: are logged in the system log file, using
1.3 deraadt 159: .Xr syslog 3 .
1.1 deraadt 160: .Sh FILES
161: .Bl -tag -width "vacation.dirxxx" -compact
162: .It Pa ~/.vacation.db
163: database file
164: .It Pa ~/.vacation.msg
165: message to send
166: .El
167: .Sh SEE ALSO
168: .Xr sendmail 8 ,
1.3 deraadt 169: .Xr syslog 3
1.1 deraadt 170: .Sh HISTORY
171: The
172: .Nm vacation
173: command appeared in
174: .Bx 4.3 .
![[BACK]](/icons/back.gif){kind=icon}
Return to vacation.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / vacation