summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorNiko Tyni <ntyni@iki.fi>2005-02-16 21:18:48 +0100
committerNiko Tyni <ntyni@iki.fi>2005-02-16 21:18:48 +0100
commit09df26f453b88aafaddf53c08c740d32e1342336 (patch)
tree31d0fca65fc939a40b78f768ed909a3c793b221c /doc
parent94f0e104fd177a53bc73ab83838522785e785623 (diff)
downloadsmokeping-09df26f453b88aafaddf53c08c740d32e1342336.tar.gz
smokeping-09df26f453b88aafaddf53c08c740d32e1342336.tar.xz
* announce smokeping version at startup
* add matcher list to smokeping_config * make matcher names start with a capital letter * make probe names start with a capital letter * small doc updates * one more pod2html makefile fix
Diffstat (limited to 'doc')
-rw-r--r--doc/smokeping_extend.pod12
-rw-r--r--doc/smokeping_install.pod2
-rw-r--r--doc/smokeping_upgrade.pod11
3 files changed, 21 insertions, 4 deletions
diff --git a/doc/smokeping_extend.pod b/doc/smokeping_extend.pod
index 831a3d1..eef0bf6 100644
--- a/doc/smokeping_extend.pod
+++ b/doc/smokeping_extend.pod
@@ -30,8 +30,7 @@ you should too. This document will thus concentrate on the latter case.
The L<Smokeping::probes::skel|Smokeping::probes::skel> module is a non-functional probe that is intended
to make a good basis for a new probe module. Copy the file,
C<lib/probes/skel.pm>, to a new name and just fill out the blanks :)
-Note that real probe modules must have at least one capital letter
-in their name.
+Note that the names of real probe modules must start with a capital letter.
=head1 PROBE DOCUMENTATION
@@ -50,6 +49,15 @@ C<see_also>. If you don't need a particular section, just leave it out.
The special sections C<synopsys> and C<variables> are automatically
generated from the description of your variables. See below.
+Note that if you use 'here documents' ('<<') that have POD markup inside,
+you should escape the markup so that it doesn't show up in the embedded
+POD documentation. Most probes do it like this:
+
+ my $e = "=";
+ my $doc = <<DOC;
+ ${e}head1 SECTION TITLE
+ DOC
+
=head1 PROBE DESCRIPTION
The probe should offer the C<ProbeDesc> method that returns a short
diff --git a/doc/smokeping_install.pod b/doc/smokeping_install.pod
index 0d97053..7bb8a6b 100644
--- a/doc/smokeping_install.pod
+++ b/doc/smokeping_install.pod
@@ -77,7 +77,7 @@ address, you need to install it.
=item Net::Telnet
-You need this for the telnetIOSPing probe.
+You need this for the TelnetIOSPing probe.
=item Net::DNS
diff --git a/doc/smokeping_upgrade.pod b/doc/smokeping_upgrade.pod
index a5e7f67..6c5fbc3 100644
--- a/doc/smokeping_upgrade.pod
+++ b/doc/smokeping_upgrade.pod
@@ -76,6 +76,12 @@ This is not an incompatible change, but it is mentioned here nevertheless.
Target-specific variables can now be specified in the Probes section as well,
and the values given become defaults for all the targets.
+=item Matchers
+
+The matcher modules have been renamed to start with a capital letter,
+to differentiate the actual modules from the base classes. You have to
+capitalize the matcher name in the pattern definition accordingly.
+
=back
In addition to this, some probes have had minor incompatible changes to
@@ -135,7 +141,10 @@ The C<sleeptime> variable was changed to C<mininterval> and its semantics
were changed accordingly. See the LDAP explanation above. Additionally,
the time is now specified in seconds rather than microseconds.
-=item L<telnetIOSPing|Smokeping::probes::telnetIOSPing>
+=item L<TelnetIOSPing|Smokeping::probes::TelnetIOSPing>
+
+The name of this probe was changed: it now starts with a capital letter
+like all the others do.
The C<target> variable was removed. The target should now be specified
in the C<host> variable, like it is with all the other probes.