home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F278533_rotatelogs.xml < prev    next >
Extensible Markup Language  |  2004-09-04  |  6KB  |  139 lines
  1. <?xml version='1.0' encoding='UTF-8' ?>
  2. <!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4.  
  5. <!--
  6.  Copyright 2003-2004 The Apache Software Foundation
  7.  
  8.  Licensed under the Apache License, Version 2.0 (the "License");
  9.  you may not use this file except in compliance with the License.
  10.  You may obtain a copy of the License at
  11.  
  12.      http://www.apache.org/licenses/LICENSE-2.0
  13.  
  14.  Unless required by applicable law or agreed to in writing, software
  15.  distributed under the License is distributed on an "AS IS" BASIS,
  16.  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17.  See the License for the specific language governing permissions and
  18.  limitations under the License.
  19. -->
  20.  
  21. <manualpage metafile="rotatelogs.xml.meta">
  22. <parentdocument href="./">Programs</parentdocument>
  23.  
  24.   <title>rotatelogs - Piped logging program to rotate Apache logs</title>
  25.  
  26. <summary>
  27.      <p><code>rotatelogs</code> is a simple program for use in
  28.      conjunction with Apache's piped logfile feature.  For example:</p>
  29.  
  30. <example>
  31.      CustomLog "|bin/rotatelogs /var/logs/logfile 86400" common
  32. </example>
  33.      
  34.      <p>This creates the files /var/logs/logfile.nnnn where nnnn  is
  35.      the system time at which the log nominally starts (this time
  36.      will always be a multiple of the rotation time, so  you  can
  37.      synchronize cron scripts with it).  At the end of each rotation
  38.      time (here after 24 hours) a new log is started.</p>
  39.  
  40. <example>
  41.      CustomLog "|bin/rotatelogs /var/logs/logfile 5M" common
  42. </example>
  43.  
  44.      <p>This configuration will rotate the logfile whenever it reaches
  45.      a size of 5 megabytes.</p>
  46.    
  47. <example>
  48.      ErrorLog "|bin/rotatelogs /var/logs/errorlog.%Y-%m-%d-%H_%M_%S 5M"
  49. </example>
  50.      <p>This configuration will rotate the error logfile whenever it
  51.      reaches a size of 5 megabytes, and the suffix to the logfile name
  52.      will be created of the form
  53.      <code>errorlog.YYYY-mm-dd-HH_MM_SS</code>.</p>
  54.  
  55. </summary>
  56.  
  57. <section id="synopsis"><title>Synopsis</title>
  58.  
  59.      <p><code><strong>rotatelogs</strong>
  60.      [ -<strong>l</strong> ]
  61.      <var>logfile</var>
  62.      [ <var>rotationtime</var> [ <var>offset</var> ]] |
  63.      [ <var>filesize</var>M ]</code></p>
  64. </section>
  65.  
  66. <section id="options"><title>Options</title>
  67.  
  68. <dl>
  69.  
  70. <dt><code>-l</code> (<em>2.0.51 and later</em>)</dt>
  71. <dd>Causes the use of local time rather than GMT as the base for the
  72. interval. Note that using <code>-l</code> in an environment which changes the
  73. GMT offset (such as for BST or DST) can lead to unpredictable results!</dd>
  74.  
  75. <dt><code><var>logfile</var></code></dt>
  76.  
  77. <dd>The path plus basename of the logfile.  If <var>logfile</var>
  78. includes any '%' characters, it is treated as a format string for
  79. <code>strftime(3)</code>.  Otherwise, the suffix
  80. <var>.nnnnnnnnnn</var> is automatically added and is the time in
  81. seconds.  Both formats compute the start time from the beginning of
  82. the current period.</dd>
  83.  
  84. <dt><code><var>rotationtime</var></code></dt>
  85.  
  86. <dd>The time between log file rotations in seconds.</dd>
  87.  
  88. <dt><code><var>offset</var></code></dt>
  89.  
  90. <dd>The number of minutes offset from UTC.  If omitted, zero is
  91. assumed and UTC is used.  For example, to use local time in the zone
  92. UTC -5 hours, specify a value of <code>-300</code> for this argument.</dd>
  93.  
  94. <dt><code><var>filesize</var>M</code></dt>
  95.  
  96. <dd>The maximum file size in megabytes followed by the letter
  97. <code>M</code> to specify size rather than time.  Use this parameter
  98. in place of both rotationtime and offset.</dd>
  99. </dl>
  100. </section>
  101.  
  102. <section id="portability"><title>Portability</title>
  103.  
  104. <p>The following logfile format string substitutions should be
  105. supported by all <code>strftime(3)</code> implementations, see
  106. the <code>strftime(3)</code> man page for library-specific
  107. extensions.</p>
  108.  
  109. <table border="1" style="zebra">
  110. <tr><td><code>%A</code></td><td>full weekday name (localized)</td></tr>
  111. <tr><td><code>%a</code></td><td>3-character weekday name (localized)</td></tr>
  112. <tr><td><code>%B</code></td><td>full month name (localized)</td></tr>
  113. <tr><td><code>%b</code></td><td>3-character month name (localized)</td></tr>
  114. <tr><td><code>%c</code></td><td>date and time (localized)</td></tr>
  115. <tr><td><code>%d</code></td><td>2-digit day of month</td></tr>
  116. <tr><td><code>%H</code></td><td>2-digit hour (24 hour clock)</td></tr>
  117. <tr><td><code>%I</code></td><td>2-digit hour (12 hour clock)</td></tr>
  118. <tr><td><code>%j</code></td><td>3-digit day of year</td></tr>
  119. <tr><td><code>%M</code></td><td>2-digit minute</td></tr>
  120. <tr><td><code>%m</code></td><td>2-digit month</td></tr>
  121. <tr><td><code>%p</code></td><td>am/pm of 12 hour clock (localized)</td></tr>
  122. <tr><td><code>%S</code></td><td>2-digit second</td></tr>
  123. <tr><td><code>%U</code></td><td>2-digit week of year 
  124. (Sunday first day of week)</td></tr>
  125. <tr><td><code>%W</code></td><td>2-digit week of year 
  126. (Monday first day of week)</td></tr>
  127. <tr><td><code>%w</code></td><td>1-digit weekday 
  128. (Sunday first day of week)</td></tr>
  129. <tr><td><code>%X</code></td><td>time (localized)</td></tr>
  130. <tr><td><code>%x</code></td><td>date (localized)</td></tr>
  131. <tr><td><code>%Y</code></td><td>4-digit year</td></tr>
  132. <tr><td><code>%y</code></td><td>2-digit year</td></tr>
  133. <tr><td><code>%Z</code></td><td>time zone name</td></tr>
  134. <tr><td><code>%%</code></td><td>literal `%'</td></tr>
  135. </table>
  136.  
  137. </section>
  138. </manualpage>
  139.