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