Annotation of src/usr.bin/lock/lock.1, Revision 1.18
1.18 ! cheloha 1: .\" $OpenBSD: lock.1,v 1.17 2013/08/14 08:39:26 jmc Exp $
1.1 deraadt 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.
1.12 millert 14: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 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: .\"
1.18 ! cheloha 32: .Dd $Mdocdate: August 14 2013 $
1.1 deraadt 33: .Dt LOCK 1
34: .Os
35: .Sh NAME
36: .Nm lock
37: .Nd reserve a terminal
38: .Sh SYNOPSIS
39: .Nm lock
1.14 jmc 40: .Op Fl np
1.11 millert 41: .Op Fl a Ar style
1.1 deraadt 42: .Op Fl t Ar timeout
43: .Sh DESCRIPTION
1.6 aaron 44: .Nm
1.1 deraadt 45: requests a password from the user, reads it again for verification
46: and then will normally not relinquish the terminal until the password is
47: repeated.
48: There are two other conditions under which it will terminate: it
49: will timeout after some interval of time and it may be killed by someone
1.4 aaron 50: with the appropriate privileges.
1.1 deraadt 51: .Pp
1.8 aaron 52: The options are as follows:
1.10 aaron 53: .Bl -tag -width Ds
1.14 jmc 54: .It Fl a Ar style
1.17 jmc 55: The specified
56: .Bx
57: Authentication login
1.14 jmc 58: .Ar style
59: (as specified in
60: .Pa /etc/login.conf )
61: will be used to authenticate the user.
62: If the particular
63: .Ar style
64: requires a challenge/response handshake or a special prompt, the
65: user may enter the name of the
66: .Ar style
67: to get the standard prompt for that
68: .Ar style .
1.3 downsj 69: .It Fl n
1.9 aaron 70: Don't use a timeout value.
71: Terminal will be locked forever.
1.18 ! cheloha 72: This option is incompatible with the
! 73: .Fl t
! 74: option.
1.1 deraadt 75: .It Fl p
76: A password is not requested, instead the user's current login password
77: is used.
1.11 millert 78: If the user has an S/Key key, they may also use it to unlock the terminal.
1.9 aaron 79: To do this the user should enter
80: .Qq s/key
81: at the unlock
82: .Dq Key:
83: prompt.
84: The user will then be issued an S/Key
1.7 alex 85: challenge to which they may respond with a six-word S/Key one-time
1.1 deraadt 86: password.
1.6 aaron 87: .It Fl t Ar timeout
1.1 deraadt 88: The time limit (default 15 minutes) is changed to
89: .Ar timeout
90: minutes.
1.18 ! cheloha 91: This option is incompatible with the
! 92: .Fl n
! 93: option.
1.1 deraadt 94: .El
95: .Sh SEE ALSO
1.11 millert 96: .Xr skey 1 ,
97: .Xr login.conf 5
1.1 deraadt 98: .Sh HISTORY
99: The
1.6 aaron 100: .Nm
1.16 schwarze 101: command first appeared in
102: .Bx 2 .
103: .Sh AUTHORS
104: .An Kurt Shoens .