diff options
| author | Rainer Gerhards <rgerhards@adiscon.com> | 2013-11-29 15:52:44 +0100 |
|---|---|---|
| committer | Rainer Gerhards <rgerhards@adiscon.com> | 2013-11-29 15:52:44 +0100 |
| commit | c66ac7d6f1dc53dbae8e99e1a3954d65d418fc2a (patch) | |
| tree | 3f2a04be80f23557b42d40f848902c5f54852652 | |
| parent | 54f41ae512ddd5c5555bcbfa49da56a72d94ad9f (diff) | |
| download | rsyslog-c66ac7d6f1dc53dbae8e99e1a3954d65d418fc2a.tar.gz rsyslog-c66ac7d6f1dc53dbae8e99e1a3954d65d418fc2a.tar.bz2 rsyslog-c66ac7d6f1dc53dbae8e99e1a3954d65d418fc2a.zip | |
doc: create skeleton for global() config object
| -rw-r--r-- | doc/Makefile.am | 1 | ||||
| -rw-r--r-- | doc/global.html | 34 | ||||
| -rw-r--r-- | doc/rainerscript.html | 4 |
3 files changed, 39 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index e1757644..5bf89060 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -74,6 +74,7 @@ html_files = \ tls_cert_client.html \ tls_cert_scenario.html \ rainerscript.html \ + global.html \ lookup_tables.html \ rscript_abnf.html \ rsconf1_actionexeconlywhenpreviousissuspended.html \ diff --git a/doc/global.html b/doc/global.html new file mode 100644 index 00000000..a58f5c69 --- /dev/null +++ b/doc/global.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head> +<title>global() configuration object</title> +</head> + +<body> +<h1>global() configuration object</h1> + +<p>The global configuration object permits to set global parameters. +Note that each parameter can only be set once and cannot be re-set +thereafter. If a parameter is set multiple times, the behaviour is +unpredictable. + +<p>The following paramters can be set: +<ul> +<li>workDirectory +<li>dropMsgsWithMaliciousDNSPtrRecords +<li>localHostname +<li>preserveFQDN +<li>defaultNetstreamDriverCAFile +<li>defaultNetstreamDriverKeyFile +<li>defaultNetstreamDriver +<li>maxMessageSize +</ul> + +<p>[<a href="rsyslog_conf.html">rsyslog.conf overview</a>] +[<a href="rainerscript.html">RainerScript reference</a>] [<a href="http://www.rsyslog.com/">rsyslog site</a>]</p> +<p><font size="2">This documentation is part of the +<a href="http://www.rsyslog.com/">rsyslog</a> project.<br> +Copyright © 2013 by <a href="http://www.gerhards.net/rainer">Rainer Gerhards</a> and +<a href="http://www.adiscon.com/">Adiscon</a>. +Released under ASL 2.0 or higher.</font></p> +</body> +</html> diff --git a/doc/rainerscript.html b/doc/rainerscript.html index 7cbbfa9f..1880cd29 100644 --- a/doc/rainerscript.html +++ b/doc/rainerscript.html @@ -51,6 +51,10 @@ of a and b should be tested as "a <> b". The "not" operator should be reserved to cases where it actually is needed to form a complex boolean expression. In those cases, parenthesis are highly recommended. +<h2>configuration objects</h2> +<h3>global()</h3> +<p>This is used to set global configuration parameters. For details, please +see the <a href="rsyslog_global">rsyslog global configuration object</a>. <h2>Lookup Tables</h2> <p><a href="lookup_tables.html">Lookup tables</a> are a powerful construct to obtain "class" information based on message content (e.g. to build |