document the change in prompt timeout handling
[vlock.git] / README
blobcb29ae4fa681518817cd892de0d006b13504ba93
1 ::
3    VV       VV  LL          OOO       CCCCC  KK   KK
4     VV     VV   LL        OO   OO   CC       KK KK    originally written by
5      VV   VV    LL       OO     OO  CC       KK        Michael K. Johnson
6       VV VV     LL        OO   OO   CC       KK KK    for Linux Journal
7        VVV      LLLLLLLL    OOO       CCCCC  KK   KK
10 This is vlock, the Linux _V_irtual Console locking program.  It allows
11 you to lock one or all of the sessions of your Linux console display.
13 Usage is very simple; by default, vlock locks the single console or
14 terminal you are on.  If you want to lock the console completely so that
15 no one else can log into any of the virtual consoles (perhaps because
16 you have login sessions running on several other virtual consoles at the
17 same time), you use the -a or --all flag to cause vlock to not allow any
18 user to switch to any console without typing your password.
20   WARNING: If you lock all the consoles, they will be *really*
21   locked.  Unless you have a serial terminal, or can log in
22   remotely to kill vlock, you *will not* be able to get back to
23   your terminal session without correct authentication.
25   After a new installation always test vlock in a terminal to
26   verify that authentication is set up correctly.
28   If you loose data because you have to reset your computer
29   because of vlock -a, it is your own problem, not mine.  I
30   warned you.
32 The root user will *always* be able to unlock any vlock session, unless
33 disabled at compile time.
35 vlock consists of several plugins.  Some of them are potentially
36 dangerous and access to them should be restricted.  Please refer to
37 SECURITY for a detailed description.
39 "vlock -h" or "vlock --help" will get you a help message.
41 To make vlock switch to a new console before locking, use the -n or
42 --new flag.  If installed with proper permissions this even works from
43 an X11 session.  The -n flag implies -a and thus all warnings about -a
44 also apply to -n.
46 vlock is maintained by Frank Benkstein <frank-vlock@benkstein.net>.