]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - contrib/sendmail/vacation/vacation.1
Merge commit '850ef5ae11d69ea3381bd310f564f025fc8caea3'
[FreeBSD/FreeBSD.git] / contrib / sendmail / vacation / vacation.1
1 .\" Copyright (c) 1999-2002 Proofpoint, 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.35 2013-11-22 20:52:02 ca Exp $
13 .\"
14 .TH VACATION 1 "$Date: 2013-11-22 20:52:02 $"
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 It also scans the headers for a
214 ``Return-Path:''
215 header to determine the sender.
216 If both are present, the sender from the 
217 ``Return-Path:''
218 header is used.
219 .PP
220 No message will be sent unless
221 .I login
222 (or an
223 .I alias
224 supplied using the
225 .B \-a
226 option) is part of either the
227 ``To:''
228 or
229 ``Cc:''
230 headers of the mail.
231 No messages from
232 ``???-REQUEST'',
233 ``???-RELAY'',
234 ``???-OWNER'',
235 ``OWNER-???'',
236 ``Postmaster'',
237 ``UUCP'',
238 ``MAILER'',
239 or
240 ``MAILER-DAEMON''
241 will be replied to (where these strings are
242 case insensitive) nor is a notification sent if a
243 ``Precedence: bulk'',
244 ``Precedence: list'',
245 or
246 ``Precedence: junk''
247 line is included in the mail headers.
248 Likewise, a response will not be sent if the headers contain a
249 ``Auto-Submitted:''
250 header with any value except
251 ``no''
252 or a
253 ``List-Id:''
254 header is found.
255 The people who have sent you messages are maintained as a
256 db(3)
257 or
258 dbm(3)
259 database in the file
260 .I .vacation.db
261 or
262 .I .vacation.{dir,pag}
263 in your home directory.
264 .PP
265 .B Vacation
266 expects a file
267 .IR .vacation.msg ,
268 in your home directory, containing a message to be sent back to each
269 sender.  It should be an entire message (including headers).  For
270 example, it might contain:
271 .IP
272 .nf
273 From: eric@CS.Berkeley.EDU (Eric Allman)
274 Subject: I am on vacation
275 Delivered-By-The-Graces-Of: The Vacation program
276 Precedence: bulk
277
278 I am on vacation until July 22.  If you have something urgent,
279 please contact Keith Bostic <bostic@CS.Berkeley.EDU>.
280 --eric
281 .fi
282 .PP
283 Any occurrence of the string
284 ``$SUBJECT''
285 in
286 .IR .vacation.msg
287 will be replaced by the first line of the subject of the message
288 that triggered the
289 .B vacation
290 program.
291 .SH FILES
292 .TP 1.8i
293 ~/.vacation.db
294 default database file for db(3)
295 .TP 1.8i
296 ~/.vacation.{dir,pag}
297 default database file for dbm(3)
298 .TP
299 ~/.vacation.msg
300 default message to send
301 .SH SEE ALSO
302 sendmail(8),
303 syslog(8)
304 .SH HISTORY
305 The
306 .B vacation
307 command appeared in
308 4.3BSD.