Annotation of src/usr.bin/vacation/vacation.1, Revision 1.22
1.22 ! bentley 1: .\" $OpenBSD: vacation.1,v 1.21 2014/09/16 16:11:56 jmc 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: .\"
1.22 ! bentley 33: .Dd $Mdocdate: September 16 2014 $
1.1 deraadt 34: .Dt VACATION 1
1.8 aaron 35: .Os
1.1 deraadt 36: .Sh NAME
37: .Nm vacation
1.22 ! bentley 38: .Nd provide absence notification when receiving email
1.1 deraadt 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.
1.17 deraadt 78: .It Fl r Ar interval
1.1 deraadt 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
1.20 okan 85: or
1.1 deraadt 86: .Dq Li infinite
87: (actually, any non-numeric character) will never send more than
1.13 aaron 88: one reply.
1.1 deraadt 89: .El
90: .Pp
1.16 jmc 91: Messages will not be replied to
92: if any of the following conditions are true:
93: .Bl -dash -offset indent
94: .It
95: Message are not
96: .Dq To:
97: or
98: .Dq Cc:
99: a valid
1.1 deraadt 100: .Ar login
1.16 jmc 101: (or
1.1 deraadt 102: .Ar alias
103: supplied using the
104: .Fl a
1.16 jmc 105: option).
106: .It
107: Messages are from
1.1 deraadt 108: .Dq ???-REQUEST ,
109: .Dq Postmaster ,
110: .Dq Tn UUCP ,
111: .Dq MAILER ,
112: or
113: .Dq MAILER-DAEMON
1.16 jmc 114: (where these strings are case insensitive).
115: .It
116: 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.
1.16 jmc 122: .It
123: An
124: .Dq Auto-Submitted
125: line is included in the mail headers
126: with a value of anything but
127: .Dq no .
1.18 deraadt 128: .It
129: A
130: .Dq List-Id
131: line (with any value) is included in the mail headers.
1.16 jmc 132: .El
133: .Pp
1.1 deraadt 134: The people who have sent you messages are maintained as a
135: .Xr db 3
136: database in the file
137: .Pa .vacation.db
138: in your home directory.
139: .Pp
1.13 aaron 140: .Nm
1.1 deraadt 141: expects a file
142: .Pa .vacation.msg ,
143: in your home directory, containing a message to be sent back to each
1.13 aaron 144: sender.
145: It should be an entire message (including headers).
146: For example, it might contain:
1.15 jmc 147: .Bd -literal -offset indent
1.1 deraadt 148: From: eric@CS.Berkeley.EDU (Eric Allman)
149: Subject: I am on vacation
150: Delivered-By-The-Graces-Of: The Vacation program
151: Precedence: bulk
152:
1.13 aaron 153: I am on vacation until July 22.
154: If you have something urgent,
1.1 deraadt 155: please contact Keith Bostic <bostic@CS.Berkeley.EDU>.
156: --eric
157: .Ed
1.7 marc 158: .Pp
1.9 pjanzen 159: Any occurrence of the string
1.7 marc 160: .Li $SUBJECT
1.10 aaron 161: in
1.7 marc 162: .Pa .vacation.msg
163: will be replaced by the subject of the message that triggered the
1.13 aaron 164: .Nm
1.7 marc 165: program.
1.1 deraadt 166: .Pp
1.13 aaron 167: .Nm
1.5 marc 168: reads the incoming message from standard input, checking the message
169: headers for either the
1.1 deraadt 170: .Ux
171: .Dq From
1.5 marc 172: line or a
173: .Dq Return-Path
1.13 aaron 174: header to determine the sender.
175: If both are present the sender from the
1.5 marc 176: .Dq Return-Path
177: header is used.
1.1 deraadt 178: .Pp
179: Fatal errors, such as calling
1.13 aaron 180: .Nm
1.1 deraadt 181: with incorrect arguments, or with non-existent
182: .Ar login Ns Ar s ,
183: are logged in the system log file, using
1.3 deraadt 184: .Xr syslog 3 .
1.1 deraadt 185: .Sh FILES
186: .Bl -tag -width "vacation.dirxxx" -compact
187: .It Pa ~/.vacation.db
188: database file
189: .It Pa ~/.vacation.msg
190: message to send
191: .El
192: .Sh SEE ALSO
1.6 alex 193: .Xr syslog 3 ,
1.21 jmc 194: .Xr smtpd 8
1.1 deraadt 195: .Sh HISTORY
196: The
1.13 aaron 197: .Nm
1.1 deraadt 198: command appeared in
199: .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