From: Eric S. Raymond <esr@thyrsus.com>
Date: Tue, 2 Oct 2012 13:58:13 +0000 (-0400)
Subject: Add a configuration example.
X-Git-Tag: 1.4~4
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=efe1b1b22d074e86ec93ca23a7625dc724c395f1;p=irker.git

Add a configuration example.
---

diff --git a/irkerhook.xml b/irkerhook.xml
index 6229c37..67e043c 100644
--- a/irkerhook.xml
+++ b/irkerhook.xml
@@ -146,12 +146,21 @@ a value less than 2, however, would probably be unwise.</para>
 <refsect2 id="git"><title>git</title>
 
 <para>Under git, <application>irkerhook.py</application> does not
-require any arguments.  All variables may be set in the repo
-<filename>config</filename> file in an [irker] section.  Command-line
-variable=value arguments are accepted but not required.  No attempt is
-made to interpret an <filename>irker.conf</filename> file.  You should
-not set the "repository" variable (an equivalent will be
-computed).</para>
+require any arguments.  Preferences may be set in the repo
+<filename>config</filename> file in an [irker] section. Here
+is an example of what that can look like:</para>
+
+<programlisting>
+[irker]
+    project = gpsd
+    color = ANSI
+    channels = {irc://chat.freenode.net/gpsd, irc://chat.freenode.net/commits}
+</programlisting>
+
+<para>Command-line variable=value arguments are accepted but not
+required.  No attempt is made to interpret an
+<filename>irker.conf</filename> file.  You should not set the
+"repository" variable (an equivalent will be computed).</para>
 
 <para>The default value of the "project" variable is the basename
 of the repository directory. The default value of the "urlprefix"