Annotation of src/usr.bin/lock/lock.1, Revision 1.20
1.20 ! schwarze 1: .\" $OpenBSD: lock.1,v 1.19 2019/07/19 18:32:19 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.20 ! schwarze 32: .Dd $Mdocdate: July 19 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.20 ! schwarze 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: .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.20 ! schwarze 66: .It Fl n
! 67: Lock the terminal forever.
! 68: This overrides
! 69: .Fl t
! 70: and is the default on
! 71: .Ox
! 72: unless
! 73: .Fl t
! 74: is specified.
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.19 cheloha 88: Unlock the terminal after
1.1 deraadt 89: .Ar timeout
1.20 ! schwarze 90: minutes unless
! 91: .Fl n
! 92: is also specified.
1.19 cheloha 93: When used in this manner
94: .Nm
95: should be invoked so that the user is safely logged out
96: if the timeout elapses:
97: .Pp
98: .Dl $ lock -t 15 || exit
1.1 deraadt 99: .El
100: .Sh SEE ALSO
1.11 millert 101: .Xr skey 1 ,
102: .Xr login.conf 5
1.1 deraadt 103: .Sh HISTORY
104: The
1.6 aaron 105: .Nm
1.16 schwarze 106: command first appeared in
107: .Bx 2 .
108: .Sh AUTHORS
109: .An Kurt Shoens .