.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "MODGZIP2DLF.IN 1"
.TH MODGZIP2DLF.IN 1 2025-09-28 "Lire 2.1.1" "LogReport's Lire Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
modgzip2dlf \- convert Common Log Format with mod_gzip extensions web server log files to DLF
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBmodgzip2dlf\fR \fIfile\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBmodgzip2dlf\fR converts web server log file in the common log format
with extensions for mod_gzip to www DLF.
.PP
mod_gzip is an Apache extension developed by RemoteCommunications,
Inc. Sourcecode is free available from
http://www.RemoteCommunications.com/apache/mod_gzip/mod_gzip. More
informations can be found at
http://www.RemoteCommunications.com/apache/mod_gzip/mod_gzip_faq.htm.
.PP
mod_gzip can log informations about the compression of pages by
configuring Apache to log using the \*(Aqgzip\*(Aq format which can be defined
as follows:
.PP
.Vb 1
\& LogFormat "%h %l %u %t \e"%r\e" %>s %b %{mod_gzip_result}n %{mod_gzip_compression_ratio}n" gzip
.Ve
.SH "MOD_GZIP EXTENSIONS"
.IX Header "MOD_GZIP EXTENSIONS"
The mod_gzip extensions adds two fields to the Common Log Format; see
\&\fBcommon2dlf\fR\|(1):
.PP
.Vb 1
\&  gzip_result compression_ratio
.Ve
.IP \fIgzip_result\fR 4
.IX Item "gzip_result"
The \fBgzip\fR\*(Aqs result code. Usually \fBOK\fR.
.IP \fIcompressio_ratio\fR 4
.IX Item "compressio_ratio"
The ratio by which the content was compressed. A number from 0 to 100.
.PP
Log example :
.PP
.Vb 2
\&  127.0.01 \- \- [11/03/2001 12:12:01 \-0400] "GET / HTTP/1.0" 200 252 "\-" "Mozilla/5.0" OK 49
\&  dsl1.myprovider.com \- francis [11/03/2001 12:14:01 \-0400] "GET /secret/ HTTP/1.0" 200 300 "http://www.example.com/index.html" "Mozilla/5.0" OK 74
.Ve
.SH EXAMPLES
.IX Header "EXAMPLES"
To process a log as produced in the modgzip logformat:
.PP
.Vb 1
\& $ modgzip2dlf < common.log
.Ve
.PP
modgzip2dlf will be rarely used on its own, but is more likely called
by lr_log2report:
.PP
.Vb 1
\& $ lr_log2report modgzip < /var/log/httpd/common.log
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBcommon2dlf\fR\|(1), \fBcombined\fR\|(2), \fBreferer2dlf\fR\|(1)
.SH AUTHORS
.IX Header "AUTHORS"
Joost van Baal <joostvb@logreport.org>, Francis J. Lacoste
<flacoste@logreport.org> and Egon Willighagen <egonw@logreport.org>,
based on an idea by Edwin Groothuis
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR modgzip2dlf.in,v 1.10 2006/07/23 13:16:36 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2000, 2001 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program (see COPYING); if not, check with
http://www.gnu.org/copyleft/gpl.html.