freebsd-skq/usr.bin/lock/lock.1

.\" Copyright (c) 1987, 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)lock.1	8.1 (Berkeley) 6/6/93
.\" $FreeBSD$
.\"
.Dd July 10, 2002
.Dt LOCK 1
.Os
.Sh NAME
.Nm lock
.Nd reserve a terminal
.Sh SYNOPSIS
.Nm
.Op Fl npv
.Op Fl t Ar timeout
.Sh DESCRIPTION
The
.Nm
utility requests a password from the user, reads it again for verification
and then will normally not relinquish the terminal until the password is
repeated.
There are two other conditions under which it will terminate: it
will timeout after some interval of time and it may be killed by someone
with the appropriate permission.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl n
Do not use a timeout value.
Terminal will be locked forever.
.It Fl p
A password is not requested, instead the user's current login password
is used.
.It Fl t Ar timeout
The time limit (default 15 minutes) is changed to
.Ar timeout
minutes.
.It Fl v
Disable switching virtual terminals while this terminal is locked.
This option is implemented in a way similar to the
.Fl S
option of
.Xr vidcontrol 1 ,
and thus has the same restrictions.
It is only available if the terminal in question is a
.Xr syscons 4
or
.Xr vt 4
virtual terminal.
.El
.Sh SEE ALSO
.Xr vidcontrol 1 ,
.Xr syscons 4 ,
.Xr vt 4
.Sh HISTORY
The
.Nm
command appeared in
.Bx 3.0 .
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" Copyright (c) 1987, 1990, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96 2017-02-28 23:42:47 +00:00			`.\" 3. Neither the name of the University nor the names of its contributors`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)lock.1 8.1 (Berkeley) 6/6/93`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\"`
Add a -v option that prevents switching virtual terminals while this terminal is locked. This permits the user to easily lock the entire console from a single terminal. 2002-07-28 07:13:53 +00:00			`.Dd July 10, 2002`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Dt LOCK 1`
			`.Os`
			`.Sh NAME`
			`.Nm lock`
			`.Nd reserve a terminal`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
Add a -v option that prevents switching virtual terminals while this terminal is locked. This permits the user to easily lock the entire console from a single terminal. 2002-07-28 07:13:53 +00:00			`.Op Fl npv`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Op Fl t Ar timeout`
			`.Sh DESCRIPTION`
Use `The .Nm utility' 2002-04-20 12:18:28 +00:00			`The`
			`.Nm`
			`utility requests a password from the user, reads it again for verification`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`and then will normally not relinquish the terminal until the password is`
			`repeated.`
			`There are two other conditions under which it will terminate: it`
			`will timeout after some interval of time and it may be killed by someone`
			`with the appropriate permission.`
			`.Pp`
Introduce options definition the standard way. 2003-06-09 19:32:02 +00:00			`The following options are available:`
			`.Bl -tag -width indent`
Closes PR bin/1567 /usr/bin/lock can be used to lock a terminal much like xlock does for your X-windows session. Problem is, /usr/bin/lock cannot lock your terminal indefinately. Rather you must specify a timeout value, after which, your terminal is unlocked and become unsecured. I have added a ``-n'' no timeout option to /usr/bin/lock Currently the only way to get this functionality is to use a huge timeout value and hope it is long enought (in time). This method also requires you to know the maxium number of minutes you are allowed to specify. Submitted by: David E. O'Brien <obrien@Nuxi.cs.ucdavis.edu> 1996-09-14 09:00:52 +00:00			`.It Fl n`
Expand *n't contractions. 2005-02-13 22:25:33 +00:00			`Do not use a timeout value.`
Mechanically kill hard sentence breaks. 2004-07-02 22:22:35 +00:00			`Terminal will be locked forever.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl p`
			`A password is not requested, instead the user's current login password`
			`is used.`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`.It Fl t Ar timeout`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`The time limit (default 15 minutes) is changed to`
			`.Ar timeout`
			`minutes.`
Add a -v option that prevents switching virtual terminals while this terminal is locked. This permits the user to easily lock the entire console from a single terminal. 2002-07-28 07:13:53 +00:00			`.It Fl v`
			`Disable switching virtual terminals while this terminal is locked.`
			`This option is implemented in a way similar to the`
			`.Fl S`
			`option of`
			`.Xr vidcontrol 1 ,`
Document the fact that VTY locking is easily bypassable when DDB is compiled in the kernel. Also add some useful xrefs to lock(1). 2003-02-27 18:25:26 +00:00			`and thus has the same restrictions.`
			`It is only available if the terminal in question is a`
Add a -v option that prevents switching virtual terminals while this terminal is locked. This permits the user to easily lock the entire console from a single terminal. 2002-07-28 07:13:53 +00:00			`.Xr syscons 4`
More man pages that need to know about vt in addition to syscons. MFC after: 3 dayS 2014-08-26 10:55:08 +00:00			`or`
			`.Xr vt 4`
Add a -v option that prevents switching virtual terminals while this terminal is locked. This permits the user to easily lock the entire console from a single terminal. 2002-07-28 07:13:53 +00:00			`virtual terminal.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.El`
Document the fact that VTY locking is easily bypassable when DDB is compiled in the kernel. Also add some useful xrefs to lock(1). 2003-02-27 18:25:26 +00:00			`.Sh SEE ALSO`
			`.Xr vidcontrol 1 ,`
Missed comma. 2014-08-26 11:04:51 +00:00			`.Xr syscons 4 ,`
More man pages that need to know about vt in addition to syscons. MFC after: 3 dayS 2014-08-26 10:55:08 +00:00			`.Xr vt 4`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh HISTORY`
			`The`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`command appeared in`
			`.Bx 3.0 .`