summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNiko Tyni <ntyni@iki.fi>2005-02-15 12:35:12 +0100
committerNiko Tyni <ntyni@iki.fi>2005-02-15 12:35:12 +0100
commitfeee384f64b9d1e747b5e966bf6298c354ea8ae8 (patch)
tree0c332dc10a86d6460f88dfcb9369a2e55c9c3e2e
parent4051f04d0275f51929aa4a08b34dbf3c70788e8c (diff)
downloadsmokeping-feee384f64b9d1e747b5e966bf6298c354ea8ae8.tar.gz
smokeping-feee384f64b9d1e747b5e966bf6298c354ea8ae8.tar.xz
Docs: more L<> links.
Makefile: really filter out smokeping_config.pod.
-rw-r--r--Makefile2
-rwxr-xr-xbin/smokeping.dist6
-rw-r--r--lib/Smokeping.pm2
-rw-r--r--lib/Smokeping/probes/CiscoRTTMonDNS.pm10
-rw-r--r--lib/Smokeping/probes/CiscoRTTMonEchoICMP.pm8
-rw-r--r--lib/Smokeping/probes/CiscoRTTMonTcpConnect.pm8
-rw-r--r--lib/Smokeping/probes/Curl.pm2
-rw-r--r--lib/Smokeping/probes/EchoPing.pm2
-rw-r--r--lib/Smokeping/probes/EchoPingChargen.pm2
-rw-r--r--lib/Smokeping/probes/EchoPingDiscard.pm2
-rw-r--r--lib/Smokeping/probes/EchoPingHttp.pm2
-rw-r--r--lib/Smokeping/probes/EchoPingHttps.pm2
-rw-r--r--lib/Smokeping/probes/EchoPingIcp.pm2
-rw-r--r--lib/Smokeping/probes/EchoPingSmtp.pm2
-rw-r--r--lib/Smokeping/probes/FPing.pm2
-rw-r--r--lib/Smokeping/probes/FPing6.pm2
-rw-r--r--lib/Smokeping/probes/IOSPing.pm2
-rw-r--r--lib/Smokeping/probes/base.pm2
-rw-r--r--lib/Smokeping/probes/basefork.pm2
-rw-r--r--lib/Smokeping/probes/basevars.pm4
-rw-r--r--lib/Smokeping/probes/passwordchecker.pm2
-rw-r--r--lib/Smokeping/probes/skel.pm2
22 files changed, 35 insertions, 35 deletions
diff --git a/Makefile b/Makefile
index 67b067a..a0cceb8 100644
--- a/Makefile
+++ b/Makefile
@@ -6,7 +6,7 @@ GROFF = groff
.SUFFIXES:
.SUFFIXES: .pm .pod .txt .html .man .1 .3 .5 .7
-DOCS = $(filter-out smokeping_config,$(wildcard doc/*.pod)) doc/smokeping_examples.pod # section 7
+DOCS = $(filter-out doc/smokeping_config.pod,$(wildcard doc/*.pod)) doc/smokeping_examples.pod # section 7
DOCSCONFIG := doc/smokeping_config.pod # section 5
PM := lib/ISG/ParseConfig.pm lib/Smokeping.pm lib/Smokeping/Examples.pm
PODPROBE := $(wildcard lib/Smokeping/probes/*.pm)
diff --git a/bin/smokeping.dist b/bin/smokeping.dist
index 889a486..02deda1 100755
--- a/bin/smokeping.dist
+++ b/bin/smokeping.dist
@@ -102,10 +102,10 @@ would include all the targets
would include all but /B/C.
-The B<--makepod> does get used internally to produce the documentation on
-the SmokePing configuration file.
+The B<--makepod> does get used internally to produce the
+L<documentation on the SmokePing configuration file|smokeping_config>.
-Please refer to the installation document for detailed setup instructions.
+Please refer to L<the installation document|smokeping_install> for detailed setup instructions.
=head1 SETUP
diff --git a/lib/Smokeping.pm b/lib/Smokeping.pm
index 239cb8d..9878cff 100644
--- a/lib/Smokeping.pm
+++ b/lib/Smokeping.pm
@@ -2831,7 +2831,7 @@ Smokeping.pm - SmokePing Perl Module
=head1 OVERVIEW
Almost all SmokePing functionality sits in this Module.
-The programs B<smokeping> and B<smokeping.cgi> are merely
+The programs L<smokeping|smokeping> and L<smokeping.cgi|smokeping.cgi> are merely
figure heads allowing to hardcode some pathnames.
If you feel like documenting what is happening within this library you are
diff --git a/lib/Smokeping/probes/CiscoRTTMonDNS.pm b/lib/Smokeping/probes/CiscoRTTMonDNS.pm
index 0f16154..45a9dd9 100644
--- a/lib/Smokeping/probes/CiscoRTTMonDNS.pm
+++ b/lib/Smokeping/probes/CiscoRTTMonDNS.pm
@@ -28,7 +28,7 @@ sub pod_hash {
return {
name => <<DOC,
Smokeping::probes::CiscoRTTMonDNS.pm - Probe for SmokePing
-DOC,
+DOC
description => <<DOC,
A probe for smokeping, which uses the ciscoRttMon MIB functionality ("Service Assurance Agent", "SAA") of Cisco IOS to time ( recursive, type A) DNS queries to a DNS server.
@@ -63,13 +63,13 @@ DOC
The probe does unnecessary DNS queries, i.e. more than configured in the "pings" variable, because the RTTMon MIB only allows to set a total time for all queries in one measurement run (one "life"). Currently the probe sets the life duration to "pings"*2+3 seconds (2 secs is the timeout value hardcoded into this probe).
DOC
see_also => <<DOC,
-http://people.ee.ethz.ch/~oetiker/webtools/smokeping/
+L<http://people.ee.ethz.ch/~oetiker/webtools/smokeping/>
-http://www.switch.ch/misc/leinen/snmp/perl/
+L<http://www.switch.ch/misc/leinen/snmp/perl/>
-The best source for background info on SAA is Cisco's documentation on http://www.cisco.com and the CISCO-RTTMON-MIB documentation, which is available at:
+The best source for background info on SAA is Cisco's documentation on L<http://www.cisco.com> and the CISCO-RTTMON-MIB documentation, which is available at:
-ftp://ftp.cisco.com/pub/mibs/v2/CISCO-RTTMON-MIB.my
+L<ftp://ftp.cisco.com/pub/mibs/v2/CISCO-RTTMON-MIB.my>
DOC
authors => <<DOC,
Joerg.Kummer at Roche.com
diff --git a/lib/Smokeping/probes/CiscoRTTMonEchoICMP.pm b/lib/Smokeping/probes/CiscoRTTMonEchoICMP.pm
index 550921f..f763fde 100644
--- a/lib/Smokeping/probes/CiscoRTTMonEchoICMP.pm
+++ b/lib/Smokeping/probes/CiscoRTTMonEchoICMP.pm
@@ -62,12 +62,12 @@ DOC
The probe sends unnecessary pings, i.e. more than configured in the "pings" variable, because the RTTMon MIB only allows to set a total time for all pings in one measurement run (one "life"). Currently the probe sets the life duration to "pings"*2+3 seconds (2 secs is the ping timeout value hardcoded into this probe).
DOC
see_also => <<DOC,
-http://people.ee.ethz.ch/~oetiker/webtools/smokeping/
+L<http://people.ee.ethz.ch/~oetiker/webtools/smokeping/>
-http://www.switch.ch/misc/leinen/snmp/perl/
+L<http://www.switch.ch/misc/leinen/snmp/perl/>
-The best source for background info on SAA is Cisco's documentation on http://www.cisco.com and the CISCO-RTTMON-MIB documentation, which is available at:
-ftp://ftp.cisco.com/pub/mibs/v2/CISCO-RTTMON-MIB.my
+The best source for background info on SAA is Cisco's documentation on L<http://www.cisco.com> and the CISCO-RTTMON-MIB documentation, which is available at:
+L<ftp://ftp.cisco.com/pub/mibs/v2/CISCO-RTTMON-MIB.my>
DOC
authors => <<DOC,
Joerg.Kummer at Roche.com
diff --git a/lib/Smokeping/probes/CiscoRTTMonTcpConnect.pm b/lib/Smokeping/probes/CiscoRTTMonTcpConnect.pm
index d11f76b..c278e1f 100644
--- a/lib/Smokeping/probes/CiscoRTTMonTcpConnect.pm
+++ b/lib/Smokeping/probes/CiscoRTTMonTcpConnect.pm
@@ -57,12 +57,12 @@ DOC
The probe establishes unnecessary connections, i.e. more than configured in the "pings" variable, because the RTTMon MIB only allows to set a total time for all connections in one measurement run (one "life"). Currently the probe sets the life duration to "pings"*2+3 seconds (2 secs is the timeout value hardcoded into this probe).
DOC
see_also => <<DOC,
-http://people.ee.ethz.ch/~oetiker/webtools/smokeping/
+L<http://people.ee.ethz.ch/~oetiker/webtools/smokeping/>
-http://www.switch.ch/misc/leinen/snmp/perl/
+L<http://www.switch.ch/misc/leinen/snmp/perl/>
-The best source for background info on SAA is Cisco's documentation on http://www.cisco.com and the CISCO-RTTMON-MIB documentation, which is available at:
-ftp://ftp.cisco.com/pub/mibs/v2/CISCO-RTTMON-MIB.my
+The best source for background info on SAA is Cisco's documentation on L<http://www.cisco.com> and the CISCO-RTTMON-MIB documentation, which is available at:
+L<ftp://ftp.cisco.com/pub/mibs/v2/CISCO-RTTMON-MIB.my>
DOC
authors => <<DOC,
Joerg.Kummer at Roche.com
diff --git a/lib/Smokeping/probes/Curl.pm b/lib/Smokeping/probes/Curl.pm
index 2bbf476..e04e6c9 100644
--- a/lib/Smokeping/probes/Curl.pm
+++ b/lib/Smokeping/probes/Curl.pm
@@ -35,7 +35,7 @@ versions of Smokeping, and the 'host' setting did not influence it in any
way. The variable name has now been changed to 'urlformat', and it can
(and in most cases should) contain a placeholder for the 'host' variable.
DOC
- see_also => "curl(1), Smokeping::probes::Curl(3pm) etc., http://curl.haxx.se/",
+ see_also => "curl(1), L<http://curl.haxx.se/>",
}
}
diff --git a/lib/Smokeping/probes/EchoPing.pm b/lib/Smokeping/probes/EchoPing.pm
index f2aded2..097cfe6 100644
--- a/lib/Smokeping/probes/EchoPing.pm
+++ b/lib/Smokeping/probes/EchoPing.pm
@@ -44,7 +44,7 @@ DOC
Niko Tyni <ntyni@iki.fi>
DOC
see_also => <<DOC,
-echoping(1), Smokeping::probes::EchoPingHttp(3pm) etc., http://echoping.sourceforge.net/
+echoping(1), L<Smokeping::probes::EchoPingHttp> etc., L<http://echoping.sourceforge.net/>
DOC
}
}
diff --git a/lib/Smokeping/probes/EchoPingChargen.pm b/lib/Smokeping/probes/EchoPingChargen.pm
index e0740c9..5570b67 100644
--- a/lib/Smokeping/probes/EchoPingChargen.pm
+++ b/lib/Smokeping/probes/EchoPingChargen.pm
@@ -33,7 +33,7 @@ DOC
Niko Tyni <ntyni@iki.fi>
DOC
see_also => <<DOC,
-Smokeping::probes::EchoPing(3pm)
+L<Smokeping::probes::EchoPing>
DOC
}
}
diff --git a/lib/Smokeping/probes/EchoPingDiscard.pm b/lib/Smokeping/probes/EchoPingDiscard.pm
index 31ddd39..33933b6 100644
--- a/lib/Smokeping/probes/EchoPingDiscard.pm
+++ b/lib/Smokeping/probes/EchoPingDiscard.pm
@@ -26,7 +26,7 @@ DOC
Niko Tyni <ntyni@iki.fi>
DOC
see_also => <<DOC,
-Smokeping::probes::EchoPing(3pm)
+L<Smokeping::probes::EchoPing>
DOC
}
}
diff --git a/lib/Smokeping/probes/EchoPingHttp.pm b/lib/Smokeping/probes/EchoPingHttp.pm
index 45f9bd9..6483e10 100644
--- a/lib/Smokeping/probes/EchoPingHttp.pm
+++ b/lib/Smokeping/probes/EchoPingHttp.pm
@@ -33,7 +33,7 @@ DOC
Niko Tyni <ntyni@iki.fi>
DOC
see_also => <<DOC,
-EchoPing(3pm), EchoPingHttps(3pm)
+L<Smokeping::probes::EchoPing>, L<Smokeping::probes::EchoPingHttps>
DOC
}
}
diff --git a/lib/Smokeping/probes/EchoPingHttps.pm b/lib/Smokeping/probes/EchoPingHttps.pm
index 32e8cb0..13cd7f5 100644
--- a/lib/Smokeping/probes/EchoPingHttps.pm
+++ b/lib/Smokeping/probes/EchoPingHttps.pm
@@ -34,7 +34,7 @@ DOC
Niko Tyni <ntyni@iki.fi>
DOC
see_also => <<DOC,
-EchoPingHttp(3pm)
+L<Smokeping::probes::EchoPingHttp>
DOC
}
}
diff --git a/lib/Smokeping/probes/EchoPingIcp.pm b/lib/Smokeping/probes/EchoPingIcp.pm
index 0b781de..7392e60 100644
--- a/lib/Smokeping/probes/EchoPingIcp.pm
+++ b/lib/Smokeping/probes/EchoPingIcp.pm
@@ -34,7 +34,7 @@ DOC
Niko Tyni <ntyni@iki.fi>
DOC
see_also => <<DOC,
-EchoPing(3pm), EchoPingHttp(3pm)
+L<Smokeping::probes::EchoPing>, L<Smokeping::probes::EchoPingHttp>
DOC
}
}
diff --git a/lib/Smokeping/probes/EchoPingSmtp.pm b/lib/Smokeping/probes/EchoPingSmtp.pm
index 2c2115d..8175fea 100644
--- a/lib/Smokeping/probes/EchoPingSmtp.pm
+++ b/lib/Smokeping/probes/EchoPingSmtp.pm
@@ -33,7 +33,7 @@ DOC
Niko Tyni <ntyni@iki.fi>
DOC
see_also => <<DOC,
-EchoPing(3pm)
+L<Smokeping::probes::EchoPing>
DOC
}
}
diff --git a/lib/Smokeping/probes/FPing.pm b/lib/Smokeping/probes/FPing.pm
index fca2a8d..17f649d 100644
--- a/lib/Smokeping/probes/FPing.pm
+++ b/lib/Smokeping/probes/FPing.pm
@@ -28,7 +28,7 @@ DOC
description => <<DOC,
Integrates FPing as a probe into smokeping. The variable B<binary> must
point to your copy of the FPing program. If it is not installed on
-your system yet, you can get it from http://www.fping.com/.
+your system yet, you can get it from L<http://www.fping.com/>.
The (optional) B<packetsize> option lets you configure the packetsize for the pings sent.
diff --git a/lib/Smokeping/probes/FPing6.pm b/lib/Smokeping/probes/FPing6.pm
index 27e6a59..bd70649 100644
--- a/lib/Smokeping/probes/FPing6.pm
+++ b/lib/Smokeping/probes/FPing6.pm
@@ -33,7 +33,7 @@ Tobias Oetiker <tobi@oetiker.ch>
Niko Tyni <ntyni@iki.fi>
DOC
see_also => <<DOC
-Smokeping::probes::FPing
+L<Smokeping::probes::FPing>
DOC
}
}
diff --git a/lib/Smokeping/probes/IOSPing.pm b/lib/Smokeping/probes/IOSPing.pm
index 708c03f..7a10e4a 100644
--- a/lib/Smokeping/probes/IOSPing.pm
+++ b/lib/Smokeping/probes/IOSPing.pm
@@ -66,7 +66,7 @@ DOC
authors => <<'DOC',
Paul J Murphy <paul@murph.org>
-based on Smokeping::probes::FPing by
+based on L<Smokeping::probes::FPing|Smokeping::probes::FPing> by
Tobias Oetiker <tobi@oetiker.ch>
DOC
diff --git a/lib/Smokeping/probes/base.pm b/lib/Smokeping/probes/base.pm
index 0309550..dab2979 100644
--- a/lib/Smokeping/probes/base.pm
+++ b/lib/Smokeping/probes/base.pm
@@ -29,7 +29,7 @@ sub pod_hash {
Smokeping::probes::base - Base Class for implementing SmokePing Probes
DOC
overview => <<DOC,
-For the time being, please use the Smokeping::probes::FPing for
+For the time being, please use the L<Smokeping::probes::FPing|Smokeping::probes::FPing> for
inspiration when implementing your own probes.
DOC
authors => <<'DOC',
diff --git a/lib/Smokeping/probes/basefork.pm b/lib/Smokeping/probes/basefork.pm
index 4324e6d..b7b5554 100644
--- a/lib/Smokeping/probes/basefork.pm
+++ b/lib/Smokeping/probes/basefork.pm
@@ -74,7 +74,7 @@ DOC
Niko Tyni <ntyni@iki.fi>
DOC
see_also => <<DOC,
-Smokeping::probes::basevars(3pm), Smokeping::probes::EchoPing(3pm)
+L<Smokeping::probes::basevars>, L<Smokeping::probes::EchoPing>
DOC
}
}
diff --git a/lib/Smokeping/probes/basevars.pm b/lib/Smokeping/probes/basevars.pm
index 26c0d85..8a1b475 100644
--- a/lib/Smokeping/probes/basevars.pm
+++ b/lib/Smokeping/probes/basevars.pm
@@ -25,7 +25,7 @@ sub pod_hash {
Smokeping::probes::basevars - Another Base Class for implementing SmokePing Probes
DOC
overview => <<DOC,
-Like Smokeping::probes::base, but supports host-specific variables for the probe.
+Like L<Smokeping::probes::base|Smokeping::probes::base>, but supports host-specific variables for the probe.
DOC
description => <<DOC,
Provides the method `targets' that returns a list of hashes.
@@ -59,7 +59,7 @@ Uses `Smokeping::probes::base' internals too much to be a derived class, but
I didn't want to touch the base class directly.
DOC
see_also => <<DOC,
-Smokeping::probes::base(3pm), Smokeping::probes::EchoPing(3pm)
+L<Smokeping::probes::base>, L<Smokeping::probes::EchoPing>
DOC
}
}
diff --git a/lib/Smokeping/probes/passwordchecker.pm b/lib/Smokeping/probes/passwordchecker.pm
index cc4f59f..7633eba 100644
--- a/lib/Smokeping/probes/passwordchecker.pm
+++ b/lib/Smokeping/probes/passwordchecker.pm
@@ -80,7 +80,7 @@ The need for storing cleartext passwords can be considered a bug in itself.
DOC
see_also => <<DOC,
-Smokeping::probes::basefork(3pm), Smokeping::probes::Radius(3pm), Smokeping::probes::LDAP(3pm)
+L<Smokeping::probes::basefork>, L<Smokeping::probes::Radius>, L<Smokeping::probes::LDAP>
DOC
}
}
diff --git a/lib/Smokeping/probes/skel.pm b/lib/Smokeping/probes/skel.pm
index fb7ade1..ba60a47 100644
--- a/lib/Smokeping/probes/skel.pm
+++ b/lib/Smokeping/probes/skel.pm
@@ -34,7 +34,7 @@ DOC
Niko Tyni <ntyni@iki.fi>,
DOC
see_also => <<DOC
-The L<smokeping_extend> document
+L<smokeping_extend>
DOC
};
}