torrus/doc/manpages/torrus_compilexml.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_compilexml.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $
  18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
  19 #
  20 #
  21
  22 =head1 NAME
  23
  24 compilexml - Torrus XML configuration (re)compiler.
  25
  26 =head1 SYNOPSIS
  27
  28 B<torrus compilexml> --tree=I<TREENAME> [I<options...>]
  29
  30 =head1 DESCRIPTION
  31
  32 This command compiles the Torrus's XML configuration for the tree
  33 I<TREENAME>. It does not require any other processes to be restarted
  34 after the configuration is changed. Renderer's cache is automatically
  35 flushed on on the next Renderer's run. Monitor automatically resets on
  36 the next monitoring cycle. All dynamic tokensets in the given tree are
  37 emptied.
  38
  39 =head1 OPTIONS
  40
  41 =over 4
  42
  43 =item B<--all>
  44
  45 Instructs to compile configuration for all trees.
  46
  47 =item B<--nods>
  48
  49 Instructs to compile non-datasource configuration only.
  50
  51 =item B<--noval>
  52
  53 Disables all validation of the XML configuration. This speeds up the
  54 compilation up to 2 times, while adding a risk to end up with an
  55 unusable configuration. In addition, the first initialization cycle of
  56 Collector and Monitor in this case would be much longer.
  57
  58 =item B<--force>
  59
  60 Normally the compiler would fail to start if another compiler process
  61 is already running for the specific tree. In case of abnormal function,
  62 the running status of the previous pcompiler may stay in the database.
  63 This option forces the compiler to continue even if if sees the presence
  64 of another process.
  65
  66 =item B<--debug>
  67
  68 Sets the log level to debug.
  69
  70 =item B<--verbose>
  71
  72 Sets the debug level to info.
  73
  74 =item B<--help>
  75
  76 Displays a help message.
  77
  78 =back
  79
  80 =head1 SEE ALSO
  81
  82 L<torrus(@mansec_usercmd@)>
  83
  84 =head1 NOTES
  85
  86 See more documentation at Torrus home page: http://torrus.org
  87
  88
  89 =head1 AUTHOR
  90
  91 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>