xref: /freebsd/usr.bin/lock/lock.1 (revision 3ef9e138dd8b70879ba91d84ac623baa0d4b6c91)
1*3ef9e138SAlexander Ziaee.\"-
2*3ef9e138SAlexander Ziaee.\" SPDX-License-Identifier: BSD-3-Clause
3*3ef9e138SAlexander Ziaee.\"
49b50d902SRodney W. Grimes.\" Copyright (c) 1987, 1990, 1993
59b50d902SRodney W. Grimes.\"	The Regents of the University of California.  All rights reserved.
69b50d902SRodney W. Grimes.\"
79b50d902SRodney W. Grimes.\" Redistribution and use in source and binary forms, with or without
89b50d902SRodney W. Grimes.\" modification, are permitted provided that the following conditions
99b50d902SRodney W. Grimes.\" are met:
109b50d902SRodney W. Grimes.\" 1. Redistributions of source code must retain the above copyright
119b50d902SRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer.
129b50d902SRodney W. Grimes.\" 2. Redistributions in binary form must reproduce the above copyright
139b50d902SRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer in the
149b50d902SRodney W. Grimes.\"    documentation and/or other materials provided with the distribution.
15fbbd9655SWarner Losh.\" 3. Neither the name of the University nor the names of its contributors
169b50d902SRodney W. Grimes.\"    may be used to endorse or promote products derived from this software
179b50d902SRodney W. Grimes.\"    without specific prior written permission.
189b50d902SRodney W. Grimes.\"
199b50d902SRodney W. Grimes.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
209b50d902SRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
219b50d902SRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
229b50d902SRodney W. Grimes.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
239b50d902SRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
249b50d902SRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
259b50d902SRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
269b50d902SRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
279b50d902SRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
289b50d902SRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
299b50d902SRodney W. Grimes.\" SUCH DAMAGE.
309b50d902SRodney W. Grimes.\"
31c06f992bSFernando Apesteguía.Dd December 11, 2020
329b50d902SRodney W. Grimes.Dt LOCK 1
339b50d902SRodney W. Grimes.Os
349b50d902SRodney W. Grimes.Sh NAME
359b50d902SRodney W. Grimes.Nm lock
369b50d902SRodney W. Grimes.Nd reserve a terminal
379b50d902SRodney W. Grimes.Sh SYNOPSIS
388fe908efSRuslan Ermilov.Nm
3916a8de73SDima Dorfman.Op Fl npv
409b50d902SRodney W. Grimes.Op Fl t Ar timeout
419b50d902SRodney W. Grimes.Sh DESCRIPTION
42e8937ba0SPhilippe CharnierThe
43e8937ba0SPhilippe Charnier.Nm
44e8937ba0SPhilippe Charnierutility requests a password from the user, reads it again for verification
459b50d902SRodney W. Grimesand then will normally not relinquish the terminal until the password is
469b50d902SRodney W. Grimesrepeated.
479b50d902SRodney W. GrimesThere are two other conditions under which it will terminate: it
489b50d902SRodney W. Grimeswill timeout after some interval of time and it may be killed by someone
499b50d902SRodney W. Grimeswith the appropriate permission.
509b50d902SRodney W. Grimes.Pp
51f88e6136SPhilippe CharnierThe following options are available:
52*3ef9e138SAlexander Ziaee.Bl -tag -width "-t timeout"
532280509cSOllivier Robert.It Fl n
540227791bSRuslan ErmilovDo not use a timeout value.
556a3e8b0aSRuslan ErmilovTerminal will be locked forever.
569b50d902SRodney W. Grimes.It Fl p
579b50d902SRodney W. GrimesA password is not requested, instead the user's current login password
589b50d902SRodney W. Grimesis used.
599b50d902SRodney W. Grimes.It Fl t Ar timeout
609b50d902SRodney W. GrimesThe time limit (default 15 minutes) is changed to
619b50d902SRodney W. Grimes.Ar timeout
629b50d902SRodney W. Grimesminutes.
6316a8de73SDima Dorfman.It Fl v
6416a8de73SDima DorfmanDisable switching virtual terminals while this terminal is locked.
6516a8de73SDima DorfmanThis option is implemented in a way similar to the
6616a8de73SDima Dorfman.Fl S
6716a8de73SDima Dorfmanoption of
6816a8de73SDima Dorfman.Xr vidcontrol 1 ,
69356168f5SMaxime Henrionand thus has the same restrictions.
70356168f5SMaxime HenrionIt is only available if the terminal in question is a
7116a8de73SDima Dorfman.Xr syscons 4
72f071b64eSStefan Eßeror
73f071b64eSStefan Eßer.Xr vt 4
7416a8de73SDima Dorfmanvirtual terminal.
759b50d902SRodney W. Grimes.El
76c06f992bSFernando Apesteguía.Sh EXAMPLES
77c06f992bSFernando ApesteguíaLock the terminal for 5 minutes, disable switching virtual terminals and
78c06f992bSFernando Apesteguíarequire the user's login password to unlock:
79c06f992bSFernando Apesteguía.Pp
80c06f992bSFernando Apesteguía.Dl $ lock -p -t 5 -v
81356168f5SMaxime Henrion.Sh SEE ALSO
82356168f5SMaxime Henrion.Xr vidcontrol 1 ,
83eb261ddaSSergey Kandaurov.Xr syscons 4 ,
84f071b64eSStefan Eßer.Xr vt 4
859b50d902SRodney W. Grimes.Sh HISTORY
869b50d902SRodney W. GrimesThe
878fe908efSRuslan Ermilov.Nm
889b50d902SRodney W. Grimescommand appeared in
899b50d902SRodney W. Grimes.Bx 3.0 .
90