First cut at irkerhook manual page (incomplete).

diff --git a/.gitignore b/.gitignore
index b1443c7c99f9ff47cc15fa771448ff87c17bc6c3..79fde5126de72d40c64ace684c5f3075191537ce 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,8 @@
 irkerd.pyc
 irkerhook.pyc
-irkerd.1
+irkerd.8
+irkerhook.1
 irkerd.html
+irkerhook.html
 irc
 irc-*/

diff --git a/Makefile b/Makefile
index c1ef880d0b351b55b320b37b65f7c267389afe0d..f980bf24a9c546f16dee0bb18e3f6bc168d6a5ce 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -2,24 +2,33 @@
 
 VERS=$(shell irkerd -V | sed 's/irkerd version //')
 
-docs: irkerd.html irkerd.1
+docs: irkerd.html irkerd.8 irkerhook.html irkerhook.1
 
-irkerd.1: irkerd.xml
+irkerd.8: irkerd.xml
        xmlto man irkerd.xml
 irkerd.html: irkerd.xml
        xmlto html-nochunks irkerd.xml
 
-install: irkerd.1 uninstall
+irkerhook.1: irkerhook.xml
+       xmlto man irkerhook.xml
+irkerhook.html: irkerhook.xml
+       xmlto html-nochunks irkerhook.xml
+
+install: irkerd.8 irkerhook.1 uninstall
        install -m 755 -o 0 -g 0 -d $(ROOT)/usr/bin/
        install -m 755 -o 0 -g 0 irkerd $(ROOT)/usr/bin/irkerd
        install -m 755 -o 0 -g 0 -d $(ROOT)/usr/share/man/man1/
-       install -m 755 -o 0 -g 0 irkerd.1 $(ROOT)/usr/share/man/man1/irkerd.1
+       install -m 755 -o 0 -g 0 irkerd.8 $(ROOT)/usr/share/man/man1/irkerd.8
+       install -m 755 -o 0 -g 0 -d $(ROOT)/usr/share/man/man8/
+       install -m 755 -o 0 -g 0 irkerd.8 $(ROOT)/usr/share/man/man1/irkerhook.1
 
 uninstall:
-       rm -f ${ROOT}/usr/bin/irkerd ${ROOT}/usr/share/man/man1/irkerd.1
+       rm -f ${ROOT}/usr/bin/irkerd 
+       rm -f ${ROOT}/usr/share/man/man1/irkerd.8
+       rm -f ${ROOT}/usr/share/man/man1/irkerhook.1
 
 clean:
-       rm -f irkerd.1 irker-*.tar.gz *~
+       rm -f irkerd.8 irker-*.tar.gz *~
        rm -f SHIPPER.* *.html
 
 PYLINTOPTS = --rcfile=/dev/null --reports=n --include-ids=y --disable="C0103,C0111,C0301,R0201,R0902,R0903,R0912,E1101,W0201,W0621,W0702"
@@ -29,15 +38,15 @@ pylint:
 
 
 SOURCES = README COPYING NEWS BUGS install.txt security.txt \
-       irkerd irkerhook.py Makefile irkerd.xml irker-logo.png
+       irkerd irkerhook.py Makefile irkerd.xml irkerhook.xml irker-logo.png
 
 version:
        @echo $(VERS)
 
-irker-$(VERS).tar.gz: $(SOURCES) irkerd.1
+irker-$(VERS).tar.gz: $(SOURCES) irkerd.8 irkerhook.1
        tar --transform='s:^:irker-$(VERS)/:' --show-transformed-names -cvzf irker-$(VERS).tar.gz $(SOURCES)
 
 dist: irker-$(VERS).tar.gz
 
-release: irker-$(VERS).tar.gz irkerd.html
+release: irker-$(VERS).tar.gz irkerd.html irkerhook.html
        shipper -u -m -t; make clean

diff --git a/irkerd.xml b/irkerd.xml
index c203fa8b789c2d4fa200e20ffcfd20e58aea5044..0642a66f6014c3d61bb81da544184d1887d22763 100644 (file)
--- a/irkerd.xml
+++ b/irkerd.xml
@@ -1,10 +1,10 @@
 <!DOCTYPE refentry PUBLIC 
    "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "docbook/docbookx.dtd">
-<refentry id='irkerd.1'>
+<refentry id='irkerd.8'>
 <refmeta>
 <refentrytitle>irkerd</refentrytitle>
-<manvolnum>1</manvolnum>
+<manvolnum>8</manvolnum>
 <refmiscinfo class='date'>Aug 27 2012</refmiscinfo>
 <refmiscinfo class='source'>irkerd</refmiscinfo>
 <refmiscinfo class='product'>irkerd</refmiscinfo>

diff --git a/irkerhook.xml b/irkerhook.xml
new file mode 100644 (file)
index 0000000..c56b64f
--- /dev/null
+++ b/irkerhook.xml
@@ -0,0 +1,66 @@
+<!DOCTYPE refentry PUBLIC 
+   "-//OASIS//DTD DocBook XML V4.1.2//EN"
+   "docbook/docbookx.dtd">
+<refentry id='irkerhook.1'>
+<refmeta>
+<refentrytitle>irkerhook</refentrytitle>
+<manvolnum>1</manvolnum>
+<refmiscinfo class='date'>Aug 27 2012</refmiscinfo>
+<refmiscinfo class='source'>irkerd</refmiscinfo>
+<refmiscinfo class='product'>irkerd</refmiscinfo>
+<refmiscinfo class='manual'>Commands</refmiscinfo>
+</refmeta>
+<refnamediv id='name'>
+<refname>irkerhook</refname>
+<refpurpose>repository hook script issuing irker notifications</refpurpose>
+</refnamediv>
+<refsynopsisdiv id='synopsis'>
+
+<cmdsynopsis>
+  <command>irkerhook.py</command>
+     <arg>-n</arg>
+     <arg>-V</arg>
+     <arg rep='repeat'><replaceable>key=val</replaceable></arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1 id='description'><title>DESCRIPTION</title>
+
+<para><application>irkerhook.py</application> is a Python script intended 
+to be called from the post-commit hook of a version-control repository. Its
+job is to collect information about the commit that fired the hook (and
+possibly preferences set by the repository owner) and ship that information
+to an instance of <application>irkerd</application> for forwarding to
+various announcement channels.</para>
+
+</refsect1>
+
+<refsect1 id='options'><title>OPTIONS</title>
+
+<para><application>irkerhook.py</application> takes the following
+options:</para>
+
+<variablelist>
+<varlistentry>
+<term>-n</term>
+<listitem><para>Suppress transmission to a daemon. Instead, dump the
+generated JSON request to standard output. Useful for
+debugging.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>-V</term>
+<listitem><para>Write the program version to stdout and
+terminate.</para></listitem>
+</varlistentry>
+</variablelist>
+
+</refsect1>
+
+<refsect1 id='authors'><title>AUTHOR</title>
+<para>Eric S. Raymond <email>esr@snark.thyrsus.com</email>.  See the
+project page at <ulink
+url='http://www.catb.org/~esr/'>http://www.catb.org/~esr/irker</ulink>
+for updates and other resources.</para>
+</refsect1>
+</refentry>
+