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