Importing the initial manual pages for locker(1) and lockerctl(1)

Makefile

@@ -1,6 +1,6 @@
 PACKAGE	= Locker
 VERSION	= 0.1.3
-SUBDIRS	= data include po src tools
+SUBDIRS	= data doc include po src tools
 RM	?= rm -f
 LN	?= ln -f
 TAR	?= tar -czvf
@@ -24,6 +24,11 @@ dist:
 		$(PACKAGE)-$(VERSION)/data/Makefile \
 		$(PACKAGE)-$(VERSION)/data/locker-settings.desktop \
 		$(PACKAGE)-$(VERSION)/data/project.conf \
+		$(PACKAGE)-$(VERSION)/doc/Makefile \
+		$(PACKAGE)-$(VERSION)/doc/docbook.sh \
+		$(PACKAGE)-$(VERSION)/doc/locker.xml \
+		$(PACKAGE)-$(VERSION)/doc/lockerctl.xml \
+		$(PACKAGE)-$(VERSION)/doc/project.conf \
 		$(PACKAGE)-$(VERSION)/include/Locker.h \
 		$(PACKAGE)-$(VERSION)/include/Makefile \
 		$(PACKAGE)-$(VERSION)/include/project.conf \

doc/.cvsignore

@@ -0,0 +1,4 @@
+locker.1
+locker.html
+lockerctl.1
+lockerctl.html

doc/Makefile

@@ -0,0 +1,42 @@
+TARGETS	= locker.1 locker.html lockerctl.1 lockerctl.html
+PREFIX	= /usr/local
+DESTDIR	=
+RM	?= rm -f
+LN	?= ln -f
+MKDIR	?= mkdir -p
+INSTALL	?= install
+
+
+all: $(TARGETS)
+
+locker.1: locker.xml
+	./docbook.sh -P "$(PREFIX)" -- "locker.1"
+
+locker.html: locker.xml
+	./docbook.sh -P "$(PREFIX)" -- "locker.html"
+
+lockerctl.1: lockerctl.xml
+	./docbook.sh -P "$(PREFIX)" -- "lockerctl.1"
+
+lockerctl.html: lockerctl.xml
+	./docbook.sh -P "$(PREFIX)" -- "lockerctl.html"
+
+clean:
+	$(RM) -- $(locker.1_OBJS) $(locker.html_OBJS) $(lockerctl.1_OBJS) $(lockerctl.html_OBJS)
+
+distclean: clean
+	$(RM) -- $(TARGETS)
+
+install: $(TARGETS)
+	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "locker.1"
+	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "locker.html"
+	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "lockerctl.1"
+	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -i -- "lockerctl.html"
+
+uninstall:
+	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "locker.1"
+	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "locker.html"
+	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "lockerctl.1"
+	./docbook.sh -P "$(DESTDIR)$(PREFIX)" -u -- "lockerctl.html"
+
+.PHONY: all clean distclean install uninstall

doc/docbook.sh

@@ -0,0 +1,130 @@
+#!/bin/sh
+#$Id$
+#Copyright (c) 2012 Pierre Pronchery <[email protected]>
+#
+#Redistribution and use in source and binary forms, with or without
+#modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+#THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+#AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+#IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+#DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+#FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+#DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+#SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+#CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+#OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+#OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+
+#variables
+PREFIX="/usr/local"
+. "../config.sh"
+DEBUG="_debug"
+INSTALL="install -m 0644"
+MKDIR="mkdir -m 0755 -p"
+RM="rm -f"
+XSLTPROC="xsltproc --nonet --xinclude"
+
+
+#functions
+#debug
+_debug()
+{
+	echo "$@" 1>&2
+	"$@"
+}
+
+
+#usage
+_usage()
+{
+	echo "Usage: docbook.sh [-i|-u][-P prefix] target" 1>&2
+	return 1
+}
+
+
+#main
+install=0
+uninstall=0
+while getopts "iuP:" "name"; do
+	case "$name" in
+		i)
+			uninstall=0
+			install=1
+			;;
+		u)
+			install=0
+			uninstall=1
+			;;
+		P)
+			PREFIX="$2"
+			;;
+		?)
+			_usage
+			exit $?
+			;;
+	esac
+done
+shift $((OPTIND - 1))
+if [ $# -eq 0 ]; then
+	_usage
+	exit $?
+fi
+
+[ -z "$DATADIR" ] && DATADIR="$PREFIX/share"
+[ -z "$MANDIR" ] && MANDIR="$DATADIR/man"
+
+while [ $# -gt 0 ]; do
+	target="$1"
+	source="${target%.*}.xml"
+	shift
+
+	#determine the type
+	ext="${target##*.}"
+	ext="${ext##.}"
+	case "$ext" in
+		html)
+			XSL="http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl"
+			[ -f "${target%.*}.xsl" ] && XSL="${target%.*}.xsl"
+			instdir="$DATADIR/doc/$ext/$PACKAGE"
+			;;
+		1|2|3|4|5|6|7|8|9)
+			XSL="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"
+			instdir="$MANDIR/man$ext"
+			;;
+		*)
+			echo "$0: $target: Unknown type" 1>&2
+			exit 2
+			;;
+	esac
+
+	#uninstall
+	if [ "$uninstall" -eq 1 ]; then
+		$DEBUG $RM -- "$instdir/$target"		|| exit 2
+		continue
+	fi
+
+	#install
+	if [ "$install" -eq 1 ]; then
+		$DEBUG $MKDIR -- "$instdir"			|| exit 2
+		$DEBUG $INSTALL -- "$target" "$instdir/$target"	|| exit 2
+		continue
+	fi
+
+	#create
+	$DEBUG $XSLTPROC -o "$target" "$XSL" "$source"
+	#XXX ignore errors
+	if [ $? -ne 0 ]; then
+		echo "$0: $target: Could not create page" 1>&2
+		$RM -- "$target"
+		break
+	fi
+done

doc/locker.xml

@@ -0,0 +1,95 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- $Id$ -->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+	<!ENTITY firstname "Pierre">
+	<!ENTITY surname   "Pronchery">
+	<!ENTITY username  "khorben">
+	<!ENTITY email     "[email protected]">
+	<!ENTITY section   "1">
+	<!ENTITY title     "Locker User Manual">
+	<!ENTITY package   "DeforaOS Locker">
+	<!ENTITY name      "locker">
+	<!ENTITY purpose   "Desktop screensaver">
+]>
+<refentry>
+	<refentryinfo>
+		<title>&title;</title>
+		<productname>&package;</productname>
+		<authorgroup>
+			<author>
+				<firstname>&firstname;</firstname>
+				<surname>&surname;</surname>
+				<contrib>Code and documentation.</contrib>
+				<address>
+					<email>&email;</email>
+				</address>
+			</author>
+		</authorgroup>
+		<copyright>
+			<year>2012</year>
+			<holder>&firstname; &surname; &lt;&email;&gt;</holder>
+		</copyright>
+		<legalnotice>
+			<para>This manual page was written for the DeforaOS project (and may be
+				used by others).</para>
+			<para>Permission is granted to copy, distribute and/or modify this
+				document under the terms of the GNU General Public License,
+				Version 3 as published by the Free Software Foundation.</para>
+		</legalnotice>
+	</refentryinfo>
+	<refmeta>
+		<refentrytitle>&name;</refentrytitle>
+		<manvolnum>&section;</manvolnum>
+	</refmeta>
+	<refnamediv>
+		<refname>&name;</refname>
+		<refpurpose>&purpose;</refpurpose>
+	</refnamediv>
+	<refsynopsisdiv>
+		<cmdsynopsis>
+			<command>&name;</command>
+			<arg choice="opt"><option>-d</option> <replaceable>demo</replaceable></arg>
+			<arg choice="opt"><option>-p</option> <replaceable>plug-in</replaceable></arg>
+		</cmdsynopsis>
+	</refsynopsisdiv>
+	<refsect1 id="description">
+		<title>Description</title>
+		<para><command>&name;</command> is a desktop screensaver. It can play
+			background animations, lock the screen and authenticate the user in a number
+			of different ways.</para>
+	</refsect1>
+	<refsect1 id="options">
+		<title>Options</title>
+		<para>The following options are available:</para>
+		<variablelist>
+			<varlistentry>
+				<term><option>-d</option></term>
+				<listitem>
+					<para>Animation plug-in to load.</para>
+				</listitem>
+			</varlistentry>
+			<varlistentry>
+				<term><option>-p</option></term>
+				<listitem>
+					<para>Authentication plug-in to load.</para>
+				</listitem>
+			</varlistentry>
+		</variablelist>
+	</refsect1>
+	<refsect1 id="bugs">
+		<title>Bugs</title>
+		<para>Issues can be listed and reported at <ulink
+				url="http://www.defora.org/os/project/bug_list/3467/Locker"/>.</para>
+	</refsect1>
+	<refsect1 id="see_also">
+		<title>See also</title>
+		<para>
+			<citerefentry>
+				<refentrytitle>lockerctl</refentrytitle>
+				<manvolnum>1</manvolnum>
+			</citerefentry>
+		</para>
+	</refsect1>
+</refentry>
+<!-- vim: set noet ts=1 sw=1 sts=1 tw=80: -->