diff options
| author | Rainer Gerhards <rgerhards@adiscon.com> | 2008-02-11 13:46:19 +0000 |
|---|---|---|
| committer | Rainer Gerhards <rgerhards@adiscon.com> | 2008-02-11 13:46:19 +0000 |
| commit | 7a29f77fc5376b39ad365a7893d5c016743c912e (patch) | |
| tree | 6924b2af30997b9026e5dcf33a4cb23b5ed9e071 /doc | |
| parent | d219b5ee742984ad17f520ca5913840dbe51ff81 (diff) | |
| download | rsyslog-7a29f77fc5376b39ad365a7893d5c016743c912e.tar.gz rsyslog-7a29f77fc5376b39ad365a7893d5c016743c912e.tar.xz rsyslog-7a29f77fc5376b39ad365a7893d5c016743c912e.zip | |
some doc enhancements, including a template for module descriptions
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/omsnmp.html | 40 | ||||
| -rw-r--r-- | doc/rsconf1_filecreatemode.html | 2 | ||||
| -rw-r--r-- | doc/rsyslog_conf.html | 15 | ||||
| -rw-r--r-- | doc/rsyslog_ng_comparison.html | 11 |
4 files changed, 66 insertions, 2 deletions
diff --git a/doc/omsnmp.html b/doc/omsnmp.html new file mode 100644 index 00000000..7378ad72 --- /dev/null +++ b/doc/omsnmp.html @@ -0,0 +1,40 @@ +<html> + +<head> +<meta http-equiv="Content-Language" content="de"> +<title>Understanding rsyslog queues</title> +</head> + +<body> + +<h1>SNMP Output Module</h1> +<p><b>Module Name: omsnmp</b></p> +<p><b>Description</b>:</p> +<p>Provides the ability to send SNMPv1 & v2 traps.</p> +<p>...</p> +<p><b>Action Line:</b></p> +<p>%omsnmp% without any further parameters.</p> +<p><b>Configuration Directives</b>:</p> +<ul> + <li>$ActionSNMPTransport ...</li> + <li>...</li> +</ul> +<p><b>Caveats/Known Bugs:</b></p> +<p><b>Sample:</b></p> +<p>The following commands send every message as a snmp trap.</p> +<textarea rows="4" cols="60">$ModLoad omsnmp.so +.... +*.* :omsnmp: +</textarea> + +<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 © 2008 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/rsconf1_filecreatemode.html b/doc/rsconf1_filecreatemode.html index 7c6f1713..c8440864 100644 --- a/doc/rsconf1_filecreatemode.html +++ b/doc/rsconf1_filecreatemode.html @@ -30,6 +30,6 @@ index</a>] [<a href="http://www.rsyslog.com/">rsyslog site</a>]</p> <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> +version 3 or higher.</font></p> </body> </html> diff --git a/doc/rsyslog_conf.html b/doc/rsyslog_conf.html index 63f92d6e..8ad06416 100644 --- a/doc/rsyslog_conf.html +++ b/doc/rsyslog_conf.html @@ -20,6 +20,21 @@ obvious reasons, <a href="features.html">enhanced features</a> require a different config file syntax, rsyslogd should be able to work with a standard syslog.conf file. This is especially useful while you are migrating from syslogd to rsyslogd.</p> +<h2>Modules</h2> +<p>Rsyslog has a modular design. Consequently, there is a growing number of +modules. Here is the entry point to their documentation and what they do (list +is currently not complete)</p> +<ul> + <li><a href="omsnmp.html">omsnmp</a> - SNMP trap output module</li> + <li>ommysql - output module for MySQL</li> + <li>ompgsql - output module for PostgreSQL</li> + <li>imfile - [in development] input module for text files</li> + <li>imklog - kernel logging</li> +</ul> +<p>Please note that each module provides configuration directives, which are NOT +necessarily being listed below. Also remember, that a modules configuration +directive (and functionality) is only available if it has been loaded (using +$ModLoad).</p> <h2>Global Directives</h2> <p>All global directives need to be specified on a line by their own and must start with a dollar-sign. Here is a list in alphabetical order. Follow links for diff --git a/doc/rsyslog_ng_comparison.html b/doc/rsyslog_ng_comparison.html index 53a8d9ff..7ffb4612 100644 --- a/doc/rsyslog_ng_comparison.html +++ b/doc/rsyslog_ng_comparison.html @@ -298,12 +298,21 @@ don't be shy ;)</p> <td valign="top">many popular *nixes</td> </tr> <tr> + <td valign="top">DNS cache</td> + <td valign="top">no</td> + <td valign="top">yes</td> + </tr> + <tr> <td valign="top">? (probably many I do no know off...)</td> <td valign="top">no</td> <td valign="top">yes</td> </tr> </table> -<p>This document is current as of 2008-01-29 and definitely incomplete (I did +<p>Based on a discussion I had, I also wrote about the <b>political argument why +it is good to have another strong syslogd besides syslog-ng</b>. You may want to +read it at my blog at "<a href="http://rgerhards.blogspot.com/2007/08/why-does-world-need-another-syslogd.html">Why +does the world need another syslogd?</a>".</p> +<p>This document is current as of 2008-02-11 and definitely incomplete (I did not yet manage to complete it!).</p> </body> |