Annotation of src/usr.bin/leave/leave.1, Revision 1.9
1.9 ! aaron 1: .\" $OpenBSD: leave.1,v 1.8 2000/05/08 16:15:29 espie 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.
15: .\" 3. All advertising materials mentioning features or use of this software
16: .\" must display the following acknowledgement:
17: .\" This product includes software developed by the University of
18: .\" California, Berkeley and its contributors.
19: .\" 4. Neither the name of the University nor the names of its contributors
20: .\" may be used to endorse or promote products derived from this software
21: .\" without specific prior written permission.
22: .\"
23: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33: .\" SUCH DAMAGE.
34: .\"
35: .\" @(#)leave.1 8.3 (Berkeley) 4/28/95
36: .\"
37: .Dd April 28, 1995
38: .Dt LEAVE 1
39: .Os
40: .Sh NAME
41: .Nm leave
42: .Nd remind you when you have to leave
43: .Sh SYNOPSIS
44: .Nm leave
45: .Sm off
46: .Oo
47: .Op Cm \&+
48: .Ns Ar hhmm
49: .Oc
50: .Sm on
51: .Sh DESCRIPTION
1.3 aaron 52: .Nm leave
1.1 deraadt 53: waits until the specified time, then reminds you that you
54: have to leave.
55: You are reminded 5 minutes and 1 minute before the actual
56: time, at the time, and every minute thereafter.
57: When you log off,
58: .Nm leave
59: exits just before it would have
60: printed the next message.
61: .Pp
1.5 aaron 62: The options are as follows:
1.9 ! aaron 63: .Bl -tag -width Ds
1.1 deraadt 64: .It Ar hhmm
65: The time of day is in the form
66: .Ar hhmm
67: where
68: .Ar hh
69: is a time in
70: hours (on a 12 or 24 hour clock), and
71: .Ar mm
1.3 aaron 72: in minutes.
1.8 espie 73: In ambiguous cases, times are converted to a 12 hour clock,
74: and assumed to be in the next 12 hours.
1.1 deraadt 75: .It Cm \&+
76: If the time is preceded by
1.6 aaron 77: .Ql + ,
1.1 deraadt 78: the alarm will go off in hours and minutes
79: from the current time.
80: .El
81: .Pp
82: If no argument is given,
83: .Nm leave
84: prompts with "When do you
1.7 aaron 85: have to leave?".
86: A reply of newline causes
1.1 deraadt 87: .Nm leave
88: to exit,
89: otherwise the reply is assumed to be a time.
90: This form is suitable for inclusion in a
91: .Pa .login
92: or
1.3 aaron 93: .Pa .profile .
1.1 deraadt 94: .Pp
1.3 aaron 95: .Nm leave
96: ignores interrupts, quits, and terminates.
1.1 deraadt 97: To get rid of it you should either log off or use
98: .Ql kill \-s KILL
1.3 aaron 99: giving its process ID.
1.1 deraadt 100: .Sh SEE ALSO
101: .Xr calendar 1
102: .Sh HISTORY
103: The
104: .Nm leave
105: command appeared in
106: .Bx 3.0 .