1XTRLOCK(1)                  General Commands Manual                 XTRLOCK(1)
2
3
4

NAME

6       xtrlock - Lock X display until password supplied, leaving windows visi‐
7       ble
8

SYNOPSIS

10       xtrlock [-b] [-f]
11

DESCRIPTION

13       xtrlock locks the X server till the user enters their password  at  the
14       keyboard.
15
16       While  xtrlock  is  running, the mouse and keyboard are grabbed and the
17       mouse cursor becomes a padlock.  Output displayed by  X  programs,  and
18       windows  put  up  by new X clients, continue to be visible, and any new
19       output is displayed normally.
20
21       The mouse and keyboard are returned when the user types their password,
22       followed  by Enter or Newline.  If an incorrect password is entered the
23       bell is sounded.  Pressing Backspace or Delete erases one character  of
24       a  password  partially  typed; pressing Escape or Clear clears anything
25       that has been entered.
26
27       If too many attempts are made in too short a  time  further  keystrokes
28       generate bells and are otherwise ignored until a timeout has expired.
29
30       The  X  server  screen saver continues to operate normally; if it comes
31       into operation the display may be restored by the usual means of touch‐
32       ing a key (Shift, for example) or the mouse.
33

WARNING

35       Due  to  limitations  in the X11 protocol, the xtrlock cannot intercept
36       all keyboard and mouse events if run under a Wayland-based desktop  en‐
37       vironment.  In  this  situation, applications that use the "legacy" X11
38       protocol will be locked whilst ones supporting Wayland can still be in‐
39       teracted  with, even when xtrlock is in operation. Some keyboard short‐
40       cuts may also continue to function whilst the display is locked.
41
42       A warning is printed if such an environment is detected. For an  alter‐
43       native solution, please see swaylock(1) or similar.
44

OPTIONS

46       -b     blank the screen as well as displaying the padlock
47
48       -f     fork after locking is complete, and return success from the par‐
49              ent process
50

X RESOURCES, CONFIGURATION

52       None.
53

BUGS

55       Additional input devices other than the keyboard and mouse are not dis‐
56       abled.
57
58       The timeouts, bitmaps and mouse cursor colour cannot be modified.
59

SEE ALSO

61       X(1), Xlib Documentation.
62

AUTHOR

64       Ian Jackson <ian@chiark.greenend.org.uk>
65

67       Copyright (C) 1993, 1994 by Ian Jackson.
68
69       Permission  to  use,  copy, modify and distribute this software and its
70       documentation is granted under the terms of the GNU General Public  Li‐
71       cence,  version  2  or later, as published by the Free Software Founda‐
72       tion.
73
74       This program is distributed in the hope that it  will  be  useful,  but
75       WITHOUT  ANY  WARRANTY;  without  even  the  implied  warranty  of MER‐
76       CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU  General
77       Public License for more details.
78
79
80
81                                                                    XTRLOCK(1)
Impressum