.\" -*- 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 "LR_LOG2REPORT.IN 1"
.TH LR_LOG2REPORT.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
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 DLF 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\*(Aqs 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 STDIN or the specified argument
and will output a formatted Lire report on STDOUT 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 DLF converters.
.PP
In case the log is passed in a compressed format, it\*(Aqs uncompressed on the fly,
using \fBgzip\fR\|(1).
.PP
WARNING: 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 STDOUT (but see the BUGS section).
.PP
WARNING: Running this command on big logfiles generally means you\*(Aqll 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 HTML 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 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.