Add a manpage and install it, update debian description

diff --git a/Makefile b/Makefile
index 4a8d2a15fb0bd924b36cc9f613ed8ff0514da55b..0f0c9b771d5459719e61328e79be47fcab366e63 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -40,7 +40,9 @@ dist: clean
 install: all
        @echo installing executable file to $(DESTDIR)$(PREFIX)/bin
        $(INSTALL) -d $(DESTDIR)$(PREFIX)/bin
+       $(INSTALL) -d $(MANDIR)/man1
        $(INSTALL) -m 4755 i3lock $(DESTDIR)$(PREFIX)/bin/i3lock
+       $(INSTALL) -m 644 i3lock.1 $(MANDIR)/man1/i3lock.1
 
 uninstall:
        @echo removing executable file from $(DESTDIR)$(PREFIX)/bin

diff --git a/config.mk b/config.mk
index 4ed82385229896d32069fb2037ddc8a532bd4f3b..9f1d5e5b8d0f1e8deadcf4030d4cf992ac818211 100644 (file)
--- a/config.mk
+++ b/config.mk
@@ -9,6 +9,8 @@ PREFIX = /usr
 X11INC = /usr/X11R6/include
 X11LIB = /usr/X11R6/lib
 
+MANDIR = $(DESTDIR)$(PREFIX)/share/man
+
 # includes and libs
 INCS = -I. -I/usr/include -I${X11INC}
 LIBS = -L/usr/lib -lc -lcrypt -L${X11LIB} -lX11

diff --git a/debian/control b/debian/control
index 460e852848293967d2d2a92183b3910d7009a64d..86ab5c28a5a2a63499132db74e3228b9d6ff2b2f 100644 (file)
--- a/debian/control
+++ b/debian/control
@@ -12,12 +12,10 @@ Priority: optional
 Section: x11
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Description: a slightly improved version of slock
- Key features of i3 are correct implementation of Xinerama (workspaces are
- assigned to virtual screens, i3 does the right thing when attaching new
- monitors), XrandR support (not done yet), horizontal and vertical columns
- (think of a table) in tiling. Also, special focus is on writing clean,
- readable and well documented code. i3 uses xcb for asynchronous
- communication with X11, and has several measures to be very fast.
- .
- Please be aware i3 is primarily targeted at advanced users and developers
- and that you’re currently trying an alpha version (which may contain bugs).
+ i3lock improves slock by making it fork() and therefore combinable with
+ commands to suspend your computer. Additionally, instead of turning of
+ your screen via DPMS and/or displaying a black screen, 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,
+ i3lock does not call XBell(). This is important because i3lock/slock think
+ you've entered a password when resuming from suspend, at least sometimes.

diff --git a/i3lock.1 b/i3lock.1
new file mode 100644 (file)
index 0000000..4d208d7
--- /dev/null
+++ b/i3lock.1
@@ -0,0 +1,46 @@
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+
+.TH i3lock 1 "MARCH 2009" Linux "User Manuals"
+
+.SH NAME
+i3lock \- slightly improved version of slock
+
+.SH SYNOPSIS
+i3lock takes no arguments
+
+.SH DESCRIPTION
+.B i3lock
+locks your screen by making it white. To quit
+.B i3lock
+just enter your password.
+
+.SH DIFFERENCES TO SLOCK
+
+.B i3lock
+improves slock by making it fork() and therefore combinable with
+commands to suspend your computer. Additionally, instead of turning of
+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,
+.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.
+
+.B i3lock
+was forked from slock-0.9
+
+.SH AUTHOR
+Michael Stapelberg <michael+i3lock at stapelberg dot de>
+
+forked from slock-0.9 by Anselm R Garbe <garbeam at gmail dot com>

diff --git a/i3lock.c b/i3lock.c
index a72971694dae96159378b68d26b64982bf46f71d..7bf913ee47126c743930d31a20acfbcfc349b965 100644 (file)
--- a/i3lock.c
+++ b/i3lock.c
@@ -80,7 +80,8 @@ main(int argc, char **argv) {
        XSetWindowAttributes wa;
 
        if((argc == 2) && !strcmp("-v", argv[1]))
-               die("slock-"VERSION", © 2006-2008 Anselm R Garbe\n");
+               die("i3lock-"VERSION", © 2009 Michael Stapelberg\n"
+                   "based on slock, which is © 2006-2008 Anselm R Garbe\n");
        else if(argc != 1)
                die("usage: slock [-v]\n");