BSD 4_3_Tahoe release
[unix-history] / usr / src / man / man1 / vacation.1
CommitLineData
ca67e7b4
C
1.\" Copyright (c) 1985, 1987 Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms are permitted
5.\" provided that the above copyright notice and this paragraph are
6.\" duplicated in all such forms and that any documentation,
7.\" advertising materials, and other materials related to such
8.\" distribution and use acknowledge that the software was developed
9.\" by the University of California, Berkeley. The name of the
10.\" University may not be used to endorse or promote products derived
11.\" from this software without specific prior written permission.
12.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
13.\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
14.\" WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
15.\"
16.\" @(#)vacation.1 6.6 (Berkeley) 7/9/88
17.\"
18.TH VACATION 1 "July 9, 1988"
19.UC 6
20.SH NAME
21vacation \- return ``I am not here'' indication
22.SH SYNOPSIS
23.B vacation
24.B -i
25.br
26.B vacation
27[
28.B -a
29alias ] login
30.SH DESCRIPTION
31\fIVacation\fP returns a message to the sender of a message telling
32them that you are currently not reading your mail. The intended use
33is in a \fI.forward\fP file. For example, your \fI.forward\fP file
34might have:
35.PP
36.ti +5
37\eeric, "|/usr/ucb/vacation -a allman eric"
38.PP
39which would send messages to you (assuming your login name was eric) and
40reply to any messages for ``eric'' or ``allman''.
41.PP
42No message will be sent unless \fIlogin\fP or an \fIalias\fP supplied
43using the \fB-a\fP option is a substring of either the ``To:'' or ``Cc:''
44headers of the mail. No messages from ``???-REQUEST'', ``Postmaster'',
45``UUCP'', ``MAILER'', or ``MAILER-DAEMON'' will be replied to, nor is a
46notification sent if a ``Precedence: bulk'' or ``Precedence: junk'' line
47is included in the mail headers. Only one message per week will be sent
48to each unique sender. The people who have sent you messages are
49maintained as an \fIndbm\fP(3) database in the files \fI.vacation.pag\fP
50and \fI.vacation.dir\fP in your home directory.
51.PP
52The \fB-i\fP flag initializes the vacation database files. It should be
53used before you modify your \fI.forward\fP file.
54.PP
55\fIVacation\fP expects a file \fI.vacation.msg\fP, in your home directory,
56containing a message to be sent back to each sender. It should be an entire
57message (including headers). For example, it might say:
58.PP
59.in +5
60.nf
61From: eric@ucbmonet.Berkeley.EDU (Eric Allman)
62Subject: I am on vacation
63Delivered-By-The-Graces-Of: The Vacation program
64Precedence: bulk
65
66I am on vacation until July 22. If you have something urgent,
67please contact Joe Kalash <kalash@ucbingres.Berkeley.EDU>.
68 --eric
69.fi
70.in -5
71.PP
72\fIVacation\fP reads the first line from the standard input for
73a \s-1UNIX\s0-style ``From'' line to determine the sender.
74\fISendmail\fP(8) includes this ``From'' line automatically.
75.PP
76Fatal errors, such as calling \fIvacation\fP with incorrect arguments,
77or with non-existent \fIlogin\fPs, are logged in the system log file,
78using \fIsyslog\fP(8).
79.SH FILES
80.nf
81.ta \w'~/.vacation.msg 'u
82~/.vacation.dir database file
83~/.vacation.msg message to send
84~/.vacation.pag database file
85.fi
86.SH "SEE ALSO"
87sendmail(8), syslog(8)