Expand PMF_FN_* macros.
[netbsd-mini2440.git] / usr.bin / lock / lock.1
blobadaebcf5a938a427045b886a3324a385d8861ba7
1 .\"     $NetBSD: lock.1,v 1.8 2002/09/26 01:11:33 wiz Exp $
2 .\"
3 .\" Copyright (c) 1987, 1990, 1993
4 .\"     The Regents of the University of California.  All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the University nor the names of its contributors
15 .\"    may be used to endorse or promote products derived from this software
16 .\"    without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\"     @(#)lock.1      8.1 (Berkeley) 6/6/93
31 .\"
32 .Dd June 6, 1993
33 .Dt LOCK 1
34 .Os
35 .Sh NAME
36 .Nm lock
37 .Nd reserve a terminal
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl np
41 .Op Fl t Ar timeout
42 .Sh DESCRIPTION
43 .Nm
44 requests a password from the user, reads it again for verification
45 and then will normally not relinquish the terminal until the password is
46 repeated.
47 There are two other conditions under which it will terminate: it
48 will timeout after some interval of time and it may be killed by someone
49 with the appropriate permission.
50 .Pp
51 Options:
52 .Pp
53 .Bl -tag -width Fl
54 .It Fl n
55 No timeout is used.
56 The terminal will be locked indefinitely or until current challenge is met.
57 .It Fl p
58 A password is not requested, instead the user's current login password
59 is used.
60 If the user has an S/Key key, they may also use it
61 to unlock the terminal.
62 To do this the user should enter "s/key" at the unlock "Key:" prompt.
63 The user will then be issued an S/Key challenge to which they may respond
64 with a six-word S/Key one-time password.
65 .It Fl t Ar timeout
66 The time limit (default 15 minutes) is changed to
67 .Ar timeout
68 minutes.
69 .El
70 .Sh SEE ALSO
71 .Xr skey 1
72 .Sh HISTORY
73 The
74 .Nm
75 command appeared in
76 .Bx 3.0 .