svn commit: r596884 - /httpd/httpd/trunk/docs/manual/programs/rotatelogs.xml

[tr...@apache.org]

Author: trawick
Date: Tue Nov 20 16:00:12 2007
New Revision: 596884

URL: http://svn.apache.org/viewvc?rev=596884&view=rev
Log:
correct the order of filesize and offset descriptions 
according to the current syntax diagram

try to clear up occasional confusion about the 
timestamps used in filenames when rotation is based
on a time interval

Modified:
    httpd/httpd/trunk/docs/manual/programs/rotatelogs.xml

Modified: httpd/httpd/trunk/docs/manual/programs/rotatelogs.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/programs/rotatelogs.xml?rev=596884&r1=596883&r2=596884&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/programs/rotatelogs.xml (original)
+++ httpd/httpd/trunk/docs/manual/programs/rotatelogs.xml Tue Nov 20 16:00:12 2007
@@ -27,7 +27,8 @@
 
 <summary>
      <p><code>rotatelogs</code> is a simple program for use in
-     conjunction with Apache's piped logfile feature.</p>
+     conjunction with Apache's piped logfile feature.  It supports
+     rotation based on a time interval or maximum size of the log.</p>
 </summary>
 
 <section id="synopsis"><title>Synopsis</title>
@@ -57,11 +58,24 @@
 <code>strftime(3)</code>.  Otherwise, the suffix
 <var>.nnnnnnnnnn</var> is automatically added and is the time in
 seconds.  Both formats compute the start time from the beginning of
-the current period.</dd>
+the current period.  For example, if a rotation time of 86400 is 
+specified, the hour, minute, and second fields created by
+<code>strftime(3)</code> format will all be zero, referring to the
+beginning of the current 24-hour period (midnight).</dd>
 
 <dt><code><var>rotationtime</var></code></dt>
 
-<dd>The time between log file rotations in seconds.</dd>
+<dd>The time between log file rotations in seconds.  The rotation
+occurs at the beginning of this interval.  For example, if the
+rotation time is 3600, the log file will be rotated at the beginning
+of every hour; if the rotation time is 86400, the log file will be
+rotated every night at midnight.  (If no data is logged during an
+interval, no file will be created.)</dd>
+
+<dt><code><var>filesize</var>M</code></dt>
+
+<dd>The maximum file size in megabytes followed by the letter
+<code>M</code> to specify size rather than time.</dd>
 
 <dt><code><var>offset</var></code></dt>
 
@@ -71,11 +85,6 @@
 In most cases, <code>-l</code> should be used instead of specifying
 an offset.</dd>
 
-<dt><code><var>filesize</var>M</code></dt>
-
-<dd>The maximum file size in megabytes followed by the letter
-<code>M</code> to specify size rather than time.  Use this parameter
-in place of rotationtime.</dd>
 </dl>
 </section>