man/vlock-all.8: update to reflect latest changes
[vlock.git] / README
blob42979fd02c26884179b1e8e1ff28642c95723fbe
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
11 allows you to lock one or all of the sessions of your Linux console
12 display.
14 Usage is very simple; by default, vlock locks the single console
15 you are on.  The -a or --all flags cause it to lock the console
16 completely, so that users cannot switch to another virtual
17 console.
19 If you are working on a shared Linux computer, and want to lock
20 a console session as you left it, but want to allow other users
21 to log onto other sessions, simply run vlock when you leave the
22 computer.
24 If you want to lock the console so that no one else can log onto
25 any of the virtual consoles (perhaps because you have login sessions
26 running on several other virtual consoles at the same time), you
27 use the -a or --all flag to cause vlock to not allow any user
28 to switch to any console without typing your password.
30   WARNING: If you lock all the consoles, they will be *really*
31   locked.  Unless you have a serial terminal, or can log in
32   remotely via a network to kill vlock, you *will not* be able
33   to get back to your terminal session without entering the
34   correct password.  If you loose data because you have to reset
35   your computer because of vlock -a, it is your own problem,
36   not mine.  I warned you.
38 The root password will *always* be able to unlock any vlock
39 session [1].  If anyone else can log in as you, they can send a
40 SIGTERM or SIGKILL to vlock, which *will* kill it [2].
42 vlock consists of several binaries some of which have to be installed
43 as setuid root to function correctly.  Please refer to SECURITY for a
44 detailed description.
46 "vlock -h" or "vlock --help" will get you a help message.
48 To run vlock on a new VC, use the -n or --new flag.  If installed with
49 proper permissions this even works from an X11 session.
51 vlock is maintained by Frank Benkstein <frank-vlock@benkstein.net>.
53 [1] This is a compile time option and can be disabled with the
54     USE_ROOT_PASS compile flag.
55 [2] This, too, is a compile time option (USER_KILL), that can be
56     disabled.