usr.bin/vacation/vacation.1

   1 .\" Copyright (c) 1985, 1987, 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)vacation.1  8.1 (Berkeley) 6/16/93
  33 .\"
  34 .Dd June 16, 1993
  35 .Dt VACATION 1
  36 .Os BSD 4.3
  37 .Sh NAME
  38 .Nm vacation
  39 .Nd return ``I am not here'' indication
  40 .Sh SYNOPSIS
  41 .Nm vacation
  42 .Fl i
  43 .Op Fl r Ar interval
  44 .Nm vacation
  45 .Op Fl a Ar alias
  46 .Ar login
  47 .Sh DESCRIPTION
  48 .Nm Vacation
  49 returns a message to the sender of a message telling them that you
  50 are currently not reading your mail.  The intended use is in a
  51 .Pa .forward
  52 file.  For example, your
  53 .Pa .forward
  54 file might have:
  55 .Bd -literal -offset indent
  56 \eeric, "|/usr/bin/vacation -a allman eric"
  57 .Ed
  58 which would send messages to you (assuming your login name was eric) and
  59 reply to any messages for
  60 .Dq eric
  61 or
  62 .Dq allman .
  63 .Pp
  64 Available options:
  65 .Bl -tag -width Ds
  66 .It Fl a Ar alias
  67 Handle messages for
  68 .Ar alias
  69 in the same manner as those received for the user's
  70 login name.
  71 .It Fl i
  72 Initialize the vacation database files.  It should be used
  73 before you modify your
  74 .Pa .forward
  75 file.
  76 .It Fl r
  77 Set the reply interval to
  78 .Ar interval
  79 days.  The default is one week.  An interval of
  80 .Dq 0
  81 means that
  82 a reply is sent to each message, and an interval of
  83 .Dq Li infinite
  84 (actually, any non-numeric character) will never send more than
  85 one reply.  It should be noted that intervals of
  86 .Dq Li \&0
  87 are quite
  88 dangerous, as it allows mailers to get into
  89 .Dq I am on vacation
  90 loops.
  91 .El
  92 .Pp
  93 No message will be sent unless
  94 .Ar login
  95 (or an
  96 .Ar alias
  97 supplied using the
  98 .Fl a
  99 option) is part of either the
 100 .Dq To:
 101 or
 102 .Dq Cc:
 103 headers of the mail.
 104 No messages from
 105 .Dq ???-REQUEST ,
 106 .Dq Postmaster ,
 107 .Dq Tn UUCP ,
 108 .Dq MAILER ,
 109 or
 110 .Dq MAILER-DAEMON
 111 will be replied to (where these strings are
 112 case insensitive) nor is a notification sent if a
 113 .Dq Precedence: bulk
 114 or
 115 .Dq Precedence: junk
 116 line is included in the mail headers.
 117 The people who have sent you messages are maintained as an
 118 .Xr ndbm 3
 119 database in the file
 120 .Pa .vacation.db
 121 in your home directory.
 122 .Pp
 123 .Nm Vacation
 124 expects a file
 125 .Pa .vacation.msg ,
 126 in your home directory, containing a message to be sent back to each
 127 sender.  It should be an entire message (including headers).  For
 128 example, it might contain:
 129 .Pp
 130 .Bd -unfilled -offset indent -compact
 131 From: eric@CS.Berkeley.EDU (Eric Allman)
 132 Subject: I am on vacation
 133 Delivered-By-The-Graces-Of: The Vacation program
 134 Precedence: bulk
 135
 136 I am on vacation until July 22.  If you have something urgent,
 137 please contact Keith Bostic <bostic@CS.Berkeley.EDU>.
 138 --eric
 139 .Ed
 140 .Pp
 141 .Nm Vacation
 142 reads the first line from the standard input for a
 143 .Ux
 144 .Dq From
 145 line to determine the sender.
 146 .Xr Sendmail 8
 147 includes this
 148 .Dq From
 149 line automatically.
 150 .Pp
 151 Fatal errors, such as calling
 152 .Nm vacation
 153 with incorrect arguments, or with non-existent
 154 .Ar login Ns Ar s ,
 155 are logged in the system log file, using
 156 .Xr syslog 8 .
 157 .Sh FILES
 158 .Bl -tag -width "vacation.dirxxx" -compact
 159 .It Pa ~/.vacation.db
 160 database file
 161 .It Pa ~/.vacation.msg
 162 message to send
 163 .El
 164 .Sh SEE ALSO
 165 .Xr sendmail 8 ,
 166 .Xr syslog 8
 167 .Sh HISTORY
 168 The
 169 .Nm vacation
 170 command appeared in
 171 .Bx 4.3 .