diff options
| author | Rainer Gerhards <rgerhards@adiscon.com> | 2007-08-08 13:59:43 +0000 |
|---|---|---|
| committer | Rainer Gerhards <rgerhards@adiscon.com> | 2007-08-08 13:59:43 +0000 |
| commit | 4459faa3799e4804402327e8fc4ea92abc96a0e1 (patch) | |
| tree | 079eb0a10c3aeaaf5d1ebd2b78d4e420a537514b /doc/rsconf1_includeconfig.html | |
| parent | 7f4405ff42927df2d10fb03b3139b327b474565f (diff) | |
| download | rsyslog-4459faa3799e4804402327e8fc4ea92abc96a0e1.tar.gz rsyslog-4459faa3799e4804402327e8fc4ea92abc96a0e1.tar.xz rsyslog-4459faa3799e4804402327e8fc4ea92abc96a0e1.zip | |
somewhat improved config file doc - thanks to Florian Riedl for doing the
bulk of work
Diffstat (limited to 'doc/rsconf1_includeconfig.html')
| -rw-r--r-- | doc/rsconf1_includeconfig.html | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/rsconf1_includeconfig.html b/doc/rsconf1_includeconfig.html new file mode 100644 index 00000000..155dcd44 --- /dev/null +++ b/doc/rsconf1_includeconfig.html @@ -0,0 +1,44 @@ +<html> +<head> +<title>rsyslog.conf file</title> +</head> +<body> +<h2>$IncludeConfig</h2> +<p><b>Type:</b> global configuration directive</p> +<p><b>Default:</b> </p> +<p><b>Description:</b></p> +<p>This directive allows to include other files into the main configuration file. As soon as an IncludeConfig directive is found, the contents of the new file is processed. IncludeConfigs can be nested. Please note that from a logical point of view the files are merged. Thus, if the include modifies some parameters (e.g. $DynaFileChacheSize), these new parameters are in place for the "calling" configuration file when the include is completed. To avoid any side effects, do a $ResetConfigVariables after the $IncludeConfig. It may also be a good idea to do a $ResetConfigVariables right at the start of the include, so that the module knows exactly what it does. Of course, one might specifically NOT do this to inherit parameters from the main file. As always, use it as it best fits...</p> +<p>If all regular files in the /etc/rsyslog.d directory are included, then files starting with "." are ignored - so you can use them to place comments into the dir (e.g. "/etc/rsyslog.d/.mycomment" will be ignored). <a href="http://sourceforge.net/tracker/index.php?func=detail&aid=1764088&group_id=123448&atid=696555">Michael Biebl had the idea to this functionality</a>. Let me quote hím:</p> +<blockquote> +<p><i>Say you can add an option<br> +$IncludeConfig /etc/rsyslog.d/<br> +(which probably would make a good default)<br> +to /etc/rsyslog.conf, which would then merge and include all *.conf files<br> +in /etc/rsyslog.d/.<br> +<br> +This way, a distribution can modify its packages easily to drop a simple<br> +config file into this directory upon installation.<br> +<br> +As an example, the network-manager package could install a simple config<br> +file /etc/rsyslog.d/network-manager.conf which would contain.<br> +:programname, contains, "NetworkManager" -/var/log/NetworkManager.log<br> +<br> +Upon uninstallation, the file could be easily removed again. This approach<br> +would be much cleaner and less error prone, than having to munge around<br> +with the /etc/rsyslog.conf file directly.</i></p> +</blockquote> +<p>Please note that in this description, only "*.conf" files would be read. The actual implementation, however, reads all files except for those starting with a dot. If you find this is a real big problem, please complain.</p> +<p><b>Sample:</b></p> +<p><code><b>$IncludeConfig /etc/some-included-file.conf</b></code></p> +<p>Directories can also be included. To do so, the name must end on a slash:</p> +<p><code><b>$IncludeConfig /etc/rsyslog.d/</b></code></p> + +<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 © 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> +</body> +</html>
\ No newline at end of file |