| 1 |
.TH VLOCK 1 "28 July 2007" "Linux" "Linux User's Manual" |
| 2 |
.SH NAME |
| 3 |
vlock \- Virtual Console lock program |
| 4 |
.SH SYNOPSIS |
| 5 |
.B vlock [ -hv ] |
| 6 |
.PP |
| 7 |
.B vlock [ -acns ] [ -t <timeout> ] [ plugins... ] |
| 8 |
.SH DESCRIPTION |
| 9 |
.B vlock |
| 10 |
is a program to lock one or more sessions on the Linux console. This is |
| 11 |
especially useful for Linux machines which have multiple users with access |
| 12 |
to the console. One user may lock his or her session(s) while still allowing |
| 13 |
other users to use the system on other virtual consoles. If desired, the |
| 14 |
entire console may be locked and virtual console switching disabled. |
| 15 |
.PP |
| 16 |
By default, only the current VC (virtual console) is locked. With the |
| 17 |
\fB-a,--all\fR option all VCs are locked. The locked VCs cannot be unlocked |
| 18 |
without the invoker's password or the root password. The root password will |
| 19 |
always be able to unlock any or all sessions, unless disabled at compile time. |
| 20 |
.PP |
| 21 |
Please note that it is entirely possible to completely lock yourself out of the |
| 22 |
console with the \fB-a,--all\fR option if you cannot remember your password! |
| 23 |
Unless you are able to kill vlock by logging in remotely via a serial terminal |
| 24 |
or network, a hard reset is the only method of ``unlocking'' the display. |
| 25 |
.PP |
| 26 |
When locking the entire console display it is sometimes still possible to kill |
| 27 |
vlock using the Secure Access Key (SAK) or other commands that are available |
| 28 |
through the SysRq mechanism. When the \fB-s,--disable-sysrq\fR and |
| 29 |
\fB-a,--all\fR options are given the SysRq mechanism is disabled while vlock is |
| 30 |
running. See /usr/src/linux/Documentation/sysrq.txt for more details. |
| 31 |
.PP |
| 32 |
The options \fB-s,--disable-sysrq\fR, and \fB-t,--timeout\fR |
| 33 |
only work if vlock is compiled with plugin support. See the PLUGINS section |
| 34 |
for more information. |
| 35 |
.SH OPTIONS |
| 36 |
.B -a,--all |
| 37 |
.IP |
| 38 |
Lock all console sessions and disable VC switching. |
| 39 |
.PP |
| 40 |
.B -c,--current |
| 41 |
.IP |
| 42 |
Lock the current session (this is the default). |
| 43 |
.PP |
| 44 |
.B -s,--disable-sysrq |
| 45 |
.IP |
| 46 |
Disable the SysRq mechanism while consoles are locked. This option only works |
| 47 |
if the \fB-a,--all\fR option given. |
| 48 |
.PP |
| 49 |
.B -t,--timeout <seconds> |
| 50 |
.IP |
| 51 |
Specify the timeout for the screensaver plugins. See vlock-plugins(5) for more |
| 52 |
information. |
| 53 |
.PP |
| 54 |
.B -h,--help |
| 55 |
.IP |
| 56 |
Print a brief help message. |
| 57 |
.PP |
| 58 |
.B -v,--version |
| 59 |
.IP |
| 60 |
Print the version number. |
| 61 |
.PP |
| 62 |
.SH "ENVIRONMENT VARIABLES" |
| 63 |
The following environment variables can be used to change vlock's behavior: |
| 64 |
.PP |
| 65 |
.B USER |
| 66 |
.IP |
| 67 |
If this variable is when \fBvlock\fR is run as root (uid 0) vlock locks the |
| 68 |
screen as this user instead of root. The root password will still be able to |
| 69 |
unlock the session, unless disabled at compile time. |
| 70 |
.PP |
| 71 |
.B VLOCK_ALL_MESSAGE |
| 72 |
.IP |
| 73 |
If this variable is set and all consoles are locked its contents will be used |
| 74 |
as the locking message instead of the default message. |
| 75 |
.PP |
| 76 |
.B VLOCK_CURRENT_MESSAGE |
| 77 |
.IP |
| 78 |
If this variable is set and only the current consoles is locked its contents |
| 79 |
will be used as the locking message instead of the default message. |
| 80 |
.PP |
| 81 |
.B VLOCK_MESSAGE |
| 82 |
.IP |
| 83 |
If this variable is set its contents will be used as the locking message |
| 84 |
instead of the default. This overrides the former two variables. |
| 85 |
.PP |
| 86 |
.B VLOCK_PLUGINS |
| 87 |
.IP |
| 88 |
If this variable is set it is interpreted as a space separated list of plugins |
| 89 |
that will be loaded when vlock starts additionally to the ones listed on the |
| 90 |
command line. |
| 91 |
.PP |
| 92 |
.B VLOCK_TIMEOUT |
| 93 |
.IP |
| 94 |
Set this variable to specify the timeout (in seconds) after which the screen |
| 95 |
saver plugins (if any) will be invoked. If this variable is unset or set to an |
| 96 |
invalid value or 0 no timeout is used. See vlock-plugins(5) for more |
| 97 |
information about plugins. |
| 98 |
.PP |
| 99 |
.B VLOCK_PROMPT_TIMEOUT |
| 100 |
.IP |
| 101 |
Set this variable to specify the amount of time (in seconds) you will have to |
| 102 |
enter your password at the password prompt. If this variable is unset or set |
| 103 |
to an invalid value or 0 no timeout is used. \fBWarning\fR: If this value is |
| 104 |
too low, you may not be able to unlock your session. |
| 105 |
.PP |
| 106 |
.SH FILES |
| 107 |
.B ~/.vlockrc |
| 108 |
.IP |
| 109 |
This file is read by \fBvlock\fR on startup if it exists. All the variables |
| 110 |
mentioned above can be set here. |
| 111 |
.SH SECURITY |
| 112 |
See the SECURITY file in the \fBvlock\fR distribution for more information. |
| 113 |
.PP |
| 114 |
.SH "SEE ALSO" |
| 115 |
.BR vlock-main (8), |
| 116 |
.BR vlock-plugins (5) |
| 117 |
.SH AUTHORS |
| 118 |
Michael K. Johnson <http://danlj.org/mkj/> |
| 119 |
.PP |
| 120 |
Frank Benkstein <[email protected]> |