Use this documentation with care! It describes the heavily outdated version 5, which was actively developed around 2010 and is considered dead by the rsyslog team for many years now.

This documentation reflects the latest update of the previously existing (now removed) v5-stable branch. It describes the 5.10.2 version, which was never released. As such, it contains some content that does not apply to any released version.

To obtain the doc that properly matches your installed v5 version, obtain the doc set from your distro. Each version of rsyslog contained the version that exactly matches it.

As general advise, it is strongly suggested to upgrade to the current version supported by the rsyslog project. The current version can always be found on the right-hand side info box on the rsyslog web site.

Note that there is no rsyslog community support available for this heavily outdated version. If you need to stick with it, please ask your distribution for support.



Type: global configuration directive

Default: \


This option specifies the prefix character to be used for control character escaping (see option $EscapeControlCharactersOnReceive). By default, it is ‘', which is backwards-compatible with sysklogd. Change it to ‘#’ in order to be compliant to the value that is somewhat suggested by Internet-Draft syslog-protocol.

IMPORTANT: do not use the ‘ character. This is reserved and will most probably be used in the future as a character delimiter. For the same reason, the syntax of this directive will probably change in future releases.


$EscapeControlCharactersOnReceive # as of syslog-protocol

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

This documentation is part of the rsyslog project. Copyright © 2007 by Rainer Gerhards and Adiscon. Released under the GNU GPL version 2 or higher.

Previous topic


Next topic


This Page