xref: /netbsd-src/usr.bin/leave/leave.1 (revision ac6da2a96c355aa682a405eed1d19bfb797cdfa0)
1*ac6da2a9Snjoly.\"	$NetBSD: leave.1,v 1.12 2012/02/21 15:01:51 njoly Exp $
231ac284aSjtc.\"
331ac284aSjtc.\" Copyright (c) 1980, 1990, 1993
431ac284aSjtc.\"	The Regents of the University of California.  All rights reserved.
561f28255Scgd.\"
661f28255Scgd.\" Redistribution and use in source and binary forms, with or without
761f28255Scgd.\" modification, are permitted provided that the following conditions
861f28255Scgd.\" are met:
961f28255Scgd.\" 1. Redistributions of source code must retain the above copyright
1061f28255Scgd.\"    notice, this list of conditions and the following disclaimer.
1161f28255Scgd.\" 2. Redistributions in binary form must reproduce the above copyright
1261f28255Scgd.\"    notice, this list of conditions and the following disclaimer in the
1361f28255Scgd.\"    documentation and/or other materials provided with the distribution.
1489aaa1bbSagc.\" 3. Neither the name of the University nor the names of its contributors
1561f28255Scgd.\"    may be used to endorse or promote products derived from this software
1661f28255Scgd.\"    without specific prior written permission.
1761f28255Scgd.\"
1861f28255Scgd.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
1961f28255Scgd.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2061f28255Scgd.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2161f28255Scgd.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2261f28255Scgd.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2361f28255Scgd.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2461f28255Scgd.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2561f28255Scgd.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2661f28255Scgd.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2761f28255Scgd.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2861f28255Scgd.\" SUCH DAMAGE.
2961f28255Scgd.\"
303f2b3b5aSjtc.\"	@(#)leave.1	8.3 (Berkeley) 4/28/95
3161f28255Scgd.\"
3288c16e89Sfair.Dd January 19, 2002
3361f28255Scgd.Dt LEAVE 1
3461f28255Scgd.Os
3561f28255Scgd.Sh NAME
3661f28255Scgd.Nm leave
3761f28255Scgd.Nd remind you when you have to leave
3861f28255Scgd.Sh SYNOPSIS
3944b3805aSlukem.Nm
4061f28255Scgd.Sm off
4161f28255Scgd.Oo
4261f28255Scgd.Op Cm \&+
4361f28255Scgd.Ns Ar hhmm
4461f28255Scgd.Oc
4561f28255Scgd.Sm on
4661f28255Scgd.Sh DESCRIPTION
4744b3805aSlukem.Nm
4888c16e89Sfairwaits until the specified time (within the next 12 hours), then
4988c16e89Sfairreminds you that you have to leave by writing to the TTY that you
5088c16e89Sfairexecuted
5188c16e89Sfair.Nm
5288c16e89Sfairon.
5388c16e89Sfair.Pp
5461f28255ScgdYou are reminded 5 minutes and 1 minute before the actual
5561f28255Scgdtime, at the time, and every minute thereafter.
5661f28255ScgdWhen you log off,
5744b3805aSlukem.Nm
5861f28255Scgdexits just before it would have
5961f28255Scgdprinted the next message.
6088c16e89Sfair.Sh OPTIONS
6161f28255Scgd.Bl -tag -width flag
6261f28255Scgd.It Ar hhmm
6361f28255ScgdThe time of day is in the form
6461f28255Scgd.Ar hhmm
6561f28255Scgdwhere
6661f28255Scgd.Ar hh
6761f28255Scgdis a time in
6861f28255Scgdhours (on a 12 or 24 hour clock), and
6961f28255Scgd.Ar mm
7061f28255Scgdare minutes.
7188c16e89Sfair.Pp
7288c16e89SfairHowever, all times are converted to a 12 hour clock, and assumed to
7361f28255Scgdbe in the next 12 hours.
7488c16e89SfairAn attempt to set an alarm for farther into the future will be truncated
7588c16e89Sfairto within the next 12 hours.
7661f28255Scgd.It Cm \&+
7731ac284aSjtcIf the time is preceded by
7861f28255Scgd.Ql Cm \&+ ,
7961f28255Scgdthe alarm will go off in hours and minutes
8061f28255Scgdfrom the current time.
8161f28255Scgd.El
8261f28255Scgd.Pp
8361f28255ScgdIf no argument is given,
8444b3805aSlukem.Nm
8560bf82edSwizprompts with "When do you have to leave?".
8688c16e89SfairA reply of newline causes
8744b3805aSlukem.Nm
8861f28255Scgdto exit,
8961f28255Scgdotherwise the reply is assumed to be a time.
9061f28255ScgdThis form is suitable for inclusion in a
9188c16e89Sfair.Pa ~/.login
9261f28255Scgdor
9388c16e89Sfair.Pa ~/.profile .
9461f28255Scgd.Sh SEE ALSO
9588c16e89Sfair.Xr calendar 1 ,
9688c16e89Sfair.Xr csh 1 ,
97c70c55b9Swiz.Xr sh 1
98c70c55b9Swiz.Sh HISTORY
99c70c55b9SwizThe
100c70c55b9Swiz.Nm
101c70c55b9Swizcommand appeared in
102c70c55b9Swiz.Bx 3.0 .
10388c16e89Sfair.Sh BUGS
10488c16e89SfairIn the modern age with
10560bf82edSwiz.Xr X 7
10688c16e89Sfairand window multiplexing programs like
107*ac6da2a9Snjoly.Xr tmux 1
10888c16e89Sfairand
10988c16e89Sfair.Xr screen 1 ,
11088c16e89Sfairthe
11188c16e89Sfair.Nm
11288c16e89Sfaircommand's reminders and admonitions might not be seen if the user
11388c16e89Sfairhas the window where
11488c16e89Sfair.Nm
11588c16e89Sfairwas started minimized or obscured.
11688c16e89Sfair.Pp
11788c16e89SfairThis all begs for a more general user notifications system to be implemented.
118