From: Eric S. Raymond Date: Thu, 27 Sep 2012 20:31:13 +0000 (-0400) Subject: irker -> irkerd X-Git-Tag: 1.0~6 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=ac13cb65a9cc656445a17f7966d7533269f6140a;p=irker.git irker -> irkerd --- diff --git a/Makefile b/Makefile index 5fcf74c..d836d4e 100644 --- a/Makefile +++ b/Makefile @@ -4,32 +4,32 @@ VERS=$(shell irker -V | sed 's/irker version //') 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) @@ -39,5 +39,5 @@ irker-$(VERS).tar.gz: $(SOURCES) irker.1 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 diff --git a/irker b/irkerd similarity index 100% rename from irker rename to irkerd diff --git a/irker.xml b/irkerd.xml similarity index 80% rename from irker.xml rename to irkerd.xml index af933af..150f361 100644 --- a/irker.xml +++ b/irkerd.xml @@ -1,23 +1,23 @@ - + -irker +irkerd 1 Aug 27 2012 -irker -irker +irkerd +irkerd Commands -irker +irkerd relay for shipping notifications to IRC servers - irker + irkerd -d debuglevel -V @@ -25,12 +25,12 @@ DESCRIPTION -irker is a specialized write-only IRC +irkerd 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. -irker is a socket server that listens +irkerd 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 @@ -49,13 +49,13 @@ will be prepended to it before shipping. The host part of the URL may have a port-number suffix separated by a colon, as shown in the third example; otherwise -irker sends messages to the the default 6667 IRC +irkerd sends messages to the the default 6667 IRC port of each server. OPTIONS -irker takes the following options: +irkerd takes the following options: @@ -78,11 +78,11 @@ terminate. by avoiding TCP connection setup time; the cost is that delivery is not reliable in the face of packet loss. -An irker instance with a +An irkerd 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 irker +project-hosting sites where the irkerd 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. @@ -100,8 +100,9 @@ appropriate care. Eric S. Raymond esr@snark.thyrsus.com. See the project page at http://www.catb.org/~esr/irker -for updates and other resources. The implementation uses the Python -IRC library by Joe Rosdahl and Jason R. Coombs. +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.