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