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