.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "LR_LOG2REPORT.IN 1"
.TH LR_LOG2REPORT.IN 1 "2020-07-07" "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"
lr_log2report \- generates a report from a log file
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBlr_log2report\fR \fB[\fR\fIoptions\fR\fB]\fR \fIdlf_converter\fR \fB[\fR \fIlogfile\fR \fB]\fR \fB[\fR \fIoutput_file\fR \fB]\fR
.PP
\&\fBlr_log2report\fR \fB\-\-version\fR
.PP
\&\fBlr_log2report\fR \fB\-\-help\fR \fB[dlf\-converters|output\-formats|report\-templates]\fR
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-\-help\fR \fB[\fR\fIsection\fR\fB]\fR" 4
.IX Item "--help [section]"
If no argument is given, prints usage information and exits. Argument
can be one of the following:
.RS 4
.IP "dlf-converters" 4
.IX Item "dlf-converters"
Prints the list of available \s-1DLF\s0 converters and exits.
.IP "output-formats" 4
.IX Item "output-formats"
Prints the list of available output formats and exits.
.IP "report-templates" 4
.IX Item "report-templates"
Prints the list of available report templates and exits.
.RE
.RS 4
.RE
.IP "\fB\-\-version\fR" 4
.IX Item "--version"
Prints Lire's version and exits.
.IP "\fB\-\-output\-format|\-o\fR \fIoutput format\fR" 4
.IX Item "--output-format|-o output format"
Selects the ouput format in which to generate the report.
.IP "\fB\-\-template|\-t\fR \fIname\fR" 4
.IX Item "--template|-t name"
Uses the report configuration named \fIname\fR to generate the report.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBlr_log2report\fR reads a log file from \s-1STDIN\s0 or the specified argument
and will output a formatted Lire report on \s-1STDOUT\s0 or in the
\&\fIoutput_file\fR argument. The format of the log file is specified using
the \fIdlf_converter\fR argument. Use the \fB\-\-help dlf-converters\fR option
to get a list of all currently available \s-1DLF\s0 converters.
.PP
In case the log is passed in a compressed format, it's uncompressed on the fly,
using \fBgzip\fR\|(1).
.PP
\&\s-1WARNING:\s0 This command outputs binary data on the terminal for all
output formats except \fBtxt\fR and \fBxml\fR. You should redirect
stdout to a file when using those output formats.
.PP
In the case where \fIoutput format\fR is \fBhtml\fR, the \fIoutput_file\fR argument will
be interpreted as a directory name.  This directory will get created if needed,
and will hold the various html files.  In case this argument is omitted, a
\&\fBtar\fR\|(1) file should be output on \s-1STDOUT\s0 (but see the \s-1BUGS\s0 section).
.PP
\&\s-1WARNING:\s0 Running this command on big logfiles generally means you'll need
lots of free diskspace.  See \fBLire::LrCommand\fR\|(3pm) for details.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
To process a Postfix log and display the report as text, use
.PP
.Vb 1
\& $ lr_log2report postfix /var/log/mail.log
.Ve
.PP
To process a Postfix log and create an \s-1HTML\s0 report in a directory, use
.PP
.Vb 1
\& $ lr_log2report \-o html postfix /var/log/mail.log postfix\-report
.Ve
.SH "BUGS"
.IX Header "BUGS"
If
.PP
.Vb 1
\& \-\-output html
.Ve
.PP
is specified, both \fIlogfile\fR and \fIoutput_file\fR need to be specified.
Specifying \f(CW\*(C`\-\*(C'\fR (or \f(CW\*(C`/dev/stdin\*(C'\fR) as \fIlogfile\fR is supported.  So this
.PP
.Vb 2
\& $ tai64nfrac < /var/log/qmail\-send/current | \e
\&    lr_log2report qmail \-\-output html \- /tmp/report
.Ve
.PP
will work.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBlr_log2mail\fR\|(1), \fBlr_xml2report\fR\|(1), \fBlr_xml2mail\fR\|(1), \fBlire\fR\|(1), \fBlire\fR\|(7),
\&\fBLire::LrCommand\fR\|(3pm), documentation in the Lire User Manual
.SH "AUTHORS"
.IX Header "AUTHORS"
.Vb 2
\&  Joost van Baal <joostvb@logreport.org>
\&  Francis J. Lacoste <flacoste@logreport.org>
.Ve
.SH "VERSION"
.IX Header "VERSION"
\&\f(CW$Id:\fR lr_log2report.in,v 1.100 2006/10/04 10:19:17 vanbaal Exp $
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2000\-2004 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This program is part of Lire.
.PP
Lire is free software; you can redistribute it and/or modify
it under the terms of the \s-1GNU\s0 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 \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0  See the
\&\s-1GNU\s0 General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program (see \s-1COPYING\s0); if not, check with
http://www.gnu.org/copyleft/gpl.html.