.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
.\" DO NOT EDIT! Generated from XML source.
.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "ROTATELOGS" 8 "2007-12-09" "Apache HTTP Server" "rotatelogs"

.SH NAME
rotatelogs \- Piped logging program to rotate Apache logs

.SH "SYNOPSIS"
 
.PP
\fBrotatelogs\fR [ -\fBl\fR ] \fIlogfile\fR \fIrotationtime\fR|\fIfilesize\fRM [ \fIoffset\fR ]
 

.SH "SUMMARY"
 
.PP
rotatelogs is a simple program for use in conjunction with Apache's piped logfile feature\&. It supports rotation based on a time interval or maximum size of the log\&.
 

.SH "OPTIONS"
 
 
.TP
-l
Causes the use of local time rather than GMT as the base for the interval or for strftime(3) formatting with size-based rotation\&. Note that using -l in an environment which changes the GMT offset (such as for BST or DST) can lead to unpredictable results!  
.TP
\fIlogfile\fR
The path plus basename of the logfile\&. If \fIlogfile\fR includes any '%' characters, it is treated as a format string for strftime(3)\&. Otherwise, the suffix \fI\&.nnnnnnnnnn\fR is automatically added and is the time in seconds\&. Both formats compute the start time from the beginning of the current period\&. For example, if a rotation time of 86400 is specified, the hour, minute, and second fields created from the strftime(3) format will all be zero, referring to the beginning of the current 24-hour period (midnight)\&.  
.TP
\fIrotationtime\fR
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\&.)  
.TP
\fIfilesize\fRM
The maximum file size in megabytes followed by the letter M to specify size rather than time\&.  
.TP
\fIoffset\fR
The number of minutes offset from UTC\&. If omitted, zero is assumed and UTC is used\&. For example, to use local time in the zone UTC -5 hours, specify a value of -300 for this argument\&. In most cases, -l should be used instead of specifying an offset\&.  
 
.SH "EXAMPLES"
 
.nf

     CustomLog "|bin/rotatelogs /var/logs/logfile 86400" common

.fi
 
.PP
This creates the files /var/logs/logfile\&.nnnn where nnnn is the system time at which the log nominally starts (this time will always be a multiple of the rotation time, so you can synchronize cron scripts with it)\&. At the end of each rotation time (here after 24 hours) a new log is started\&.
 
.nf

     CustomLog "|bin/rotatelogs -l /var/logs/logfile\&.%Y\&.%m\&.%d 86400" common

.fi
 
.PP
This creates the files /var/logs/logfile\&.yyyy\&.mm\&.dd where yyyy is the year, mm is the month, and dd is the day of the month\&. Logging will switch to a new file every day at midnight, local time\&.
 
.nf

     CustomLog "|bin/rotatelogs /var/logs/logfile 5M" common

.fi
 
.PP
This configuration will rotate the logfile whenever it reaches a size of 5 megabytes\&.
 
.nf

     ErrorLog "|bin/rotatelogs /var/logs/errorlog\&.%Y-%m-%d-%H_%M_%S 5M"

.fi
 
.PP
This configuration will rotate the error logfile whenever it reaches a size of 5 megabytes, and the suffix to the logfile name will be created of the form errorlog\&.YYYY-mm-dd-HH_MM_SS\&.
 
.SH "PORTABILITY"
 
.PP
The following logfile format string substitutions should be supported by all strftime(3) implementations, see the strftime(3) man page for library-specific extensions\&.
  
.Ip "\(bu \s-1%A\s0 \- full weekday name (localized)
 
.Ip "\(bu \s-1%a\s0 \- 3-character weekday name (localized)
 
.Ip "\(bu \s-1%B\s0 \- full month name (localized)
 
.Ip "\(bu \s-1%b\s0 \- 3-character month name (localized)
 
.Ip "\(bu \s-1%c\s0 \- date and time (localized)
 
.Ip "\(bu \s-1%d\s0 \- 2-digit day of month
 
.Ip "\(bu \s-1%H\s0 \- 2-digit hour (24 hour clock)
 
.Ip "\(bu \s-1%I\s0 \- 2-digit hour (12 hour clock)
 
.Ip "\(bu \s-1%j\s0 \- 3-digit day of year
 
.Ip "\(bu \s-1%M\s0 \- 2-digit minute
 
.Ip "\(bu \s-1%m\s0 \- 2-digit month
 
.Ip "\(bu \s-1%p\s0 \- am/pm of 12 hour clock (localized)
 
.Ip "\(bu \s-1%S\s0 \- 2-digit second
 
.Ip "\(bu \s-1%U\s0 \- 2-digit week of year (Sunday first day of week)
 
.Ip "\(bu \s-1%W\s0 \- 2-digit week of year (Monday first day of week)
 
.Ip "\(bu \s-1%w\s0 \- 1-digit weekday (Sunday first day of week)
 
.Ip "\(bu \s-1%X\s0 \- time (localized)
 
.Ip "\(bu \s-1%x\s0 \- date (localized)
 
.Ip "\(bu \s-1%Y\s0 \- 4-digit year
 
.Ip "\(bu \s-1%y\s0 \- 2-digit year
 
.Ip "\(bu \s-1%Z\s0 \- time zone name
 
.Ip "\(bu \s-1%%\s0 \- literal `%'