xtrlock.man

   1 .TH XTRLOCK 1
   2 .SH NAME
   3 xtrlock \- Lock X display until password supplied, leaving windows visible
   4 .SH SYNOPSIS
   5 .B xtrlock [-b] [-f]
   6 .SH DESCRIPTION
   7 .B xtrlock
   8 locks the X server till the user enters their password at the keyboard.
   9
  10 While
  11 .B xtrlock
  12 is running, the mouse and keyboard are grabbed and the mouse cursor
  13 becomes a padlock.  Output displayed by X programs, and windows put up
  14 by new X clients, continue to be visible, and any new output is
  15 displayed normally.
  16
  17 The mouse and keyboard are returned when the user types their
  18 password, followed by Enter or Newline.  If an incorrect password is
  19 entered the bell is sounded.  Pressing Backspace or Delete erases one
  20 character of a password partially typed; pressing Escape or Clear
  21 clears anything that has been entered.
  22
  23 If too many attempts are made in too short a time further keystrokes
  24 generate bells and are otherwise ignored until a timeout has expired.
  25
  26 The X server screen saver continues to operate normally; if it comes
  27 into operation the display may be restored by the usual means of
  28 touching a key (Shift, for example) or the mouse.
  29 .SH OPTIONS
  30 .TP
  31 \fB\-b\fR
  32 blank the screen as well as displaying the padlock
  33 .TP
  34 \fB\-f\fR
  35 fork after locking is complete, and return success from the parent
  36 process
  37 .SH X RESOURCES, CONFIGURATION
  38 None.
  39 .SH BUGS
  40 Additional input devices other than the keyboard and mouse are not
  41 disabled.
  42
  43 The timeouts, bitmaps and mouse cursor colour cannot be modifed.
  44 .SH SEE ALSO
  45 .BR X "(1), Xlib Documentation."
  46 .SH AUTHOR
  47 Ian Jackson <ian@chiark.greenend.org.uk>
  48 .SH COPYRIGHT
  49 Copyright (C) 1993, 1994 by Ian Jackson.
  50
  51 Permission to use, copy, modify and distribute this software and its
  52 documentation is granted under the terms of the GNU General Public
  53 Licence, version 2 or later, as published by the Free Software
  54 Foundation.
  55
  56 This program is distributed in the hope that it will be useful, but
  57 WITHOUT ANY WARRANTY; without even the implied warranty of
  58 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  59 General Public License for more details.