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