Annotation of src/usr.bin/leave/leave.1, Revision 1.12
1.12 ! jmc 1: .\" $OpenBSD: leave.1,v 1.11 2003/06/03 02:56:09 millert Exp $
1.1 deraadt 2: .\" $NetBSD: leave.1,v 1.5 1995/08/31 22:32:10 jtc Exp $
3: .\"
4: .\" Copyright (c) 1980, 1990, 1993
5: .\" The Regents of the University of California. All rights reserved.
6: .\"
7: .\" Redistribution and use in source and binary forms, with or without
8: .\" modification, are permitted provided that the following conditions
9: .\" are met:
10: .\" 1. Redistributions of source code must retain the above copyright
11: .\" notice, this list of conditions and the following disclaimer.
12: .\" 2. Redistributions in binary form must reproduce the above copyright
13: .\" notice, this list of conditions and the following disclaimer in the
14: .\" documentation and/or other materials provided with the distribution.
1.11 millert 15: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 16: .\" may be used to endorse or promote products derived from this software
17: .\" without specific prior written permission.
18: .\"
19: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29: .\" SUCH DAMAGE.
30: .\"
31: .\" @(#)leave.1 8.3 (Berkeley) 4/28/95
32: .\"
33: .Dd April 28, 1995
34: .Dt LEAVE 1
35: .Os
36: .Sh NAME
37: .Nm leave
38: .Nd remind you when you have to leave
39: .Sh SYNOPSIS
40: .Nm leave
41: .Sm off
42: .Oo
43: .Op Cm \&+
44: .Ns Ar hhmm
45: .Oc
46: .Sm on
47: .Sh DESCRIPTION
1.3 aaron 48: .Nm leave
1.1 deraadt 49: waits until the specified time, then reminds you that you
50: have to leave.
51: You are reminded 5 minutes and 1 minute before the actual
52: time, at the time, and every minute thereafter.
53: When you log off,
54: .Nm leave
55: exits just before it would have
56: printed the next message.
57: .Pp
1.5 aaron 58: The options are as follows:
1.9 aaron 59: .Bl -tag -width Ds
1.1 deraadt 60: .It Ar hhmm
61: The time of day is in the form
62: .Ar hhmm
63: where
64: .Ar hh
65: is a time in
66: hours (on a 12 or 24 hour clock), and
67: .Ar mm
1.3 aaron 68: in minutes.
1.12 ! jmc 69: In ambiguous cases, times are converted to a 12 hour clock,
1.8 espie 70: and assumed to be in the next 12 hours.
1.1 deraadt 71: .It Cm \&+
72: If the time is preceded by
1.6 aaron 73: .Ql + ,
1.1 deraadt 74: the alarm will go off in hours and minutes
75: from the current time.
76: .El
77: .Pp
78: If no argument is given,
79: .Nm leave
80: prompts with "When do you
1.7 aaron 81: have to leave?".
82: A reply of newline causes
1.1 deraadt 83: .Nm leave
84: to exit,
85: otherwise the reply is assumed to be a time.
86: This form is suitable for inclusion in a
87: .Pa .login
88: or
1.3 aaron 89: .Pa .profile .
1.1 deraadt 90: .Sh SEE ALSO
91: .Xr calendar 1
92: .Sh HISTORY
93: The
94: .Nm leave
95: command appeared in
96: .Bx 3.0 .