Remove advertising header from man pages.
[dragonfly.git] / usr.bin / lock / lock.1
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: src/usr.bin/lock/lock.1,v 1.4.2.4 2002/09/15 22:32:56 dd Exp $
30 .\" $DragonFly: src/usr.bin/lock/lock.1,v 1.3 2008/05/02 02:05:07 swildner Exp $
31 .\"
32 .Dd July 10, 2002
33 .Dt LOCK 1
34 .Os
35 .Sh NAME
36 .Nm lock
37 .Nd reserve a terminal
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl npv
41 .Op Fl t Ar timeout
42 .Sh DESCRIPTION
43 The
44 .Nm
45 utility requests a password from the user, reads it again for verification
46 and then will normally not relinquish the terminal until the password is
47 repeated.
48 There are two other conditions under which it will terminate: it
49 will timeout after some interval of time and it may be killed by someone
50 with the appropriate permission.
51 .Pp
52 Options:
53 .Bl -tag -width Fl
54 .It Fl n
55 Don't use a timeout value.  Terminal will be locked forever.
56 .It Fl p
57 A password is not requested, instead the user's current login password
58 is used.
59 .It Fl t Ar timeout
60 The time limit (default 15 minutes) is changed to
61 .Ar timeout
62 minutes.
63 .It Fl v
64 Disable switching virtual terminals while this terminal is locked.
65 This option is implemented in a way similar to the
66 .Fl S
67 option of
68 .Xr vidcontrol 1 ,
69 and is only available if the terminal in question is a
70 .Xr syscons 4
71 virtual terminal.
72 .El
73 .Sh HISTORY
74 The
75 .Nm
76 command appeared in
77 .Bx 3.0 .