Documentation: updating the Readme with the new network interface options.
authorGuilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
Tue, 13 Mar 2012 23:57:21 +0000 (20:57 -0300)
committerGuilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
Tue, 13 Mar 2012 23:57:21 +0000 (20:57 -0300)
Readme

diff --git a/Readme b/Readme
index 4c2a210..2ca6c61 100644 (file)
--- a/Readme
+++ b/Readme
@@ -53,8 +53,10 @@ block.
 2.1. General
 ---------------------------------------
 This configurations are shared among and affect all the hosts.
-- source-network-interface: the local network interface from where the ping
-  packages with originate.
+- default-source-network-interface: the local network interface from where the
+  ping packages will originate. If this configuration is present, all hosts
+  will use this interface as source, otherwise, a per host source-network-
+  interface must be provided.
 - nameserver: the server which the hosts names will be resolved. It is the
   lookup server which the application will query first. If left blank or omited,
   it will use the /etc/resolv.conf.
@@ -81,6 +83,9 @@ This configurations are shared among and affect all the hosts.
   IP is provide, it is the only which will be pinged.
 - port: when using a port based protocol, like TCP, this field specifies in
   which port to ping the host.
+- source-network-interface: the local network interface from where the ping
+  packages for a given host will originate. This setting is used only if the
+  global network interface was not provided.
 - interval: the host will be pinged every "interval" seconds.
 - ping-protocol: indicates which protocol to use to ping the destination host,
   the currently supported protocols are TCP and ICMP.