freebsd-skq/usr.bin/leave/leave.1

.\" Copyright (c) 1980, 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)leave.1	8.3 (Berkeley) 4/28/95
.\" $FreeBSD$
.\"
.Dd April 28, 1995
.Dt LEAVE 1
.Os
.Sh NAME
.Nm leave
.Nd remind you when you have to leave
.Sh SYNOPSIS
.Nm
.Op Oo Cm \&+ Oc Ns Ar hhmm
.Sh DESCRIPTION
The
.Nm
utility waits until the specified time, then reminds you that you
have to leave.
You are reminded 5 minutes and 1 minute before the actual
time, at the time, and every minute thereafter.
When you log off,
.Nm
exits just before it would have
printed the next message.
.Pp
The following options are available:
.Bl -tag -width indent
.It Ar hhmm
The time of day is in the form
.Ar hhmm
where
.Ar hh
is a time in
hours (on a 12 or 24 hour clock), and
.Ar mm
are minutes.
All times are converted to a 12 hour clock, and assumed to
be in the next 12 hours.
.It Cm \&+
If the time is preceded by
.Sq Cm \&+ ,
the alarm will go off in hours and minutes
from the current time.
.El
.Pp
If no argument is given,
.Nm
prompts with "When do you
have to leave?".
A reply of newline causes
.Nm
to exit,
otherwise the reply is assumed to be a time.
This form is suitable for inclusion in a
.Pa .login
or
.Pa .profile .
.Pp
To get rid of
.Nm
you should either log off or use
.Ql kill \-s KILL
giving its process id.
.Sh SEE ALSO
.Xr calendar 1
.Sh HISTORY
The
.Nm
command appeared in
.Bx 3.0 .
Import Lite2's src/usr.bin/leave. The man page is still on the vendor branch and this import just makes a cosmetic change. 1997-07-06 03:45:58 +00:00			`.\" Copyright (c) 1980, 1990, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96 2017-02-28 23:42:47 +00:00			`.\" 3. Neither the name of the University nor the names of its contributors`
Import Lite2's src/usr.bin/leave. The man page is still on the vendor branch and this import just makes a cosmetic change. 1997-07-06 03:45:58 +00:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)leave.1 8.3 (Berkeley) 4/28/95`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
Import Lite2's src/usr.bin/leave. The man page is still on the vendor branch and this import just makes a cosmetic change. 1997-07-06 03:45:58 +00:00			`.\"`
			`.Dd April 28, 1995`
			`.Dt LEAVE 1`
			`.Os`
			`.Sh NAME`
			`.Nm leave`
			`.Nd remind you when you have to leave`
			`.Sh SYNOPSIS`
Check fgets' return value, silent -Wall. Obtained from: OpenBSD 1997-07-21 12:04:31 +00:00			`.Nm`
mdoc(7) police: simplify construct. 2001-02-06 16:20:31 +00:00			`.Op Oo Cm \&+ Oc Ns Ar hhmm`
Import Lite2's src/usr.bin/leave. The man page is still on the vendor branch and this import just makes a cosmetic change. 1997-07-06 03:45:58 +00:00			`.Sh DESCRIPTION`
Use `The .Nm utility' 2002-04-20 12:18:28 +00:00			`The`
			`.Nm`
			`utility waits until the specified time, then reminds you that you`
Import Lite2's src/usr.bin/leave. The man page is still on the vendor branch and this import just makes a cosmetic change. 1997-07-06 03:45:58 +00:00			`have to leave.`
			`You are reminded 5 minutes and 1 minute before the actual`
			`time, at the time, and every minute thereafter.`
			`When you log off,`
Check fgets' return value, silent -Wall. Obtained from: OpenBSD 1997-07-21 12:04:31 +00:00			`.Nm`
Import Lite2's src/usr.bin/leave. The man page is still on the vendor branch and this import just makes a cosmetic change. 1997-07-06 03:45:58 +00:00			`exits just before it would have`
			`printed the next message.`
			`.Pp`
Add .Nm. Options: -> The following options are available: 2000-03-26 14:27:19 +00:00			`The following options are available:`
			`.Bl -tag -width indent`
Import Lite2's src/usr.bin/leave. The man page is still on the vendor branch and this import just makes a cosmetic change. 1997-07-06 03:45:58 +00:00			`.It Ar hhmm`
			`The time of day is in the form`
			`.Ar hhmm`
			`where`
			`.Ar hh`
			`is a time in`
			`hours (on a 12 or 24 hour clock), and`
			`.Ar mm`
			`are minutes.`
			`All times are converted to a 12 hour clock, and assumed to`
			`be in the next 12 hours.`
			`.It Cm \&+`
			`If the time is preceded by`
Fixed the abuses of .Ql visible on stderr in troff mode. PR: docs/37176 2002-12-23 16:04:51 +00:00			`.Sq Cm \&+ ,`
Import Lite2's src/usr.bin/leave. The man page is still on the vendor branch and this import just makes a cosmetic change. 1997-07-06 03:45:58 +00:00			`the alarm will go off in hours and minutes`
			`from the current time.`
			`.El`
			`.Pp`
			`If no argument is given,`
Check fgets' return value, silent -Wall. Obtained from: OpenBSD 1997-07-21 12:04:31 +00:00			`.Nm`
Import Lite2's src/usr.bin/leave. The man page is still on the vendor branch and this import just makes a cosmetic change. 1997-07-06 03:45:58 +00:00			`prompts with "When do you`
Get rid of hard sentence break Asked by: Sheldon 2000-03-27 20:38:21 +00:00			`have to leave?".`
			`A reply of newline causes`
Check fgets' return value, silent -Wall. Obtained from: OpenBSD 1997-07-21 12:04:31 +00:00			`.Nm`
Import Lite2's src/usr.bin/leave. The man page is still on the vendor branch and this import just makes a cosmetic change. 1997-07-06 03:45:58 +00:00			`to exit,`
			`otherwise the reply is assumed to be a time.`
			`This form is suitable for inclusion in a`
			`.Pa .login`
			`or`
Check fgets' return value, silent -Wall. Obtained from: OpenBSD 1997-07-21 12:04:31 +00:00			`.Pa .profile .`
Import Lite2's src/usr.bin/leave. The man page is still on the vendor branch and this import just makes a cosmetic change. 1997-07-06 03:45:58 +00:00			`.Pp`
Don't claim to ignore interrupts. PR: 27747 Submitted by: Gerhard Sittig <Gerhard.Sittig@gmx.net> 2001-05-30 02:39:53 +00:00			`To get rid of`
			`.Nm`
			`you should either log off or use`
Import Lite2's src/usr.bin/leave. The man page is still on the vendor branch and this import just makes a cosmetic change. 1997-07-06 03:45:58 +00:00			`.Ql kill \-s KILL`
			`giving its process id.`
Add extremely useful calendar(1) application to FreeBSD It does extremely useful things like execute sendmail and spew dubiously accurate factoids. From the feedback, it seems like it is an essential utility in a modern unix and not at all a useless bikeshed. How do those Linux people live without it? Reverts r358561. 2020-03-03 00:20:08 +00:00			`.Sh SEE ALSO`
			`.Xr calendar 1`
Import Lite2's src/usr.bin/leave. The man page is still on the vendor branch and this import just makes a cosmetic change. 1997-07-06 03:45:58 +00:00			`.Sh HISTORY`
			`The`
Check fgets' return value, silent -Wall. Obtained from: OpenBSD 1997-07-21 12:04:31 +00:00			`.Nm`
Import Lite2's src/usr.bin/leave. The man page is still on the vendor branch and this import just makes a cosmetic change. 1997-07-06 03:45:58 +00:00			`command appeared in`
			`.Bx 3.0 .`