diff options
| author | Rainer Gerhards <rgerhards@adiscon.com> | 2007-08-08 13:59:43 +0000 |
|---|---|---|
| committer | Rainer Gerhards <rgerhards@adiscon.com> | 2007-08-08 13:59:43 +0000 |
| commit | 4459faa3799e4804402327e8fc4ea92abc96a0e1 (patch) | |
| tree | 079eb0a10c3aeaaf5d1ebd2b78d4e420a537514b /doc/rsconf1_escapecontrolcharactersonreceive.html | |
| parent | 7f4405ff42927df2d10fb03b3139b327b474565f (diff) | |
| download | rsyslog-4459faa3799e4804402327e8fc4ea92abc96a0e1.tar.gz rsyslog-4459faa3799e4804402327e8fc4ea92abc96a0e1.tar.bz2 rsyslog-4459faa3799e4804402327e8fc4ea92abc96a0e1.zip | |
somewhat improved config file doc - thanks to Florian Riedl for doing the
bulk of work
Diffstat (limited to 'doc/rsconf1_escapecontrolcharactersonreceive.html')
| -rw-r--r-- | doc/rsconf1_escapecontrolcharactersonreceive.html | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/rsconf1_escapecontrolcharactersonreceive.html b/doc/rsconf1_escapecontrolcharactersonreceive.html new file mode 100644 index 00000000..f273b85a --- /dev/null +++ b/doc/rsconf1_escapecontrolcharactersonreceive.html @@ -0,0 +1,29 @@ +<html> +<head> +<title>rsyslog.conf file</title> +</head> +<body> +<h2>$EscapeControlCharactersOnReceive</h2> +<p><b>Type:</b> global configuration directive</p> +<p><b>Default:</b> on</p> +<p><b>Description:</b></p> +<p>This directive 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 truned 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.</p> +<p><b>Warning:</b></p> +<ul> + <li>turning on this option most probably destroys non-western character sets + (like Japanese, Chinese and Korean)</li> + <li>turning on this option destroys digital signatures if such exists inside + the message</li> +</ul> +<p><b>Sample:</b></p> +<p><code><b>$EscapeControlCharactersOnReceive on</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 © 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 |