Merge pull request #10 from Deiz/modifiers

[i3/i3lock] / i3lock.1

diff --git a/i3lock.1 b/i3lock.1
index 9c349b1665e114304ee2d919345ca498551f9c31..07f127054de8242d4e90f7ac1d4cdda421fe8b86 100644 (file)
--- a/i3lock.1
+++ b/i3lock.1
@@ -28,6 +28,8 @@ i3lock \- improved screen locker
 .IR pointer\|]
 .RB [\|\-u\|]
 .RB [\|\-e\|]
+.RB [\|\-I\|]
+.RB [\|\-f\|]
 
 .SH DESCRIPTION
 .B i3lock
@@ -37,17 +39,14 @@ entering your password.
 
 .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
@@ -71,9 +70,16 @@ Enable turning off your screen using DPMS. Note that, when you do not specify th
 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 \-I, \-\-inactivity-timeout
+Specifies the number of seconds i3lock will wait for another password before
+turning off the monitors, in case you entered a wrong password or canceled by
+pressing Escape. Only makes sense together with \-d. If omitted, the default is
+30 seconds.
+
 .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).
@@ -84,8 +90,8 @@ Display the given PNG image instead of a blank screen.
 
 .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
@@ -96,10 +102,10 @@ If an image is specified (via \-i) it will display the image tiled all over the
 .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
@@ -110,6 +116,15 @@ 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 \-\-debug
+Enables debug logging.
+Note, that this will log the password used for authentication to stdout.
+
 .SH SEE ALSO
 .IR xautolock(1)
 \- use i3lock as your screen saver