Code

Merge remote-tracking branch 'github/pr/387'
[collectd.git] / src / collectdmon.pod
1 =encoding UTF-8
3 =head1 NAME
5 collectdmon - Monitoring daemon for collectd
7 =head1 SYNOPSIS
9 collectdmon I<[options]> [-- I<collectd options>]
11 =head1 DESCRIPTION
13 collectdmon is a small "wrapper" daemon which starts and monitors the collectd
14 daemon. If collectd terminates it will automatically be restarted, unless
15 collectdmon was told to shut it down.
17 =head1 OPTIONS
19 collectdmon supports the following options:
21 =over 4
23 =item B<-c> I<E<lt>pathE<gt>>
25 Specify the pathname of the collectd binary. You may either specify an
26 absolute path or simply the name of the binary in which case the B<PATH>
27 variable will be searched for it. The default is "B<collectd>".
29 =item B<-P> I<E<lt>pid-fileE<gt>>
31 Specify the pid file. The default is "I</var/run/collectdmon.pid>".
33 =item B<-h>
35 Output usage information and exit.
37 =item I<collectd options>
39 Specify options that are passed on to collectd. If it is not already included,
40 B<-f> will be added to these options. See L<collectd(1)>.
42 =back
44 =head1 SIGNALS
46 B<collectdmon> accepts the following signals:
48 =over 4
50 =item B<SIGINT>, B<SIGTERM>
52 These signals cause B<collectdmon> to terminate B<collectd>, wait for its
53 termination and then shut down.
55 =item B<SIGHUP>
57 This signal causes B<collectdmon> to terminate B<collectd>, wait for its
58 termination and then restart it.
60 =back
62 =head1 SEE ALSO
64 L<collectd(1)>,
65 L<collectd.conf(5)>,
66 L<http://collectd.org/>
68 =head1 AUTHOR
70 collectd has been written by Florian Forster E<lt>octo at verplant.orgE<gt>
71 and many contributors (see `AUTHORS').
73 collectdmon has been written by Sebastian Harl E<lt>sh@tokkee.orgE<gt>.
75 =cut