Annotation of src/usr.bin/lock/lock.1, Revision 1.19
1.19 ! cheloha 1: .\" $OpenBSD: lock.1,v 1.18 2019/07/05 14:11:26 cheloha 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.19 ! cheloha 32: .Dd $Mdocdate: July 5 2019 $
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.19 ! cheloha 40: .Op Fl p
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: .Pp
1.8 aaron 49: The options are as follows:
1.10 aaron 50: .Bl -tag -width Ds
1.14 jmc 51: .It Fl a Ar style
1.17 jmc 52: The specified
53: .Bx
54: Authentication login
1.14 jmc 55: .Ar style
56: (as specified in
57: .Pa /etc/login.conf )
58: will be used to authenticate the user.
59: If the particular
60: .Ar style
61: requires a challenge/response handshake or a special prompt, the
62: user may enter the name of the
63: .Ar style
64: to get the standard prompt for that
65: .Ar style .
1.1 deraadt 66: .It Fl p
67: A password is not requested, instead the user's current login password
68: is used.
1.11 millert 69: If the user has an S/Key key, they may also use it to unlock the terminal.
1.9 aaron 70: To do this the user should enter
71: .Qq s/key
72: at the unlock
73: .Dq Key:
74: prompt.
75: The user will then be issued an S/Key
1.7 alex 76: challenge to which they may respond with a six-word S/Key one-time
1.1 deraadt 77: password.
1.6 aaron 78: .It Fl t Ar timeout
1.19 ! cheloha 79: Unlock the terminal after
1.1 deraadt 80: .Ar timeout
81: minutes.
1.19 ! cheloha 82: When used in this manner
! 83: .Nm
! 84: should be invoked so that the user is safely logged out
! 85: if the timeout elapses:
! 86: .Pp
! 87: .Dl $ lock -t 15 || exit
1.1 deraadt 88: .El
89: .Sh SEE ALSO
1.11 millert 90: .Xr skey 1 ,
91: .Xr login.conf 5
1.1 deraadt 92: .Sh HISTORY
93: The
1.6 aaron 94: .Nm
1.16 schwarze 95: command first appeared in
96: .Bx 2 .
97: .Sh AUTHORS
98: .An Kurt Shoens .