Merge pull request #213 from trickeydan/patch-1

[i3/i3lock] / i3lock.1

diff --git a/i3lock.1 b/i3lock.1
index e95340c0edc0fbb172ab05718514d43ef77a9ddc..434638b6aa1ab793f2f33163065eafa3f3fca665 100644 (file)
--- a/i3lock.1
+++ b/i3lock.1
@@ -18,7 +18,6 @@ i3lock \- improved screen locker
 .RB [\|\-v\|]
 .RB [\|\-n\|]
 .RB [\|\-b\|]
-.RB [\|\-d\|]
 .RB [\|\-i
 .IR image.png \|]
 .RB [\|\-c
@@ -28,6 +27,8 @@ i3lock \- improved screen locker
 .IR pointer\|]
 .RB [\|\-u\|]
 .RB [\|\-e\|]
+.RB [\|\-f\|]
+.RB [\|\-l\|]
 
 .SH DESCRIPTION
 .B i3lock
@@ -62,12 +63,6 @@ Don't fork after starting.
 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
 Disable the unlock indicator. i3lock will by default show an unlock indicator
@@ -81,7 +76,7 @@ Display the given PNG image instead of a blank screen.
 
 .TP
 .BI \-c\  rrggbb \fR,\ \fB\-\-color= rrggbb
-Turn the screen into the given color instead of white. Color must be given in 6-byte
+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
@@ -107,6 +102,42 @@ 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