aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authoryaworsky <yaworsky>2005-10-26 04:59:51 +0000
committeryaworsky <yaworsky>2005-10-26 04:59:51 +0000
commit0f6fa595431267af5550a1b937b20f68957ca33f (patch)
tree0f7d4fab32930067e9b751e2df518df9997804d4 /doc
parent2bc65a6d5b3aa6c33e0322b6bcb786841859262b (diff)
downloadsyslog-win32-0f6fa595431267af5550a1b937b20f68957ca33f.tar.gz
syslog-win32-0f6fa595431267af5550a1b937b20f68957ca33f.tar.xz
syslog-win32-0f6fa595431267af5550a1b937b20f68957ca33f.zip
Implemented relaying.
Diffstat (limited to 'doc')
-rw-r--r--doc/src/configuration.xml49
1 files changed, 40 insertions, 9 deletions
diff --git a/doc/src/configuration.xml b/doc/src/configuration.xml
index eddd098..a29a210 100644
--- a/doc/src/configuration.xml
+++ b/doc/src/configuration.xml
@@ -117,6 +117,9 @@ name
<para>
Required.
The name of the destination.
+The type of destination may be either <quote>file</quote> or <quote>relay</quote>.
+It is determined by the presence of attributes <quote>file</quote>
+or <quote>collector</quote> respectively.
</para>
</listitem>
</varlistentry>
@@ -126,8 +129,8 @@ file
</term>
<listitem>
<para>
-Required.
-The pattern for the file name.
+The presence of this attribute defines destination type as <quote>file</quote>.
+The value of attribute is a pattern for the file name.
It may contain the following format characters:
<segmentedlist>
<?dbhtml list-presentation="table"?>
@@ -156,7 +159,7 @@ rotate
</term>
<listitem>
<para>
-Optional.
+File-specific, optional.
Rotate log files periodically.
Possible values are:
<emphasis>daily</emphasis>,
@@ -175,7 +178,7 @@ size
</term>
<listitem>
<para>
-Optional.
+File-specific, optional.
Log files are rotated when they grow bigger then <emphasis>size</emphasis> bytes.
If size is followed by M, the size if assumed to be in megabytes.
If the k is used, the size is in kilobytes.
@@ -189,7 +192,7 @@ backlogs
</term>
<listitem>
<para>
-Optional.
+File-specific, optional.
If rotation is turned on this attribute specifies the number of backlog files.
</para>
</listitem>
@@ -200,7 +203,7 @@ ifempty
</term>
<listitem>
<para>
-Optional.
+File-specific, optional.
Rotate the log file even if it is empty.
Possible values are: <emphasis>yes</emphasis>, <emphasis>no</emphasis>.
Default is <emphasis>yes</emphasis>.
@@ -213,7 +216,7 @@ olddir
</term>
<listitem>
<para>
-Optional.
+File-specific, optional.
Logs are moved to this directory for rotation.
If value is a relative path then this directory will be located in the same
directory with syslogd executable.
@@ -226,7 +229,7 @@ compresscmd
</term>
<listitem>
<para>
-Optional.
+File-specific, optional.
Command to use to compress log file.
</para>
</listitem>
@@ -237,13 +240,41 @@ compressoptions
</term>
<listitem>
<para>
-Optional.
+File-specific, optional.
Command line options may be passed to the compression program, if one is in use.
Options may contain $PATHNAME and $FILENAME substrings which will be replaced
with backlog pathname and basename respectively.
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>
+collector
+ </term>
+ <listitem>
+ <para>
+The presence of this attribute defines destination type as <quote>relay</quote>.
+The value of attribute is a name or IPv4 address of the collector optionally
+followed by the colon and port number.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+omit_hostname
+ </term>
+ <listitem>
+ <para>
+Relay-specific, optional.
+Do not include source hostname in the datagramm.
+Some syslog daemons by default do not rely on the hostname part of datagramm
+and insert actual sender hostname in the logged message.
+Note that ommiting hostname violates <ulink url="http://www.ietf.org/rfc/rfc3164.txt">RFC 3164</ulink>.
+Possible values are: <emphasis>yes</emphasis>, <emphasis>no</emphasis>.
+Default is <emphasis>no</emphasis>
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
</section>