From 7a16ae0476245170acf984676aa8c093af430c9e Mon Sep 17 00:00:00 2001
From: Tobi Oetiker <tobi@oetiker.ch>
Date: Wed, 5 Sep 2007 22:33:34 +0000
Subject: mode docs on multihost

---
 CHANGES          |  1 +
 etc/config.dist  |  7 ++++---
 lib/Smokeping.pm | 18 +++++++++---------
 3 files changed, 14 insertions(+), 12 deletions(-)

diff --git a/CHANGES b/CHANGES
index 8d425aa..5b11318 100644
--- a/CHANGES
+++ b/CHANGES
@@ -1,3 +1,4 @@
+* better documentation on multihost syntax added -- tobi
 * slaves should skip multi target hosts -- tobi
 * set Content-Length header to help multi request queries -- tobi
 
diff --git a/etc/config.dist b/etc/config.dist
index 35369e6..48f03d1 100644
--- a/etc/config.dist
+++ b/etc/config.dist
@@ -124,8 +124,9 @@ alerts = someloss
 slaves = boomer
 host = james.oetiker.ch
 
-++ Summer
+++ MultiHost
 
-menu = Summer Host
-title = My Favorite hosts
+menu = Multihost
+title = James and James as seen from Boomer
 host = /Test/James /Test/James~boomer
+
diff --git a/lib/Smokeping.pm b/lib/Smokeping.pm
index 9b88a7d..65ad07c 100644
--- a/lib/Smokeping.pm
+++ b/lib/Smokeping.pm
@@ -1845,11 +1845,11 @@ There are three types of "hosts" in smokeping.
 
 =over
 
-=item 1.
+=item 1
 
 The 'hostname' is a name of a host you want to target from smokeping
 
-=item 2.
+=item 2
 
 The string B<DYNAMIC>. Is for machines that have a dynamic IP address. These boxes
 are required to regularly contact the SmokePing server to confirm their IP address.
@@ -1862,14 +1862,14 @@ SNMP SmokePing will also query the hosts
 sysContact, sysName and sysLocation properties to make sure it is
 still the same host.
 
-=item 3.
+=item 3
 
-A space separated list of 'target-path' entries. All targets mentioned in
-this list will be displayed in one graph. Note that the graph will look
-different from the normal smokeping graphs the normal graph is designed to
-show only one host with all its information. The syntax is as follows:
+A space separated list of 'target-path' entries (multihost target). All
+targets mentioned in this list will be displayed in one graph. Note that the
+graph will look different from the normal smokeping graphs. The syntax for
+multihost targets is as follows:
 
- /target/target/target[~slave] [/target/...] ...
+ host = /world/town/host1 /world/town2/host33 /world/town2/host1~slave
 
 =back
 
@@ -2817,7 +2817,7 @@ DOC
            }, #detail
            multihost => {
               _vars => [ qw(colors) ],
-              _doc => "Settings for the multihost graphs",
+              _doc => "Settings for the multihost graphs. At the moment this is only used for the color setting. Check the documentation on the host property of the target section for more.",
               colors => {
                  _doc => "Space separated list of colors for multihost graphs",
                  _example => "ff0000 00ff00 0000ff",
-- 
cgit v1.2.3-24-g4f1b