man/vlock-current.8: document VLOCK_PROMPT_TIMEOUT and wording
[vlock.git] / man / vlock-current.8
blobca138c84214593b549321ffe7b654edfef367546
1 .TH VLOCK-CURRENT 8 "28 July 2007" "Linux" "Linux Programmer's Manual"
2 .SH NAME
3 vlock-current \- lock current virtual console
4 .SH SYNOPSIS
5 .B vlock-current
6 .SH DESCRIPTION
7 \fBvlock-current\fR is part of vlock(1), the Virtual Console locking program
8 for Linux.  Once started it only exits if correct authentification data (either
9 the current user's or root's) is received.  Authentification can be done
10 against PAM or shadow, determined at compile time.
11 .SH "ENVIRONMENT VARIABLES"
12 .B USER
13 .IP
14 When \fBvlock-current\fR is run as root (uid 0) and this environment variable is
15 set \fBvlock-current\fR works the same as if it was run by that user.
16 .PP
17 .B VLOCK_MESSAGE
18 .IP
19 When this environment variable is set \fBvlock-current\fR prints its contents
20 before each password prompt.
21 .PP
22 .B VLOCK_PROMPT_TIMEOUT
23 .IP
24 Set this variable to specify the amount of time (in seconds) you will have to
25 enter your password at the password prompt.  \fBWarning\fR: If this value is too
26 low, you will have trouble unlocking your machine.
27 .SH "EXIT CODES"
28 \fBvlock-current\fR exits 111 when the username can not be determined.
29 .SH SIGNALS
30 SIGINT, SIGQUIT, and SIGTSTP are ignored ignored.  If \fBvlock-current\fR
31 is killed by any other signal the terminal is not restored.
32 .SH "SEE ALSO"
33 .BR vlock (1)
34 .SH AUTHORS
35 Frank Benkstein <frank-vlock@benkstein.net>