.fi
..
-.TH i3lock 1 "JULY 2011" Linux "User Manuals"
+.TH i3lock 1 "JANUARY 2012" Linux "User Manuals"
.SH NAME
i3lock \- improved screen locker
.RB [\|\-v\|]
.RB [\|\-n\|]
.RB [\|\-b\|]
-.RB [\|\-d\|]
.RB [\|\-i
.IR image.png \|]
.RB [\|\-c
.RB [\|\-t\|]
.RB [\|\-p
.IR pointer\|]
+.RB [\|\-u\|]
+.RB [\|\-e\|]
+.RB [\|\-f\|]
+.RB [\|\-l\|]
.SH DESCRIPTION
.B i3lock
.SH IMPROVEMENTS
-.TP
-* 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)
-
-.TP
-* You can specify either a background color or a PNG image which will be displayed while your screen is locked.
-
-.TP
-* You can specify whether i3lock should bell upon a wrong password.
-
-.TP
-* i3lock uses PAM and therefore is compatible with LDAP etc.
+.IP \[bu] 2
+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)
+.IP \[bu]
+You can specify either a background color or a PNG image which will be displayed while your screen is locked.
+.IP \[bu]
+You can specify whether i3lock should bell upon a wrong password.
+.IP \[bu]
+i3lock uses PAM and therefore is compatible with LDAP, etc.
.SH OPTIONS
Enable beeping. Be sure to not do this when you are about to annoy other people,
like when opening your laptop in a boring lecture.
-.TP
-.B \-d, \-\-dpms
-Enable turning off your screen using DPMS. Note that, when you do not specify this
-option, DPMS will turn off your screen after 15 minutes of inactivity anyways (if
-you did not disable this in your X server).
-
.TP
.B \-u, \-\-no-unlock-indicator
-Disables the unlock indicator. i3lock will by default show an unlock indicator
+Disable the unlock indicator. i3lock will by default show an unlock indicator
after pressing keys. This will give feedback for every keypress and it will
show you the current PAM state (whether your password is currently being
verified or whether it is wrong).
.TP
.BI \-c\ rrggbb \fR,\ \fB\-\-color= rrggbb
-Turns the screen into the given color instead of white. Color must be given in 6-byte
-format: rrggbb (i.e. ff0000 is red)
+Turn the screen into the given color instead of white. Color must be given in 3-byte
+format: rrggbb (i.e. ff0000 is red).
.TP
.B \-t, \-\-tiling
-If an image is specified (via -i) it will display the image tiled all over the screen
+If an image is specified (via \-i) it will display the image tiled all over the screen
(if it is a multi-monitor setup, the image is visible on all screens).
.TP
.BI \-p\ win|default \fR,\ \fB\-\-pointer= win|default
If you specify "default",
.B i3lock
-does not hide your Mousepointer. If you specify "win",
+does not hide your mouse pointer. If you specify "win",
.B i3lock
-displays a hardcoded Windows-Pointer (thus enabling you to fuck with your
-friends by using a Screenshot of a Windows-Desktop as a locking-screen).
+displays a hardcoded Windows-Pointer (thus enabling you to mess with your
+friends by using a screenshot of a Windows desktop as a locking-screen).
+
+.TP
+.B \-e, \-\-ignore-empty-password
+When an empty password is provided by the user, do not validate
+it. Without this option, the empty password will be provided to PAM
+and, if invalid, the user will have to wait a few seconds before
+another try. This can be useful if the XF86ScreenSaver key is used to
+put a laptop to sleep and bounce on resume or if you happen to wake up
+your computer with the enter key.
+
+.TP
+.B \-f, \-\-show-failed-attempts
+Show the number of failed attempts, if any.
+
+.TP
+.B \-l, \-\-lock-console
+Lock the console to disable TTY switching (Linux only).
+
+.TP
+.B \-\-debug
+Enables debug logging.
+Note, that this will log the password used for authentication to stdout.
+
+.SH DPMS
+
+The \-d (\-\-dpms) option was removed from i3lock in version 2.8. There were
+plenty of use-cases that were not properly addressed, and plenty of bugs
+surrounding that feature. While features are not normally removed from i3 and
+its tools, we felt the need to make an exception in this case.
+
+Users who wish to explicitly enable DPMS only when their screen is locked can
+use a wrapper script around i3lock like the following:
+
+.Vb 6
+\& #!/bin/sh
+\& revert() {
+\& xset dpms 0 0 0
+\& }
+\& trap revert HUP INT TERM
+\& xset +dpms dpms 5 5 5
+\& i3lock -n
+\& revert
+.Ve
+
+The \-I (-\-inactivity-timeout=seconds) was removed because it only makes sense with DPMS.
+
+.SH SEE ALSO
+.IR xautolock(1)
+\- use i3lock as your screen saver
.SH AUTHOR
Michael Stapelberg <michael+i3lock at stapelberg dot de>
projects / i3 / i3lock / blobdiff