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