From c150f3ce9c0e25829527838af9c4c8cffa5d8ba1 Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Fri, 22 Feb 2008 08:24:05 +0000 Subject: corrected config doc - IETF no longer intends to add facilities --- doc/rsyslog_conf.html | 36 ++++++++++++++---------------------- 1 file changed, 14 insertions(+), 22 deletions(-) diff --git a/doc/rsyslog_conf.html b/doc/rsyslog_conf.html index eb1e29d3..977d37f0 100644 --- a/doc/rsyslog_conf.html +++ b/doc/rsyslog_conf.html @@ -1,7 +1,5 @@ -rsyslog.conf file - - +rsyslog.conf file

rsyslog.conf configuration file

This document is currently being enhanced. Please @@ -412,7 +410,7 @@ to filter based on priority and facility, you should do this with selector lines. They are not second-class citizens in rsyslog and offer the best performance for this job.

The selector field itself again consists of two parts, a -facility and a priority, separated by a period (``.''). Both parts are +facility and a priority, separated by a period (".''). Both parts are case insensitive and can also be specified as decimal numbers, but don't do that, you have been warned. Both facilities and priorities are described in rsyslog(3). The names mentioned below correspond to the @@ -426,39 +424,34 @@ not be used in applications. Anyway, you may want to specify and redirect these messages here. The facility specifies the subsystem that produced the message, i.e. all mail programs log with the mail facility (LOG_MAIL) if they log using syslog.
-
-Please note that the upcoming next syslog-RFC specifies many more -facilities. Support for them will be added in a future version of -rsyslog, which might require changes to existing configuration files.
-
-The priority is one of the following keywords, in ascending order: +
The priority is one of the following keywords, in ascending order: debug, info, notice, warning, warn (same as warning), err, error (same as err), crit, alert, emerg, panic (same as emerg). The keywords error, warn and panic are deprecated and should not be used anymore. The -priority defines the severity of the message
+priority defines the severity of the message.

The behavior of the original BSD syslogd is that all messages of the specified priority and higher are logged according to the given action. Rsyslogd behaves the same, but has some extensions.

In addition to the above mentioned names the rsyslogd(8) understands -the following extensions: An asterisk (``*'') stands for all facilities +the following extensions: An asterisk ("*'') stands for all facilities or all priorities, depending on where it is used (before or after the period). The keyword none stands for no priority of the given facility.

You can specify multiple facilities with the same priority pattern in -one statement using the comma (``,'') operator. You may specify as much +one statement using the comma (",'') operator. You may specify as much facilities as you want. Remember that only the facility part from such a statement is taken, a priority part would be skipped.

Multiple selectors may be specified for a single action using -the semicolon (``;'') separator. Remember that each selector in the +the semicolon (";'') separator. Remember that each selector in the selector field is capable to overwrite the preceding ones. Using this behavior you can exclude some priorities from the pattern.

Rsyslogd has a syntax extension to the original BSD source, that makes its use more intuitively. You may precede every priority -with an equation sign (``='') to specify only this single priority and +with an equation sign ("='') to specify only this single priority and not any of the above. You may also (both is valid, too) precede the -priority with an exclamation mark (``!'') to ignore all that +priority with an exclamation mark ("!'') to ignore all that priorities, either exact this one or this and any higher priority. If you use both extensions than the exclamation mark must occur before the equation sign, just use it intuitively.
@@ -605,7 +598,7 @@ compared to the otherwise-equal config directives below:

Typically messages are logged to real files. The file has to be specified with full pathname, beginning with a slash "/''.

-You may prefix each entry with the minus ``-'' sign to omit syncing the +You may prefix each entry with the minus "-'' sign to omit syncing the file after every logging. Note that you might lose information if the system crashes right behind a write attempt. Nevertheless this might give you back some performance, especially if you run programs that use @@ -651,7 +644,7 @@ file name:

Named Pipes

This version of rsyslogd(8) has support for logging output to named pipes (fifos). A fifo or named pipe can be used as a destination -for log messages by prepending a pipe symbol (``|'') to the name of the +for log messages by prepending a pipe symbol ("|'') to the name of the file. This is handy for debugging. Note that the fifo must be created with the mkfifo(1) command before rsyslogd(8) is started.

Terminal and Console
@@ -761,7 +754,7 @@ use a different template. Use that one:
sysklogd,"<%PRI%>%TIMESTAMP% %syslogtag%%msg%\""
*.* @192.168.0.1;sysklogd

List of Users
-
Usually critical messages are also directed to ``root'' on +
Usually critical messages are also directed to "root'' on that machine. You can specify a list of users that shall get the message by simply writing the login. You may specify more than one user by separating them with commas (",''). If they're logged in they get @@ -1019,8 +1012,7 @@ currently logged in users. This is the wall action.
*.alert root,rgerhards

This rule directs all messages with a priority of alert or higher to -the terminals of the operator, i.e. of the users ``root'' and -``rgerhards'' if they're logged in.
+the terminals of the operator, i.e. of the users "root'' and "rgerhards'' if they're logged in.

*.* @finlandia
@@ -1072,7 +1064,7 @@ Please note the colon in fron

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