summaryrefslogtreecommitdiffstats
path: root/doc/rsconf1_controlcharacterescapeprefix.html
diff options
context:
space:
mode:
authorRainer Gerhards <rgerhards@adiscon.com>2007-08-08 13:59:43 +0000
committerRainer Gerhards <rgerhards@adiscon.com>2007-08-08 13:59:43 +0000
commit4459faa3799e4804402327e8fc4ea92abc96a0e1 (patch)
tree079eb0a10c3aeaaf5d1ebd2b78d4e420a537514b /doc/rsconf1_controlcharacterescapeprefix.html
parent7f4405ff42927df2d10fb03b3139b327b474565f (diff)
downloadrsyslog-4459faa3799e4804402327e8fc4ea92abc96a0e1.tar.gz
rsyslog-4459faa3799e4804402327e8fc4ea92abc96a0e1.tar.xz
rsyslog-4459faa3799e4804402327e8fc4ea92abc96a0e1.zip
somewhat improved config file doc - thanks to Florian Riedl for doing the
bulk of work
Diffstat (limited to 'doc/rsconf1_controlcharacterescapeprefix.html')
-rw-r--r--doc/rsconf1_controlcharacterescapeprefix.html23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/rsconf1_controlcharacterescapeprefix.html b/doc/rsconf1_controlcharacterescapeprefix.html
new file mode 100644
index 00000000..23bf5c61
--- /dev/null
+++ b/doc/rsconf1_controlcharacterescapeprefix.html
@@ -0,0 +1,23 @@
+<html>
+<head>
+<title>rsyslog.conf file</title>
+</head>
+<body>
+<h2>$ControlCharacterEscapePrefix</h2>
+<p><b>Type:</b> global configuration directive</p>
+<p><b>Default:</b> \</p>
+<p><b>Description:</b></p>
+<p>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.</p>
+<p><b>IMPORTANT</b>: 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 furture releases.</p>
+<p><b>Sample:</b></p>
+<p><code><b>$EscapeControlCharactersOnReceive #&nbsp; # as of syslog-protocol</b></code></p>
+
+<p>[<a href="rsyslog_conf.html">rsyslog.conf overview</a>] [<a href="manual.html">manual
+index</a>] [<a href="http://www.rsyslog.com/">rsyslog site</a>]</p>
+<p><font size="2">This documentation is part of the
+<a href="http://www.rsyslog.com/">rsyslog</a> project.<br>
+Copyright &copy; 2007 by <a href="http://www.gerhards.net/rainer">Rainer Gerhards</a> and
+<a href="http://www.adiscon.com/">Adiscon</a>. Released under the GNU GPL
+version 2 or higher.</font></p>
+</body>
+</html> \ No newline at end of file