xref: /freebsd/usr.bin/leave/leave.1 (revision 3078531de10dcae44b253a35125c949ff4235284)
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.\" $FreeBSD$
30.\"
31.Dd April 28, 1995
32.Dt LEAVE 1
33.Os
34.Sh NAME
35.Nm leave
36.Nd remind you when you have to leave
37.Sh SYNOPSIS
38.Nm
39.Op Oo Cm \&+ Oc Ns Ar hhmm
40.Sh DESCRIPTION
41The
42.Nm
43utility waits until the specified time, then reminds you that you
44have to leave.
45You are reminded 5 minutes and 1 minute before the actual
46time, at the time, and every minute thereafter.
47When you log off,
48.Nm
49exits just before it would have
50printed the next message.
51.Pp
52The following options are available:
53.Bl -tag -width indent
54.It Ar hhmm
55The time of day is in the form
56.Ar hhmm
57where
58.Ar hh
59is a time in
60hours (on a 12 or 24 hour clock), and
61.Ar mm
62are minutes.
63All times are converted to a 12 hour clock, and assumed to
64be in the next 12 hours.
65.It Cm \&+
66If the time is preceded by
67.Sq Cm \&+ ,
68the alarm will go off in hours and minutes
69from the current time.
70.El
71.Pp
72If no argument is given,
73.Nm
74prompts with "When do you
75have to leave?".
76A reply of newline causes
77.Nm
78to exit,
79otherwise the reply is assumed to be a time.
80This form is suitable for inclusion in a
81.Pa .login
82or
83.Pa .profile .
84.Pp
85To get rid of
86.Nm
87you should either log off or use
88.Ql kill \-s KILL
89giving its process id.
90.Sh SEE ALSO
91.Xr calendar 1
92.Sh HISTORY
93The
94.Nm
95command appeared in
96.Bx 3.0 .
97