From 9b59581a6f7d161c7aafbc3300689337939bb382 Mon Sep 17 00:00:00 2001
From: Michael Biebl <biebl@debian.org>
Date: Fri, 18 Jul 2008 16:41:52 +0200
Subject: use the $ModLoad syntax consistently.

Update the documentation to use the new, preferred $ModLoad syntax:
- no more MySQL
- name of the in/output plugin without the trailing .so

Signed-off-by: Rainer Gerhards <rgerhards@adiscon.com>
---
 doc/gssapi.html                      |  6 +++---
 doc/imfile.html                      |  4 ++--
 doc/imgssapi.html                    |  2 +-
 doc/imtcp.html                       |  4 ++--
 doc/install.html                     | 10 +++++-----
 doc/omlibdbi.html                    |  4 ++--
 doc/omsnmp.html                      |  4 ++--
 doc/rsconf1_modload.html             |  2 +-
 doc/rsyslog-example.conf             |  2 +-
 doc/rsyslog_conf.html                |  4 ++--
 doc/rsyslog_high_database_rate.html  | 18 ++++++++++--------
 doc/rsyslog_mysql.html               |  6 +++---
 doc/rsyslog_reliable_forwarding.html |  4 ++--
 doc/v3compatibility.html             | 14 +++++++-------
 14 files changed, 43 insertions(+), 41 deletions(-)

diff --git a/doc/gssapi.html b/doc/gssapi.html
index 400be4a3..3ad7d07b 100644
--- a/doc/gssapi.html
+++ b/doc/gssapi.html
@@ -61,7 +61,7 @@ on receiver </li>
 </p>
 <ul>
 <li>set-up rsyslog, in /etc/rsyslog.conf</li>
-<li>$ModLoad omgssapi.so - load output gss module </li>
+<li>$ModLoad omgssapi - load output gss module </li>
 <li>$GSSForwardServiceName
 otherThanHost - set the name of service principal, "host" is the
 default one</li>
@@ -81,7 +81,7 @@ rsyslog, in /etc/rsyslog.conf </p>
 </li>
 <li class="P16">
 <p class="P16" style="margin-left: 0.25cm;">$ModLoad
-<a href="imgssapi.html">imgssapi.so</a> - load input gss module </p>
+<a href="imgssapi.html">imgssapi</a> - load input gss module </p>
 </li>
 <li class="P16">
 <p class="P16" style="margin-left: 0.25cm;">$InputGSSServerServiceName
@@ -115,4 +115,4 @@ Copyright 
 Gerhards</a> and
 <a href="http://www.adiscon.com/">Adiscon</a>.
 Released under the GNU GPL version 3 or higher.</font></p>
-</body></html>
\ No newline at end of file
+</body></html>
diff --git a/doc/imfile.html b/doc/imfile.html
index d8a105bf..6fc6c2e2 100644
--- a/doc/imfile.html
+++ b/doc/imfile.html
@@ -103,7 +103,7 @@ your distro puts rsyslog's config files). Note that only commands
 actually needed need to be specified. The second file uses less
 commands and uses defaults instead.<br>
 </p>
-<textarea rows="15" cols="60">$ModLoad imfile.so #
+<textarea rows="15" cols="60">$ModLoad imfile #
 needs to be done just once
 # File 1
 $InputFileName /path/to/file1
@@ -131,4 +131,4 @@ Copyright 
 Gerhards</a> and
 <a href="http://www.adiscon.com/">Adiscon</a>.
 Released under the GNU GPL version 3 or higher.</font></p>
-</body></html>
\ No newline at end of file
+</body></html>
diff --git a/doc/imgssapi.html b/doc/imgssapi.html
index cf16eb01..d644303e 100644
--- a/doc/imgssapi.html
+++ b/doc/imgssapi.html
@@ -36,7 +36,7 @@ Sets the maximum number of sessions supported</li>
 <p>This sets up a GSS server on port 1514 that also permits to
 receive plain tcp syslog messages (on the same port):<br>
 </p>
-<textarea rows="15" cols="60">$ModLoad imtcp.so # needs to be done just once
+<textarea rows="15" cols="60">$ModLoad imtcp # needs to be done just once
 $InputGSSServerRun 1514
 $InputGSSServerPermitPlainTCP on
 </textarea>
diff --git a/doc/imtcp.html b/doc/imtcp.html
index b2c6d21d..2c8ead56 100644
--- a/doc/imtcp.html
+++ b/doc/imtcp.html
@@ -35,7 +35,7 @@ Sets the maximum number of sessions supported</li>
 <p><b>Sample:</b></p>
 <p>This sets up a TCP server on port 514:<br>
 </p>
-<textarea rows="15" cols="60">$ModLoad imtcp.so #
+<textarea rows="15" cols="60">$ModLoad imtcp #
 needs to be done just once
 $InputTCPServerRun 514
 </textarea>
@@ -48,4 +48,4 @@ Copyright 
 Gerhards</a> and
 <a href="http://www.adiscon.com/">Adiscon</a>.
 Released under the GNU GPL version 3 or higher.</font></p>
-</body></html>
\ No newline at end of file
+</body></html>
diff --git a/doc/install.html b/doc/install.html
index 711552e6..661ae943 100644
--- a/doc/install.html
+++ b/doc/install.html
@@ -58,11 +58,11 @@ to load plug-in modules to perform useful work (more about
 <a href="v3compatibility.html">compatibilty notes v3</a>). To load the most common plug-ins,
 add the following to the top of rsyslog.conf:</p>
 <p>
-$ModLoad immark.so   # provides --MARK-- message capability <br />
-$ModLoad imudp.so  # provides UDP syslog reception <br />
-$ModLoad imtcp.so  # provides TCP syslog reception and GSS-API (if compiled to support it) <br />
-$ModLoad imuxsock.so # provides support for local system logging (e.g. via logger command) <br />
-$ModLoad imklog.so # provides kernel logging support (previously done by rklogd) <br />
+$ModLoad immark # provides --MARK-- message capability <br />
+$ModLoad imudp # provides UDP syslog reception <br />
+$ModLoad imtcp # provides TCP syslog reception and GSS-API (if compiled to support it) <br />
+$ModLoad imuxsock # provides support for local system logging (e.g. via logger command) <br />
+$ModLoad imklog # provides kernel logging support (previously done by rklogd) <br />
 </p>
 Change rsyslog.conf for any further
 enhancements you would like to see. For example, you can add database writing as 
diff --git a/doc/omlibdbi.html b/doc/omlibdbi.html
index c66dc06b..8ff74371 100644
--- a/doc/omlibdbi.html
+++ b/doc/omlibdbi.html
@@ -106,7 +106,7 @@ database "syslog_db" on mysqlsever.example.com. The server is MySQL and
 being accessed under the account of "user" with password "pwd" (if you
 have empty passwords, just remove the $ActionLibdbiPassword line).<br>
 </p>
-<textarea rows="15" cols="60">$ModLoad omlibdbi.so
+<textarea rows="15" cols="60">$ModLoad omlibdbi
 $ActionLibdbiDriver mysql
 $ActionLibdbiHost mysqlserver.example.com
 $ActionLibdbiUserName user
@@ -123,4 +123,4 @@ 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>
\ No newline at end of file
+</body></html>
diff --git a/doc/omsnmp.html b/doc/omsnmp.html
index 5b10bd9e..31aaef24 100644
--- a/doc/omsnmp.html
+++ b/doc/omsnmp.html
@@ -152,7 +152,7 @@ developer (headers) package installed. </p>
 	will need to have the adiscon mibs installed. </li></ul>
 <p><b>Sample:</b></p>
 <p>The following commands send every message as a snmp trap.</p>
-<textarea rows="10" cols="60">$ModLoad omsnmp.so
+<textarea rows="10" cols="60">$ModLoad omsnmp
 
 $actionsnmptransport udp
 $actionsnmptarget localhost
@@ -171,4 +171,4 @@ Copyright © 2008 by <a href="http://www.gerhards.net/rainer">Rainer Gerhards</a
 <a href="http://www.adiscon.com/">Adiscon</a>. Released under the GNU GPL 
 version 3 or higher.</font></p>
 
-</body></html>
\ No newline at end of file
+</body></html>
diff --git a/doc/rsconf1_modload.html b/doc/rsconf1_modload.html
index 37623a1f..a2b8087a 100644
--- a/doc/rsconf1_modload.html
+++ b/doc/rsconf1_modload.html
@@ -18,7 +18,7 @@ $ModDir</a> directive.</p>
 <p>If a full path name is specified, the module is loaded from that path. The 
 default module directory is ignored in that case.</p>
 <p><b>Sample:</b></p>
-<p><code><b>$ModLoad MySQL&nbsp; # load MySQL functionality<br>
+<p><code><b>$ModLoad ommysql # load MySQL functionality<br>
 $ModLoad /rsyslog/modules/ompgsql.so # load the postgres module via absolute path</b></code></p>
 
 <p>[<a href="rsyslog_conf.html">rsyslog.conf overview</a>] [<a href="manual.html">manual 
diff --git a/doc/rsyslog-example.conf b/doc/rsyslog-example.conf
index 495bc566..a3ec2f1f 100644
--- a/doc/rsyslog-example.conf
+++ b/doc/rsyslog-example.conf
@@ -34,7 +34,7 @@ $IncludeConfig /etc/rsyslog.d/                 # whole directory (must contain t
 
 # $ModLoad - Dynamically loads a plug-in and activates it
 # --------
-$ModLoad MySQL  # load MySQL functionality
+$ModLoad ommysql  # load MySQL functionality
 $ModLoad /rsyslog/modules/somemodule.so # load a module via absolute path
 
 
diff --git a/doc/rsyslog_conf.html b/doc/rsyslog_conf.html
index 9325f73c..cdfffec4 100644
--- a/doc/rsyslog_conf.html
+++ b/doc/rsyslog_conf.html
@@ -915,7 +915,7 @@ template name can follow the connect information. This is as follows:<br>
 <p><b>Important: to use the database functionality, the
 MySQL output module must be loaded in the config file</b> BEFORE
 the first database table action is used. This is done by placing the</p>
-<p><code><b>$ModLoad MySQL</b></code></p>
+<p><code><b>$ModLoad ommysql</b></code></p>
 <p>directive some place above the first use of the database write
 (we recommend doing at the the beginning of the config file).</p>
 <h3>Discard</h3>
@@ -1190,4 +1190,4 @@ additional
 and database support). For obvious reasons, the syntax for defining
 such features is available in rsyslogd, only.<br>
 &nbsp;</p>
-</body></html>
\ No newline at end of file
+</body></html>
diff --git a/doc/rsyslog_high_database_rate.html b/doc/rsyslog_high_database_rate.html
index 5b0a29ae..158a4df6 100644
--- a/doc/rsyslog_high_database_rate.html
+++ b/doc/rsyslog_high_database_rate.html
@@ -72,10 +72,11 @@ restarts, so even a reboot of the system will not cause any message loss.</p>
 disk queue and then configure your action. There is nothing else to do. With the 
 following simple config file, you log anything you receive to a MySQL database 
 and have buffering applied automatically.</p>
-<textarea rows="11" cols="80">$ModLoad ommysql.so  # load the output driver (use ompgsql.so for PostgreSQL)
-$ModLoad imudp.so    # network reception
-$UDPServerRun 514    # start a udp server at port 514
-$ModLoad imuxsock.so # local message reception
+<textarea rows="11" cols="80">
+$ModLoad ommysql  # load the output driver (use ompgsql for PostgreSQL)
+$ModLoad imudp    # network reception
+$UDPServerRun 514 # start a udp server at port 514
+$ModLoad imuxsock # local message reception
 
 $WorkDirectory /rsyslog/work # default location for work (spool) files
 $MainMsgQueueFileName mainq  # set file name, also enables disk mode
@@ -100,10 +101,11 @@ a single database or send messages reliably to another host, you can do all of
 this on their own queues, de-coupling their processing speeds.</p>
 <p>The configuration for the de-coupled database write involves just a few more 
 commands:</p>
-<textarea rows="11" cols="80">$ModLoad ommysql.so  # load the output driver (use ompgsql.so for PostgreSQL)
-$ModLoad imudp.so    # network reception
-$UDPServerRun 514    # start a udp server at port 514
-$ModLoad imuxsock.so # local message reception
+<textarea rows="11" cols="80">
+$ModLoad ommysql  # load the output driver (use ompgsql for PostgreSQL)
+$ModLoad imudp    # network reception
+$UDPServerRun 514 # start a udp server at port 514
+$ModLoad imuxsock # local message reception
 
 $WorkDirectory /rsyslog/work # default location for work (spool) files
 
diff --git a/doc/rsyslog_mysql.html b/doc/rsyslog_mysql.html
index 57a779d5..a5c72429 100644
--- a/doc/rsyslog_mysql.html
+++ b/doc/rsyslog_mysql.html
@@ -137,9 +137,9 @@ functionality, MySQL must be enabled in the config file BEFORE the
 first database table action is
 used. This is done by placing the</p>
 <blockquote>
-<p><code>$ModLoad ommysql.so</code></p>
+<p><code>$ModLoad ommysql</code></p>
 </blockquote>
-<p>directive at the begining of /etc/rsyslog.conf. For other databases, use their plugin name (e.g. ompgsql.so).</p>
+<p>directive at the begining of /etc/rsyslog.conf. For other databases, use their plugin name (e.g. ompgsql).</p>
 <p>Next, we need to tell rsyslogd to write data to the database.
 As we use the default schema, we do NOT need to define a template for
 this. We can use the hardcoded one (rsyslogd handles the proper
@@ -259,4 +259,4 @@ document under the terms of the GNU Free Documentation License, Version
 with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
 Texts. A copy of the license can be viewed at <a href="http://www.gnu.org/copyleft/fdl.html">
 http://www.gnu.org/copyleft/fdl.html</a>.</p>
-</body></html>
\ No newline at end of file
+</body></html>
diff --git a/doc/rsyslog_reliable_forwarding.html b/doc/rsyslog_reliable_forwarding.html
index 870ca9b7..d04d9ead 100644
--- a/doc/rsyslog_reliable_forwarding.html
+++ b/doc/rsyslog_reliable_forwarding.html
@@ -92,9 +92,9 @@ file names for the second action, else you will mess up your system.
 <p>A sample for forwarding to two hosts looks like this:
 <p>
 <textarea rows="20" cols="80">
-$ModLoad imuxsock.so # local message reception
+$ModLoad imuxsock             # local message reception
 
-$WorkDirectory /rsyslog/work # default location for work (spool) files
+$WorkDirectory /rsyslog/work  # default location for work (spool) files
 
 # start forwarding rule 1
 $ActionQueueType LinkedList   # use asynchronous processing
diff --git a/doc/v3compatibility.html b/doc/v3compatibility.html
index f4eef3a1..51619947 100644
--- a/doc/v3compatibility.html
+++ b/doc/v3compatibility.html
@@ -32,11 +32,11 @@ are available by which modules.</p>
 <p>It is suggested that input modules be loaded in the top part
 of the config file. Here is an example, also highlighting the most
 important modules:</p>
-<p><b>$ModLoad immark&nbsp; # provides --MARK--
+<p><b>$ModLoad immark # provides --MARK--
 message capability<br>
-$ModLoad imudp&nbsp; # provides UDP syslog reception<br>
-$ModLoad imtcp&nbsp; # provides TCP syslog reception<br>
-</b><b>$ModLoad imgssapi&nbsp; # provides GSSAPI syslog
+$ModLoad imudp # provides UDP syslog reception<br>
+$ModLoad imtcp # provides TCP syslog reception<br>
+</b><b>$ModLoad imgssapi # provides GSSAPI syslog
 reception<br>
 </b><b>$ModLoad imuxsock # provides support for local
 system logging (e.g.
@@ -94,7 +94,7 @@ set the local address the server should listen to via <b>$UDPServerAddress
 &lt;ip&gt;</b> config directive.</p>
 <p>The following example configures an UDP syslog server at the
 local address 192.0.2.1 on port 514:</p>
-<p><b>$ModLoad imudp.so<br>
+<p><b>$ModLoad imudp<br>
 $UDPSeverAddress 192.0.2.1 # this MUST be before the $UDPServerRun
 directive!<br>
 $UDPServerRun 514</b></p>
@@ -102,7 +102,7 @@ $UDPServerRun 514</b></p>
 This is the default if no directive is specified.</p>
 <p>Please note that now multiple listeners are supported. For
 example, you can do the following:</p>
-<p><b>$ModLoad imudp.so<br>
+<p><b>$ModLoad imudp<br>
 $UDPSeverAddress 192.0.2.1 # this MUST be before the $UDPServerRun
 directive!<br>
 $UDPServerRun 514<br>
@@ -122,7 +122,7 @@ the "Run" directive, e.g. "<i>$UDPServerRun syslog</i>".</p>
 <h2>klogd</h2>
 <p>klogd has (finally) been replaced by a loadable input module.
 To enable klogd functionality, do</p>
-<p><b>$ModLoad imklog.so</b></p>
+<p><b>$ModLoad imklog</b></p>
 <p>Note that this can not be handled by the compatibility layer,
 as klogd was a separate binary.A limited set of klogd command line
 settings is now supported
-- 
cgit