diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 1 | ||||
| -rw-r--r-- | doc/global.html | 41 | ||||
| -rw-r--r-- | doc/rainerscript.html | 3 |
3 files changed, 45 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index f7a9efe0..9a7ed162 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -83,6 +83,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..8b47f6f4 --- /dev/null +++ b/doc/global.html @@ -0,0 +1,41 @@ +<!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></b>action.reportSuspension</b> - binary, default "on", v7.5.8+c<br> +If enabled ("on") action will log message under syslog.* when an action +suspends or resume itself. This usually happens when there are problems +connecting to backend systems. If disabled ("off"), these messages are +not generated. These messages can be useful in detecting problems with +backend systems. Most importantly, frequent suspension and resumption +points to a problem area. +<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 0a780ac4..217ef28a 100644 --- a/doc/rainerscript.html +++ b/doc/rainerscript.html @@ -67,6 +67,9 @@ $MainMsgQ... statements are ignored. <p>Example:</p> <textarea rows="2" cols="60">main_queue(queue.size="100000" queue.type="LinkedList") </textarea> +<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>Expressions</h2> The language supports arbitrary complex expressions. All usual operators are supported. The precedence of operations is as follows |