* Introduction

Kbdlock is a simple and safe console locker for Linux.

* Installation

Follow the steps below:

1) [optional] Edit Makefile to your liking.

Follow the instructions in the "User-configurable variables" section.

2) Run

    make install

3) Edit /etc/group.

Only users from the `kbdlock' group are allowed to run this program.

* Usage

When run without arguments, kbdlock locks your screen for an
indefinite time. To unlock, enter your system account password
at the prompt.

Command line options modify its behavior. Below is a concise summary
of these, see the kbdlock(1) manpage for a detailed discussion. 

When given the `-p' (`--password') option, the program will ask you to
supply the password to use instead of your system one.

The `-t' (`--timeout') option instructs the program to unlock the
screen automatically after a given time elapses. The argument to this
option is a time specification in a human-readable form. For example,
`kbdlock -t 2h30m' locks the screen for at most two hours and a half.

Normally, kbdlock displays the content of the /etc/issues file
followed by the password prompt:

  tty is locked by <username>

If the `-t' option is used, the timeout information is included in the
prompt.

If kbdlock is linked with the curses library, the `-c' (`--clear')
option can be used to request clearing the screen prior to that.

To display other file than /etc/issues, use the `-i' (`--issue')
option followed by the name of the file to use. If the issue file
does not exist or is not readable, kbdlock will silently ignore it.

If you wish to clear the screen and not display anything but the
password prompt, use:

  kbdlock -c -i /dev/null

To disable printing the prompt, run kbdlock with the `-q' (`--quiet')
option. Notice that this can be confusing.

To discourage brute force attacks, kbdlock waits 3 seconds after each
invalid password input. This interval can be configured using the `-s'
(`--sleep') option.

The rest of options understood by kbdlock are informative. The `-h'
(`--help') option displays a short usage summary, and `-v'
(`--version') shows the program version and a short license statement.

* Bug reports

Report bugs and suggestions to <gray@gnu.org.ua>.

This is a very old program of mine, originally written in plain K&R
C. When I recently decided to improve it somewhat, I deliberately
remained true to K&R because of my deep affection to it. This
means, in particular, that depending on your compiler and the options
you supply to it in the Makefile, you can get quite a few warnings
about implicit function declarations, missing return types and another
meaningless cruft like that. Please, do not report these as bugs --
they are not.

* Copyright information:

Copyright (C) 1999,2005,2012 Sergey Poznyakoff 

   Permission is granted to anyone to make or distribute verbatim copies
   of this document as received, in any medium, provided that the
   copyright notice and this permission notice are preserved,
   thus giving the recipient permission to redistribute in turn.

   Permission is granted to distribute modified versions
   of this document, or of portions of it,
   under the above conditions, provided also that they
   carry prominent notices stating who last changed them.


Local variables:
mode: outline
paragraph-separate: "[ 	]*$"
end:

