man/vlock-main.8

   1 .TH VLOCK-MAIN 8 "28 July 2007" "Linux" "Linux Programmer's Manual"
   2 .SH NAME
   3 vlock-main \- lock current virtual console
   4 .SH SYNOPSIS
   5 .B vlock-main [plugins...]
   6 .SH DESCRIPTION
   7 \fBvlock-main\fR is part of vlock(1), the Virtual Console locking program for
   8 Linux.  It locks the current session and will only exit if the current user can
   9 authenticate themselves.  The root user will also be able to unlock the
  10 session, unless disabled at compile time.  The command line arguments specify
  11 plugins that should be loaded by vlock-main.  See vlock-plugins(5) for more
  12 information.
  13 .PP
  14 If plugin support is disabled at compile time, the only supported argument is
  15 "all".
  16 .SH "ENVIRONMENT VARIABLES"
  17 The following environment variables can be used to change the behavior of
  18 vlock-main:
  19 .PP
  20 .B USER
  21 .IP
  22 If this variable is when vlock-main is run as root (uid 0) vlock locks
  23 the screen as this user instead of root.  The root password will still be able
  24 to unlock the session, unless disabled at compile time.
  25 .PP
  26 .B VLOCK_ALL_MESSAGE
  27 .IP
  28 If this variable is set and all consoles are locked its contents will be used
  29 as the locking message instead of the default message.
  30 .PP
  31 .B VLOCK_CURRENT_MESSAGE
  32 .IP
  33 If this variable is set and only the current consoles is locked its contents
  34 will be used as the locking message instead of the default message.
  35 .PP
  36 .B VLOCK_MESSAGE
  37 .IP
  38 If this variable is set its contents will be used as the locking message
  39 instead of the default.  This overrides the former two variables.
  40 .PP
  41 .B VLOCK_TIMEOUT
  42 .IP
  43 Set this variable to specify the timeout (in seconds) after which the screen
  44 saver plugins (if any) will be invoked.  If this variable is unset or set to an
  45 invalid value or 0 no timeout is used.  See vlock-plugins(5) for more
  46 information about plugins.
  47 .PP
  48 .B VLOCK_PROMPT_TIMEOUT
  49 .IP
  50 Set this variable to specify the amount of time (in seconds) you will
  51 have to enter your password at the password prompt.  Every keystroke
  52 resets the timeout.  If this variable is unset or set to an invalid
  53 value or 0 no timeout is used.  \fBWarning\fR: If this value is too
  54 low, you may not be able to unlock your session.
  55 .PP
  56 .SH SIGNALS
  57 Several signals are ignored.  \fBvlock-main\fR will try to exit cleanly if
  58 SIGTERM is received.
  59 .SH "SEE ALSO"
  60 .BR vlock (1),
  61 .BR vlock-plugins (5)
  62 .SH AUTHORS
  63 Frank Benkstein <frank-vlock@benkstein.net>