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