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