xref: /netbsd-src/usr.bin/leave/leave.1 (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1.\"	$NetBSD: leave.1,v 1.12 2012/02/21 15:01:51 njoly Exp $
2.\"
3.\" Copyright (c) 1980, 1990, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\"	@(#)leave.1	8.3 (Berkeley) 4/28/95
31.\"
32.Dd January 19, 2002
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.Sm off
41.Oo
42.Op Cm \&+
43.Ns Ar hhmm
44.Oc
45.Sm on
46.Sh DESCRIPTION
47.Nm
48waits until the specified time (within the next 12 hours), then
49reminds you that you have to leave by writing to the TTY that you
50executed
51.Nm
52on.
53.Pp
54You are reminded 5 minutes and 1 minute before the actual
55time, at the time, and every minute thereafter.
56When you log off,
57.Nm
58exits just before it would have
59printed the next message.
60.Sh OPTIONS
61.Bl -tag -width flag
62.It Ar hhmm
63The time of day is in the form
64.Ar hhmm
65where
66.Ar hh
67is a time in
68hours (on a 12 or 24 hour clock), and
69.Ar mm
70are minutes.
71.Pp
72However, all times are converted to a 12 hour clock, and assumed to
73be in the next 12 hours.
74An attempt to set an alarm for farther into the future will be truncated
75to within the next 12 hours.
76.It Cm \&+
77If the time is preceded by
78.Ql Cm \&+ ,
79the alarm will go off in hours and minutes
80from the current time.
81.El
82.Pp
83If no argument is given,
84.Nm
85prompts with "When do you have to leave?".
86A reply of newline causes
87.Nm
88to exit,
89otherwise the reply is assumed to be a time.
90This form is suitable for inclusion in a
91.Pa ~/.login
92or
93.Pa ~/.profile .
94.Sh SEE ALSO
95.Xr calendar 1 ,
96.Xr csh 1 ,
97.Xr sh 1
98.Sh HISTORY
99The
100.Nm
101command appeared in
102.Bx 3.0 .
103.Sh BUGS
104In the modern age with
105.Xr X 7
106and window multiplexing programs like
107.Xr tmux 1
108and
109.Xr screen 1 ,
110the
111.Nm
112command's reminders and admonitions might not be seen if the user
113has the window where
114.Nm
115was started minimized or obscured.
116.Pp
117This all begs for a more general user notifications system to be implemented.
118