From c66ac7d6f1dc53dbae8e99e1a3954d65d418fc2a Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Fri, 29 Nov 2013 15:52:44 +0100 Subject: doc: create skeleton for global() config object --- doc/Makefile.am | 1 + doc/global.html | 34 ++++++++++++++++++++++++++++++++++ doc/rainerscript.html | 4 ++++ 3 files changed, 39 insertions(+) create mode 100644 doc/global.html 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 @@ + + +global() configuration object + + + +

global() configuration object

+ +

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. + +

The following paramters can be set: +

workDirectory +
dropMsgsWithMaliciousDNSPtrRecords +
localHostname +
preserveFQDN +
defaultNetstreamDriverCAFile +
defaultNetstreamDriverKeyFile +
defaultNetstreamDriver +
maxMessageSize +

+ +

[rsyslog.conf overview] +[RainerScript reference] [rsyslog site]

This documentation is part of the +rsyslog project.
+Copyright © 2013 by Rainer Gerhards and +Adiscon. +Released under ASL 2.0 or higher.

+ + 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. +

configuration objects

global()

This is used to set global configuration parameters. For details, please +see the rsyslog global configuration object.

Lookup Tables

Lookup tables are a powerful construct to obtain "class" information based on message content (e.g. to build -- cgit v1.2.3