xref: /openbsd/usr.bin/leave/leave.1 (revision d415bd75)
1.\"	$OpenBSD: leave.1,v 1.17 2020/01/22 04:04:39 tedu Exp $
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. Neither the name of the University nor the names of its contributors
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 $Mdocdate: January 22 2020 $
34.Dt LEAVE 1
35.Os
36.Sh NAME
37.Nm leave
38.Nd print reminders when it is time to leave
39.Sh SYNOPSIS
40.Nm leave
41.Op Oo Cm + Oc Ns Ar hhmm
42.Sh DESCRIPTION
43.Nm leave
44waits until the specified time, then prints a reminder
45that it is time to leave.
46Reminders are printed 5 minutes and 1 minute before the actual
47time, at the time, and every minute thereafter.
48If the login session ends,
49.Nm leave
50exits just before it would have
51printed the next message.
52.Pp
53The options are as follows:
54.Bl -tag -width Ds
55.It Ar hhmm
56The time of day is in the form
57.Ar hhmm
58where
59.Ar hh
60is a time in
61hours (on a 12 or 24 hour clock), and
62.Ar mm
63in minutes.
64In ambiguous cases, times are converted to a 12 hour clock,
65and assumed to be in the next 12 hours.
66.It Cm +
67If the time is preceded by
68.Ql + ,
69the alarm will go off in hours and minutes
70from the current time.
71.El
72.Pp
73If no argument is given,
74.Nm leave
75prompts with "When do you have to leave?".
76A reply of newline causes
77.Nm leave
78to exit,
79otherwise the reply is assumed to be a time.
80This form is suitable for inclusion in a
81.Pa .login
82or
83.Pa .profile .
84.Sh SEE ALSO
85.Xr calendar 1
86.Sh HISTORY
87The
88.Nm leave
89command appeared in
90.Bx 3.0 .
91.Sh AUTHORS
92.An Mary Ann Horton .
93