docs: irker.html irker.1
-irker.1: irker.xml
- xmlto man irker.xml
-irker.html: irker.xml
- xmlto html-nochunks irker.xml
+irkerd.1: irkerd.xml
+ xmlto man irkerd.xml
+irkerd.html: irkerd.xml
+ xmlto html-nochunks irkerd.xml
install: irker.1 uninstall
install -m 755 -o 0 -g 0 -d $(ROOT)/usr/bin/
- install -m 755 -o 0 -g 0 irker $(ROOT)/usr/bin/irker.py
+ 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 irker.1 $(ROOT)/usr/share/man/man1/irker.1
+ install -m 755 -o 0 -g 0 irkerd.1 $(ROOT)/usr/share/man/man1/irkerd.1
uninstall:
rm -f ${ROOT}/usr/bin/irker ${ROOT}/usr/share/man/man1/irker.1
clean:
- rm -f irker irker.1 irker-*.rpm irker-*.tar.gz *~
+ rm -f irkerd.1 irker-*.tar.gz *~
rm -f SHIPPER.* *.html
PYLINTOPTS = --rcfile=/dev/null --reports=n --include-ids=y --disable="C0103,C0111,C0301,R0201,R0902,R0903,E1101,W0621,W0702"
pylint:
- @pylint --output-format=parseable $(PYLINTOPTS) irker
+ @pylint --output-format=parseable $(PYLINTOPTS) irkerd
@pylint --output-format=parseable $(PYLINTOPTS) irkerhook.py
SOURCES = README COPYING NEWS BUGS install.txt \
- irker irkerhook.py Makefile irker.xml irker-logo.png
+ irkerd irkerhook.py Makefile irkerd.xml irker-logo.png
version:
@echo $(VERS)
dist: irker-$(VERS).tar.gz
-release: irker-$(VERS).tar.gz irker.html
+release: irker-$(VERS).tar.gz irkerd.html
shipper -u -m -t; make clean
<!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.1.2//EN"
"docbook/docbookx.dtd">
-<refentry id='irker.1'>
+<refentry id='irkerd.1'>
<refmeta>
-<refentrytitle>irker</refentrytitle>
+<refentrytitle>irkerd</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class='date'>Aug 27 2012</refmiscinfo>
-<refmiscinfo class='source'>irker</refmiscinfo>
-<refmiscinfo class='product'>irker</refmiscinfo>
+<refmiscinfo class='source'>irkerd</refmiscinfo>
+<refmiscinfo class='product'>irkerd</refmiscinfo>
<refmiscinfo class='manual'>Commands</refmiscinfo>
</refmeta>
<refnamediv id='name'>
-<refname>irker</refname>
+<refname>irkerd</refname>
<refpurpose>relay for shipping notifications to IRC servers</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
- <command>irker</command>
+ <command>irkerd</command>
<arg>-d <replaceable>debuglevel</replaceable></arg>
<arg>-V</arg>
</cmdsynopsis>
<refsect1 id='description'><title>DESCRIPTION</title>
-<para><application>irker</application> is a specialized write-only IRC
+<para><application>irkerd</application> is a specialized write-only IRC
client intended to be used for shipping notification messages to IRC
channels. The use case in mind when it was designed was broadcasting
notifications from commit hooks in version-control systems.</para>
-<para><application>irker</application> is a socket server that listens
+<para><application>irkerd</application> is a socket server that listens
on for UDP or TCP packets on port 6659 for textual request lines
containing JSON objects and terminated by a newline. Each JSON object
must have exactly two members: "to" specifying a destination or
<para>The host part of the URL may have a port-number suffix separated by a
colon, as shown in the third example; otherwise
-<application>irker</application> sends messages to the the default 6667 IRC
+<application>irkerd</application> sends messages to the the default 6667 IRC
port of each server.</para>
</refsect1>
<refsect1 id='options'><title>OPTIONS</title>
-<para><application>irker</application> takes the following options:</para>
+<para><application>irkerd</application> takes the following options:</para>
<variablelist>
<varlistentry>
by avoiding TCP connection setup time; the cost is that delivery is
not reliable in the face of packet loss.</para>
-<para>An <application>irker</application> instance with a
+<para>An <application>irkerd</application> instance with a
publicly-accessible request socket could complicate blocking of IRC
spam by making it easy for spammers to submit while hiding their IP
addresses; the better way to deploy, then, is on places like
-project-hosting sites where the <application>irker</application>
+project-hosting sites where the <application>irkerd</application>
socket can be visible from commit-hook code but not exposed to the
outside world. Priming your firewall with blocklists of IP addresses
known to spew spam is always a good idea.</para>
<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. The implementation uses the Python
-IRC library by Joe Rosdahl and Jason R. Coombs.</para>
+for updates and other resources, including an insrtallable repository
+hook script. The implementation uses the Python IRC library by Joe
+Rosdahl and Jason R. Coombs.</para>
</refsect1>
</refentry>