torrus/doc/manpages/torrus_monitor.pod.in

   1 #  Copyright (C) 2004  Stanislav Sinyagin
   2 #
   3 #  This program is free software; you can redistribute it and/or modify
   4 #  it under the terms of the GNU General Public License as published by
   5 #  the Free Software Foundation; either version 2 of the License, or
   6 #  (at your option) any later version.
   7 #
   8 #  This program is distributed in the hope that it will be useful,
   9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 #  GNU General Public License for more details.
  12 #
  13 #  You should have received a copy of the GNU General Public License
  14 #  along with this program; if not, write to the Free Software
  15 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  16
  17 # $Id: torrus_monitor.pod.in,v 1.1 2010-12-27 00:04:38 ivan Exp $
  18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
  19 #
  20 #
  21
  22 =head1 NAME
  23
  24 monitor - Torrus Monitor.
  25
  26 =head1 SYNOPSIS
  27
  28 B<torrus monitor> --tree=I<TREENAME> [I<options...>]
  29
  30 =head1 DESCRIPTION
  31
  32 This command starts the Monitor process for the tree I<TREENAME>. By
  33 default it forks into a daemon, sets the log output file to
  34 F<@logdir@/monitor.TREENAME.log>, performs one monitoring cycle, and
  35 sleeps until the next cycle is scheduled. In daemon mode the log file
  36 can be reopened by sending it a SIGHUP signal.
  37
  38 =head1 OPTIONS
  39
  40 =over 4
  41
  42 =item B<--nodaemon>
  43
  44 Prevents the process from becoming a daemon and sets the log to STDERR.
  45
  46 =item B<--runonce>
  47
  48 Instructs the script to run once and exit. Implies B<--nodaemon>.
  49
  50 =item B<--delay=N>
  51
  52 Makes the daemon sleep for N minutes before starting the first cycle.
  53 This would happen on the daemon startup and also after each configuration
  54 recompilation.
  55 For example, when monitor and collector start simultaneously, the collector
  56 needs some time to retrieve the data being monitored.
  57
  58 =item B<--debug>
  59
  60 Sets the log level to debug.
  61
  62 =item B<--verbose>
  63
  64 Sets the debug level to info.
  65
  66 =item B<--help>
  67
  68 Displays a help message.
  69
  70 =back
  71
  72 =head1 FILES
  73
  74 =over 4
  75
  76 =item F<@siteconfdir@/torrus-siteconfig.pl>
  77
  78 Torrus site configuration script.
  79
  80 =item F<@logdir@/monitor.TREENAME.log>
  81
  82 Monitor's log for the tree I<TREENAME>.
  83
  84 =back
  85
  86 =head1 SEE ALSO
  87
  88 L<torrus(@mansec_usercmd@)>
  89
  90 =head1 NOTES
  91
  92 See more documentation at Torrus home page: http://torrus.org
  93
  94 =head1 AUTHOR
  95
  96 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>