add slock.1 man page - slock - simple X display locker utility | |
git clone git://git.suckless.org/slock | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit 6a52a85a1ac87b29048863d599a8b0f0ee712482 | |
parent c28ac1ebf16e5d10a8e0416065e7e3980be1ca5c | |
Author: Markus Teich <[email protected]> | |
Date: Thu, 11 Feb 2016 16:49:59 +0100 | |
add slock.1 man page | |
Diffstat: | |
M Makefile | 9 ++++++++- | |
M config.mk | 1 + | |
A slock.1 | 29 +++++++++++++++++++++++++++++ | |
3 files changed, 38 insertions(+), 1 deletion(-) | |
--- | |
diff --git 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-${V… | |
+ @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/sl… | |
+ @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 | |
@@ -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 | |
@@ -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. |