From: Stephen L Johnson <sjohnson@monsters.org>
Date: Sat, 6 Jan 2001 06:36:13 +0000 (+0000)
Subject: documentation updates
X-Git-Tag: spong-2_7_2~2
X-Git-Url: http://git.etc.gen.nz/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=859ac3c9a8c54ef7ca79c2d85aad3f4196c5fffe;p=spong.git

documentation updates
---

diff --git a/pod/admin-guide.pod b/pod/admin-guide.pod
index dba07b2..e3c9f94 100755
--- a/pod/admin-guide.pod
+++ b/pod/admin-guide.pod
@@ -37,7 +37,7 @@ file, then please email it to me so that I can add it to the distribution.
 =item *
 
 Make sure you are in the directory that you unpacked spong in and type: 
-C<./build <os>> where E<lt>osE<gt> is the name corresponding to your
+C<./build> C<os> where E<lt>osE<gt> is the name corresponding to your
 operating system. You can type C<./build help> to generate a list of
 valid operating system strings.
 
@@ -129,14 +129,15 @@ file.
 This is the URI path to the location of the B<www-spong> CGI program in the web
 server's document tree. For example, if the URL of www-spong is going to be
 C<http://www.example.org/spong/cgi-bin/www-spong>, you need to set I<$WWWSPONG>
-to '/spong/cgi-bin/www-spong'. See also L</"SPONG CGI DIR">.
+to '/spong/cgi-bin/www-spong'. See also L</"Spong CGI Directory">.
 
 =item $WWWACK
 
 This is the URI path to the location of the B<www-spong-ack> CGI program in the
 web server's document tree. For example, if the URL of www-spong is going to be
 C<http://www.example.org/spong/cgi-bin/www-spong-ack>, you need to set
-I<$WWWSPONG> to '/spong/cgi-bin/www-spong-ack'. See also L</"SPONG CGI DIR">.
+I<$WWWSPONG> to '/spong/cgi-bin/www-spong-ack'. See also
+ L</"Spong CGI Directory">.
 
 =item $WWWGIF
 
diff --git a/pod/builddoc b/pod/builddoc
index 0d88c1d..4d580ac 100755
--- a/pod/builddoc
+++ b/pod/builddoc
@@ -6,7 +6,7 @@
 # the POD document sources. It will build various formats: html, text and man
 #
 
-# $Id: builddoc,v 1.1 2000/09/14 17:19:32 sljohnson Exp $
+# $Id: builddoc,v 1.2 2001/01/06 06:36:13 sljohnson Exp $
 
 use File::Basename;
 use Getopt::Long;
@@ -52,7 +52,7 @@ if ($doctype eq "dist") {
    $files =~ s/\s+/ /g;  # Make the whitepace into spaces
 
    $cmd = "mpod2html -dir ../www/docs/ -tocname spongtoc -idxname spongindex" 
-            . " $files 1> /tmp/pod.out 2>&1";
+            . " $files >/tmp/pod.out 2>&1";
    system $cmd;
    exit 0;
 }
diff --git a/pod/spong-network.pod b/pod/spong-network.pod
index 3ae4c0b..7a82d4e 100644
--- a/pod/spong-network.pod
+++ b/pod/spong-network.pod
@@ -171,7 +171,7 @@ are the list of services that will be check for each host. The I<ping> service
 is prepended to the list of services unless 'noping' is defined.
 
 Another important attribute for a host is the
-L<skip_network_checks|spong.conf/"skip_network_check"> flag. If this flag is
+L<skip_network_checks|spong.hosts/"skip_network_check"> flag. If this flag is
 set for a host. The B<spong-network> proram will skip the check for the host.
 
 =back
diff --git a/pod/spong.hosts.pod b/pod/spong.hosts.pod
index adbef78..bf79ab3 100755
--- a/pod/spong.hosts.pod
+++ b/pod/spong.hosts.pod
@@ -73,7 +73,7 @@ format
 The I<ip_addr> attribute is a list (well reference to one anyway) of IP
 address that the machine responds to.
 
-The I<skip_network_checks) flag be used to temporarily disable the network
+The I<skip_network_checks> flag be used to temporarily disable the network
 checks for one or more hosts. The hosts can stll received spong-client status
 updates.  And the historical network information for the hosts is available.
 This is useful when the hosts are being renamed or re-networked over an
diff --git a/pod/user-guide.pod b/pod/user-guide.pod
index 8f7f74a..29e1e75 100644
--- a/pod/user-guide.pod
+++ b/pod/user-guide.pod
@@ -271,7 +271,7 @@ This is discussed above.
 =item Summary Information
 
 This section shows summary information for the service. First is a colored bar
-that shows the current status color of the service. See L<|"Status Colors"> for
+that shows the current status color of the service. See L<"Status Colors"> for
 details. Next is the I<Updated:> field which if the date and time of the last
 update of the status. The I<Duration> field shows the amount of time that the
 service has been in it's current status.  And last is the I<Summary> field
diff --git a/src/lib/Spong/Network/plugins/check_interfaces b/src/lib/Spong/Network/plugins/check_interfaces
index fd69769..865689f 100644
--- a/src/lib/Spong/Network/plugins/check_interfaces
+++ b/src/lib/Spong/Network/plugins/check_interfaces
@@ -175,12 +175,12 @@ field will have a detailed description of the cause of an error.
 
 The default SNMP Community name is I<public>. To provide an alternate default
 SNMP Community name add it to the
-L<$HOSTS_DEFAULTS|spong.conf/"$HOSTS_DEFAULTS"> entry in the B<spong.conf> file
+L<$HOSTS_DEFAULTS|spong.hosts/"$HOSTS_DEFAULTS"> entry in the B<spong.conf> file
 (i.e. $HOSTS_DEFAULTS{'snmp_community'} = 'secret';).
 
 To override the default name on a per host basis, specify a C<snmp_ community>
 attribute in a host's entry in the I<%HOSTS> variabile of the L<spong.conf>
-configuration file. See the L<Examples|"EXAMPLES"> section for a detailed
+configuration file. See the L<"EXAMPLES"> section for a detailed
 example.
 
 =item Ignored Interfaces
@@ -192,7 +192,7 @@ $HOSTS with a list of network interface to ignore.
 A default list of interfaces to ignore is added an 'ignore_interfaces' entry
 to the $HOSTS_DEFAULTS variable.  A list of interfaces to ignore in all hosts
 is created by adding an 'ignore_interfaces' entry to the $HOSTS_ALL varirable.
-See the L<Examples|"EXAMPLES> section for a detailed example.
+See the L<Examples|"EXAMPLES"> section for a detailed example.
 
 =back
 
@@ -218,7 +218,7 @@ See the L<Examples|"EXAMPLES> section for a detailed example.
 
 L<spong-network>, L<check_snmp>,
 L<spong-network Modules Template|spong-network-mod-template>,
-L<Spong Developer Guide|develop-guide>
+L<Spong Developer Guide|developer-guide>
 
 =head1 NOTES