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