.\" -*- 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_LOG2MAIL.IN 1"
.TH LR_LOG2MAIL.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_log2mail \- send a report generated from a log file by email
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBlr_log2mail\fR \fB[\fR\f(BIoptions\fR\fB]\fR \fIservice\fR \fIaddresses\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\fR \fIname\fR" 4
.IX Item "--template name"
Uses the report configuration named \fIname\fR to generate the report.
.IP "\fB\-\-log\-file\fR \fIlogfile\fR" 4
.IX Item "--log-file logfile"
Selects the log file that should be processed instead of STDIN.
.IP "\fB\-\-subject|\-s\fR \fIsubject\fR" 4
.IX Item "--subject|-s subject"
Sets the subject of the email message. Defaults to \*(AqYour \fIformat\fR report\*(Aq.
.IP "\fB\-\-extra\-file\fR \fIfile\fR" 4
.IX Item "--extra-file file"
An additional text file that will be sent along the report. If the
output format is txt, it will be appended to the report.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBlr_log2mail\fR command is similar to the \fBlr_log2report\fR\|(1) command
with the difference that the report is sent by email. The log file is
read from STDIN or from the file specified using the \fB\-\-log\-file\fR
option. 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. All remaining
arguments are interpreted as email addresses to which to send the
report. In case the log is passed in a compressed format, it\*(Aqs
uncompressed on the fly, using \fBgzip\fR\|(1).
.PP
The report will be encapsulated in a MIME email appropriate for the
output format. For example, ASCII reports will be sent inline, PDF
reports will be sent as a file attachment and HTML reports should
appear inline in a HTML\-capable mail reader.
.PP
The From and Reply\-To headers in the outgoing emails are set to the
values of the \fIlr_mail_from\fR and \fIlr_mail_replyto\fR configuration
variables.
.SH EXAMPLE
.IX Header "EXAMPLE"
.Vb 2
\& % lr_log2mail \-s "bind8 report" bind8_query \e
\&     root "Joe User <joe@example.com>" < /var/log/query.log
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBlr_log2report\fR\|(1), \fBlr_xml2report\fR\|(1), \fBlr_xml2mail\fR\|(1), \fBlire\fR\|(1), \fBlire\fR\|(7),
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_log2mail.in,v 1.60 2006/07/23 13:16:33 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.