xref: /freebsd/usr.bin/lock/lock.1 (revision bc96366c864c07ef352edb92017357917c75b36c)
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.\" 4. 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.\" $FreeBSD$
30.\"
31.Dd July 10, 2002
32.Dt LOCK 1
33.Os
34.Sh NAME
35.Nm lock
36.Nd reserve a terminal
37.Sh SYNOPSIS
38.Nm
39.Op Fl npv
40.Op Fl t Ar timeout
41.Sh DESCRIPTION
42The
43.Nm
44utility requests a password from the user, reads it again for verification
45and then will normally not relinquish the terminal until the password is
46repeated.
47There are two other conditions under which it will terminate: it
48will timeout after some interval of time and it may be killed by someone
49with the appropriate permission.
50.Pp
51The following options are available:
52.Bl -tag -width indent
53.It Fl n
54Do not use a timeout value.
55Terminal will be locked forever.
56.It Fl p
57A password is not requested, instead the user's current login password
58is used.
59.It Fl t Ar timeout
60The time limit (default 15 minutes) is changed to
61.Ar timeout
62minutes.
63.It Fl v
64Disable switching virtual terminals while this terminal is locked.
65This option is implemented in a way similar to the
66.Fl S
67option of
68.Xr vidcontrol 1 ,
69and thus has the same restrictions.
70It is only available if the terminal in question is a
71.Xr syscons 4
72or
73.Xr vt 4
74virtual terminal.
75.El
76.Sh SEE ALSO
77.Xr vidcontrol 1 ,
78.Xr syscons 4 ,
79.Xr vt 4
80.Sh HISTORY
81The
82.Nm
83command appeared in
84.Bx 3.0 .
85