From f9629777face0c4893ae6c3577610535b4476ace Mon Sep 17 00:00:00 2001 From: Tom Bergfeld Date: Thu, 17 Mar 2011 11:56:22 +0100 Subject: somewhat improved documentation index Signed-off-by: Rainer Gerhards --- doc/rsyslog_conf.html | 69 ++++++--------------------- doc/rsyslog_conf_basic_structure.html | 35 ++++++++++++++ doc/rsyslog_conf_file_syntax_differences.html | 32 +++++++++++++ doc/rsyslog_conf_lines.html | 23 +++++++++ 4 files changed, 105 insertions(+), 54 deletions(-) create mode 100644 doc/rsyslog_conf_basic_structure.html create mode 100644 doc/rsyslog_conf_file_syntax_differences.html create mode 100644 doc/rsyslog_conf_lines.html diff --git a/doc/rsyslog_conf.html b/doc/rsyslog_conf.html index 6990c6bd..6ee6529b 100644 --- a/doc/rsyslog_conf.html +++ b/doc/rsyslog_conf.html @@ -9,65 +9,26 @@ typically found in /etc. By default, rsyslogd reads the file /etc/rsyslog.conf. This may be changed by a command line option.

Configuration file examples can be found in the rsyslog wiki.

There is also one sample file provided together with the -documentation set. If you do not like to read, be sure to have at least -a quick look at -rsyslog-example.conf. -

While rsyslogd contains enhancements over standard syslogd, efforts have been made to keep the configuration file as compatible as possible. While, for obvious reasons, enhanced features require a different config file syntax, rsyslogd should be able to work with a standard syslog.conf file. This is especially useful while you are migrating from syslogd to rsyslogd.

Modules

Lines

-Lines can be continued by specifying a backslash ("\") as the last -character of the line. There is a hard-coded maximum line length of 4K. -If you need lines larger than that, you need to change compile-time -settings inside rsyslog and recompile. -

Configuration Directives

Basic Structure

Rsyslog supports standard sysklogd's configuration file format -and extends it. So in general, you can take a "normal" syslog.conf and -use it together with rsyslogd. It will understand everything. However, -to use most of rsyslogd's unique features, you need to add extended -configuration directives.

Rsyslogd supports the classical, selector-based rule lines. -They are still at the heart of it and all actions are initiated via -rule lines. A rule lines is any line not starting with a $ or the -comment sign (#). Lines starting with $ carry rsyslog-specific -directives.

Every rule line consists of two fields, a selector field and -an action field. These two fields are separated by one or more spaces -or tabs. The selector field specifies a pattern of facilities and -priorities belonging to the specified action.
-
-Lines starting with a hash mark ("#'') and empty lines are ignored. -

Templates

Output Channels

Filter Conditions

Actions

Examples

Here you will find examples for templates and selector lines. I hope -they are self-explanatory. If not, please see -www.monitorware.com/rsyslog/ for advise.

Configuration File Syntax Differences

Rsyslogd uses a slightly different syntax for its -configuration file than the original BSD sources. Originally all -messages of a specific priority and above were forwarded to the log -file. The modifiers "='', "!'' and "!-'' were added to make rsyslogd -more flexible and to use it in a more intuitive manner.
-
-The original BSD syslogd doesn't understand spaces as separators -between the selector and the action field.
-
-When compared to syslogd from sysklogd package, rsyslogd offers -additional -features (like template -and database support). For obvious reasons, the syntax for defining -such features is available in rsyslogd, only.

+ +

Follow the links below to learn more about specific topics:

-> + diff --git a/doc/rsyslog_conf_basic_structure.html b/doc/rsyslog_conf_basic_structure.html new file mode 100644 index 00000000..4ce78de0 --- /dev/null +++ b/doc/rsyslog_conf_basic_structure.html @@ -0,0 +1,35 @@ + +Basic Structure - rsyslog.conf + +

This is a part of the rsyslog.conf documentation.

+Back to rsyslog.conf manual +

Basic Structure

Rsyslog supports standard sysklogd's configuration file format +and extends it. So in general, you can take a "normal" syslog.conf and +use it together with rsyslogd. It will understand everything. However, +to use most of rsyslogd's unique features, you need to add extended +configuration directives.

Rsyslogd supports the classical, selector-based rule lines. +They are still at the heart of it and all actions are initiated via +rule lines. A rule lines is any line not starting with a $ or the +comment sign (#). Lines starting with $ carry rsyslog-specific +directives.

Every rule line consists of two fields, a selector field and +an action field. These two fields are separated by one or more spaces +or tabs. The selector field specifies a pattern of facilities and +priorities belonging to the specified action.
+
+Lines starting with a hash mark ("#'') and empty lines are ignored. +

+ +

[manual index] +[rsyslog.conf] +[rsyslog site]

This documentation is part of the +rsyslog project.
+Copyright © 2008-2010 by Rainer Gerhards and +Adiscon. Released under the GNU GPL +version 3 or higher.

+ + + diff --git a/doc/rsyslog_conf_file_syntax_differences.html b/doc/rsyslog_conf_file_syntax_differences.html new file mode 100644 index 00000000..bfac8926 --- /dev/null +++ b/doc/rsyslog_conf_file_syntax_differences.html @@ -0,0 +1,32 @@ + +Configuration File Syntax Differences - rsyslog.conf + +

This is a part of the rsyslog.conf documentation.

+Back to rsyslog.conf manual +

Configuration File Syntax Differences

Rsyslogd uses a slightly different syntax for its +configuration file than the original BSD sources. Originally all +messages of a specific priority and above were forwarded to the log +file. The modifiers "='', "!'' and "!-'' were added to make rsyslogd +more flexible and to use it in a more intuitive manner.
+
+The original BSD syslogd doesn't understand spaces as separators +between the selector and the action field.
+
+When compared to syslogd from sysklogd package, rsyslogd offers +additional +features (like template +and database support). For obvious reasons, the syntax for defining +such features is available in rsyslogd, only.

+ +

[manual index] +[rsyslog.conf] +[rsyslog site]

+ + + diff --git a/doc/rsyslog_conf_lines.html b/doc/rsyslog_conf_lines.html new file mode 100644 index 00000000..0e6cc0d3 --- /dev/null +++ b/doc/rsyslog_conf_lines.html @@ -0,0 +1,23 @@ + +Lines - rsyslog.conf + +

This is a part of the rsyslog.conf documentation.

+Back to rsyslog.conf manual +

Lines

Lines can be continued by specifying a backslash ("\") as the last +character of the line. There is a hard-coded maximum line length of 4K.
+If you need lines larger than that, you need to change compile-time +settings inside rsyslog and recompile. +

+ +

[manual index] +[rsyslog.conf] +[rsyslog site]

+ + + -- cgit v1.2.3