Smokeping::Examples(3)             SmokePing            Smokeping::Examples(3)



NNAAMMEE
       Smokeping::Examples - A module for generating the smokeping_examples
       document

OOVVEERRVVIIEEWW
       This module generates smokeping_examples and the example configuration
       files distributed with Smokeping. It is supposed to be invoked from the
       smokeping distribution top directory, as it will need the "etc/con-
       fig.dist" template configuration file and will create files in the
       directories "doc" and "doc/examples".

DDEESSCCRRIIPPTTIIOONN
       The entry point to the module is the "make" subroutine. It takes one
       optional parameter, "check", that makes the module run a syntax check
       for all the created example configuration files.

BBUUGGSS
       This module uses more or less internal functions from Smokeping.pm.
       It's a separate module only because the latter is much too big already.

       It should be possible to include POD markup in the configuration expla-
       nations and have this module filter them away for the config files.

       It might be nice for the probe module authors to be able to provide an
       example configuration as part of the probe module instead of having to
       modify Smokeping::Examples too.

CCOOPPYYRRIIGGHHTT
       Copyright 2005 by Niko Tyni.

LLIICCEENNSSEE
       This program is free software; you can redistribute it and/or modify it
       under the terms of the GNU General Public License as published by the
       Free Software Foundation; either version 2 of the License, or (at your
       option) any later version.

       This program is distributed in the hope that it will be useful, but
       WITHOUT ANY WARRANTY; without even the implied warranty of MER-
       CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
       Public License for more details.

       You should have received a copy of the GNU General Public License along
       with this program; if not, write to the Free Software Foundation, Inc.,
       675 Mass Ave, Cambridge, MA 02139, USA.

AAUUTTHHOORR
       Niko Tyni <ntyni@iki.fi>



2.4.2                             2007-04-15            Smokeping::Examples(3)