manual page first distributed with 4.3BSD
[unix-history] / usr / src / usr.bin / vacation / vacation.1
CommitLineData
62cdb418
KM
1.\" Copyright (c) 1985 Regents of the University of California.
2.\" All rights reserved. The Berkeley software License Agreement
3.\" specifies the terms and conditions for redistribution.
4.\"
5.\" @(#)vacation.1 6.1 (Berkeley) %G%
6.\"
7.TH VACATION 1 ""
8.UC 6
9.SH NAME
10vacation \- return ``I am on vacation'' indication
11.SH SYNOPSIS
12.B vacation
13.B \-I
14.br
15.B vacation
16[
17.BI \-t N
18]
19user
20.SH DESCRIPTION
21.I Vacation
22returns a message to the sender of a message
23telling that you are on vacation.
24The intended use is in a
25.I \&.forward
26file.
27For example,
28your
29.I \&.forward
30file might have:
31.PP
32.ti +5
33\eeric, "|vacation eric"
34.PP
35which would send messages to you
36(assuming your login name was eric)
37and send a message back to the sender.
38.PP
39.I Vacation
40expects a file
41.I \&.vacation.msg
42in your home directory containing a message to be sent back
43to each sender.
44For example, it might say:
45.PP
46.in +5
47.nf
48I am on vacation until July 22. If you have something urgent,
49please contact Joe Kalash (IngVAX:kalash).
50 --eric
51.fi
52.in -5
53.PP
54This message will only be sent once a week to each unique
55sender.
56This timeout can be reset using the
57.B \-t
58flag;
59a trailing `s', `m', `h', `d', or `w'
60scales the number to seconds, minutes, hours, days, or weeks
61respectively.
62The people who have sent you messages are kept in the files
63.I \&.vacation.pag
64and
65.I \&.vacation.dir
66in your home directory.
67The
68.B \-I
69option initializes these files,
70and should be executed before you modify your
71.I \&.forward
72file.
73.PP
74If the
75.B \-I
76flag is not specified,
77.I vacation
78reads the first line from the standard input
79for a \s-1UNIX\s0-style
80``From'' line
81to determine the sender.
82If this is not present,
83a nasty diagnostic is produced.
84.IR Sendmail (8)
85includes this automatically.
86.SH SEE\ ALSO
87sendmail(8)