From 7a29f77fc5376b39ad365a7893d5c016743c912e Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Mon, 11 Feb 2008 13:46:19 +0000 Subject: some doc enhancements, including a template for module descriptions --- doc/omsnmp.html | 40 ++++++++++++++++++++++++++++++++++++++++ doc/rsconf1_filecreatemode.html | 2 +- doc/rsyslog_conf.html | 15 +++++++++++++++ doc/rsyslog_ng_comparison.html | 11 ++++++++++- 4 files changed, 66 insertions(+), 2 deletions(-) create mode 100644 doc/omsnmp.html 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 @@ + + + + +Understanding rsyslog queues + + + + +

SNMP Output Module

+

Module Name:    omsnmp

+

Description:

+

Provides the ability to send SNMPv1 & v2 traps.

+

...

+

Action Line:

+

%omsnmp% without any further parameters.

+

Configuration Directives:

+ +

Caveats/Known Bugs:

+

Sample:

+

The following commands send every message as a snmp trap.

+ + +

[rsyslog.conf overview] [manual +index] [rsyslog site]

+

This documentation is part of the +rsyslog project.
+Copyright © 2008 by Rainer Gerhards and +Adiscon. Released under the GNU GPL +version 3 or higher.

+ + + + 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] [rsyslog site]

rsyslog project.
Copyright © 2007 by Rainer Gerhards and Adiscon. Released under the GNU GPL -version 2 or higher.

+version 3 or higher.

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, enhanced features 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.

+

Modules

+

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)

+ +

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).

Global Directives

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 @@ -297,13 +297,22 @@ don't be shy ;)

Linux, anecdotical seen on Solaris many popular *nixes + + DNS cache + no + yes + ? (probably many I do no know off...) no yes -

This document is current as of 2008-01-29 and definitely incomplete (I did +

Based on a discussion I had, I also wrote about the political argument why +it is good to have another strong syslogd besides syslog-ng. You may want to +read it at my blog at "Why +does the world need another syslogd?".

+

This document is current as of 2008-02-11 and definitely incomplete (I did not yet manage to complete it!).

-- cgit v1.2.3