cleaned up the script mess

README: added README files for the whole directory as well as the subdirs
adv_graphgen/* : contains the graphgen files
tinc_setup/* : contains the build script and the bootstrap script
tinc_multicast/* : contains the multicast script

13 files changed, 62 insertions, 15 deletions

diff --git a/retiolum/hosts/.scripts/README b/retiolum/hosts/.scripts/README
index 8d104179..4dbb42af 100644
--- a/retiolum/hosts/.scripts/README
+++ b/retiolum/hosts/.scripts/README
@@ -1,15 +1,16 @@
-This directory contains the build and install scripts for shack-retiolum
-
-1. build_arch 
-    arch linux build script
-2. build_debian
-    debian build script
-3. build_debian_clean
-    debian script which builds a clean tinc daemon
-4. build_ec2
-    Amazon ec2 base instance build script
-5. install.sh
-    configures the tinc daemon 
-    $1 is the nickname
-    $2 is the ip-address
-hosts.tar contains the currently available hosts
+This Folder contains all the cool scripts created for tinc_retiolum
+
+currently the following functions are deployed:
+
+adv_graphgen/ - makefu
+    this folder contains a script suite which parses the interesting
+    parameters from the syslog file by sending SIGUSR2 to the tinc process
+
+tinc_multicast/ - Miefda,Lassulus
+    A tinc multicast script suite which provides automagic-discovery in a
+    local network by utilizing multicast
+
+tinc_setup/ - makefu (i am so sorry...)
+    A number of scripts which build and configure tinc on a local machine.
+    Core is the install.sh script which actually writes the configuration
+    and creates users as well as private/public keys
diff --git a/retiolum/hosts/.scripts/adv_graphgen/README b/retiolum/hosts/.scripts/adv_graphgen/README
new file mode 100644
index 00000000..082e0f2b
--- /dev/null
+++ b/retiolum/hosts/.scripts/adv_graphgen/README
@@ -0,0 +1,28 @@
+The folder contains a number of scripts which provide a convenient way to
+generate advanced graphs from the SIGUSR2 output of tinc.
+
+it currently contains the following files:
+
+sanitize.sh:
+    wrapper arond parse.py which filters the syslog file for all tinc
+    related lines and removes the status informations: 
+    this means that
+    <code>
+    May 19 20:40:44 servarch dnsmasq[5382]: reading /etc/resolv.conf
+    May 19 20:41:38 servarch tinc.retiolum[4780]: Error looking up pa-sharepoint.informatik.ba-stuttgart.de port 655: Name or service not known
+    </code>
+    becomes
+    <code>
+    Error looking up pa-sharepoint.informatik.ba-stuttgart.de port 655: Name or service not known
+    </code>
+    and so on.
+    It also provides a wrapper around graphviz which automagically
+    generates graphs from the produced graph file
+
+parse.py:
+    reads from stdin the sanitized syslog file and prints a valid dot file
+    from the given output.
+    The parser module may also produce any other output (e.g. for dns
+    entries and so on) you will need to actually read and modify the source
+    in order to be able to do this. ~May the source be with you~
+    
diff --git a/retiolum/hosts/.scripts/parse.py b/retiolum/hosts/.scripts/adv_graphgen/parse.py
index 27fe3a99..27fe3a99 100755
--- a/retiolum/hosts/.scripts/parse.py
+++ b/retiolum/hosts/.scripts/adv_graphgen/parse.py
diff --git a/retiolum/hosts/.scripts/sanitize.sh b/retiolum/hosts/.scripts/adv_graphgen/sanitize.sh
index 88591b67..88591b67 100755
--- a/retiolum/hosts/.scripts/sanitize.sh
+++ b/retiolum/hosts/.scripts/adv_graphgen/sanitize.sh
diff --git a/retiolum/hosts/.scripts/retiolum.py b/retiolum/hosts/.scripts/tinc_multicast/retiolum.py
index 6f1064e2..6f1064e2 100755
--- a/retiolum/hosts/.scripts/retiolum.py
+++ b/retiolum/hosts/.scripts/tinc_multicast/retiolum.py
diff --git a/retiolum/hosts/.scripts/tinc_setup/README b/retiolum/hosts/.scripts/tinc_setup/README
new file mode 100644
index 00000000..11d6f6e9
--- /dev/null
+++ b/retiolum/hosts/.scripts/tinc_setup/README
@@ -0,0 +1,18 @@
+This directory contains the build and install scripts for shack-retiolum
+
+1. build_arch 
+    arch linux build script
+2. build_debian
+    debian build script
+3. build_debian_clean
+    debian script which builds a clean tinc daemon
+4. build_ec2
+    Amazon ec2 base instance build script
+5. install.sh
+    configures the tinc daemon 
+    $1 is the nickname
+    $2 is the ip-address
+    also writes a python file inside the tinc/retiolum folder which posts
+    the public key into the IRC:freenode/#tincspasm
+6. build_no.de
+    nonfunct no.de smartmachine build script
diff --git a/retiolum/hosts/.scripts/bootstrap.sh b/retiolum/hosts/.scripts/tinc_setup/bootstrap.sh
index 32919e7d..32919e7d 100644
--- a/retiolum/hosts/.scripts/bootstrap.sh
+++ b/retiolum/hosts/.scripts/tinc_setup/bootstrap.sh
diff --git a/retiolum/hosts/.scripts/build_arch.sh b/retiolum/hosts/.scripts/tinc_setup/build_arch.sh
index 5ef5d765..5ef5d765 100755
--- a/retiolum/hosts/.scripts/build_arch.sh
+++ b/retiolum/hosts/.scripts/tinc_setup/build_arch.sh
diff --git a/retiolum/hosts/.scripts/build_debian.sh b/retiolum/hosts/.scripts/tinc_setup/build_debian.sh
index ddc63aed..ddc63aed 100755
--- a/retiolum/hosts/.scripts/build_debian.sh
+++ b/retiolum/hosts/.scripts/tinc_setup/build_debian.sh
diff --git a/retiolum/hosts/.scripts/build_debian_clean.sh b/retiolum/hosts/.scripts/tinc_setup/build_debian_clean.sh
index a7332f4e..a7332f4e 100755
--- a/retiolum/hosts/.scripts/build_debian_clean.sh
+++ b/retiolum/hosts/.scripts/tinc_setup/build_debian_clean.sh
diff --git a/retiolum/hosts/.scripts/build_ec2.sh b/retiolum/hosts/.scripts/tinc_setup/build_ec2.sh
index 79f2af28..79f2af28 100755
--- a/retiolum/hosts/.scripts/build_ec2.sh
+++ b/retiolum/hosts/.scripts/tinc_setup/build_ec2.sh
diff --git a/retiolum/hosts/.scripts/build_no.de.sh b/retiolum/hosts/.scripts/tinc_setup/build_no.de.sh
index 2976d3a2..2976d3a2 100644
--- a/retiolum/hosts/.scripts/build_no.de.sh
+++ b/retiolum/hosts/.scripts/tinc_setup/build_no.de.sh
diff --git a/retiolum/hosts/.scripts/install.sh b/retiolum/hosts/.scripts/tinc_setup/install.sh
index 4b21bcd4..4b21bcd4 100755
--- a/retiolum/hosts/.scripts/install.sh
+++ b/retiolum/hosts/.scripts/tinc_setup/install.sh