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