summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRainer Gerhards <rgerhards@adiscon.com>2010-08-06 17:25:38 +0200
committerRainer Gerhards <rgerhards@adiscon.com>2010-08-06 17:25:38 +0200
commit80ff634c841d692c1d9f335b88e225d6ce7317f7 (patch)
treed7db3f16ab7fbd187f0b02d2746292cc335bb526 /doc
parent1be79730693be187e99319377cf110fba41cc801 (diff)
downloadrsyslog-80ff634c841d692c1d9f335b88e225d6ce7317f7.tar.gz
rsyslog-80ff634c841d692c1d9f335b88e225d6ce7317f7.tar.xz
rsyslog-80ff634c841d692c1d9f335b88e225d6ce7317f7.zip
added omuxsock, which permits to write message to local Unix sockets
this is the counterpart to imuxsock, enabling fast local forwarding
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am1
-rw-r--r--doc/imuxsock.html2
-rw-r--r--doc/omuxsock.html43
-rw-r--r--doc/rsyslog_conf_modules.html1
4 files changed, 46 insertions, 1 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 5beebf0e..24a0ea74 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -100,6 +100,7 @@ html_files = \
gssapi.html \
licensing.html \
ommail.html \
+ omuxsock.html \
omrelp.html \
syslog_parsing.html \
troubleshoot.html \
diff --git a/doc/imuxsock.html b/doc/imuxsock.html
index 15c365a6..381374d2 100644
--- a/doc/imuxsock.html
+++ b/doc/imuxsock.html
@@ -100,7 +100,7 @@ $InputUnixListenSocketHostName /var/run/sshd/dev/log
<p><font size="2">This documentation is part of the
<a href="http://www.rsyslog.com/">rsyslog</a>
project.<br>
-Copyright © 2008 by <a href="http://www.gerhards.net/rainer">Rainer
+Copyright &copy; 2008-2010 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 3 or higher.</font></p>
diff --git a/doc/omuxsock.html b/doc/omuxsock.html
new file mode 100644
index 00000000..4ffc53eb
--- /dev/null
+++ b/doc/omuxsock.html
@@ -0,0 +1,43 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><title>Unix sockets output module (omuxsock) - sending syslog messages to local socket</title>
+<a href="features.html">back</a>
+</head>
+<body>
+<h1>Mail Output Module (omuxsock)</h1>
+<p><b>Module Name:&nbsp;&nbsp;&nbsp; omuxsock</b></p>
+<p><b>Available since:&nbsp;&nbsp;&nbsp;</b> 4.7.3, 5.5.7</p>
+<p><b>Author: </b>Rainer Gerhards &lt;rgerhards@adiscon.com&gt;</p>
+<p><b>Description</b>:</p>
+<p>This module supports sending syslog messages to local Unix sockets.
+Thus it provided a fast message-passing interface between different rsyslog
+instances. The counterpart to omuxsock is <a href="imuxsock.html">imuxsock</a>.
+Note that the template used together with omuxsock must be suitable to be
+processed by the receiver.
+<p><b>Configuration Directives</b>:</p>
+<ul>
+<li><b>$OMUxSockSocket</b><br>
+Name of the socket to send data to. This has no default and <b>must</b>
+be set.
+</li>
+<li><b>$OMUxSockDefaultTemplate</b><br>
+This can be used to override the default template to be used together
+with omuxsock. This is primarily useful if there are many forwarding
+actions and each of them should use the same template.</li>
+</ul>
+<b>Caveats/Known Bugs:</b>
+<p>Currently, only datagram sockets are supported.
+<p><b>Sample:</b></p>
+<p>The following sample writes all messages to the "/tmp/socksample" socket.
+</p>
+<textarea rows="4" cols="80">$ModLoad omucsock
+$OMUxSockSocket /tmp/socksample
+*.* :omuxsock:
+</textarea>
+[<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; 2010 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 3 or higher.</font></p>
+
+</body></html>
diff --git a/doc/rsyslog_conf_modules.html b/doc/rsyslog_conf_modules.html
index c36b8c6d..a6555c1a 100644
--- a/doc/rsyslog_conf_modules.html
+++ b/doc/rsyslog_conf_modules.html
@@ -52,6 +52,7 @@ SQLLite, Ingres, Oracle, mSQL)</li>
<li><a href="ommail.html">ommail</a> -
permits rsyslog to alert folks by mail if something important happens</li>
<li><a href="omoracle.html">omoracle</a> - output module for Oracle (native OCI interface)</li>
+<li><a href="omuxsock.html">omuxsock</a> - output module Unix domain sockets</li>
</ul>
<h2>Library Modules</h2>