← Back to branch summary

~ubuntu-branches/ubuntu/feisty/apache2/feisty

« back to all changes in this revision

Viewing changes to docs/man/rotatelogs.8

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Barth
  • Date: 2006-12-09 21:05:45 UTC
  • mfrom: (0.6.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20061209210545-h70s0xaqc2v8vqr2
Tags: 2.2.3-3.2
http://bugs.debian.org/396265
* Non-maintainer upload.
* 043_ajp_connection_reuse: Patch from upstream Bugzilla, fixing a critical
  issue with regard to connection reuse in mod_proxy_ajp.
  Closes: #396265

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2004-06-20" "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 ] \fIlogfile\fR [ \fIrotationtime\fR [ \fIoffset\fR ]] | [ \fIfilesize\fRM ]
 
31
 
 
32
 
 
33
.SH "SUMMARY"
 
34
 
 
35
.PP
 
36
rotatelogs is a simple program for use in conjunction with Apache's piped logfile feature\&. For example:
 
37
 
 
38
.nf
 
39
 
 
40
     CustomLog "|bin/rotatelogs /var/logs/logfile 86400" common
 
41
 
 
42
.fi
 
43
 
 
44
.PP
 
45
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\&.
 
46
 
 
47
.nf
 
48
 
 
49
     CustomLog "|bin/rotatelogs /var/logs/logfile 5M" common
 
50
 
 
51
.fi
 
52
 
 
53
.PP
 
54
This configuration will rotate the logfile whenever it reaches a size of 5 megabytes\&.
 
55
 
 
56
.nf
 
57
 
 
58
     ErrorLog "|bin/rotatelogs /var/logs/errorlog\&.%Y-%m-%d-%H_%M_%S 5M"
 
59
 
 
60
.fi
 
61
 
 
62
.PP
 
63
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\&.
 
64
 
 
65
 
 
66
.SH "OPTIONS"
 
67
 
 
68
 
 
69
.TP
 
70
-l
 
71
Causes the use of local time rather than GMT as the base for the interval\&. Note that using -l in an environment which changes the GMT offset (such as for BST or DST) can lead to unpredictable results!  
 
72
.TP
 
73
\fIlogfile\fR
 
74
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\&.  
 
75
.TP
 
76
\fIrotationtime\fR
 
77
The time between log file rotations in seconds\&.  
 
78
.TP
 
79
\fIoffset\fR
 
80
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\&.  
 
81
.TP
 
82
\fIfilesize\fRM
 
83
The maximum file size in megabytes followed by the letter M to specify size rather than time\&. Use this parameter in place of both rotationtime and offset\&.  
 
84
 
 
85
.SH "PORTABILITY"
 
86
 
 
87
.PP
 
88
The following logfile format string substitutions should be supported by all strftime(3) implementations, see the strftime(3) man page for library-specific extensions\&.
 
89
  
 
90
.Ip "\(bu \s-1%A\s0 \- full weekday name (localized)
 
91
 
 
92
.Ip "\(bu \s-1%a\s0 \- 3-character weekday name (localized)
 
93
 
 
94
.Ip "\(bu \s-1%B\s0 \- full month name (localized)
 
95
 
 
96
.Ip "\(bu \s-1%b\s0 \- 3-character month name (localized)
 
97
 
 
98
.Ip "\(bu \s-1%c\s0 \- date and time (localized)
 
99
 
 
100
.Ip "\(bu \s-1%d\s0 \- 2-digit day of month
 
101
 
 
102
.Ip "\(bu \s-1%H\s0 \- 2-digit hour (24 hour clock)
 
103
 
 
104
.Ip "\(bu \s-1%I\s0 \- 2-digit hour (12 hour clock)
 
105
 
 
106
.Ip "\(bu \s-1%j\s0 \- 3-digit day of year
 
107
 
 
108
.Ip "\(bu \s-1%M\s0 \- 2-digit minute
 
109
 
 
110
.Ip "\(bu \s-1%m\s0 \- 2-digit month
 
111
 
 
112
.Ip "\(bu \s-1%p\s0 \- am/pm of 12 hour clock (localized)
 
113
 
 
114
.Ip "\(bu \s-1%S\s0 \- 2-digit second
 
115
 
 
116
.Ip "\(bu \s-1%U\s0 \- 2-digit week of year (Sunday first day of week)
 
117
 
 
118
.Ip "\(bu \s-1%W\s0 \- 2-digit week of year (Monday first day of week)
 
119
 
 
120
.Ip "\(bu \s-1%w\s0 \- 1-digit weekday (Sunday first day of week)
 
121
 
 
122
.Ip "\(bu \s-1%X\s0 \- time (localized)
 
123
 
 
124
.Ip "\(bu \s-1%x\s0 \- date (localized)
 
125
 
 
126
.Ip "\(bu \s-1%Y\s0 \- 4-digit year
 
127
 
 
128
.Ip "\(bu \s-1%y\s0 \- 2-digit year
 
129
 
 
130
.Ip "\(bu \s-1%Z\s0 \- time zone name
 
131
 
 
132
.Ip "\(bu \s-1%%\s0 \- literal `%'
 
133