diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 16:27:18 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 16:27:18 +0000 |
commit | f7f20c3f5e0be02585741f5f54d198689ccd7866 (patch) | |
tree | 190d5e080f6cbcc40560b0ceaccfd883cb3faa01 /source/configuration/input_directives/rsconf1_escapecontrolcharactersonreceive.rst | |
parent | Initial commit. (diff) | |
download | rsyslog-doc-f7f20c3f5e0be02585741f5f54d198689ccd7866.tar.xz rsyslog-doc-f7f20c3f5e0be02585741f5f54d198689ccd7866.zip |
Adding upstream version 8.2402.0+dfsg.upstream/8.2402.0+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'source/configuration/input_directives/rsconf1_escapecontrolcharactersonreceive.rst')
-rw-r--r-- | source/configuration/input_directives/rsconf1_escapecontrolcharactersonreceive.rst | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/source/configuration/input_directives/rsconf1_escapecontrolcharactersonreceive.rst b/source/configuration/input_directives/rsconf1_escapecontrolcharactersonreceive.rst new file mode 100644 index 0000000..05cc623 --- /dev/null +++ b/source/configuration/input_directives/rsconf1_escapecontrolcharactersonreceive.rst @@ -0,0 +1,34 @@ +$EscapeControlCharactersOnReceive +--------------------------------- + +**Type:** global configuration parameter + +**Default:** on + +**Description:** + +This parameter instructs rsyslogd to replace control characters during +reception of the message. The intent is to provide a way to stop +non-printable messages from entering the syslog system as whole. If this +option is turned on, all control-characters are converted to a 3-digit +octal number and be prefixed with the $ControlCharacterEscapePrefix +character (being '\\' by default). For example, if the BEL character +(ctrl-g) is included in the message, it would be converted to "\\007". +To be compatible to sysklogd, this option must be turned on. + +**Warning:** + +- turning on this option most probably destroys non-western character + sets (like Japanese, Chinese and Korean) +- turning on this option destroys digital signatures if such exists + inside the message +- if turned on, the drop-cc, space-cc and escape-cc `property + replacer <property_replacer.html>`_ options do not work as expected + because control characters are already removed upon message + reception. If you intend to use these property replacer options, you + must turn off $EscapeControlCharactersOnReceive. + +**Sample:** + +``$EscapeControlCharactersOnReceive on`` + |