X-Git-Url: http://git.tremily.us/?a=blobdiff_plain;f=irkerd.xml;h=c2c37fb53d61a5021a74debfbb8b16e2ed0b773b;hb=aae700b19db564d1ef37cdfa60dcb032a6cee166;hp=9d3907ac6d3f2cf73fdde95cdfa5accb551bce80;hpb=1e1ff8a99e1fe14656daa5d338d5f903615109c3;p=irker.git
diff --git a/irkerd.xml b/irkerd.xml
index 9d3907a..c2c37fb 100644
--- a/irkerd.xml
+++ b/irkerd.xml
@@ -22,8 +22,10 @@
-l logfile
-n nick
-p password
+ -i IRC-URL
-V
- -h
+ -h
+ message text
@@ -34,6 +36,11 @@ 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.
+The main advantage of relaying through this daemon over
+individual scripted sends from applications is that it can maintain
+connection state for multiple channels, rather than producing obnoxious
+join/leave channel spam on every message.
+
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
@@ -65,10 +72,10 @@ form ?secret
or ?key=secret
, where
secret
is the channel key.
An empty message is legal and will cause
-irkerd to join the target channels without
-actually emitting a message. This may be useful for advertising that
-an instance is up and running, or for joining a channel to log its
-traffic.
+irkerd to join or maintain a connection to
+the target channels without actually emitting a message. This may be
+useful for advertising that an instance is up and running, or for
+joining a channel to log its traffic.
OPTIONS
@@ -100,7 +107,13 @@ in the event of a nick collision.
-p
Takes a following value, setting a nickserv
password to be used. If given, this password is shipped to
-authenticate the nick on receipt of a welcom message.
+authenticate the nick on receipt of a welcome message.
+
+
+-i
+Immediate mode, to be run in foreground. Takes two
+following values interpreted as a channel URL and a message
+string. Sends the message, then quits.
-V
@@ -109,8 +122,7 @@ terminate.
-h
-Print usage instructions and
-terminate.
+Print usage instructions and terminate.
@@ -154,8 +166,7 @@ discarded.
project page at http://www.catb.org/~esr/irker
for updates and other resources, including an installable repository
-hook script. The implementation uses the Python IRC library by Joe
-Rosdahl and Jason R. Coombs.
+hook script.