[emt] r228 committed - My best attempt at documenting the available global configuration opti...

[e...@googlecode.com]

Revision: 228
Author: eric....@gmail.com
Date: Mon Feb 6 13:26:52 2012
Log: My best attempt at documenting the available global configuration
options
http://code.google.com/p/emt/source/detail?r=228

Modified:
/trunk/doc/emt-configuration.texi

=======================================
--- /trunk/doc/emt-configuration.texi Thu Mar 5 13:09:28 2009
+++ /trunk/doc/emt-configuration.texi Mon Feb 6 13:26:52 2012
@@ -5,11 +5,12 @@

@menu
* Global Configuration::
+* Global Options::
* Plugin Configuration::
* Configuration of named command instances::
@end menu

-@node Global Configuration, Plugin Configuration, Configuration,
Configuration
+@node Global Configuration, Global Options, Plugin Configuration,
Configuration, Configuration
@section Global Configuration

The global configuration file contains a small set of options that are
usually required for a normal EMT installation. It's divided into sections
that are denoted by square brackets. The @code{[global]} section contains
configuration directives that aren't program or plugin-specific. Here is
the example file @file{emt.cnf}:
@@ -35,6 +36,33 @@

The @code{[emt_gather]} section is special in that it defines fields to be
gathered and the output handler(s) to send those fields to. By default,
all fields are sent to the @code{local_text} output handler, which writes
them to a file. The @code{[local_text]} section defines parameters for the
@code{local_text} output handler. If there isn't an
@code{output_handler=local_text} line in the @code{[emt_gather]} section,
the @code{[local_text]} section is ignored.

+@node Global Options, Plugin Configuration, Global Configuration,
Configuration
+@section Global Options
+
+These are the options that can be set in the global section of a config
file.
+@example
+[global]
+extra_config_dir=[dir]
+@end example
+The @code{extra_config_dir} directory will be scanned for config files.
These files are parsed after the main config file.
+@example
+[global]
+gather_time=[seconds]
+@end example
+This is the time in seconds for plugins to collect data. It defaults to 60
seconds. It is up to the plugins to regulate the amount of time they gather
data for. Command classes have this value passed to them in
@code{$this->gather_time}.
+@example
+[global]
+logger=[logger]
+@end example
+Logger defaults to syslog. It can be overriden to an alternate logger. The
available loggers are in the @code{plugins/log/} directory. To specify a
logger use the filename in @code{plugins/log/} without the .php extension.
For the text logger a @code{[logger_text]} section needs to be specified to
tell the text logger where to log. For example to log to /tmp/log.txt
create a config section like.
+@example
+[global]
+logger = text
+[logger_text]
+file = /tmp/log.txt
+@end example
+
+
@node Plugin Configuration, Configuration of named command instances,
Global Configuration, Configuration
@section Plugin Configuration