.\"	$NetBSD: vacation.1,v 1.11 1999/08/17 03:36:36 enami Exp $
.\"
.\" Copyright (c) 1985, 1987, 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)vacation.1	8.2 (Berkeley) 4/28/95
.\"
.Dd June 15, 2003
.Dt VACATION 1
.Os Linux
.Sh NAME
.Nm vacation
.Nd return
.Dq I am not here
indication
.Sh SYNOPSIS
.Nm
.Fl i
.Op Fl r Ar interval
.Nm vacation
.Fl l
.Nm vacation
.Fl x
.Nm vacation
.Op Fl a Ar alias
.Op Fl c Ar ccaddr
.Op Fl d
.Op Fl f Ar db
.Op Fl m Ar msg
.Op Fl j
.Op Fl z
.Ar login
.Sh DESCRIPTION
.Nm
returns a message to the sender of a message telling them that you
are currently not reading your mail.  The intended use is in a
.Pa .forward
file.  For example, your
.Pa .forward
file might have:
.Bd -literal -offset indent
\eeric, "|/usr/bin/vacation -a allman eric"
.Ed
.Pp
which would send messages to you (assuming your login name was eric) and
reply to any messages for
.Dq eric
or
.Dq allman .
.Pp
Available options:
.Bl -tag -width Ds
.It Fl a Ar alias
Handle messages for
.Ar alias
in the same manner as those received for the user's
login name. Using
.Fl a
.Pa alias
multiple times is possible.
.It Fl c Ar ccaddr
Copy the vacation messages to 
.Ar ccaddr .
.It Fl d
Print messages to stderr instead of syslog.
.It Fl f Ar db
Uses
.Ar db
as the database file.
.It Fl m Ar msg
Uses
.Ar msg
as the message file.
.It Fl j
Reply to the message even if our address cannot be found in the
.Dq To:
or
.Dq Cc:
headers.
This option is very dangerous and should be used with extreme care.
.It Fl z
Set the envelope sender of the reply message to
.Dq <> .
.It Fl i
Initialize the vacation database files.  It should be used
before you modify your
.Pa .forward
file.
.It Fl r
Set the reply interval to
.Ar interval
days.  The default is one week.  An interval of
.Dq 0
means that
a reply is sent to each message, and an interval of
.Dq Li infinite
(actually, any non-numeric character) will never send more than
one reply.  It should be noted that intervals of
.Dq Li \&0
are quite
dangerous, as it allows mailers to get into
.Dq I am on vacation
loops.
.It Fl x
Reads a list of addresses from standard input, one per line, and adds
them to the vacation database.
Mail coming from these excluded addresses will not get a reply.
Whole domains can be excluded using the syntax
.Dq @domain .
.It Fl l
Print the contents of the vacation database files.  For each entry,
the address the reply has been sent to and the associated time will
be printed to standard output.
.El
.Pp
When started without arguments,
.Nm
will guide the user through the configuration process.
.Pp
No message will be sent unless
.Ar login
(or an
.Ar alias
supplied using the
.Fl a
option) is part of either the
.Dq To:
or
.Dq Cc:
headers of the mail.
No messages from
.Dq ???-REQUEST ,
.Dq Postmaster ,
.Dq Tn UUCP ,
.Dq MAILER ,
or
.Dq MAILER-DAEMON
will be replied to (where these strings are
case insensitive) nor is a notification sent if a
.Dq Precedence: bulk ,
.Dq Precedence: list ,
.Dq Precedence: junk ,
.Dq X-Spam-Flag: yes
or
.Dq Auto-submitted: (something other than no)
line is included in the mail headers.
The people who have sent you messages are maintained as a
.Xr db 3
database in the file
.Pa .vacation.db
in your home directory.
.Pp
.Nm
expects a file
.Pa .vacation.msg ,
in your home directory, containing a message to be sent back to each
sender.  It should be an entire message (including headers).  For
example, it might contain:
.Pp
.Bd -unfilled -offset indent -compact
From: eric@CS.Berkeley.EDU (Eric Allman)
Subject: I am on vacation
Delivered-By-The-Graces-Of: The Vacation program
Precedence: bulk

I am on vacation until July 22.  If you have something urgent,
please contact Keith Bostic <bostic@CS.Berkeley.EDU>.
--eric
.Ed
.Pp
Any occurrence of the string
.Li $SUBJECT
in
.Pa .vacation.msg
will be replaced by the subject of the message that triggered the
.Nm
program.
.Pp
.Nm
reads the incoming message from standard input, checking the message
headers for either the
.Ux
.Dq From
line or a
.Dq Return-Path
header to determine the sender.
If both are present the sender from the
.Dq Return-Path
header is used.
.Xr Sendmail 8
includes this
.Dq From
line automatically.
.Pp
Fatal errors, such as calling
.Nm
with incorrect arguments, or with non-existent
.Ar login Ns Ar s ,
are logged on the standard error output and in the system log file, using
.Xr syslog 3 .
.Sh DIAGNOSTICS
The
.Nm
utility exits 0 on success, and >0 if an error occurs.
.Sh FILES
.Bl -tag -width "vacation.dirxxx" -compact
.It Pa ~/.vacation.db
database file
.It Pa ~/.vacation.msg
message to send
.It Pa ~/.forward
.El
.Sh SEE ALSO
.Xr aliases 5 ,
.Xr sendmail 8 ,
.Xr syslogd 8
.Sh HISTORY
The
.Nm
command appeared in
.Bx 4.3 .
.Sh AUTHOR
.Nm
was developed by Eric Allman and the University of California, Berkeley
in 1983.
.br
This version is maintained by Marco d'Itri <md@linux.it> and
contains code taken from the three free BSD and some patches applied
to a linux port.