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