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