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