manual/sendmail/original/man1/vacation.1

   1 .\" Copyright (c) 1999-2001 Sendmail, Inc. and its suppliers.
   2 .\"     All rights reserved.
   3 .\" Copyright (c) 1985, 1987, 1990, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\"
   7 .\" By using this file, you agree to the terms and conditions set
   8 .\" forth in the LICENSE file which can be found at the top level of
   9 .\" the sendmail distribution.
  10 .\"
  11 .\"
  12 .\"     $Id: vacation.1,v 8.25 2001/07/13 21:35:35 gshapiro Exp $
  13 .\"
  14 .TH VACATION 1 "$Date: 2001/07/13 21:35:35 $"
  15 .SH NAME
  16 vacation
  17 \- return ``I am not here'' indication
  18 .SH SYNOPSIS
  19 .B vacation
  20 .RB [ \-a
  21 .IR alias ]
  22 .RB [ \-C
  23 .IR cffile ]
  24 .RB [ \-d ]
  25 .RB [ \-f
  26 .IR database ]
  27 .RB [ \-i ]
  28 .RB [ \-I ]
  29 .RB [ \-l ]
  30 .RB [ \-m
  31 .IR message ]
  32 .RB [ \-r
  33 .IR interval ]
  34 .RB [ \-s
  35 .IR address ]
  36 .RB [ \-t
  37 .IR time ]
  38 .RB [ \-U ]
  39 .RB [ \-x ]
  40 .RB [ \-z ]
  41 .I login
  42 .SH DESCRIPTION
  43 .B Vacation
  44 returns a message to the sender of a message telling them that you
  45 are currently not reading your mail.  The intended use is in a
  46 .I .forward
  47 file.  For example, your
  48 .I .forward
  49 file might have:
  50 .IP
  51 \eeric, "|/usr/bin/vacation -a allman eric"
  52 .PP
  53 which would send messages to you (assuming your login name was eric) and
  54 reply to any messages for
  55 ``eric''
  56 or
  57 ``allman''.
  58 .PP
  59 Available options:
  60 .TP
  61 .BI \-a " alias"
  62 Handle messages for
  63 .I alias
  64 in the same manner as those received for the user's
  65 login name.
  66 .TP
  67 .BI \-C " cfpath"
  68 Specify pathname of the sendmail configuration file.
  69 This option is ignored if
  70 .B \-U
  71 is specified.
  72 This option defaults to the standard sendmail configuration file,
  73 located at /etc/mail/sendmail.cf on most systems.
  74 .TP
  75 .B \-d
  76 Send error/debug messages to stdout instead of syslog.
  77 Otherwise, fatal errors, such as calling
  78 .B vacation
  79 with incorrect arguments, or with non-existent
  80 .IR login s,
  81 are logged in the system log file, using
  82 syslog(8).
  83 .TP
  84 .BI \-f " filename"
  85 Use
  86 .I filename
  87 as name of the database instead of
  88 .IR ~/.vacation.db .
  89 Unless the
  90 .I filename
  91 starts with / it is relative to ~.
  92 .TP
  93 .B \-i
  94 Initialize the vacation database files.  It should be used
  95 before you modify your
  96 .I .forward
  97 file.
  98 .TP
  99 .B \-I
 100 Same as
 101 .B \-i
 102 (for backwards compatibility).
 103 .TP
 104 .BI \-m " filename"
 105 Use
 106 .I filename
 107 as name of the file containing the message to send instead of
 108 .IR ~/.vacation.msg .
 109 Unless the
 110 .I filename
 111 starts with / it is relative to ~.
 112 .TP
 113 .B \-l
 114 List the content of the vacation database file including the address
 115 and the associated time of the last auto-response to that address.
 116 .TP
 117 .BI \-r " interval"
 118 Set the reply interval to
 119 .I interval
 120 days.  The default is one week.
 121 An interval of ``0'' or
 122 ``infinite''
 123 (actually, any non-numeric character) will never send more than
 124 one reply.
 125 .TP
 126 .BI \-s " address"
 127 Use
 128 .I address
 129 instead of the incoming message sender address on the
 130 .I From
 131 line as the recipient for the vacation message.
 132 .TP
 133 .BI \-t " time"
 134 Ignored, available only for compatibility with Sun's
 135 vacation program.
 136 .TP
 137 .B \-U
 138 Do not attempt to lookup
 139 .I login
 140 in the password file.
 141 The -f and -m options must be used to specify the database and message file
 142 since there is no home directory for the default settings for these options.
 143 .TP
 144 .B \-x
 145 reads an exclusion list from stdin (one address per line).
 146 Mails coming from an address
 147 in this exclusion list won't get a reply by
 148 .BR vacation .
 149 It is possible to exclude complete domains by specifying
 150 ``@domain''
 151 as element of the exclusion list.
 152 .TP
 153 .B \-z
 154 Set the sender of the vacation message to
 155 ``<>''
 156 instead of the user.
 157 This probably violates the RFCs since vacation messages are
 158 not required by a standards-track RFC to have a null reverse-path.
 159 .PP
 160 No message will be sent unless
 161 .I login
 162 (or an
 163 .I alias
 164 supplied using the
 165 .B \-a
 166 option) is part of either the
 167 ``To:''
 168 or
 169 ``Cc:''
 170 headers of the mail.
 171 No messages from
 172 ``???-REQUEST'',
 173 ``???-RELAY'',
 174 ``???-OWNER'',
 175 ``OWNER-???'',
 176 ``Postmaster'',
 177 ``UUCP'',
 178 ``MAILER'',
 179 or
 180 ``MAILER-DAEMON''
 181 will be replied to (where these strings are
 182 case insensitive) nor is a notification sent if a
 183 ``Precedence: bulk''
 184 or
 185 ``Precedence: junk''
 186 line is included in the mail headers.
 187 The people who have sent you messages are maintained as a
 188 db(3)
 189 database in the file
 190 .I .vacation.db
 191 in your home directory.
 192 .PP
 193 .B Vacation
 194 expects a file
 195 .IR .vacation.msg ,
 196 in your home directory, containing a message to be sent back to each
 197 sender.  It should be an entire message (including headers).  For
 198 example, it might contain:
 199 .IP
 200 .nf
 201 From: eric@CS.Berkeley.EDU (Eric Allman)
 202 Subject: I am on vacation
 203 Delivered-By-The-Graces-Of: The Vacation program
 204 Precedence: bulk
 205
 206 I am on vacation until July 22.  If you have something urgent,
 207 please contact Keith Bostic <bostic@CS.Berkeley.EDU>.
 208 --eric
 209 .fi
 210 .PP
 211 .B Vacation
 212 reads the first line from the standard input for a
 213 UNIX
 214 ``From''
 215 line to determine the sender.
 216 Sendmail(8)
 217 includes this
 218 ``From''
 219 line automatically.
 220 .SH FILES
 221 .TP 1.8i
 222 ~/.vacation.db
 223 default database file
 224 .TP
 225 ~/.vacation.msg
 226 default message to send
 227 .SH SEE ALSO
 228 sendmail(8),
 229 syslog(8)
 230 .SH HISTORY
 231 The
 232 .B vacation
 233 command appeared in
 234 4.3BSD.