]> git.sur5r.net Git - i3/i3lock/blobdiff - i3lock.1
Don’t strip when building, the distro’s build systems handle this
[i3/i3lock] / i3lock.1
index 922c153b5e4aeb9c9c81912b4597193333e52762..35df6e0f662653f8f75f218f18aa9db83864bf63 100644 (file)
--- a/i3lock.1
+++ b/i3lock.1
@@ -8,7 +8,7 @@
 .fi
 ..
 
-.TH i3lock 1 "MAY 2009" Linux "User Manuals"
+.TH i3lock 1 "AUGUST 2009" Linux "User Manuals"
 
 .SH NAME
 i3lock \- slightly improved version of slock
@@ -19,10 +19,15 @@ i3lock \- slightly improved version of slock
 .RB [\|\-n\|]
 .RB [\|\-b\|]
 .RB [\|\-d\|]
+.RB [\|\-i
+.IR image.xpm \|]
+.RB [\|\-c
+.IR color \|]
+.RB [\|\-t\|]
 
 .SH DESCRIPTION
 .B i3lock
-locks your screen by making it white. To quit
+locks your screen by making it white (default). To quit
 .B i3lock
 just enter your password.
 
@@ -33,9 +38,11 @@ improves slock by making it fork() and therefore combinable with
 commands to suspend your computer. Additionally, instead of turning off
 your screen via DPMS and/or displaying a black screen,
 .B i3lock
-displays a white screen so you can see if your computer failed to resume
-from suspend or if your screen is just locked. Also, when entering a wrong
-password,
+displays a white (or colored in your favorite color) screen so you can see
+if your computer failed to resume from suspend or if your screen is just
+locked. Since version 1.1,
+.B i3lock
+can display images in XPM file format. Also, when entering a wrong password,
 .B i3lock
 does not call XBell(). This is important because
 .B i3lock/slock
@@ -64,7 +71,24 @@ 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, \-\-image
+Display the given XPM image instead of a blank screen. You can convert an image to
+XPM by using convert(1) from ImageMagick or GIMP for example.
+
+.TP
+.B \-c, \-\-color
+Turns the screen into the given color instead of white. Color must be given in 6-byte
+format: rrggbb (i.e. ff0000 is red)
+
+.TP
+.B \-t, \-\-tile
+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).
+
 .SH AUTHOR
 Michael Stapelberg <michael+i3lock at stapelberg dot de>
 
+Jan-Erik Rediger <badboy at archlinux.us>
+
 forked from slock-0.9 by Anselm R Garbe <garbeam at gmail dot com>