Annotation of src/usr.bin/vacation/vacation.1, Revision 1.12
1.12 ! aaron 1: .\" $OpenBSD: vacation.1,v 1.11 1999/08/09 22:48:58 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
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
1.12 ! aaron 61: .Pp
1.1 deraadt 62: which would send messages to you (assuming your login name was eric) and
63: reply to any messages for
64: .Dq eric
65: or
66: .Dq allman .
67: .Pp
1.12 ! aaron 68: The options are as follows:
1.1 deraadt 69: .Bl -tag -width Ds
70: .It Fl a Ar alias
71: Handle messages for
72: .Ar alias
73: in the same manner as those received for the user's
74: login name.
75: .It Fl i
76: Initialize the vacation database files. It should be used
77: before you modify your
78: .Pa .forward
79: file.
80: .It Fl r
81: Set the reply interval to
82: .Ar interval
83: days. The default is one week. An interval of
84: .Dq 0
85: means that
86: a reply is sent to each message, and an interval of
87: .Dq Li infinite
88: (actually, any non-numeric character) will never send more than
89: one reply. It should be noted that intervals of
90: .Dq Li \&0
91: are quite
92: dangerous, as it allows mailers to get into
93: .Dq I am on vacation
94: loops.
95: .El
96: .Pp
97: No message will be sent unless
98: .Ar login
99: (or an
100: .Ar alias
101: supplied using the
102: .Fl a
103: option) is part of either the
104: .Dq To:
105: or
106: .Dq Cc:
107: headers of the mail.
108: No messages from
109: .Dq ???-REQUEST ,
110: .Dq Postmaster ,
111: .Dq Tn UUCP ,
112: .Dq MAILER ,
113: or
114: .Dq MAILER-DAEMON
115: will be replied to (where these strings are
116: case insensitive) nor is a notification sent if a
1.11 deraadt 117: .Dq Precedence: bulk ,
118: .Dq Precedence: list ,
1.1 deraadt 119: or
120: .Dq Precedence: junk
121: line is included in the mail headers.
122: The people who have sent you messages are maintained as a
123: .Xr db 3
124: database in the file
125: .Pa .vacation.db
126: in your home directory.
127: .Pp
1.4 aaron 128: .Nm vacation
1.1 deraadt 129: expects a file
130: .Pa .vacation.msg ,
131: in your home directory, containing a message to be sent back to each
132: sender. It should be an entire message (including headers). For
133: example, it might contain:
134: .Pp
135: .Bd -unfilled -offset indent -compact
136: From: eric@CS.Berkeley.EDU (Eric Allman)
137: Subject: I am on vacation
138: Delivered-By-The-Graces-Of: The Vacation program
139: Precedence: bulk
140:
141: I am on vacation until July 22. If you have something urgent,
142: please contact Keith Bostic <bostic@CS.Berkeley.EDU>.
143: --eric
144: .Ed
1.7 marc 145: .Pp
1.9 pjanzen 146: Any occurrence of the string
1.7 marc 147: .Li $SUBJECT
1.10 aaron 148: in
1.7 marc 149: .Pa .vacation.msg
150: will be replaced by the subject of the message that triggered the
151: .Nm vacation
152: program.
1.1 deraadt 153: .Pp
1.4 aaron 154: .Nm vacation
1.5 marc 155: reads the incoming message from standard input, checking the message
156: headers for either the
1.1 deraadt 157: .Ux
158: .Dq From
1.5 marc 159: line or a
160: .Dq Return-Path
161: header to determine the sender. If both are present the sender from the
162: .Dq Return-Path
163: header is used.
1.1 deraadt 164: .Pp
165: Fatal errors, such as calling
166: .Nm vacation
167: with incorrect arguments, or with non-existent
168: .Ar login Ns Ar s ,
169: are logged in the system log file, using
1.3 deraadt 170: .Xr syslog 3 .
1.1 deraadt 171: .Sh FILES
172: .Bl -tag -width "vacation.dirxxx" -compact
173: .It Pa ~/.vacation.db
174: database file
175: .It Pa ~/.vacation.msg
176: message to send
177: .El
178: .Sh SEE ALSO
1.6 alex 179: .Xr syslog 3 ,
180: .Xr sendmail 8
1.1 deraadt 181: .Sh HISTORY
182: The
183: .Nm vacation
184: command appeared in
185: .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