~ubuntu-branches/ubuntu/lucid/rsyslog/lucid

« back to all changes in this revision

Viewing changes to doc/rsconf1_escapecontrolcharactersonreceive.html

  • Committer: Bazaar Package Importer
  • Author(s): Michael Biebl
  • Date: 2007-10-19 17:21:49 UTC
  • Revision ID: james.westby@ubuntu.com-20071019172149-ie6ej2xve33mxiu7
Tags: upstream-1.19.10
ImportĀ upstreamĀ versionĀ 1.19.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<html>
 
2
<head>
 
3
<title>rsyslog.conf file</title>
 
4
</head>
 
5
<body>
 
6
<h2>$EscapeControlCharactersOnReceive</h2>
 
7
<p><b>Type:</b> global configuration directive</p>
 
8
<p><b>Default:</b> on</p>
 
9
<p><b>Description:</b></p>
 
10
<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 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.</p>
 
11
<p><b>Warning:</b></p>
 
12
<ul>
 
13
        <li>turning on this option most probably destroys non-western character sets 
 
14
        (like Japanese, Chinese and Korean)</li>
 
15
        <li>turning on this option destroys digital signatures if such exists inside 
 
16
        the message</li>
 
17
</ul>
 
18
<p><b>Sample:</b></p>
 
19
<p><code><b>$EscapeControlCharactersOnReceive on</b></code></p>
 
20
 
 
21
<p>[<a href="rsyslog_conf.html">rsyslog.conf overview</a>] [<a href="manual.html">manual 
 
22
index</a>] [<a href="http://www.rsyslog.com/">rsyslog site</a>]</p>
 
23
<p><font size="2">This documentation is part of the
 
24
<a href="http://www.rsyslog.com/">rsyslog</a> project.<br>
 
25
Copyright &copy; 2007 by <a href="http://www.gerhards.net/rainer">Rainer Gerhards</a> and
 
26
<a href="http://www.adiscon.com/">Adiscon</a>. Released under the GNU GPL 
 
27
version 2 or higher.</font></p>
 
28
</body>
 
29
</html>