diff options
Diffstat (limited to 'torrus/doc/manpages')
27 files changed, 3237 insertions, 0 deletions
diff --git a/torrus/doc/manpages/Makefile.am b/torrus/doc/manpages/Makefile.am new file mode 100644 index 000000000..1f53b8764 --- /dev/null +++ b/torrus/doc/manpages/Makefile.am @@ -0,0 +1,134 @@ + +# Copyright (C) 2002 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: Makefile.am,v 1.1 2010-12-27 00:04:38 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# + +SUBST = @abs_top_builddir@/setup_tools/substvars.sh + +EXTRA_DIST = $(SRCPOD) +CLEANFILES = $(PODMAN) $(POD_FILES) + +SRCPOD = \ + torrus.pod.in \ + torrus_acledit.pod.in \ + torrus_action_notify.pod.in \ + torrus_action_printemail.pod.in \ + torrus_action_snmptrap.pod.in \ + torrus_buildsearchdb.pod.in \ + torrus_cleanup.pod.in \ + torrus_clearcache.pod.in \ + torrus_collector.pod.in \ + torrus_compilexml.pod.in \ + torrus_configinfo.pod.in \ + torrus_configsnapshot.pod.in \ + torrus_devdiscover.pod.in \ + torrus_flushmonitors.pod.in \ + torrus_genddx.pod.in \ + torrus_genlist.pod.in \ + torrus_genreport.pod.in \ + torrus_install_plugin.pod.in \ + torrus_monitor.pod.in \ + torrus_nodeid.pod.in \ + torrus_rrddir2xml.pod.in \ + torrus_schedulerinfo.pod.in \ + torrus_snmpfailures.pod.in \ + torrus_srvderive.pod.in \ + torrus_ttproclist.pod.in + +POD_FILES = \ + torrus.pod \ + torrus_acledit.pod \ + torrus_action_notify.pod \ + torrus_action_printemail.pod \ + torrus_action_snmptrap.pod \ + torrus_buildsearchdb.pod \ + torrus_cleanup.pod \ + torrus_clearcache.pod \ + torrus_collector.pod \ + torrus_compilexml.pod \ + torrus_configinfo.pod \ + torrus_configsnapshot.pod \ + torrus_devdiscover.pod \ + torrus_flushmonitors.pod \ + torrus_genddx.pod \ + torrus_genlist.pod \ + torrus_genreport.pod \ + torrus_install_plugin.pod \ + torrus_monitor.pod \ + torrus_nodeid.pod \ + torrus_rrddir2xml.pod \ + torrus_schedulerinfo.pod \ + torrus_snmpfailures.pod \ + torrus_srvderive.pod \ + torrus_ttproclist.pod + +PODMAN = \ + torrus.@mansec_usercmd@ \ + torrus_acledit.@mansec_usercmd@ \ + torrus_action_notify.@mansec_misc@ \ + torrus_action_printemail.@mansec_misc@ \ + torrus_action_snmptrap.@mansec_misc@ \ + torrus_buildsearchdb.@mansec_usercmd@ \ + torrus_cleanup.@mansec_usercmd@ \ + torrus_clearcache.@mansec_usercmd@ \ + torrus_collector.@mansec_usercmd@ \ + torrus_compilexml.@mansec_usercmd@ \ + torrus_configinfo.@mansec_usercmd@ \ + torrus_configsnapshot.@mansec_usercmd@ \ + torrus_devdiscover.@mansec_usercmd@ \ + torrus_flushmonitors.@mansec_usercmd@ \ + torrus_genddx.@mansec_usercmd@ \ + torrus_genlist.@mansec_usercmd@ \ + torrus_genreport.@mansec_usercmd@ \ + torrus_install_plugin.@mansec_misc@ \ + torrus_monitor.@mansec_usercmd@ \ + torrus_nodeid.@mansec_usercmd@ \ + torrus_rrddir2xml.@mansec_usercmd@ \ + torrus_schedulerinfo.@mansec_usercmd@ \ + torrus_snmpfailures.@mansec_usercmd@ \ + torrus_srvderive.@mansec_usercmd@ \ + torrus_ttproclist.@mansec_usercmd@ + + + +if POD2MAN_PRESENT +install-data-local: $(POD_FILES) + for f in $(PODMAN); do \ + base=`echo $$f | sed -e 's/\\.[0-9a-zA-Z]*$$//'`; \ + ext=`echo $$f | sed -e 's/^.*\\.//'`; \ + instdir=$(DESTDIR)$(mandir)/man$$ext; \ + echo BASE=$$base EXT=$$ext INSTDIR=$$instdir; \ + $(POD2MAN) --section=$$ext \ + --release="$(PACKAGE_STRING)" --center=torrus \ + $$base.pod > $$f || exit 1; \ + test -d $$instdir || $(mkinstalldirs) $$instdir || exit 1; \ + $(INSTALL_DATA) $$f $$instdir; \ + rm $$f; \ + done +endif + + +SUFFIXES = .pod.in .pod + +.PRECIOUS: $(POD_FILES) + +.pod.in.pod: + $(SUBST) $< > $@ + +pods: $(POD_FILES) diff --git a/torrus/doc/manpages/Makefile.in b/torrus/doc/manpages/Makefile.in new file mode 100644 index 000000000..d8cdedfc4 --- /dev/null +++ b/torrus/doc/manpages/Makefile.in @@ -0,0 +1,445 @@ +# Makefile.in generated by automake 1.9.6 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005 Free Software Foundation, Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +# Copyright (C) 2002 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: Makefile.in,v 1.1 2010-12-27 00:04:38 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +srcdir = @srcdir@ +top_srcdir = @top_srcdir@ +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +top_builddir = ../.. +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +INSTALL = @INSTALL@ +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +subdir = doc/manpages +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(install_sh) -d +CONFIG_CLEAN_FILES = +SOURCES = +DIST_SOURCES = +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +FIND = @FIND@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +KILL = @KILL@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LTLIBOBJS = @LTLIBOBJS@ +MAKEINFO = @MAKEINFO@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PERL = @PERL@ +PERLINC = @PERLINC@ +POD2MAN = @POD2MAN@ +POD2MAN_PRESENT_FALSE = @POD2MAN_PRESENT_FALSE@ +POD2MAN_PRESENT_TRUE = @POD2MAN_PRESENT_TRUE@ +POD2TEXT = @POD2TEXT@ +POD2TEXT_PRESENT_FALSE = @POD2TEXT_PRESENT_FALSE@ +POD2TEXT_PRESENT_TRUE = @POD2TEXT_PRESENT_TRUE@ +RM = @RM@ +SED = @SED@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +SLEEP = @SLEEP@ +STRIP = @STRIP@ +SU = @SU@ +VERSION = @VERSION@ +ac_ct_STRIP = @ac_ct_STRIP@ +am__leading_dot = @am__leading_dot@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +cachedir = @cachedir@ +cfgdefdir = @cfgdefdir@ +datadir = @datadir@ +dbhome = @dbhome@ +defrrddir = @defrrddir@ +distxmldir = @distxmldir@ +enable_pkgonly = @enable_pkgonly@ +enable_varperm = @enable_varperm@ +exec_prefix = @exec_prefix@ +exmpdir = @exmpdir@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localstatedir = @localstatedir@ +logdir = @logdir@ +mandir = @mandir@ +mansec_misc = @mansec_misc@ +mansec_usercmd = @mansec_usercmd@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +perlithreads = @perlithreads@ +perllibdir = @perllibdir@ +perllibdirs = @perllibdirs@ +piddir = @piddir@ +pkgbindir = @pkgbindir@ +pkgdocdir = @pkgdocdir@ +pkghome = @pkghome@ +plugdevdisccfgdir = @plugdevdisccfgdir@ +pluginsdir = @pluginsdir@ +plugtorruscfgdir = @plugtorruscfgdir@ +plugwrapperdir = @plugwrapperdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +reportsdir = @reportsdir@ +sbindir = @sbindir@ +scriptsdir = @scriptsdir@ +seslockdir = @seslockdir@ +sesstordir = @sesstordir@ +sharedstatedir = @sharedstatedir@ +siteconfdir = @siteconfdir@ +sitedir = @sitedir@ +sitexmldir = @sitexmldir@ +supdir = @supdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +tmpldir = @tmpldir@ +tmpluserdir = @tmpluserdir@ +torrus_user = @torrus_user@ +var_group = @var_group@ +var_mode = @var_mode@ +var_user = @var_user@ +varprefix = @varprefix@ +webplaindir = @webplaindir@ +webscriptsdir = @webscriptsdir@ +wrapperdir = @wrapperdir@ +SUBST = @abs_top_builddir@/setup_tools/substvars.sh +EXTRA_DIST = $(SRCPOD) +CLEANFILES = $(PODMAN) $(POD_FILES) +SRCPOD = \ + torrus.pod.in \ + torrus_acledit.pod.in \ + torrus_action_notify.pod.in \ + torrus_action_printemail.pod.in \ + torrus_action_snmptrap.pod.in \ + torrus_buildsearchdb.pod.in \ + torrus_cleanup.pod.in \ + torrus_clearcache.pod.in \ + torrus_collector.pod.in \ + torrus_compilexml.pod.in \ + torrus_configinfo.pod.in \ + torrus_configsnapshot.pod.in \ + torrus_devdiscover.pod.in \ + torrus_flushmonitors.pod.in \ + torrus_genddx.pod.in \ + torrus_genlist.pod.in \ + torrus_genreport.pod.in \ + torrus_install_plugin.pod.in \ + torrus_monitor.pod.in \ + torrus_nodeid.pod.in \ + torrus_rrddir2xml.pod.in \ + torrus_schedulerinfo.pod.in \ + torrus_snmpfailures.pod.in \ + torrus_srvderive.pod.in \ + torrus_ttproclist.pod.in + +POD_FILES = \ + torrus.pod \ + torrus_acledit.pod \ + torrus_action_notify.pod \ + torrus_action_printemail.pod \ + torrus_action_snmptrap.pod \ + torrus_buildsearchdb.pod \ + torrus_cleanup.pod \ + torrus_clearcache.pod \ + torrus_collector.pod \ + torrus_compilexml.pod \ + torrus_configinfo.pod \ + torrus_configsnapshot.pod \ + torrus_devdiscover.pod \ + torrus_flushmonitors.pod \ + torrus_genddx.pod \ + torrus_genlist.pod \ + torrus_genreport.pod \ + torrus_install_plugin.pod \ + torrus_monitor.pod \ + torrus_nodeid.pod \ + torrus_rrddir2xml.pod \ + torrus_schedulerinfo.pod \ + torrus_snmpfailures.pod \ + torrus_srvderive.pod \ + torrus_ttproclist.pod + +PODMAN = \ + torrus.@mansec_usercmd@ \ + torrus_acledit.@mansec_usercmd@ \ + torrus_action_notify.@mansec_misc@ \ + torrus_action_printemail.@mansec_misc@ \ + torrus_action_snmptrap.@mansec_misc@ \ + torrus_buildsearchdb.@mansec_usercmd@ \ + torrus_cleanup.@mansec_usercmd@ \ + torrus_clearcache.@mansec_usercmd@ \ + torrus_collector.@mansec_usercmd@ \ + torrus_compilexml.@mansec_usercmd@ \ + torrus_configinfo.@mansec_usercmd@ \ + torrus_configsnapshot.@mansec_usercmd@ \ + torrus_devdiscover.@mansec_usercmd@ \ + torrus_flushmonitors.@mansec_usercmd@ \ + torrus_genddx.@mansec_usercmd@ \ + torrus_genlist.@mansec_usercmd@ \ + torrus_genreport.@mansec_usercmd@ \ + torrus_install_plugin.@mansec_misc@ \ + torrus_monitor.@mansec_usercmd@ \ + torrus_nodeid.@mansec_usercmd@ \ + torrus_rrddir2xml.@mansec_usercmd@ \ + torrus_schedulerinfo.@mansec_usercmd@ \ + torrus_snmpfailures.@mansec_usercmd@ \ + torrus_srvderive.@mansec_usercmd@ \ + torrus_ttproclist.@mansec_usercmd@ + +SUFFIXES = .pod.in .pod +all: all-am + +.SUFFIXES: +.SUFFIXES: .pod.in .pod +$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh \ + && exit 0; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/manpages/Makefile'; \ + cd $(top_srcdir) && \ + $(AUTOMAKE) --gnu doc/manpages/Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +uninstall-info-am: +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's|.|.|g'`; \ + list='$(DISTFILES)'; for file in $$list; do \ + case $$file in \ + $(srcdir)/*) file=`echo "$$file" | sed "s|^$$srcdirstrip/||"`;; \ + $(top_srcdir)/*) file=`echo "$$file" | sed "s|^$$topsrcdirstrip/|$(top_builddir)/|"`;; \ + esac; \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + dir=`echo "$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test "$$dir" != "$$file" && test "$$dir" != "."; then \ + dir="/$$dir"; \ + $(mkdir_p) "$(distdir)$$dir"; \ + else \ + dir=''; \ + fi; \ + if test -d $$d/$$file; then \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \ + fi; \ + cp -pR $$d/$$file $(distdir)$$dir || exit 1; \ + else \ + test -f $(distdir)/$$file \ + || cp -p $$d/$$file $(distdir)/$$file \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-am +all-am: Makefile +installdirs: +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + `test -z '$(STRIP)' || \ + echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install +mostlyclean-generic: + +clean-generic: + -test -z "$(CLEANFILES)" || rm -f $(CLEANFILES) + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +@POD2MAN_PRESENT_FALSE@install-data-local: +clean: clean-am + +clean-am: clean-generic mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic + +dvi: dvi-am + +dvi-am: + +html: html-am + +info: info-am + +info-am: + +install-data-am: install-data-local + +install-exec-am: + +install-info: install-info-am + +install-man: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-info-am + +.PHONY: all all-am check check-am clean clean-generic distclean \ + distclean-generic distdir dvi dvi-am html html-am info info-am \ + install install-am install-data install-data-am \ + install-data-local install-exec install-exec-am install-info \ + install-info-am install-man install-strip installcheck \ + installcheck-am installdirs maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic pdf \ + pdf-am ps ps-am uninstall uninstall-am uninstall-info-am + + +@POD2MAN_PRESENT_TRUE@install-data-local: $(POD_FILES) +@POD2MAN_PRESENT_TRUE@ for f in $(PODMAN); do \ +@POD2MAN_PRESENT_TRUE@ base=`echo $$f | sed -e 's/\\.[0-9a-zA-Z]*$$//'`; \ +@POD2MAN_PRESENT_TRUE@ ext=`echo $$f | sed -e 's/^.*\\.//'`; \ +@POD2MAN_PRESENT_TRUE@ instdir=$(DESTDIR)$(mandir)/man$$ext; \ +@POD2MAN_PRESENT_TRUE@ echo BASE=$$base EXT=$$ext INSTDIR=$$instdir; \ +@POD2MAN_PRESENT_TRUE@ $(POD2MAN) --section=$$ext \ +@POD2MAN_PRESENT_TRUE@ --release="$(PACKAGE_STRING)" --center=torrus \ +@POD2MAN_PRESENT_TRUE@ $$base.pod > $$f || exit 1; \ +@POD2MAN_PRESENT_TRUE@ test -d $$instdir || $(mkinstalldirs) $$instdir || exit 1; \ +@POD2MAN_PRESENT_TRUE@ $(INSTALL_DATA) $$f $$instdir; \ +@POD2MAN_PRESENT_TRUE@ rm $$f; \ +@POD2MAN_PRESENT_TRUE@ done + +.PRECIOUS: $(POD_FILES) + +.pod.in.pod: + $(SUBST) $< > $@ + +pods: $(POD_FILES) +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/torrus/doc/manpages/torrus.pod.in b/torrus/doc/manpages/torrus.pod.in new file mode 100644 index 000000000..674b5ae21 --- /dev/null +++ b/torrus/doc/manpages/torrus.pod.in @@ -0,0 +1,98 @@ +# 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.pod.in,v 1.1 2010-12-27 00:04:37 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +torrus - Commandline wrapper for Torrus utilities + +=head1 SYNOPSIS + +B<torrus> I<command> [I<options...>] + +=head1 DESCRIPTION + +All Torrus utilities use this common command-line wrapper, which simply +passes all arguments to the appropriate utility. + +Accepted commands: + +=over 4 + +=item B<acledit> + +=item B<cleanup> + +=item B<clearcache> + +=item B<collector> + +=item B<compilexml> + +=item B<configinfo> + +=item B<configsnapshot> + +=item B<devdiscover> + +=item B<genddx> + +=item B<genlist> + +=item B<install_plugin> + +=item B<monitor> + +=item B<rrddir2xml> + +=item B<schedulerinfo> + +=item B<srvderive> + +=back + +=head1 OPTIONS + +Refer to approproate manpages for options for each Torrus command. + +=head1 SEE ALSO + +L<torrus_acledit(@mansec_usercmd@)>, +L<torrus_action_printemail(@mansec_misc@)>, +L<torrus_action_snmptrap(@mansec_misc@)>, +L<torrus_clearcache(@mansec_usercmd@)>, +L<torrus_collector(@mansec_usercmd@)>, +L<torrus_compilexml(@mansec_usercmd@)>, +L<torrus_configinfo(@mansec_usercmd@)>, +L<torrus_configsnapshot(@mansec_usercmd@)>, +L<torrus_devdiscover(@mansec_usercmd@)>, +L<torrus_genddx(@mansec_usercmd@)>, +L<torrus_monitor(@mansec_usercmd@)>, +L<torrus_rrddir2xml(@mansec_usercmd@)>, +L<torrus_schedulerinfo(@mansec_usercmd@)> +L<torrus_srvderive(@mansec_usercmd@)> + +=head1 NOTES + +See more documentation at Torrus home page: http://torrus.org + +=head1 AUTHOR + +Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt> diff --git a/torrus/doc/manpages/torrus_acledit.pod.in b/torrus/doc/manpages/torrus_acledit.pod.in new file mode 100644 index 000000000..eab10ac0a --- /dev/null +++ b/torrus/doc/manpages/torrus_acledit.pod.in @@ -0,0 +1,212 @@ +# 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_acledit.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +acledit - Manage Torrus access control lists (ACLs). + +=head1 SYNOPSIS + +B<torrus acledit> [I<options...>] + +=head1 DESCRIPTION + +This command manages the Torrus access control lists. Each user is +identified by user ID, and has a set of attributes. Currently +supported attributes are C<cn> (common name) and C<userPasswordMD5> +(MD5 digest of the user's password). + +Each user belongs to one or several groups. Each group has its own +set of privileges. A privilege is identified by privilege name and +object name. Currently only one privilege name is supported: +C<DisplayTree>, and the object name is the name of the tree that +this group is allowed to browse. + +User authorization in the web interface is controlled by the +C<$Torrus::CGI::authorizeUsers> variable in F<torrus-siteconfig.pl>. + +=head1 GROUP MANAGEMENT OPTIONS + +=over 4 + +=item B<--addgroup>=I<GROUP> + +Creates a new group with the given name. + +=item B<--delgroup>=I<GROUP> + +Deletes the group with the given name. + +=item B<--modgroup>=I<GROUP> + +Modifies the given group. + +=item B<--permit>=I<PRIVILEGE> + +Grants privilege to group(s). Currently supported privileges are: +C<DisplayTree> for displaying a datasource tree, and C<DisplayAdmInfo> +for displaying the administrative information (all significant +parameters for a given datasource leaf). + +=item B<--deny>=I<PRIVILEGE> + +Revokes group(s) privilege. + +=item B<--for>=I<OBJECT> + +Object for which privileges are granted or revoked. Currently it must be +the name of the tree for which the C<DisplayTree> and C<DisplayAdmInfo> +privilegs are granted or revoked. The asterisk (*) instead of the object +name assigns the privilege for all objects. + +=back + + +=head1 USER MANAGEMENT OPTIONS + +=over 4 + +=item B<--adduser>=I<UID> + +Creates a new user with the given user ID. + +=item B<--addhost>=I<HOST> + +Creates a new user for host-based authentication. I<HOST> should be an +IPv4 or IPv6 address of the HTTP client. The new username is the address +with all non-alphanumeric characters replaced with underscores. +Host password is changed by <--hostpassword> option. + +=item B<--deluser>=I<UID> + +Deletes user with the given user ID. + +=item B<--moduser>=I<UID> + +Modifies the user attributes for the given user ID. + +=item B<--addtogroup>=I<GROUP> + +Adds user to the given group. + +=item B<--delfromgroup>=I<GROUP> + +Deletes user from the given group. + +=item B<--password>=I<PASSWORD> + +Sets user's password. + +=item B<--hostpassword>=I<PASSWORD> + +Sets the password for host-based authentication. The HTTP client should +add C<hostauth> parameter with the password as a value. + +=item B<--cn>=I<NAME> + +Sets user's common name. + +=item B<--showuser>=I<UID> + +Displays information for a given user. + +=back + + +=head1 GENERAL OPTIONS + +=over 4 + +=item B<--export>=I<FILE> + +Exports ACL configuration to a given file. + +=item B<--template>=I<FILE> + +Uses the given template file when exporting. Default value is F<aclexport.xml>. + +=item B<--import>=I<FILE> + +Imports ACL configuration from the given file. + +=item B<--clear> + +Deletes all user and privileges configuration. + +=item B<--list> + +Lists all users and groups they belong to. + +=item B<--debug> + +Sets the log level to debug. + +=item B<--verbose> + +Sets the log level to info. + +=item B<--help> + +Displays a help message. + +=back + + +=head1 EXAMPLES + + torrus acledit --addgroup=staff --permit=DisplayTree \ + --for=main --for=thecustomer + torrus acledit --adduser=jsmith --password=mysecretpassword \ + --cn="John Smith" --addtogroup=staff + torrus acledit --addgroup=admin --permit=DisplayTree --for='*' + +This example creates a group I<staff> and gives all its members the permission +to browse the datasource trees I<main> and I<thecustomer>. The next command +creates a user I<jsmith> and addts it to this group. The user name will +be displayed as I<John Smith>, and it will be let in with the given +password. The third command creates a group I<admin> which is allowed +o browse all existing trees. + +=head1 FILES + +=over 4 + +=item F<@siteconfdir@/torrus-siteconfig.pl> + +Torrus site configuration script. + +=item F<@tmpldir@/aclexport.xml> + +Default template for the exports of ACL configuration. + +=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> diff --git a/torrus/doc/manpages/torrus_action_notify.pod.in b/torrus/doc/manpages/torrus_action_notify.pod.in new file mode 100644 index 000000000..386c3d923 --- /dev/null +++ b/torrus/doc/manpages/torrus_action_notify.pod.in @@ -0,0 +1,100 @@ +# Copyright (C) 2006 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_action_notify.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +action_notify - Generic notification handler for Torrus monitor + +=head1 SYNOPSIS + + <action name="notify"> + <param name="action-type" value="exec" /> + <param name="command"> + $TORRUS_BIN/action_notify + </param> + <param name="launch-when" value="set" /> + </action> + +=head1 DESCRIPTION + +This program is designed for usage from a monitor action only. It takes +the arguments from environment variables, as described in action-type +C<exec> in B<Torrus XML Configuration Guide>. + +The handler reads its configuration from <notify-siteconfig.pl>, a small +Perl file which defines the notification paths for various conditions. + +Example: + + %Torrus::Notify::programs = + ( + 'mailto' => '$TORRUS_BIN/action_printemail | /usr/bin/mail $ARG1', + 'page' => '/usr/bin/echo $TORRUS_NODEPATH:$TORRUS_MONITOR ' . + '>> /tmp/monitor.$ARG1.log' + ); + + %Torrus::Notify::policies = + ( + 'CUST_A' => { + 'match' => sub { $ENV{'TORRUS_P_notify_policy'} eq 'A' }, + 'severity' => { + '3' => [ 'mailto:aaa@domain.com', + 'mailto:bbb@domain.com' ], + '5' => [ 'page:1234', 'mailto:boss@domain.com' ] } } ); + + +In this example, we define two message handlers: e-mail sender and +a dummy replacement for a pager program. Then we define the notification +policies. For the customer I<A>, we define the policy so that +the parameter C<notify-policy> should match the name C<A>. The parameter +is defined in the datasource tree and marks only those leaves +that belong to this customer. +Then, depending on the monitor severity, different notification +paths are defined. For severity values higher or equal 3, aaa@domain.com and +bbb@domain.com will receive the email notifications, and for severity +higher than or equal 5 all recipients will receive the notification. + +The C<match> argument is a Perl subroutine, and can depend on various +parameters, such as time of day or day of the week, the tree name, and so on. + + +=head1 FILES + +=over 4 + +=item F<@siteconfdir@/notify-siteconfig.pl> + +Notification policies configuration + + +=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> diff --git a/torrus/doc/manpages/torrus_action_printemail.pod.in b/torrus/doc/manpages/torrus_action_printemail.pod.in new file mode 100644 index 000000000..e63b94e4b --- /dev/null +++ b/torrus/doc/manpages/torrus_action_printemail.pod.in @@ -0,0 +1,101 @@ +# 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_action_printemail.pod.in,v 1.1 2010-12-27 00:04:38 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +action_printemail - A script for sending email from monitor action. + +=head1 SYNOPSIS + + <action name="report-email"> + <param name="action-type" value="exec" /> + <param name="command"> + $TORRUS_BIN/action_printemail | mail alarms@example.com + </param> + <param name="launch-when" value="set, clear" /> + </action> + +=head1 DESCRIPTION + +This program is designed for usage from a monitor action only. It takes +the arguments from environment variables, as described in action-type +C<exec> in B<Torrus XML Configuration Guide>. In addition, some values +may be supplied via command-line arguments (see section OPTIONS below). + +Site-specific variables must be specified in the file F<email-siteconfig.pl>. +Default values are installed by the first run of C<make install>. Subsequent +runs of C<make install> do not override this file. + +=head1 OPTIONS + +=over 4 + +=item B<--url>=I<GRAPHER-URL> + +Sets the URL of the grapher CGI script. + +=item B<--template>=I<TEMPLATE-FILE> + +Uses given file as a template. The template file must reside in @tmpldir@ +directory. It must be a Template-toolkit file, with the following variables +defined: + + tree Tree name + token Leaf token + path Leaf path + url URL for browsing this leaf + ncomment This leaf comment + npcomment Leaf's parent comment + event Event type + monitor Monitor name + mcomment Monitor comment + timestamp Time and date of the event + env(VAR) Environment variable VAR + +=back + +=head1 FILES + +=over 4 + +=item F<@siteconfdir@/email-siteconfig.pl> + +Torrus site email configuration script. + +=item F<@tmpldir@> + +=item F<@tmpluserdir@> + +Torrus template directories. + +=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> diff --git a/torrus/doc/manpages/torrus_action_snmptrap.pod.in b/torrus/doc/manpages/torrus_action_snmptrap.pod.in new file mode 100644 index 000000000..409a9109e --- /dev/null +++ b/torrus/doc/manpages/torrus_action_snmptrap.pod.in @@ -0,0 +1,97 @@ +# 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_action_snmptrap.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +action_snmptrap, action_snmpv1trap - Scripts for sending +SNMP traps (version 2c and 1 respectively) from monitor action. +C<action_snmpv1trap> is obsolete as the preferred SNMP version is 2c. + +=head1 SYNOPSIS + + <action name="snmptrap"> + <param name="action-type" value="exec" /> + <param name="command" value="$TORRUS_BIN/action_snmptrap" /> + <param name="launch-when" value="set, clear" /> + </action> + +=head1 DESCRIPTION + +This program is designed for usage from a monitor action only. It takes +the arguments from environment variables, as described in action-type +C<exec> in B<Torrus XML Configuration Guide>. In addition, some values +may be supplied via command-line arguments (see section OPTIONS below). + +Site-specific variables must be specified in the file +F<snmptrap-siteconfig.pl>. Default values are installed by the first run +of C<make install>. Subsequent +runs of C<make install> do not override this file. + +=head1 OPTIONS + +=over 4 + +=item B<--host>=I<HOSTNAME> + +Sets the hostname of the destination host. + +=item B<--community>=I<COMMUNITY> + +Sets the community string to use when sending the trap. + +=item B<--port>=I<PORT> + +Sets the destination UDP port. + +=item B<--enterprise>=I<OID> + +Sets the C<enterprise> field of the SNMPv1 trap to a given OID (see +RFC 1157 for more details). This option is only available for +C<action_snmpv1trap> and will be ignored for C<action_snmptrap>. + +=item B<--severity>=I<SEVERITY> + +Sets the optional severity SNMP variable to some integer value. + +=back + +=head1 FILES + +=over 4 + +=item F<@siteconfdir@/snmptrap-siteconfig.pl> + +Torrus site configuration script for SNMP traps. + +=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> diff --git a/torrus/doc/manpages/torrus_buildsearchdb.pod.in b/torrus/doc/manpages/torrus_buildsearchdb.pod.in new file mode 100644 index 000000000..a4984e61e --- /dev/null +++ b/torrus/doc/manpages/torrus_buildsearchdb.pod.in @@ -0,0 +1,79 @@ +# Copyright (C) 2007 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_buildsearchdb.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +buildsearchdb - Build the search database + +=head1 SYNOPSIS + +B<torrus buildsearchdb> I<options...> + +=head1 DESCRIPTION + +This command indexes the Torrus configuration objects and builds the +search index database. One of the three options B<--tree>, B<--all> or +B<--global> is required. + +=head1 OPTIONS + +=over 4 + +=item B<--tree>=I<TREE> + +Build the indexes for a given tree. + +=item B<--all> + +Builds the tree indexes for all trees. + +=item B<--global> + +Builds the global index for all trees and also the tree indexes for every +tree. In order to use the global search database, the web user +should have the permission to display all trees and also it should have +the permission for GlobalSearch for all trees, for example: + + torrus acledit --addgroup=staff --permit=GlobalSearch --for='*' + + +=item B<--verbose> + +Prints extra information + +=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> + diff --git a/torrus/doc/manpages/torrus_cleanup.pod.in b/torrus/doc/manpages/torrus_cleanup.pod.in new file mode 100644 index 000000000..d01b3e84a --- /dev/null +++ b/torrus/doc/manpages/torrus_cleanup.pod.in @@ -0,0 +1,60 @@ +# 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_cleanup.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +cleanup - Cleans up Torrus web session data. + +=head1 SYNOPSIS + +B<torrus cleanup> + +=head1 DESCRIPTION + +This command cleans out the expired (older than 2 days) Torrus web interface +session data. + +=head1 FILES + +=over 4 + +=item F<@sesstordir@> + +Torrus session data storage directory. + +=item F<@seslockdir@> + +Torrus session data lock directory. + +=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> + diff --git a/torrus/doc/manpages/torrus_clearcache.pod.in b/torrus/doc/manpages/torrus_clearcache.pod.in new file mode 100644 index 000000000..a9c5a5be3 --- /dev/null +++ b/torrus/doc/manpages/torrus_clearcache.pod.in @@ -0,0 +1,47 @@ +# 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_clearcache.pod.in,v 1.1 2010-12-27 00:04:38 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +clearcache - Clears the Torrus Renderer's cache. + +=head1 SYNOPSIS + +B<torrus clearcache> + +=head1 DESCRIPTION + +This program clears Torrus Renderer's cache. It is intended for debugging +purposes only. + +=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> + diff --git a/torrus/doc/manpages/torrus_collector.pod.in b/torrus/doc/manpages/torrus_collector.pod.in new file mode 100644 index 000000000..071b308d9 --- /dev/null +++ b/torrus/doc/manpages/torrus_collector.pod.in @@ -0,0 +1,129 @@ +# 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_collector.pod.in,v 1.1 2010-12-27 00:04:38 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +collector - Torrus data Collector. + +=head1 SYNOPSIS + +B<torrus collector> --tree=I<TREENAME> [I<options...>] + +=head1 DESCRIPTION + +This command starts the Collector process for the tree I<TREENAME>. By +default it forks into a daemon, sets the log output file to +F<@logdir@/collector.TREENAME.log>, performs one +Collector cycle, and sleeps until the next cycle is scheduled. In +daemon mode the log file can be reopened by sending it a SIGHUP +signal. + +Collector cycle scheduling is controlled by two parameters defined +for each individual configuration leaf: C<collector-period> and +C<collector-timeoffset>. See the B<Torrus Configuration Guide> for more +details. + +The number of OID (Object IDentifier) variable bindings sent by +Collector is controlled by the datasource parameter C<snmp-oids-per-pdu>. +It is set to a default value of 40 in F<snmp-defs.xml>, and may be +overwritten at the host level. + +=head1 OPTIONS + +=over 4 + +=item B<--instance>=I<N> + +Defines the collector instance. A single tree can allow more than one +collector instance. The number of instances is defined in C<run> hash +in the F<torrus-siteconfig.pl>'s C<%Torrus::Global::treeConfig>. +If the number of instances is more than one, this option is mandatory. +The collecting job is split between the instances, and normally all +instances should be started by the startup scripts. The tree should +be re-compiled after the number of instances is changed in the siteconfig. +In the example below the tree I<tree_A> will be served by three +collector instances: + + %Torrus::Global::treeConfig = ( + 'tree_A' => { + 'description' => 'The First Tree', + 'xmlfiles' => [qw(a1.xml a2.xml a3.xml)], + 'run' => { 'collector' => 3, 'monitor' => 1 } }, + ); + +=item B<--nodaemon> + +Prevents the process from becoming a daemon and sets the log to STDERR. + +=item B<--runonce> + +Instructs the collector to run once and exit. Implies B<--nodaemon>. + +=item B<--runalways> + +Instructs the collector process to continue running even if no collector +datasources are defined in the tree. In this case, the process will check +once per hour if the configuration has changed. + +=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 FILES + +=over 4 + +=item F<@siteconfdir@/torrus-siteconfig.pl> + +Torrus site configuration script. + +=item F<@logdir@/collector.TREENAME.log> + +Collector's log for the tree I<TREENAME>. + +=item F<@distxmldir@/snmp-defs.xml> + +Basic variable definitions for the SNMP collector. + +=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> diff --git a/torrus/doc/manpages/torrus_compilexml.pod.in b/torrus/doc/manpages/torrus_compilexml.pod.in new file mode 100644 index 000000000..281e1fbf2 --- /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> diff --git a/torrus/doc/manpages/torrus_configinfo.pod.in b/torrus/doc/manpages/torrus_configinfo.pod.in new file mode 100644 index 000000000..7c561e304 --- /dev/null +++ b/torrus/doc/manpages/torrus_configinfo.pod.in @@ -0,0 +1,46 @@ +# 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_configinfo.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +configinfo - Displays useful statistics for all Torrus trees. + +=head1 SYNOPSIS + +B<torrus configinfo> + +=head1 DESCRIPTION + +This command displays information on all available Torrus trees, including +the names of the trees, counts of leaves, subtrees, views, monitors and +actions, and other information. + +=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> diff --git a/torrus/doc/manpages/torrus_configsnapshot.pod.in b/torrus/doc/manpages/torrus_configsnapshot.pod.in new file mode 100644 index 000000000..27231497c --- /dev/null +++ b/torrus/doc/manpages/torrus_configsnapshot.pod.in @@ -0,0 +1,144 @@ +# 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_configsnapshot.pod.in,v 1.1 2010-12-27 00:04:37 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +configsnapshot - Generates a configuration snapshot for a Torrus tree. + +=head1 SYNOPSIS + +B<torrus configsnapshot> --tree=I<TREENAME> [I<options...>] + +=head1 DESCRIPTION + +This command generates a configuration snapshot from current +datasources for tree I<TREENAME>. The output is an XML file, ready for +compilation, representing all datasources, monitors and tokensets of a +given tree. The snapshot does not include view definitions. Templates +and file patterns are expanded inside the file. It does not require +any other XML configuration files, except for F<defaults.xml> and your +custom view definitions. + +B<Warning:> C<configsnapshot> from RRFW release 0.1.5 will not work +correctly with databases from previous releases. Use RRFW release +C<0.1.4bf2> instead. C<configsnapshot> utility from RRFW release 0.1.4bf2 +does not preserve aliases. + +This utility is useful in Torrus upgrade process. In case when RRD files +structure is changing in Torrus default templates, and user(s) demand to +preserve the historical data, the following steps could be done: + +=over 4 + +=item * + +Stop the collector and monitor processes. + +=item * + +Install newest Torrus software and do not run C<compilexml> immediately. + +=item * + +Create snapshots of the trees that you want to preserve for historical reasons: + + torrus configsnapshot --tree=myrouters \ + --out=@sitexmldir@/myrouters-snapshot.xml + +=item * + +If needed, move the existing RRD files into different directory. Then +change the C<data-dir> parameters in the snapshot XML accordingly. + +=item * + +Create a new tree with only the snapshot file in it. Compile the tree. + +=item * + +At this stage, it is up to the user to decide wether to continue running the +collector and monitor daemons for this new tree. The old data may be preserved +for historical reference, and collector may be run with the newest tree +structure and definitions. + +=back + +=head1 OPTIONS + +=over 4 + +=item B<--tree>=I<TREE> + +Mandatory parameter specifying the tree name. + +=item B<--out>=I<FILE> + +Sets the output file to I<FILE>. Default is F<snapshot.xml>. + +=item B<--param>=I<PARAM> B<--value>=I<VALUE> + +Sets the filter on datasource leaves that have to be included in the snapshot. +I<PARAM> specifies the name of the datasource parameter, and I<VALUE> +sets the matching value. By default the numeric comparison is performed. + +=item B<--op>=I<OPERATOR> + +Sets the fiter comparison operator. Accepted values: B<=> (numeric), +B<eq> (text string comparison), and B<re> (regular expression match). Default +is numeric comparison. + + +=item B<--verbose> + +Displays some extra information. + +=item B<--help> + +Displays a help message. + +=back + +=head1 FILES + +=over 4 + +=item F<@distxmldir@/defaults.xml> + +XML configuration file with default settings for the datasources and +tokensets, as well as default view definitions. + +=item F<snapshot.xml> + +Default B<configsnapshot> output file. + +=back + +=head1 SEE ALSO + +L<torrus(@mansec_usercmd@)>, L<torrus_compilexml(@mansec_usercmd@)> + +=head1 NOTES + +See more documentation at Torrus home page: http://torrus.org + +=head1 AUTHOR + +Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt> diff --git a/torrus/doc/manpages/torrus_devdiscover.pod.in b/torrus/doc/manpages/torrus_devdiscover.pod.in new file mode 100644 index 000000000..452694208 --- /dev/null +++ b/torrus/doc/manpages/torrus_devdiscover.pod.in @@ -0,0 +1,114 @@ +# 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_devdiscover.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +devdiscover - Performs SNMP discovery and generates Torrus XML +configuration file. + +=head1 SYNOPSIS + +B<torrus devdiscover> [--in=I<XMLFILE>] [I<options...>] [I<XMLFILES>] + +=head1 DESCRIPTION + +B<devdiscover> performs SNMP discovery using the I<XMLFILE> +for the discovery instructions. It generates a corresponding +Torrus XML configuration file. See B<Torrus SNMP Discovery User Guide> for +details. + +The generic input file, or device discovery XML (DDX), may be generated +by the B<genddx> utility, and then edited and maintained manually. +Multiple input files may be specified by several instances of I<--in> +option, or simply as arguments. + +Input file name is searched in the current directory, and then in +F<@sitedir@/discovery/>. + +=head1 OPTIONS + +=over 4 + +=item B<--mkdir> + +Creates C<data-dir> directories. + +=item B<--limit>=I<REGEXP> + +Limits the discovery to the output files matching the regular expression +I<REGEXP>. + +=item B<--forcebundle> + +With this option enabled, C<devdiscover> will write the bundle +file even if some of the bundle members were not created because of errors. + +=item B<--fallback>=I<INTEGER> + +Requires B<--forcebundle>. In case if an SNMP device is not available, +the bundle file will include an older version of the XML output file, +provided that it exists and it is not older than the specified number of days. + +=item B<--threads>=I<INTEGER> + +If the threads are enabled in the local Perl, this option determins +how many parallel discovery threads are to be executed. +The discovery jobs are distributed per output files, thus it makes +sence to use threads only when there are many output files defined in +a single DDX file. + + +=item B<--verbose> + +Prints extra information. + +=item B<--debug> + +Prints debugging information. + +=item B<--snmpdebug> + +Prints SNMP protocol details + +=back + +=head1 FILES + +=over 4 + +=item F<@siteconfdir@/devdiscover-siteconfig.pl> + +B<devdiscover> site configuration file. + +=back + +=head1 SEE ALSO + +L<torrus(@mansec_usercmd@)>, L<torrus_genddx>(@mansec_usercmd@) + +=head1 NOTES + +See I<Torrus SNMP Discovery User Guide> for more details at Torrus home +page: http://torrus.org + +=head1 AUTHOR + +Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt> diff --git a/torrus/doc/manpages/torrus_flushmonitors.pod.in b/torrus/doc/manpages/torrus_flushmonitors.pod.in new file mode 100644 index 000000000..eec9a5f5b --- /dev/null +++ b/torrus/doc/manpages/torrus_flushmonitors.pod.in @@ -0,0 +1,68 @@ +# Copyright (C) 2010 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_flushmonitors.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +flushmonitors - Flush monitor alarms and tokenset members + +=head1 SYNOPSIS + +B<torrus flushmonitors> --tree=I<TREENAME> [I<options...>] + +=head1 DESCRIPTION + +This command flushes the state of all monitor alarms for a given tree, +and also the tokenset members which were originated by the monitor alarms. + +=head1 OPTIONS + +=over 4 + +=item B<--all> + +Instructs to flush all trees. + +=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> diff --git a/torrus/doc/manpages/torrus_genddx.pod.in b/torrus/doc/manpages/torrus_genddx.pod.in new file mode 100644 index 000000000..8fff69e49 --- /dev/null +++ b/torrus/doc/manpages/torrus_genddx.pod.in @@ -0,0 +1,136 @@ +# 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_genddx.pod.in,v 1.1 2010-12-27 00:04:38 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +genddx - Generates SNMP discovery instructions file for +B<devdiscover> + +=head1 SYNOPSIS + +B<torrus genddx> --host=I<HOSTNAME> | --hostfile=I<HOSTFILENAME> \ +[I<options...>] + +=head1 DESCRIPTION + +B<genddx> generates the SNMP discovery instructions file, which may +be later used as input for the B<devdiscover> utility to produce the +corresponding Torrus XML configuration file. The hostname(s) of router(s) to +be included in SNMP discovery must be specified either using the +B<--host> (for a single router) or B<--hostfile> option. In the latter +case the file I<HOSTFILENAME> must contain a space-separated list of router +hostnames. Hostnames may have the form C<host:devname> where C<devname> is +a symbolic device name. + +This utility is designed to be used only once, in order to generate +the discovery XML canvas, for futher manual editing. It generates only +basic set of parameters, and there are much more of those that you may +use to customize the discovery process. + +See L<torrus_ttproclist(@mansec_usercmd@)> for a more flexible and +complex DDX generator. + +More information is available in B<Torrus SNMP Discovery User Guide>. + +=head1 OPTIONS + +=over 4 + +=item B<--out>=I<OUTFILENAME> + +Sets the output file to I<OUTFILENAME>. Default is F<routers.ddx>. Without +absolute path, the file will be placed in F<@sitedir@/discovery>. + +=item B<--discout>=I<FILENAME> + +Sets the discovery output file to I<FILENAME>. This will be the filename of +the Torrus XML configuration file once the output file of the B<genddx> +is processed by the B<devdiscover> utility. Default value is +F<routers.xml>. Without absolute path, the file would be resided in +F<@sitexmldir@>. + +=item B<--domain>=I<DOMAIN> + +Sets the DNS domain name to I<DOMAIN>. + +=item B<--version>=I<SNMPVERSION> + +Sets discovery SNMP version to SNMPVERSION. Default value is C<2c>. + +=item B<--community>=I<COMMUNITY> + +Sets discovery SNMP read community value to string I<COMMUNITY>. Default +is C<public>. + +=item B<--port>=I<PORT> + +Sets SNMP port to I<PORT>. Default is 161. + +=item B<--retries>=I<NUMRETRIES> + +Sets number of retries to I<NUMRETRIES>. Default value is 2. + +=item B<--timeout>=I<TIMEOUT> + +Sets SNMP timeout to I<TIMEOUT> seconds. Default value is 10. + +=item B<--subtree>=I<SUBTREE> + +Sets the subtree name to I<SUBTREE>. Default is C</Routers>. + +=item B<--datadir>=I<DATADIR> + +Sets the path of the directory where SNMP data is collected to I<DATADIR>. +Default value is F<@defrrddir@>. + +=item B<--holtwinters> + +Enables Holt-Winters analysis. + +=back + +=head1 FILES + +=over 4 + +=item F<@sitedir@/discovery/routers.ddx> + +Default output file of genddx. + +=item F<@sitexmldir@/routers.xml> + +Default Torrus XML configuration file which will be written once the +genddx output file is processed with devdiscover utility. + +=back + +=head1 SEE ALSO + +L<torrus(@mansec_usercmd@)>, L<torrus_devdiscover(@mansec_usercmd@)>, +L<torrus_ttproclist(@mansec_usercmd@)> + +=head1 NOTES + +See more documentation at Torrus home page: http://torrus.org + +=head1 AUTHOR + +Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt> diff --git a/torrus/doc/manpages/torrus_genlist.pod.in b/torrus/doc/manpages/torrus_genlist.pod.in new file mode 100644 index 000000000..a3e112c56 --- /dev/null +++ b/torrus/doc/manpages/torrus_genlist.pod.in @@ -0,0 +1,71 @@ +# 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_genlist.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +genlist - Lists Torrus objects + +=head1 SYNOPSIS + +B<torrus genlist> --tree=I<TREENAME> [I<options...>] + +=head1 DESCRIPTION + +This command generates a listing of objects in Torrus +configuration tree I<TREENAME>. Currently it lists the RRD files only. + +=head1 OPTIONS + +=over 4 + +=item B<--path>=I<PATH> + +Sets the subtree path to I<PATH>. Default values is "/". + +=item B<--what>=I<ITEMS> + +Includes items I<ITEMS> in the listing. Currently only "rrdfiles" is +a supported item. + +=item B<--type>=I<TYPE> + +Sets selection type. Currently supported values are "collector" (Collector +leaves), "readonly" (read-only leaves) and "all" (this also happens to be +default value). + +=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> + diff --git a/torrus/doc/manpages/torrus_genreport.pod.in b/torrus/doc/manpages/torrus_genreport.pod.in new file mode 100644 index 000000000..8b7767166 --- /dev/null +++ b/torrus/doc/manpages/torrus_genreport.pod.in @@ -0,0 +1,93 @@ +# Copyright (C) 2007 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_genreport.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +genreport - Generate the Usage Report + +=head1 SYNOPSIS + +B<torrus genreport> --report=I<ReportName> --date=I<YYYY-MM-DD> [I<options...>] +B<torrus genreport> --genhtml [I<options...>] + + +=head1 DESCRIPTION + +When the Torrus Reporting engine is set up, this command is used +to generate the reports from the collected data. +See I<Torrus Reporting Setup Guide> for more information. + +=head1 OPTIONS + +=over 4 + +=item B<--report>=I<ReportName> + +The name of the report that is to be generated. Currently supported: +C<MonthlyUsage>. + +=item B<--date>=I<YYYY-MM-DD> + +Specifies the start date of the reported period. For the monthly report, +this should be any day within the calendar month. + +=item B<--time>=I<hh:mm> + +Specifies the start time of the reported period. This option +is ignored for the monthly reports. + +=item B<--genhtml> + +Instructs the report engine to build the HTML output from the generated +reports. + +=item B<--tree=TREE> + +When used with C<--genhtml>, generates the HTML reports only for +the specified tree. + +=item B<--all2tree=TREE> + +When used with C<--genhtml>, generates the HTML reports only for +all available service IDs in the specified tree. + +=item B<--verbose> + +Prints extra informatgion. + +=item B<--debug> + +Prints debugging information. + +=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> + diff --git a/torrus/doc/manpages/torrus_install_plugin.pod.in b/torrus/doc/manpages/torrus_install_plugin.pod.in new file mode 100644 index 000000000..3aeb0835e --- /dev/null +++ b/torrus/doc/manpages/torrus_install_plugin.pod.in @@ -0,0 +1,51 @@ +# Copyright (C) 2007 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_install_plugin.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +install_plugin - Installs the Torrus plugin + +=head1 SYNOPSIS + +B<torrus install_plugin> I<DIRECTORY> + +=head1 DESCRIPTION + +This command installs a Torrus plugin. Prior to executing this command, +unpack the plugin package into some directory, and then point +C<install_plugin> to the path of the unpacked plugin distribution. + +The command would launch the C<./configure> script for the plugin +and supply all options that specify the current Torrus installation paths. +Then it would execute C<make> and C<make install>. + +=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> + diff --git a/torrus/doc/manpages/torrus_monitor.pod.in b/torrus/doc/manpages/torrus_monitor.pod.in new file mode 100644 index 000000000..dabfc01b8 --- /dev/null +++ b/torrus/doc/manpages/torrus_monitor.pod.in @@ -0,0 +1,96 @@ +# 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_monitor.pod.in,v 1.1 2010-12-27 00:04:38 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +monitor - Torrus Monitor. + +=head1 SYNOPSIS + +B<torrus monitor> --tree=I<TREENAME> [I<options...>] + +=head1 DESCRIPTION + +This command starts the Monitor process for the tree I<TREENAME>. By +default it forks into a daemon, sets the log output file to +F<@logdir@/monitor.TREENAME.log>, performs one monitoring cycle, and +sleeps until the next cycle is scheduled. In daemon mode the log file +can be reopened by sending it a SIGHUP signal. + +=head1 OPTIONS + +=over 4 + +=item B<--nodaemon> + +Prevents the process from becoming a daemon and sets the log to STDERR. + +=item B<--runonce> + +Instructs the script to run once and exit. Implies B<--nodaemon>. + +=item B<--delay=N> + +Makes the daemon sleep for N minutes before starting the first cycle. +This would happen on the daemon startup and also after each configuration +recompilation. +For example, when monitor and collector start simultaneously, the collector +needs some time to retrieve the data being monitored. + +=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 FILES + +=over 4 + +=item F<@siteconfdir@/torrus-siteconfig.pl> + +Torrus site configuration script. + +=item F<@logdir@/monitor.TREENAME.log> + +Monitor's log for the tree I<TREENAME>. + +=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> diff --git a/torrus/doc/manpages/torrus_nodeid.pod.in b/torrus/doc/manpages/torrus_nodeid.pod.in new file mode 100644 index 000000000..f80664e11 --- /dev/null +++ b/torrus/doc/manpages/torrus_nodeid.pod.in @@ -0,0 +1,124 @@ +# Copyright (C) 2010 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_nodeid.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +nodeid - Torrus utility + +=head1 SYNOPSIS + +B<torrus nodeid> --tree=I<TREENAME> --cmd=CMD I<options...> + +=head1 DESCRIPTION + +This command provides a way to integrate Torrus with external OSS systems. +It operates with I<nodeid>, a unique identifier for Torrus datasource +subtrees and leaves. + +The command prints the data on the standard output in JSON data format. + +=head1 OPTIONS + +=over 4 + +=item B<--tree=TREE> + +[Mandatory] Defines the datasouerce tree. + + +=item B<--cmd=CMD> + +[Mandatory] Defines the action command. The following commands are supported: + +=over 8 + +=item * info + +Prints information about the nodeid. Requires B<--nodeid>. + +=item * search + +Performs a prefix or substring search on node IDs and prints the results. +Requires B<--prefix> or B<--substring>. + +=item * render + +Renders a specified datasource node and prints the resulting MIME type and the +file name. Requires B<--nodeid> and B<--view>. Optional B<--out> defines +a file name to copy the output to. + +=back + + +=item B<--nodeid=NODEID> + +Specifies the Node ID string for the commands I<info> and I<render>. + + +=item B<--details> + +Toggles verbose output for the commands I<info> and I<search>. + + +=item B<--prefix=STR> + +Specifies the prefix search string for the command I<search>. + + +=item B<--substring=STR> + +Specifies the search substring for the command I<search>. + + +=item B<--view=VIEW> + +Specifies the view name for the command I<render>. The following views are +defined by standard Torrus XML files and render a PNG graph: +C<short>, C<last24h-small>, C<last24h>, C<lastweek>, +C<lastmonth>, C<lastyear>. The following views are printing the datasource +value in a text format: C<rrd-print-daily>, C<rrd-print-last>. + + +=item B<--out=FILE> + +If defined, instructs the utility to copy the rendered data into a +specified file. Otherwise the file is created in the standard renderer's cache +directory. + + +=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> diff --git a/torrus/doc/manpages/torrus_rrddir2xml.pod.in b/torrus/doc/manpages/torrus_rrddir2xml.pod.in new file mode 100644 index 000000000..bd78e48ae --- /dev/null +++ b/torrus/doc/manpages/torrus_rrddir2xml.pod.in @@ -0,0 +1,112 @@ +# 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_rrddir2xml.pod.in,v 1.1 2010-12-27 00:04:38 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +rrddir2xml - Searches a directory for RRD files and generates Torrus XML +configuration file. + +=head1 SYNOPSIS + +B<torrus rrddir2xml> --dir=I<DIR> [I<options...>] + +=head1 DESCRIPTION + +B<rrddir2xml> searches in a given directory for RRD files and +creates Torrus XML configuration file suitable for browsing ofthose data +files. + +With default options, it is usable for RRD files generated by Torrus' +SNMP collector, where the file name starts with the host name, separated by +underscore from interface name or other MIB specifics. With these +defaults, it creates a subtree per each host name, and all RRD files belonging +top that host name are sorted alphabetically in that subtree. + +=head1 OPTIONS + +=over 4 + +=item B<--dir>=I<DIR> + +Absolute path to the directory for searching. The directory may contain also +non-RRD files. Only regular files are processed, and the symlinks are ignored. + +=item B<--recursive> + +If specified, the directory will be searched recursively. All file names +across all subdirectories must be unique. Symlinks to other directories +are ignored. + +=item B<--filter>=I<Regexp> + +If the filter is specified, then B<rrddir2xml> lists only those files and +subdirectories whose names match the given regular expression. + +=item B<--out>=I<FILE> + +Output XML file name. If relative path given, the file is placed in +F<@sitexmldir@>. Default: F<rrddir.xml>. + +=item B<--subtree>=I<SUBTREE> + +Top subtree path in the generted XML. Default is the top of the tree (C</>). + +=item B<--split>=I<REGEXP> + +Regular expression used for splitting the file name into parts +to build the subtree hierarchy. Default is a sequence of underscores (C<_+>). + +=item B<--levels>=I<INTEGER> + +Number of levels of hierarchy to build by splitting the file names. +Default is 2 levels. + +=item B<--comment>=I<TEXT> + +Text to put as C<comment> parameter to the top subtree. + +=item B<--holtwinters> + +If specified, Holt-Winters prediciton boundaries and failures are displayed +in the graphs. + +=item B<--verbose> + +Prints extra diagnosics. + +=item B<--debug> + +Prints debugging information. + +=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> diff --git a/torrus/doc/manpages/torrus_schedulerinfo.pod.in b/torrus/doc/manpages/torrus_schedulerinfo.pod.in new file mode 100644 index 000000000..e8567a10b --- /dev/null +++ b/torrus/doc/manpages/torrus_schedulerinfo.pod.in @@ -0,0 +1,154 @@ +# 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_schedulerinfo.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +schedulerinfo - Displays extended scheduler tasks information. + +=head1 SYNOPSIS + +B<torrus schedulerinfo> --tree=I<TREENAME> [I<options...>] + +=head1 DESCRIPTION + +This utility displays the extended scheduler tasks information for tree +I<TREENAME> on standard output. This might be useful for scheduler planning +and analysis. + +=head1 OPTIONS + +=over 4 + +=item B<--config> + +Reports scheduler's configuration. The values are explained below. + +=over 8 + +=item Total collector/monitor leaves: I<N> + +Total number of datasources being processed by collector or monitor daemon. + +=item Scheduled leaves by type + +Torrus supports arbitrary number of collector types, and this report +shows how many datasources belong to every type. Currently the monitor leaves +are not divided into types. + +=item Least common period: I<N> seconds + +The report below shows how the tasks are distributed across the time line, +and the least common period shows the period of this time line. + +=item Tasks execution timeline + +This report tells which task and how many datasources are involved in +each task startup event, and how these events are dispersed across the time. +The column I<Interval> shows the time interval from each task execution +event to the next event on the timeline. + +=back + +=item B<--runtime> + +Reports scheduler's runtime statistics, such as running cycle times, +late starts etc. The meaning of the output values is as follows. Values +that have zero values are usually not printed. + +=over 8 + +=item Task: I<Name>, Period: I<N> seconds, Offset: I<M> seconds + +Each scheduler task is characterized by its name (usually Collector or +Monitor), period, and timeoffset. Fore example, if period is set to 300 +seconds, and offset is 14 seconds, then the task would be executed at +00:00:14, 00:05:14, 00:10:14, and so on for every hour in a day. + +=item I<N> running cycles passed + +How many times the task was executed since last reset. The counter +is normally reset after L<torrus_compilexml(@mansec_usercmd@)> successfully +compiles the configuration. + +=item I<N> late starts + +How many times the task has started with a delay from its normal schedule. + +=item I<N> too long runs + +How many times the task execution time was longer than its period. + +=item I<N> overrun periods + +How many periods have been missed because of too long executions. + +=item I<N> missed periods + +How many periods were missed because of any reason (such as other tasks +delaying). + +=item Min, Max, Average, Exp Average + +The time values are displayed in four columns: Mimimum, Maximum and Average +values since last reset, and Exponential decay value, which may be interpreted +as the average for last several values. With defaults defined in +F<torrus-config.pl>, 95% of the average is calculated from last 3 values. + +=item Running Time + +How long the task executes each period. + +=item Late Start + +How long the task start was delayed. + +=item Too Long + +How much time the too long run took. + +=item RRD Queue + +In a multithreaded environment, the RRD files are writen in a background +thread. This value shows the length of the RRD update queue at the beginning +of each update cycle. + +=back + +=item B<--help> + +Displays a help message. + +=back + + + +=head1 SEE ALSO + +L<torrus(@mansec_usercmd@)>, +L<torrus_compilexml(@mansec_usercmd@)> + +=head1 NOTES + +See more documentation at Torrus home page: http://torrus.org + +=head1 AUTHOR + +Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt> diff --git a/torrus/doc/manpages/torrus_snmpfailures.pod.in b/torrus/doc/manpages/torrus_snmpfailures.pod.in new file mode 100644 index 000000000..e458b62dc --- /dev/null +++ b/torrus/doc/manpages/torrus_snmpfailures.pod.in @@ -0,0 +1,155 @@ +# Copyright (C) 2010 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_snmpfailures.pod.in,v 1.1 2010-12-27 00:04:37 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +snmpfailures - Displays SNMP collector failures. + +=head1 SYNOPSIS + +B<torrus snmpfailures> --tree=I<TREENAME> [I<options...>] + +=head1 OPTIONS + +=over 4 + +=item B<--details> + +In addition to failure counters, list the failed SNMP hosts and the time +stamps of failure events. + + +=item B<--help> + +Displays a help message. + +=back + +=head1 DESCRIPTION + +This utility prints the SNMP collector failure information in JSON format. +Without B<--details> option, it prints only the failure counters. + +Upon collector startup or after the tree re-compilation, the failure +counters are reset to zero. + +The output is very convenient for further automatic processing in any +scripting language. + +The top level of the output is a JSON object with the following name/value +pairs: + +=over 4 + +=item B<total_unreachable>: NUMBER + +Displays the number SNMP hosts that are currently unreachable. +The number adds up across multiple collector instances for a given tree. +If a host becomes reachable again, the number is decreased. + +=item B<total_deleted>: NUMBER + +Displays the number SNMP hosts that are completely removed from SNMP +collection for the life cycle of the collector process. This happens when +a host is unreachable for too long time and the collector gives up +to reach it again. +The number adds up across multiple collector instances for a given tree. + +=item B<total_mib_errors>: NUMBER + +Displays the number of MIB errors (I<noSuchObject>, I<noSuchInstance>, +and I<endOfMibView>) during the collector life cycle. +The number adds up across multiple collector instances for a given tree. + +=item B<detail_unreachable>: OBJECT, B<detail_deleted>: OBJECT + +If the option B<--details> is specified, these objects contain the host names +and timestamps of the failures. +The keys are contactenations of SNMP host, UDP port, and SNMP +community separated by "|". +The values are objects representing the UNIX timestamp and a human-readable +time string. + +=item B<detail_mib_errors>: OBJECT + +If the option B<--details> is specified, this object displays the MIB error +details: for each SNMP host, it lists the datasource leaves which had these +errors and the event timestamps. + +=back + +=head1 EXAMPLES + +The following example illustrates an SNMP host unreachable: + + torrus failures --tree=main --details + { + "detail_deleted" : {}, + "detail_mib_errors" : {}, + "detail_unreachable" : { + "217.101.101.101|161|public" : { + "time" : "Fri Jul 23 14:15:10 2010", + "timestamp" : 1279887310 + } + }, + "total_deleted" : 0, + "total_mib_errors" : 0, + "total_unreachable" : 1 + } + + +The following example illustrates a MIB error: + + torrus failures --tree=main --details + { + "detail_deleted" : {}, + "detail_mib_errors" : { + "217.101.102.102|161|public" : { + "count" : 1, + "nodes" : { + "/Routers/CMTS3/Temperature_Sensors/sensor_01" : { + "time" : "Fri Jul 23 15:26:14 2010", + "timestamp" : 1279891574 + } + } + } + }, + "detail_unreachable" : {}, + "total_deleted" : 0, + "total_mib_errors" : 1, + "total_unreachable" : 0 + } + + + + + +=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> diff --git a/torrus/doc/manpages/torrus_srvderive.pod.in b/torrus/doc/manpages/torrus_srvderive.pod.in new file mode 100644 index 000000000..a8c68c254 --- /dev/null +++ b/torrus/doc/manpages/torrus_srvderive.pod.in @@ -0,0 +1,136 @@ +# Copyright (C) 2007 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_srvderive.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +srvderive - Derive a new service ID from sum or maximum of other service values + +=head1 SYNOPSIS + +B<torrus srvderive> I<TIMESPAN> I<OUTPUT> I<FUNCTION> I<SOURCES>... + +=head1 DESCRIPTION + +When the Torrus Reporting engine is set up, this command is used +to combine several services data into a new service ID. The output data +is either the maximum or the sum of input services. + +See I<Torrus Reporting Setup Guide> for more information. + +=head1 TIMESPAN + +Either --month or --end option must be defined + +=over 4 + +=item B<--start>=I<YYYY-MM-DD> + +Sets the start date of the calculation. + +=item B<--end>=I<YYYY-MM-DD> + +Sets the next day after the eond of the period. + +=item B<--month> + +Instead of setting the end data, it is convenient to use this option. It sets +the end data in one calendar month after the start date. + +=back + + +=head1 OUTPUT + +=over 4 + +=item B<--out>=I<SERVICEID> + +Sets the output service ID. This should not be a service ID used in the +Torrus datasource trees. B<Note:> if I<srvderive> command is run twice +with the same arguments, the produced data is doubled for the output +service ID. + +=back + + + +=head1 FUNCTION + +=over 4 + +=item B<--func>=C<MAX>|C<SUM> + +Sets the function to be used when combining the input service data. +Currently only C<MAX> and C<SUM> are supportted. + +=back + + +=head1 SOURCES + +=over 4 + +=item B<--in>=I<SERVICEID> ... + +Input service IDs are specified either by B<--in> option, or as command line +arguments. At least 2 input service IDs should be specified. + +=back + + + +=head1 OPTIONS + +=over 4 + +=item B<--step> + +Default: 300. Sets the data interval for derived service ID. It is recommended +to leave this option at default value. + +=item B<--verbose> + +Prints extra informatgion. + +=item B<--debug> + +Prints debugging information. + +=item B<--help> + +Prints command usage information. + +=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> + diff --git a/torrus/doc/manpages/torrus_ttproclist.pod.in b/torrus/doc/manpages/torrus_ttproclist.pod.in new file mode 100644 index 000000000..db2100a83 --- /dev/null +++ b/torrus/doc/manpages/torrus_ttproclist.pod.in @@ -0,0 +1,144 @@ +# 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_ttproclist.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $ +# Stanislav Sinyagin <ssinyagin@yahoo.com> +# +# + +=head1 NAME + +ttproclist - Process a template with a nodelist + +=head1 SYNOPSIS + +B<torrus ttproclist> --tmpl=I<TFILE> --out=I<OFILE> +--nodes=I<NFILE> [I<options...>] + +=head1 DESCRIPTION + +This command takes a Template-Toolkit template and a list of nodes +(usually SNMP devices) as input. The output file is a result of +template substitution, according to the specified options. +Command-line options B<--tmpl>, B<--out> and B<--nodes> are mandatory. + +This utility can be used to generate the discovery instructions XML out of +a predefined template and a dynamically generated list of devices. +Alternatively, it can produce Torrus XML configuration for a given list +of objects, etc. + +The following variables are predefined when the template is processed: + +=over 4 + +=item * C<nodes> + +Hash array of nodes. Hash keys are the node names. Values are symbolic +names. If symbolic names are not defined, values are the same as keys. + +=item * C<param> + +Hash array of command-line parameters given in B<--param> option. + +=item * C<nodesfile>, C<creator> + +Informative variables. They can be used to produce the creation +note in the resulting files. C<nodesfile> returns the file name of nodes, +and C<creator> returns a detailed information how the file was generated, +with timestamp and command line options. + +=back + +=head1 OPTIONS + +=over 4 + +=item B<--tmpl>=I<TFILE> + +The file name of the input template. Relative names are looked in +the current directory and in F<@tmpluserdir@>. The file name may also be +an absolute path. + +=item B<--out>=I<OFILE> + +Output file name. If no absolute path given, the file is written in the current +directory. + +=item B<--nodes>=I<NFILE> + +The name of the nodes list. Nodes should be separated by space or tab +character or newline. Additional information, referred to as symbolic name, +can be supplied after a colon, of the form NODENAME:SYMBOLICNAME. + +=item B<--param>=I<NAME:VALUE,NAME:VALUE...> + +List of optional parameters that may be used in the template. + +=back + +=head1 EXAMPLES + +The following example gerenates C<devdiscover> input file from a template. +The template is as follows: + + <?xml version="1.0" encoding="UTF8"?> + <snmp-discovery> + >>> usual DDX parameters here, like SNMP community and data-dir + <param name="snmp-community" value="private"/> + <param... + >>> This loop generates per-host entries + [% FOREACH n = nodes.keys.sort %] + <host> + <param name="snmp-host" value="[% n %]"/> + <param name="symbolic-name" value="[% nodes.$n %]"/> + <param name="output-file" value="nodes/[% n %].xml"/> + </host> + [% END %] + >>> Generate the bundle file, so that you need only one + >>> entry in torrus-site-config.pl + <param name="output-bundle" value="[% param.BUNDLE %].xml"/> + </snmp-discovery> + +The following command would generate F<MY.ddx> from template file F<MY.ddtmpl> +as described above. The file F<MY.nodes> is a list of SNMP devices, one per +line. Then C<devdiscover> is launched with F<MY.ddx> as input. Note also the +short form of the command line wrapper. + + torrus ttproclist --tmpl=MY.ddtmpl \ + --nodes=MY.nodes \ + --out=/usr/local/etc/torrus/discovery/MY.ddx \ + --param=BUNDLE:MYNODES + + torrus dd --in=MY.ddx --verbose + +In addition, you may put some common parameters in Template BLOCK +statement in a separate file, and INCLUDE it in your templates. See the +Template-Toolkit documentation for more detail. + + +=head1 NOTES + +See more documentation at Torrus home page: http://torrus.org + +=head1 SEE ALSO + +Template-Toolkit documentation: http://template-toolkit.org/ + +L<torrus(@mansec_usercmd@)>, L<torrus_devdiscover(@mansec_usercmd@)> + +=head1 AUTHOR + +Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt> |