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