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.  Once started it only exits if correct authentification data (either the
   9 current user's or root's) is received.  Authentification can be done against
  10 PAM or shadow, determined at compile time.  The command line arguments specify
  11 the plugins that should be loaded by \fBvlock-main\fR.  If plugin support is
  12 disabled at compile time, only "all" is supported, disabling console switching
  13 while \fBvlock-main\fR is run.
  14 .SH "ENVIRONMENT VARIABLES"
  15 .B USER
  16 .IP
  17 When \fBvlock\fR is run as root (uid 0) and the \fBUSER\fR environment variable
  18 is set, \fBvlock-main\fR prompts for this user's password.
  19 .PP
  20 .B VLOCK_MESSAGE
  21 .IP
  22 If this variable is set it will be printed before each password prompt.
  23 .PP
  24 .B VLOCK_ALL_MESSAGE
  25 .B VLOCK_CURRENT_MESSAGE
  26 .IP
  27 Like \fBVLOCK_MESSAGE\fR but if you set these variables instead, \fBvlock-main\fR will
  28 automatically choose the message.  \fBVLOCK_ALL_MESSAGE\fR is printed when all
  29 sessions are locked and console switching is disabled. Otherwise
  30 \fBVLOCK_CURRENT_MESSAGE\fR is printed.  These variables will only be used
  31 if \fBVLOCK_MESSAGE\fR is unset.
  32 .PP
  33 .B VLOCK_PROMPT_TIMEOUT
  34 .IP
  35 Set this variable to specify the amount of time (in seconds) you will have to
  36 enter your password at the password prompt.  \fBWarning\fR: If this value is too
  37 low, you will have trouble unlocking your machine.
  38 .PP
  39 .B VLOCK_TIMEOUT
  40 .IP
  41 Set this variable to specify the timeout (in seconds) after which the screen
  42 saver plugins (if any) will be invoked.
  43 .SH SIGNALS
  44 Several signals are ignored.  \fBvlock-main\fR will try to exit cleanly if
  45 SIGTERM is received.
  46 .SH "SEE ALSO"
  47 .BR vlock (1)
  48 .SH AUTHORS
  49 Frank Benkstein <frank-vlock@benkstein.net>