xref: /freebsd/usr.bin/leave/leave.1 (revision 2008043f386721d58158e37e0d7e50df8095942d)
1.\" Copyright (c) 1980, 1990, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"	@(#)leave.1	8.3 (Berkeley) 4/28/95
29.\"
30.Dd April 28, 1995
31.Dt LEAVE 1
32.Os
33.Sh NAME
34.Nm leave
35.Nd remind you when you have to leave
36.Sh SYNOPSIS
37.Nm
38.Op Oo Cm \&+ Oc Ns Ar hhmm
39.Sh DESCRIPTION
40The
41.Nm
42utility waits until the specified time, then reminds you that you
43have to leave.
44You are reminded 5 minutes and 1 minute before the actual
45time, at the time, and every minute thereafter.
46When you log off,
47.Nm
48exits just before it would have
49printed the next message.
50.Pp
51The following options are available:
52.Bl -tag -width indent
53.It Ar hhmm
54The time of day is in the form
55.Ar hhmm
56where
57.Ar hh
58is a time in
59hours (on a 12 or 24 hour clock), and
60.Ar mm
61are minutes.
62All times are converted to a 12 hour clock, and assumed to
63be in the next 12 hours.
64.It Cm \&+
65If the time is preceded by
66.Sq Cm \&+ ,
67the alarm will go off in hours and minutes
68from the current time.
69.El
70.Pp
71If no argument is given,
72.Nm
73prompts with "When do you
74have to leave?".
75A reply of newline causes
76.Nm
77to exit,
78otherwise the reply is assumed to be a time.
79This form is suitable for inclusion in a
80.Pa .login
81or
82.Pa .profile .
83.Pp
84To get rid of
85.Nm
86you should either log off or use
87.Ql kill \-s KILL
88giving its process id.
89.Sh SEE ALSO
90.Xr calendar 1
91.Sh HISTORY
92The
93.Nm
94command appeared in
95.Bx 3.0 .
96