tags #307955 +patch
thanks
On Sat, May 07, 2005 at 05:01:45PM +0200, Marc Haber wrote:
> > doesn't '@include' work?
>
> Yes, that works. That should be documented in the smokeping_config man
> page.
There's a pointer there:
The Parser for the Configuration file is written using
David Schweikers ParseConfig module. Read all about it in
ISG::ParseConfig.
But yes, I guess it would be best to copy the 'General Syntax' section
from ParseConfig docs to smokeping_config, as it is useful for a much
wider audience than the rest of the ParseConfig manual.
Documentation updates are still allowed for Sarge, AIUI, so here's a
dpatch.
I'll do something similar for the upstream 2.0 release candidates.
Cheers,
--
Niko
#! /bin/sh /usr/share/dpatch/dpatch-run
## 30_config_docs.dpatch by Niko Tyni <[EMAIL PROTECTED]>
##
## All lines beginning with `## DP:' are a description of the patch.
## DP: Documentation updates
@DPATCH@
--- smokeping-1.38/lib/Smokeping.pm 2005/05/07 16:13:51 1.1
+++ smokeping-1.38/lib/Smokeping.pm 2005/05/07 16:20:43
@@ -2107,6 +2107,7 @@
sub makepod ($){
my $parser = shift;
my $e='=';
+ my $a='@';
print <<POD;
${e}head1 NAME
@@ -2129,7 +2130,29 @@
${e}head1 REFERENCE
-The text below describes the syntax of the SmokePing configuration file.
+${e}head2 GENERAL SYNTAX
+
+The text below describes the general syntax of the SmokePing configuration
file.
+It was copied from the ISG::ParseConfig documentation.
+
+'#' denotes a comment up to the end-of-line, empty lines are allowed and space
+at the beginning and end of lines is trimmed.
+
+'\\' at the end of the line marks a continued line on the next line. A single
+space will be inserted between the concatenated lines.
+
+'${a}include filename' is used to include another file.
+
+'${a}define a some value' will replace all occurences of 'a' in the following
text
+with 'some value'.
+
+Fields in tables that contain white space can be enclosed in either C<'> or
C<">.
+Whitespace can also be escaped with C<\\>. Quotes inside quotes are allowed
but must
+be escaped with a backslash as well.
+
+${e}head2 SPECIFIC SYNTAX
+
+The text below describes the specific syntax of the SmokePing configuration
file.
POD
