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
37 is a simple screen locker like slock. After starting it, you will see a white
38 screen (you can configure the color/an image). You can return to your screen by
39 entering your password.
44 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)
46 You can specify either a background color or a PNG image which will be displayed while your screen is locked.
48 You can specify whether i3lock should bell upon a wrong password.
50 i3lock uses PAM and therefore is compatible with LDAP, etc.
56 Display the version of your
61 Don't fork after starting.
65 Enable beeping. Be sure to not do this when you are about to annoy other people,
66 like when opening your laptop in a boring lecture.
70 Enable turning off your screen using DPMS. Note that, when you do not specify this
71 option, DPMS will turn off your screen after 15 minutes of inactivity anyways (if
72 you did not disable this in your X server).
75 .BI \-I\ seconds \fR,\ \fB\-\-inactivity-timeout= seconds
76 Specifies the number of seconds i3lock will wait for another password before
77 turning off the monitors, in case you entered a wrong password or canceled by
78 pressing Escape. Only makes sense together with \-d. If omitted, the default is
82 .B \-u, \-\-no-unlock-indicator
83 Disable the unlock indicator. i3lock will by default show an unlock indicator
84 after pressing keys. This will give feedback for every keypress and it will
85 show you the current PAM state (whether your password is currently being
86 verified or whether it is wrong).
89 .BI \-i\ path \fR,\ \fB\-\-image= path
90 Display the given PNG image instead of a blank screen.
93 .BI \-c\ rrggbb \fR,\ \fB\-\-color= rrggbb
94 Turn the screen into the given color instead of white. Color must be given in 3-byte
95 format: rrggbb (i.e. ff0000 is red).
99 If an image is specified (via \-i) it will display the image tiled all over the screen
100 (if it is a multi-monitor setup, the image is visible on all screens).
103 .BI \-p\ win|default \fR,\ \fB\-\-pointer= win|default
104 If you specify "default",
106 does not hide your mouse pointer. If you specify "win",
108 displays a hardcoded Windows-Pointer (thus enabling you to mess with your
109 friends by using a screenshot of a Windows desktop as a locking-screen).
112 .B \-e, \-\-ignore-empty-password
113 When an empty password is provided by the user, do not validate
114 it. Without this option, the empty password will be provided to PAM
115 and, if invalid, the user will have to wait a few seconds before
116 another try. This can be useful if the XF86ScreenSaver key is used to
117 put a laptop to sleep and bounce on resume or if you happen to wake up
118 your computer with the enter key.
121 .B \-f, \-\-show-failed-attempts
122 Show the number of failed attempts, if any.
126 Enables debug logging.
127 Note, that this will log the password used for authentication to stdout.
131 \- use i3lock as your screen saver
134 Michael Stapelberg <michael+i3lock at stapelberg dot de>
136 Jan-Erik Rediger <badboy at archlinux.us>