import torrus 1.0.9

[freeside.git] / torrus / doc / manpages / torrus_compilexml.pod.in

diff --git a/torrus/doc/manpages/torrus_compilexml.pod.in b/torrus/doc/manpages/torrus_compilexml.pod.in
new file mode 100644 (file)
index 0000000..281e1fb
--- /dev/null
+++ b/torrus/doc/manpages/torrus_compilexml.pod.in
@@ -0,0 +1,91 @@
+#  Copyright (C) 2004  Stanislav Sinyagin
+#
+#  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
+#  MERCHANTABILITY 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
+
+# $Id: torrus_compilexml.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $
+# Stanislav Sinyagin <ssinyagin@yahoo.com>
+#
+#
+
+=head1 NAME
+
+compilexml - Torrus XML configuration (re)compiler.
+
+=head1 SYNOPSIS
+
+B<torrus compilexml> --tree=I<TREENAME> [I<options...>]
+
+=head1 DESCRIPTION
+
+This command compiles the Torrus's XML configuration for the tree
+I<TREENAME>. It does not require any other processes to be restarted
+after the configuration is changed. Renderer's cache is automatically
+flushed on on the next Renderer's run. Monitor automatically resets on
+the next monitoring cycle. All dynamic tokensets in the given tree are
+emptied.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<--all>
+
+Instructs to compile configuration for all trees.
+
+=item B<--nods>
+
+Instructs to compile non-datasource configuration only.
+
+=item B<--noval>
+
+Disables all validation of the XML configuration. This speeds up the
+compilation up to 2 times, while adding a risk to end up with an
+unusable configuration. In addition, the first initialization cycle of
+Collector and Monitor in this case would be much longer.
+
+=item B<--force>
+
+Normally the compiler would fail to start if another compiler process
+is already running for the specific tree. In case of abnormal function,
+the running status of the previous pcompiler may stay in the database.
+This option forces the compiler to continue even if if sees the presence
+of another process.
+
+=item B<--debug>
+
+Sets the log level to debug.
+
+=item B<--verbose>
+
+Sets the debug level to info.
+
+=item B<--help>
+
+Displays a help message.
+
+=back
+
+=head1 SEE ALSO
+
+L<torrus(@mansec_usercmd@)>
+
+=head1 NOTES
+
+See more documentation at Torrus home page: http://torrus.org
+
+
+=head1 AUTHOR
+
+Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>