manpage: PNG instead of XPM

[i3/i3lock] / i3lock.1

diff --git a/i3lock.1 b/i3lock.1
index 35df6e0f662653f8f75f218f18aa9db83864bf63..c2e7b43768069d9199d115acf0c38d5991a383c9 100644 (file)
--- a/i3lock.1
+++ b/i3lock.1
@@ -8,10 +8,10 @@
 .fi
 ..
 
-.TH i3lock 1 "AUGUST 2009" Linux "User Manuals"
+.TH i3lock 1 "JULY 2010" Linux "User Manuals"
 
 .SH NAME
-i3lock \- slightly improved version of slock
+i3lock \- improved screen locker
 
 .SH SYNOPSIS
 .B i3lock
@@ -20,35 +20,33 @@ i3lock \- slightly improved version of slock
 .RB [\|\-b\|]
 .RB [\|\-d\|]
 .RB [\|\-i
-.IR image.xpm \|]
+.IR image.png \|]
 .RB [\|\-c
 .IR color \|]
 .RB [\|\-t\|]
+.RB [\|\-p
+.IR pointer\|]
 
 .SH DESCRIPTION
 .B i3lock
-locks your screen by making it white (default). To quit
-.B i3lock
-just enter your password.
+is a simple screen locker like slock. After starting it, you will see a white
+screen (you can configure the color/an image). You can return to your screen by
+entering your passwords.
 
-.SH DIFFERENCES TO SLOCK
+.SH IMPROVEMENTS
 
-.B i3lock
-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 (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
-think you've entered a password when resuming from suspend, at least sometimes.
+.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 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.
 
-Since version 1.0, i3lock supports PAM.
 
 .SH OPTIONS
 .TP
@@ -73,8 +71,7 @@ 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.
+Display the given PNG image instead of a blank screen.
 
 .TP
 .B \-c, \-\-color
@@ -82,13 +79,20 @@ Turns the screen into the given color instead of white. Color must be given in 6
 format: rrggbb (i.e. ff0000 is red)
 
 .TP
-.B \-t, \-\-tile
+.B \-t, \-\-tiling
 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
+.B \-p, \-\-pointer
+If you specify "default",
+.B i3lock
+does not hide your Mousepointer. 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).
+
 .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>