usr.bin/lock/lock.1

   1 .\" Copyright (c) 1987, 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 .\"     @(#)lock.1      8.1 (Berkeley) 6/6/93
  33 .\" $FreeBSD: src/usr.bin/lock/lock.1,v 1.4.2.4 2002/09/15 22:32:56 dd Exp $
  34 .\" $DragonFly: src/usr.bin/lock/lock.1,v 1.2 2003/06/17 04:29:28 dillon Exp $
  35 .\"
  36 .Dd July 10, 2002
  37 .Dt LOCK 1
  38 .Os
  39 .Sh NAME
  40 .Nm lock
  41 .Nd reserve a terminal
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl npv
  45 .Op Fl t Ar timeout
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility requests a password from the user, reads it again for verification
  50 and then will normally not relinquish the terminal until the password is
  51 repeated.
  52 There are two other conditions under which it will terminate: it
  53 will timeout after some interval of time and it may be killed by someone
  54 with the appropriate permission.
  55 .Pp
  56 Options:
  57 .Pp
  58 .Bl -tag -width Fl
  59 .It Fl n
  60 Don't use a timeout value.  Terminal will be locked forever.
  61 .It Fl p
  62 A password is not requested, instead the user's current login password
  63 is used.
  64 .It Fl t Ar timeout
  65 The time limit (default 15 minutes) is changed to
  66 .Ar timeout
  67 minutes.
  68 .It Fl v
  69 Disable switching virtual terminals while this terminal is locked.
  70 This option is implemented in a way similar to the
  71 .Fl S
  72 option of
  73 .Xr vidcontrol 1 ,
  74 and is only available if the terminal in question is a
  75 .Xr syscons 4
  76 virtual terminal.
  77 .El
  78 .Sh HISTORY
  79 The
  80 .Nm
  81 command appeared in
  82 .Bx 3.0 .