.\" -*- 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_XML2MAIL.IN 1"
.TH LR_XML2MAIL.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_xml2mail \- Formats a XML report and sends it by email
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBlr_xml2mail\fR \fB[\fR\fIoptions\fR\fB]\fR \fIreport.xml\fR \fIrecipieint\fR...
.PP
\&\fBlr_xml2mail\fR \fB\-\-version\fR
.PP
\&\fBlr_xml2mail\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\-\-output\-format\fR \fIoutput format\fR" 4
.IX Item "--output-format 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 template named \fIname\fR to merge the
reports. This option is required when using the \fB\-\-merge\fR option to
merge reports.
.IP "\fB\-\-merge\fR \fIreport_file\fR" 4
.IX Item "--merge report_file"
Merge \fIreport_file\fR before formatting the report. This option can be
used multiple times to merge more than two reports.
.IP "\fB\-\-subject\fR \fIsubject\fR" 4
.IX Item "--subject 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"
\&\fBlr_xml2mail\fR formats the XML reports generated by Lire to various
output format and sends it by email to the recipients specified as
remaining arguments.
.PP
The command will make sure the report is MIME encapsulated
properly depending on the output format chosen. For example, a PDF
report will be sent as an attachment and (X)HTML output will appear as
an HTML mail message. The content\-type of the MIME message will also
be set properly.
.PP
From and Reply\-To headers are initialized from the \f(CW\*(C`lr_from\*(C'\fR and
\&\f(CW\*(C`lr_reply_to\*(C'\fR configuration variables.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBlr_log2mail\fR\|(1), \fBlr_log2report\fR\|(1), \fBlr_xml2report\fR\|(1), \fBlire\fR\|(1), \fBlire\fR\|(7),
documentation in the Lire User Manual
.SH AUTHOR
.IX Header "AUTHOR"
.Vb 1
\&  Francis J. Lacoste <flacoste@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR lr_xml2mail.in,v 1.23 2006/07/23 13:16:33 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2002\-2004 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.