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