1i3lock(1) User Manuals i3lock(1)
3
7 i3lock - improved screen locker
8
11 i3lock [-v] [-n] [-b] [-i image.png] [-c color] [-t] [-p pointer] [-u]
12 [-e] [-f]
13
16 i3lock is a simple screen locker like slock. After starting it, you
17 will see a white screen (you can configure the color/an image). You can
18 return to your screen by entering your password.
19
22 · i3lock forks, so you can combine it with an alias to suspend to RAM
23 (run "i3lock && echo mem > /sys/power/state" to get a locked screen
24 after waking up your computer from suspend to RAM)
25 · You can specify either a background color or a PNG image which will
27 be displayed while your screen is locked.
28 · You can specify whether i3lock should bell upon a wrong password.
30 · i3lock uses PAM and therefore is compatible with LDAP, etc.
32
36 -v, --version
37 Display the version of your i3lock
38 -n, --nofork
41 Don't fork after starting.
42 -b, --beep
45 Enable beeping. Be sure to not do this when you are about to
46 annoy other people, like when opening your laptop in a boring
47 lecture.
48 -u, --no-unlock-indicator
51 Disable the unlock indicator. i3lock will by default show an
52 unlock indicator after pressing keys. This will give feedback
53 for every keypress and it will show you the current PAM state
54 (whether your password is currently being verified or whether it
55 is wrong).
56 -i path, --image=path
59 Display the given PNG image instead of a blank screen.
60 -c rrggbb, --color=rrggbb
63 Turn the screen into the given color instead of white. Color
64 must be given in 3-byte format: rrggbb (i.e. ff0000 is red).
65 -t, --tiling
68 If an image is specified (via -i) it will display the image
69 tiled all over the screen (if it is a multi-monitor setup, the
70 image is visible on all screens).
71 -p win|default, --pointer=win|default
74 If you specify "default", i3lock does not hide your mouse
75 pointer. If you specify "win", i3lock displays a hardcoded Win‐
76 dows-Pointer (thus enabling you to mess with your friends by
77 using a screenshot of a Windows desktop as a locking-screen).
78 -e, --ignore-empty-password
81 When an empty password is provided by the user, do not validate
82 it. Without this option, the empty password will be provided to
83 PAM and, if invalid, the user will have to wait a few seconds
84 before another try. This can be useful if the XF86ScreenSaver
85 key is used to put a laptop to sleep and bounce on resume or if
86 you happen to wake up your computer with the enter key.
87 -f, --show-failed-attempts
90 Show the number of failed attempts, if any.
91 --debug
94 Enables debug logging. Note, that this will log the password
95 used for authentication to stdout.
96
99 The -d (--dpms) option was removed from i3lock in version 2.8. There
100 were plenty of use-cases that were not properly addressed, and plenty
101 of bugs surrounding that feature. While features are not normally
102 removed from i3 and its tools, we felt the need to make an exception in
103 this case.
104 Users who wish to explicitly enable DPMS only when their screen is
106 locked can use a wrapper script around i3lock like the following:
107 #!/bin/sh
109 revert() {
110 xset dpms 0 0 0
111 }
112 trap revert HUP INT TERM
113 xset +dpms dpms 5 5 5
114 i3lock -n
115 revert
116 The -I (--inactivity-timeout=seconds) was removed because it only makes
118 sense with DPMS.
119
122 xautolock(1) - use i3lock as your screen saver
123
126 Michael Stapelberg <michael+i3lock at stapelberg dot de>
127 Jan-Erik Rediger <badboy at archlinux.us>
129Linux JANUARY 2012 i3lock(1)