man/vlock.1

   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 vlock works for console sessions primarily.  To lock the entire console display
  33 from an X session use the \fB-n,--new\fR option.  This will make vlock switch
  34 to an empty virtual console to lock the display.
  35 .PP
  36 The options \fB-n,--new\fR, \fB-s,--disable-sysrq\fR, and \fB-t,--timeout\fR
  37 only work if vlock is compiled with plugin support.  See the PLUGINS section
  38 for more information.
  39 .SH OPTIONS
  40 .B -a,--all
  41 .IP
  42 Lock all console sessions and disable VC switching.
  43 .PP
  44 .B -c,--current
  45 .IP
  46 Lock the current session (this is the default).
  47 .PP
  48 .B -n,--new
  49 .IP
  50 Switch to a new virtual console before locking all console sessions.
  51 .PP
  52 .B -s,--disable-sysrq
  53 .IP
  54 Disable the SysRq mechanism while consoles are locked.  This option only works
  55 if the \fB-a,--all\fR option given.
  56 .PP
  57 .B -t,--timeout <seconds>
  58 .IP
  59 Specify the timeout for the screensaver plugins.  See vlock-plugins(5) for more
  60 information.
  61 .PP
  62 .B -h,--help
  63 .IP
  64 Print a brief help message.
  65 .PP
  66 .B -v,--version
  67 .IP
  68 Print the version number.
  69 .PP
  70 .SH "ENVIRONMENT VARIABLES"
  71 The following environment variables can be used to change vlock's behavior:
  72 .PP
  73 .B USER
  74 .IP
  75 If this variable is when \fBvlock\fR is run as root (uid 0) vlock locks the
  76 screen as this user instead of root.  The root password will still be able to
  77 unlock the session, unless disabled at compile time.
  78 .PP
  79 .B VLOCK_ALL_MESSAGE
  80 .IP
  81 If this variable is set and all consoles are locked its contents will be used
  82 as the locking message instead of the default message.
  83 .PP
  84 .B VLOCK_CURRENT_MESSAGE
  85 .IP
  86 If this variable is set and only the current consoles is locked its contents
  87 will be used as the locking message instead of the default message.
  88 .PP
  89 .B VLOCK_MESSAGE
  90 .IP
  91 If this variable is set its contents will be used as the locking message
  92 instead of the default.  This overrides the former two variables.
  93 .PP
  94 .B VLOCK_PLUGINS
  95 .IP
  96 If this variable is set it is interpreted as a space separated list of plugins
  97 that will be loaded when vlock starts additionally to the ones listed on the
  98 command line.
  99 .PP
 100 .B VLOCK_TIMEOUT
 101 .IP
 102 Set this variable to specify the timeout (in seconds) after which the screen
 103 saver plugins (if any) will be invoked.  If this variable is unset or set to an
 104 invalid value or 0 no timeout is used.  See vlock-plugins(5) for more
 105 information about plugins.
 106 .PP
 107 .B VLOCK_PROMPT_TIMEOUT
 108 .IP
 109 Set this variable to specify the amount of time (in seconds) you will
 110 have to enter your password at the password prompt.  Every keystroke
 111 resets the timeout.  If this variable is unset or set to an invalid
 112 value or 0 no timeout is used.  \fBWarning\fR: If this value is too
 113 low, you may not be able to unlock your session.
 114 .PP
 115 .SH FILES
 116 .B ~/.vlockrc
 117 .IP
 118 This file is read by \fBvlock\fR on startup if it exists.  All the variables
 119 mentioned above can be set here.
 120 .SH SECURITY
 121 See the SECURITY file in the \fBvlock\fR distribution for more information.
 122 .PP
 123 .SH "SEE ALSO"
 124 .BR vlock-main (8),
 125 .BR vlock-plugins (5)
 126 .SH AUTHORS
 127 Michael K. Johnson <http://danlj.org/mkj/>
 128 .PP
 129 Frank Benkstein <frank-vlock@benkstein.net>