From: Markus Teich <markus.teich@stusta.mhn.de>
Date: Thu, 11 Feb 2016 15:49:59 +0000 (+0100)
Subject: add slock.1 man page
X-Git-Url: https://git.danieliu.xyz/?a=commitdiff_plain;h=6a52a85a1ac87b29048863d599a8b0f0ee712482;p=slock.git

add slock.1 man page
---

diff --git a/Makefile b/Makefile
index 1017ac2..86b3437 100644
--- a/Makefile
+++ b/Makefile
@@ -35,7 +35,8 @@ clean:
 dist: clean
 	@echo creating dist tarball
 	@mkdir -p slock-${VERSION}
-	@cp -R LICENSE Makefile README config.def.h config.mk ${SRC} slock-${VERSION}
+	@cp -R LICENSE Makefile README config.def.h config.mk ${SRC} slock.1 \
+		slock-${VERSION}
 	@tar -cf slock-${VERSION}.tar slock-${VERSION}
 	@gzip slock-${VERSION}.tar
 	@rm -rf slock-${VERSION}
@@ -46,9 +47,15 @@ install: all
 	@cp -f slock ${DESTDIR}${PREFIX}/bin
 	@chmod 755 ${DESTDIR}${PREFIX}/bin/slock
 	@chmod u+s ${DESTDIR}${PREFIX}/bin/slock
+	@echo installing manual page to ${DESTDIR}${MANPREFIX}/man1
+	@mkdir -p ${DESTDIR}${MANPREFIX}/man1
+	@sed "s/VERSION/${VERSION}/g" <slock.1 >${DESTDIR}${MANPREFIX}/man1/slock.1
+	@chmod 644 ${DESTDIR}${MANPREFIX}/man1/slock.1
 
 uninstall:
 	@echo removing executable file from ${DESTDIR}${PREFIX}/bin
 	@rm -f ${DESTDIR}${PREFIX}/bin/slock
+	@echo removing manual page from ${DESTDIR}${MANPREFIX}/man1
+	@rm -f ${DESTDIR}${MANPREFIX}/man1/slock.1
 
 .PHONY: all options clean dist install uninstall
diff --git a/config.mk b/config.mk
index 445c58c..f93879e 100644
--- a/config.mk
+++ b/config.mk
@@ -5,6 +5,7 @@ VERSION = 1.3
 
 # paths
 PREFIX = /usr/local
+MANPREFIX = ${PREFIX}/share/man
 
 X11INC = /usr/X11R6/include
 X11LIB = /usr/X11R6/lib
diff --git a/slock.1 b/slock.1
new file mode 100644
index 0000000..1f946d9
--- /dev/null
+++ b/slock.1
@@ -0,0 +1,29 @@
+.TH SLOCK 1 slock\-VERSION
+.SH NAME
+slock \- simple X display locker
+.SH SYNOPSIS
+.B slock
+.RB [ \-v
+|
+.IR post_lock_command ]
+.SH DESCRIPTION
+.B slock
+is a screen locker for X. If provided, the
+.IR post_lock_command
+will be executed when the screen is locked.
+.SH OPTIONS
+.TP
+.B \-v
+prints version information to stdout, then exits.
+.SH EXAMPLES
+$ slock /usr/sbin/s2ram
+.SH CUSTOMIZATION
+.B slock
+can be customized by creating a custom config.h and (re)compiling the source
+code. This keeps it fast, secure and simple.
+.SH AUTHORS
+See the LICENSE file for the authors.
+.SH LICENSE
+See the LICENSE file for the terms of redistribution.
+.SH BUGS
+Please report them.