granicus.if.org Git - apache/blob - docs/man/rotatelogs.8

   1 .\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   2 .\" DO NOT EDIT! Generated from XML source.
   3 .\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   4 .de Sh \" Subsection
   5 .br
   6 .if t .Sp
   7 .ne 5
   8 .PP
   9 \fB\\$1\fR
  10 .PP
  11 ..
  12 .de Sp \" Vertical space (when we can't use .PP)
  13 .if t .sp .5v
  14 .if n .sp
  15 ..
  16 .de Ip \" List item
  17 .br
  18 .ie \\n(.$>=3 .ne \\$3
  19 .el .ne 3
  20 .IP "\\$1" \\$2
  21 ..
  22 .TH "ROTATELOGS" 8 "2007-12-09" "Apache HTTP Server" "rotatelogs"
  23
  24 .SH NAME
  25 rotatelogs \- Piped logging program to rotate Apache logs
  26
  27 .SH "SYNOPSIS"
  28
  29 .PP
  30 \fBrotatelogs\fR [ -\fBl\fR ] [ -\fBf\fR ] \fIlogfile\fR \fIrotationtime\fR|\fIfilesize\fRM [ \fIoffset\fR ]
  31
  32
  33 .SH "SUMMARY"
  34
  35 .PP
  36 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\&.
  37
  38
  39 .SH "OPTIONS"
  40
  41
  42 .TP
  43 -l
  44 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!
  45 .TP
  46 -f
  47 Causes the logfile to be immediately opened as soon as rotatelogs starts (instead of waiting for the first log entry)
  48 .TP
  49 \fIlogfile\fR
  50 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)\&.
  51 .TP
  52 \fIrotationtime\fR
  53 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\&.)
  54 .TP
  55 \fIfilesize\fRM
  56 The maximum file size in megabytes followed by the letter M to specify size rather than time\&.
  57 .TP
  58 \fIoffset\fR
  59 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\&.
  60
  61 .SH "EXAMPLES"
  62
  63 .nf
  64
  65      CustomLog "|bin/rotatelogs /var/logs/logfile 86400" common
  66
  67 .fi
  68
  69 .PP
  70 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\&.
  71
  72 .nf
  73
  74      CustomLog "|bin/rotatelogs -l /var/logs/logfile\&.%Y\&.%m\&.%d 86400" common
  75
  76 .fi
  77
  78 .PP
  79 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\&.
  80
  81 .nf
  82
  83      CustomLog "|bin/rotatelogs /var/logs/logfile 5M" common
  84
  85 .fi
  86
  87 .PP
  88 This configuration will rotate the logfile whenever it reaches a size of 5 megabytes\&.
  89
  90 .nf
  91
  92      ErrorLog "|bin/rotatelogs /var/logs/errorlog\&.%Y-%m-%d-%H_%M_%S 5M"
  93
  94 .fi
  95
  96 .PP
  97 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\&.
  98
  99 .SH "PORTABILITY"
 100
 101 .PP
 102 The following logfile format string substitutions should be supported by all strftime(3) implementations, see the strftime(3) man page for library-specific extensions\&.
 103
 104 .Ip "\(bu \s-1%A\s0 \- full weekday name (localized)
 105
 106 .Ip "\(bu \s-1%a\s0 \- 3-character weekday name (localized)
 107
 108 .Ip "\(bu \s-1%B\s0 \- full month name (localized)
 109
 110 .Ip "\(bu \s-1%b\s0 \- 3-character month name (localized)
 111
 112 .Ip "\(bu \s-1%c\s0 \- date and time (localized)
 113
 114 .Ip "\(bu \s-1%d\s0 \- 2-digit day of month
 115
 116 .Ip "\(bu \s-1%H\s0 \- 2-digit hour (24 hour clock)
 117
 118 .Ip "\(bu \s-1%I\s0 \- 2-digit hour (12 hour clock)
 119
 120 .Ip "\(bu \s-1%j\s0 \- 3-digit day of year
 121
 122 .Ip "\(bu \s-1%M\s0 \- 2-digit minute
 123
 124 .Ip "\(bu \s-1%m\s0 \- 2-digit month
 125
 126 .Ip "\(bu \s-1%p\s0 \- am/pm of 12 hour clock (localized)
 127
 128 .Ip "\(bu \s-1%S\s0 \- 2-digit second
 129
 130 .Ip "\(bu \s-1%U\s0 \- 2-digit week of year (Sunday first day of week)
 131
 132 .Ip "\(bu \s-1%W\s0 \- 2-digit week of year (Monday first day of week)
 133
 134 .Ip "\(bu \s-1%w\s0 \- 1-digit weekday (Sunday first day of week)
 135
 136 .Ip "\(bu \s-1%X\s0 \- time (localized)
 137
 138 .Ip "\(bu \s-1%x\s0 \- date (localized)
 139
 140 .Ip "\(bu \s-1%Y\s0 \- 4-digit year
 141
 142 .Ip "\(bu \s-1%y\s0 \- 2-digit year
 143
 144 .Ip "\(bu \s-1%Z\s0 \- time zone name
 145
 146 .Ip "\(bu \s-1%%\s0 \- literal `%'
 147