contrib/sendmail-8.13.8/vacation/vacation.1

   1 .\" Copyright (c) 1999-2002 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.34 2002/06/27 23:51:52 ca Exp $
  13 .\"
  14 .TH VACATION 1 "$Date: 2002/06/27 23:51:52 $"
  15 .SH NAME
  16 vacation
  17 \- E-mail auto-responder
  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 [ \-j ]
  30 .RB [ \-l ]
  31 .RB [ \-m
  32 .IR message ]
  33 .RB [ \-R
  34 .IR returnaddr ]
  35 .RB [ \-r
  36 .IR interval ]
  37 .RB [ \-s
  38 .IR address ]
  39 .RB [ \-t
  40 .IR time ]
  41 .RB [ \-U ]
  42 .RB [ \-x ]
  43 .RB [ \-z ]
  44 .I login
  45 .SH DESCRIPTION
  46 .B Vacation
  47 returns a message,
  48 .IR ~/.vacation.msg
  49 by default, to the sender informing them that you are currently not
  50 reading your mail.
  51 The message is only sent to each sender once per reply interval (see
  52 .B \-r
  53 below).
  54 The intended use is in a
  55 .I .forward
  56 file.  For example, your
  57 .I .forward
  58 file might have:
  59 .IP
  60 \eeric, "|/usr/bin/vacation -a allman eric"
  61 .PP
  62 which would send messages to you (assuming your login name was eric) and
  63 reply to any messages for
  64 ``eric''
  65 or
  66 ``allman''.
  67 .PP
  68 Available options:
  69 .TP
  70 .BI \-a " alias"
  71 Handle messages for
  72 .I alias
  73 in the same manner as those received for the user's
  74 login name.
  75 .TP
  76 .BI \-C " cfpath"
  77 Specify pathname of the sendmail configuration file.
  78 This option is ignored if
  79 .B \-U
  80 is specified.
  81 This option defaults to the standard sendmail configuration file,
  82 located at /etc/mail/sendmail.cf on most systems.
  83 .TP
  84 .B \-d
  85 Send error/debug messages to stderr instead of syslog.
  86 Otherwise, fatal errors, such as calling
  87 .B vacation
  88 with incorrect arguments, or with non-existent
  89 .IR login s,
  90 are logged in the system log file, using
  91 syslog(8).
  92 This should only be used on the command line, not in your
  93 .I .forward
  94 file.
  95 .TP
  96 .BI \-f " filename"
  97 Use
  98 .I filename
  99 as name of the database instead of
 100 .IR ~/.vacation.db
 101 or
 102 .IR ~/.vacation.{dir,pag} .
 103 Unless the
 104 .I filename
 105 starts with / it is relative to ~.
 106 .TP
 107 .B \-i
 108 Initialize the vacation database files.  It should be used
 109 before you modify your
 110 .I .forward
 111 file.
 112 This should only be used on the command line, not in your
 113 .I .forward
 114 file.
 115 .TP
 116 .B \-I
 117 Same as
 118 .B \-i
 119 (for backwards compatibility).
 120 This should only be used on the command line, not in your
 121 .I .forward
 122 file.
 123 .TP
 124 .B \-j
 125 Respond to the message regardless of whether the login is listed as
 126 a recipient for the message.
 127 Do not use this flag unless you are sure of the consequences.
 128 For example, this will cause
 129 .i vacation
 130 to reply to mailing list messages which may result in removing
 131 you from the list.
 132 .TP
 133 .B \-l
 134 List the content of the vacation database file including the address
 135 and the associated time of the last auto-response to that address.
 136 This should only be used on the command line, not in your
 137 .I .forward
 138 file.
 139 .TP
 140 .BI \-m " filename"
 141 Use
 142 .I filename
 143 as name of the file containing the message to send instead of
 144 .IR ~/.vacation.msg .
 145 Unless the
 146 .I filename
 147 starts with / it is relative to ~.
 148 .TP
 149 .BI \-R " returnaddr"
 150 Set the reply envelope sender address
 151 .TP
 152 .BI \-r " interval"
 153 Set the reply interval to
 154 .I interval
 155 days.  The default is one week.
 156 An interval of ``0'' or
 157 ``infinite''
 158 (actually, any non-numeric character) will never send more than
 159 one reply.
 160 The
 161 .B \-r
 162 option should only be used when the vacation database is initialized
 163 (see
 164 .B \-i
 165 above).
 166 .TP
 167 .BI \-s " address"
 168 Use
 169 .I address
 170 instead of the incoming message sender address on the
 171 .I From
 172 line as the recipient for the vacation message.
 173 .TP
 174 .BI \-t " time"
 175 Ignored, available only for compatibility with Sun's
 176 vacation program.
 177 .TP
 178 .B \-U
 179 Do not attempt to lookup
 180 .I login
 181 in the password file.
 182 The -f and -m options must be used to specify the database and message file
 183 since there is no home directory for the default settings for these options.
 184 .TP
 185 .B \-x
 186 Reads an exclusion list from stdin (one address per line).
 187 Mails coming from an address
 188 in this exclusion list won't get a reply by
 189 .BR vacation .
 190 It is possible to exclude complete domains by specifying
 191 ``@domain''
 192 as element of the exclusion list.
 193 This should only be used on the command line, not in your
 194 .I .forward
 195 file.
 196 .TP
 197 .B \-z
 198 Set the sender of the vacation message to
 199 ``<>''
 200 instead of the user.
 201 This probably violates the RFCs since vacation messages are
 202 not required by a standards-track RFC to have a null reverse-path.
 203 .PP
 204 .B Vacation
 205 reads the first line from the standard input for a
 206 UNIX
 207 ``From''
 208 line to determine the sender.
 209 Sendmail(8)
 210 includes this
 211 ``From''
 212 line automatically.
 213 .PP
 214 No message will be sent unless
 215 .I login
 216 (or an
 217 .I alias
 218 supplied using the
 219 .B \-a
 220 option) is part of either the
 221 ``To:''
 222 or
 223 ``Cc:''
 224 headers of the mail.
 225 No messages from
 226 ``???-REQUEST'',
 227 ``???-RELAY'',
 228 ``???-OWNER'',
 229 ``OWNER-???'',
 230 ``Postmaster'',
 231 ``UUCP'',
 232 ``MAILER'',
 233 or
 234 ``MAILER-DAEMON''
 235 will be replied to (where these strings are
 236 case insensitive) nor is a notification sent if a
 237 ``Precedence: bulk''
 238 or
 239 ``Precedence: junk''
 240 line is included in the mail headers.
 241 The people who have sent you messages are maintained as a
 242 db(3)
 243 or
 244 dbm(3)
 245 database in the file
 246 .I .vacation.db
 247 or
 248 .I .vacation.{dir,pag}
 249 in your home directory.
 250 .PP
 251 .B Vacation
 252 expects a file
 253 .IR .vacation.msg ,
 254 in your home directory, containing a message to be sent back to each
 255 sender.  It should be an entire message (including headers).  For
 256 example, it might contain:
 257 .IP
 258 .nf
 259 From: eric@CS.Berkeley.EDU (Eric Allman)
 260 Subject: I am on vacation
 261 Delivered-By-The-Graces-Of: The Vacation program
 262 Precedence: bulk
 263
 264 I am on vacation until July 22.  If you have something urgent,
 265 please contact Keith Bostic <bostic@CS.Berkeley.EDU>.
 266 --eric
 267 .fi
 268 .SH FILES
 269 .TP 1.8i
 270 ~/.vacation.db
 271 default database file for db(3)
 272 .TP 1.8i
 273 ~/.vacation.{dir,pag}
 274 default database file for dbm(3)
 275 .TP
 276 ~/.vacation.msg
 277 default message to send
 278 .SH SEE ALSO
 279 sendmail(8),
 280 syslog(8)
 281 .SH HISTORY
 282 The
 283 .B vacation
 284 command appeared in
 285 4.3BSD.