1 .de Vb \" Begin verbatim text
6 .de Ve \" End verbatim text
11 .TH i3lock 1 "JANUARY 2012" Linux "User Manuals"
14 i3lock \- improved screen locker
36 is a simple screen locker like slock. After starting it, you will see a white
37 screen (you can configure the color/an image). You can return to your screen by
38 entering your password.
43 i3lock forks, so you can combine it with an alias to suspend to RAM (run "i3lock && echo mem > /sys/power/state" to get a locked screen after waking up your computer from suspend to RAM)
45 You can specify either a background color or a PNG image which will be displayed while your screen is locked.
47 You can specify whether i3lock should bell upon a wrong password.
49 i3lock uses PAM and therefore is compatible with LDAP, etc.
55 Display the version of your
60 Don't fork after starting.
64 Enable beeping. Be sure to not do this when you are about to annoy other people,
65 like when opening your laptop in a boring lecture.
68 .BI \-I\ seconds \fR,\ \fB\-\-inactivity-timeout= seconds
69 Specifies the number of seconds i3lock will wait for another password before
70 turning off the monitors, in case you entered a wrong password or canceled by
71 pressing Escape. Only makes sense together with \-d. If omitted, the default is
75 .B \-u, \-\-no-unlock-indicator
76 Disable the unlock indicator. i3lock will by default show an unlock indicator
77 after pressing keys. This will give feedback for every keypress and it will
78 show you the current PAM state (whether your password is currently being
79 verified or whether it is wrong).
82 .BI \-i\ path \fR,\ \fB\-\-image= path
83 Display the given PNG image instead of a blank screen.
86 .BI \-c\ rrggbb \fR,\ \fB\-\-color= rrggbb
87 Turn the screen into the given color instead of white. Color must be given in 3-byte
88 format: rrggbb (i.e. ff0000 is red).
92 If an image is specified (via \-i) it will display the image tiled all over the screen
93 (if it is a multi-monitor setup, the image is visible on all screens).
96 .BI \-p\ win|default \fR,\ \fB\-\-pointer= win|default
97 If you specify "default",
99 does not hide your mouse pointer. If you specify "win",
101 displays a hardcoded Windows-Pointer (thus enabling you to mess with your
102 friends by using a screenshot of a Windows desktop as a locking-screen).
105 .B \-e, \-\-ignore-empty-password
106 When an empty password is provided by the user, do not validate
107 it. Without this option, the empty password will be provided to PAM
108 and, if invalid, the user will have to wait a few seconds before
109 another try. This can be useful if the XF86ScreenSaver key is used to
110 put a laptop to sleep and bounce on resume or if you happen to wake up
111 your computer with the enter key.
114 .B \-f, \-\-show-failed-attempts
115 Show the number of failed attempts, if any.
119 Enables debug logging.
120 Note, that this will log the password used for authentication to stdout.
124 The \-d (\-\-dpms) option was removed from i3lock in version 2.8. There were
125 plenty of use-cases that were not properly addressed, and plenty of bugs
126 surrounding that feature. While features are not normally removed from i3 and
127 its tools, we felt the need to make an exception in this case.
129 Users who wish to explicitly enable DPMS only when their screen is locked can
130 use a wrapper script around i3lock like the following:
137 \& trap revert HUP INT TERM
138 \& xset +dpms dpms 5 5 5
145 \- use i3lock as your screen saver
148 Michael Stapelberg <michael+i3lock at stapelberg dot de>
150 Jan-Erik Rediger <badboy at archlinux.us>