From b56c996751d7913339015516cabf58fc78af1d6c Mon Sep 17 00:00:00 2001
From: Guillaume Pellerin <yomguy@parisson.com>
Date: Sun, 17 Jan 2010 02:58:29 +0000
Subject: [PATCH] begin XML doc

---
 README             | 89 +++++++++++++++++++++++++++++++++++++++++++---
 example/myfuzz.xml | 18 +++++-----
 2 files changed, 94 insertions(+), 13 deletions(-)

diff --git a/README b/README
index ac5bfa6..5d96f16 100644
--- a/README
+++ b/README
@@ -49,11 +49,11 @@ Usage : deefuzzer CONFIGFILE
 
 where CONFIGFILE is the path for a XML config file. For example::
 
-    $ deefuzzer example/myfuzz.xml
+$ deefuzzer example/myfuzz.xml
 
 To make the deefuzzer act as a deamon, just play it in the background::
 
-    $ deefuzzer example/myfuzz.xml &
+$ deefuzzer example/myfuzz.xml &
 
 Note that you must edit the config file with right parameters before playing.
 You can find an example for a draft XML file in the directory "example/" of this
@@ -66,11 +66,92 @@ BE CAREFULL : at the moment, the multi-threaded implementation of deefuzzer inst
 avoids shutting down the streams with CTRL+C... You have to kill them manually,
 after a CTRL+Z, making this::
 
-    $ kill -9 PROCESS_ID
+$ kill -9 PROCESS_ID
 
 or::
 
-    $ kill -9 `pgrep deefuzzer`
+$ kill -9 `pgrep deefuzzer`
+
+
+XML Configuration
+=================
+
+Example ::
+
+<deefuzzer>
+    <!-- A path to the log file (need directory write access rights) -->
+    <log>/path/to/log/mystation.log</log>
+
+    <!-- A path to the M3U playlist file (need directory write access rights).
+         The file is preferably accessible behind an url,
+         for example, http://mydomain.com/m3u/mystation.m3u -->
+    <m3u>/path/to/m3u/mystation.m3u</m3u>
+
+    <station>
+        <infos>
+            <!-- The short name of the station. It will define the mount point,
+                 for example http://mydomain.com:8000/my_station.mp3 -->
+            <short_name>my_station</short_name>
+
+            <!-- The name (title) of the station -->
+            <name>My best funky station</name>
+
+            <!-- The description of the station -->
+            <description>My personal best funky playlist ever !</description>
+
+            <!-- The website of the station (for metadata) -->
+            <url>http://mydomain.com</url>
+
+            <!-- The genres of the audio streams -->
+            <genre>Various Funk Groove</genre>
+        </infos>
+
+        <server>
+            <!-- The host to send the stream (domain or IP) -->
+            <host>mydomain.com</host>
+            <!-- The port of the Icecast2 server on the host -->
+            <port>8000</port>
+            <!-- The source password of the Icecast2 server on the host -->
+            <sourcepassword>icecast_source_password</sourcepassword>
+            <!-- If 1, the mount point will be public on yp.icecast.org, 0 for a private stream -->
+            <public>1</public>
+        </server>
+
+        <media>
+
+            <dir>/path/to/mp3/</dir>
+            <format>mp3</format>
+            <bitrate>192</bitrate>
+            <ogg_quality>7</ogg_quality>
+            <samplerate>44100</samplerate>
+            <voices>2</voices>
+            <shuffle>1</shuffle>
+        </media>
+        <rss>
+            <dir>/path/to/rss/</dir>
+            <enclosure>1</enclosure>
+        </rss>
+        <twitter>
+            <mode>0</mode>
+            <user>my_twitter_user</user>
+            <pass>my_twitter_password</pass>
+            <tags>bla bla</tags>
+        </twitter>
+        <jingles>
+            <mode>0</mode>
+            <dir>/path/to/jingles</dir>
+            <shuffle>1</shuffle>
+        </jingles>
+        <control>
+            <mode>0</mode>
+            <port>1234</port>
+        </control>
+        <relay>
+            <mode>0</mode>
+            <url>http://anotherdomain.com:8000/stream.mp3</url>
+        </relay>
+    </station>
+</deefuzzer>
 
 
 OSC Control
diff --git a/example/myfuzz.xml b/example/myfuzz.xml
index b2ccbca..fb009f9 100644
--- a/example/myfuzz.xml
+++ b/example/myfuzz.xml
@@ -1,6 +1,6 @@
 <deefuzzer>
-    <log>/tmp/deefuzz.log</log>
-    <m3u>/var/www/m3u/mystation.m3u</m3u>
+    <log>/path/to/log/mystation.log</log>
+    <m3u>/path/to/m3u/mystation.m3u</m3u>
     <station>
         <infos>
             <short_name>My_Station_1</short_name>
@@ -10,13 +10,13 @@
             <genre>Other</genre>
         </infos>
         <server>
-            <host>localhost</host>
+            <host>mydomain.com</host>
             <port>8000</port>
             <sourcepassword>icecast_source_password</sourcepassword>
             <public>1</public>
         </server>
         <media>
-            <dir>/path/to/my/mp3/</dir>
+            <dir>/path/to/mp3/</dir>
             <format>mp3</format>
             <bitrate>192</bitrate>
             <ogg_quality>7</ogg_quality>
@@ -25,13 +25,13 @@
             <shuffle>1</shuffle>
         </media>
         <rss>
-            <dir>/tmp/rss/</dir>
+            <dir>/path/to/rss/</dir>
             <enclosure>1</enclosure>
         </rss>
         <twitter>
             <mode>0</mode>
-            <user>xxxxxx</user>
-            <pass>xxxxxx</pass>
+            <user>my_twitter_user</user>
+            <pass>my_twitter_password</pass>
             <tags>bla bla</tags>
         </twitter>
         <jingles>
@@ -40,12 +40,12 @@
             <shuffle>1</shuffle>
         </jingles>
         <control>
-            <mode>1</mode>
+            <mode>0</mode>
             <port>1234</port>
         </control>
         <relay>
             <mode>0</mode>
-            <url>http://parisson.com:8000/deefuzz_1.mp3</url>
+            <url>http://anotherdomain.com:8000/stream.mp3</url>
         </relay>
     </station>
 </deefuzzer>
-- 
2.39.5