From: Joshua Slive Date: Mon, 21 Apr 2003 22:17:45 +0000 (+0000) Subject: Convert rotatelogs docs to xml. X-Git-Tag: pre_ajp_proxy~1810 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=383b72fdea6fdbda90cdfca32f11c003eb447fd5;p=apache Convert rotatelogs docs to xml. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@99489 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/programs/rotatelogs.html.en b/docs/manual/programs/rotatelogs.html.en new file mode 100644 index 0000000000..8d5d7baa8a --- /dev/null +++ b/docs/manual/programs/rotatelogs.html.en @@ -0,0 +1,123 @@ + + + +rotatelogs - Piped logging program to rotate Apache logs - Apache HTTP Server + + + + + +
<-
+
+Apache > HTTP Server > Documentation > Version 2.1 > Programs

rotatelogs - Piped logging program to rotate Apache logs

+

rotatelogs is a simple program for use in + conjunction with Apache's piped logfile feature. For example:

+ +

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

+ +

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 rota- + tion time (here after 24 hours) a new log is started.

+ +

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

+ +

This configuration will rotate the logfile whenever it reaches + a size of 5 megabytes.

+ +
+ +
top
+
+

Synopsis

+ +

rotatelogs logfile + [rotationtime [offset]] | + [filesizeM]

+
top
+
+

Options

+ +
+ +
logfile
+ +
The path plus basename of the logfile. If logfile +includes any '%' characters, it is treated as a format string for +strftime(3). Otherwise, the suffix +.nnnnnnnnnn is automatically added and is the time in +seconds. Both formats compute the start time from the beginning of +the current period.
+ +
rotationtime
+ +
The time between log file rotations in seconds.
+ +
offset
+ +
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.
+ +
filesizeM
+ +
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.
+
+
top
+
+

Portability

+ +

The following logfile format string substitutions should be +supported by all strftime(3) implementations, see +the strftime(3) man page for library-specific +extensions.

+ + + + + + + + + + + + + + + + + + + + + + + +
%Afull weekday name (localized)
%a3-character weekday name (localized)
%Bfull month name (localized)
%b3-character month name (localized)
%cdate and time (localized)
%d2-digit day of month
%H2-digit hour (24 hour clock)
%I2-digit hour (12 hour clock)
%j3-digit day of year
%M2-digit minute
%m2-digit month
%pam/pm of 12 hour clock (localized)
%S2-digit second
%U2-digit week of year +(Sunday first day of week)
%W2-digit week of year +(Monday first day of week)
%w1-digit weekday +(Sunday first day of week)
%Xtime (localized)
%xdate (localized)
%Y4-digit year
%y2-digit year
%Ztime zone name
%%literal `%'
+ +
+ + \ No newline at end of file diff --git a/docs/manual/programs/rotatelogs.xml b/docs/manual/programs/rotatelogs.xml new file mode 100644 index 0000000000..50109bf1c4 --- /dev/null +++ b/docs/manual/programs/rotatelogs.xml @@ -0,0 +1,106 @@ + + + + +Programs + + rotatelogs - Piped logging program to rotate Apache logs + + +

rotatelogs is a simple program for use in + conjunction with Apache's piped logfile feature. For example:

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

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 rota- + tion time (here after 24 hours) a new log is started.

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

This configuration will rotate the logfile whenever it reaches + a size of 5 megabytes.

+ +
+ +
Synopsis + +

rotatelogs logfile + [rotationtime [offset]] | + [filesizeM]

+
+ +
Options + +
+ +
logfile
+ +
The path plus basename of the logfile. If logfile +includes any '%' characters, it is treated as a format string for +strftime(3). Otherwise, the suffix +.nnnnnnnnnn is automatically added and is the time in +seconds. Both formats compute the start time from the beginning of +the current period.
+ +
rotationtime
+ +
The time between log file rotations in seconds.
+ +
offset
+ +
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.
+ +
filesizeM
+ +
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.
+
+
+ +
Portability + +

The following logfile format string substitutions should be +supported by all strftime(3) implementations, see +the strftime(3) man page for library-specific +extensions.

+ + + + + + + + + + + + + + + + + + + + + + + + +
%Afull weekday name (localized)
%a3-character weekday name (localized)
%Bfull month name (localized)
%b3-character month name (localized)
%cdate and time (localized)
%d2-digit day of month
%H2-digit hour (24 hour clock)
%I2-digit hour (12 hour clock)
%j3-digit day of year
%M2-digit minute
%m2-digit month
%pam/pm of 12 hour clock (localized)
%S2-digit second
%U2-digit week of year +(Sunday first day of week)
%W2-digit week of year +(Monday first day of week)
%w1-digit weekday +(Sunday first day of week)
%Xtime (localized)
%xdate (localized)
%Y4-digit year
%y2-digit year
%Ztime zone name
%%literal `%'
+ +
+
\ No newline at end of file diff --git a/docs/manual/programs/rotatelogs.xml.meta b/docs/manual/programs/rotatelogs.xml.meta new file mode 100644 index 0000000000..5f765afbac --- /dev/null +++ b/docs/manual/programs/rotatelogs.xml.meta @@ -0,0 +1,11 @@ + + + + rotatelogs + /programs/ + .. + + + en + +