xref: /freebsd/usr.bin/lock/lock.1 (revision cbb3ec25236ba72f91cbdf23f8b78b9d1af0cedf)
1.\" Copyright (c) 1987, 1990, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"	@(#)lock.1	8.1 (Berkeley) 6/6/93
29.\"
30.Dd December 11, 2020
31.Dt LOCK 1
32.Os
33.Sh NAME
34.Nm lock
35.Nd reserve a terminal
36.Sh SYNOPSIS
37.Nm
38.Op Fl npv
39.Op Fl t Ar timeout
40.Sh DESCRIPTION
41The
42.Nm
43utility requests a password from the user, reads it again for verification
44and then will normally not relinquish the terminal until the password is
45repeated.
46There are two other conditions under which it will terminate: it
47will timeout after some interval of time and it may be killed by someone
48with the appropriate permission.
49.Pp
50The following options are available:
51.Bl -tag -width indent
52.It Fl n
53Do not use a timeout value.
54Terminal will be locked forever.
55.It Fl p
56A password is not requested, instead the user's current login password
57is used.
58.It Fl t Ar timeout
59The time limit (default 15 minutes) is changed to
60.Ar timeout
61minutes.
62.It Fl v
63Disable switching virtual terminals while this terminal is locked.
64This option is implemented in a way similar to the
65.Fl S
66option of
67.Xr vidcontrol 1 ,
68and thus has the same restrictions.
69It is only available if the terminal in question is a
70.Xr syscons 4
71or
72.Xr vt 4
73virtual terminal.
74.El
75.Sh EXAMPLES
76Lock the terminal for 5 minutes, disable switching virtual terminals and
77require the user's login password to unlock:
78.Pp
79.Dl $ lock -p -t 5 -v
80.Sh SEE ALSO
81.Xr vidcontrol 1 ,
82.Xr syscons 4 ,
83.Xr vt 4
84.Sh HISTORY
85The
86.Nm
87command appeared in
88.Bx 3.0 .
89