summaryrefslogtreecommitdiffstats
path: root/source/configuration/input_directives/rsconf1_controlcharacterescapeprefix.rst
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--source/configuration/input_directives/rsconf1_controlcharacterescapeprefix.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/source/configuration/input_directives/rsconf1_controlcharacterescapeprefix.rst b/source/configuration/input_directives/rsconf1_controlcharacterescapeprefix.rst
new file mode 100644
index 0000000..06ddb12
--- /dev/null
+++ b/source/configuration/input_directives/rsconf1_controlcharacterescapeprefix.rst
@@ -0,0 +1,24 @@
+$ControlCharacterEscapePrefix
+-----------------------------
+
+**Type:** global configuration parameter
+
+**Default:** \\
+
+**Description:**
+
+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 parameter will probably change in future
+releases.
+
+**Sample:**
+
+``$EscapeControlCharactersOnReceive #  # as of syslog-protocol``
+