LR_LOG2REPORT.IN(1)

πŸ“¦ version 2.1.1, in arch rolling

πŸ’… lr_log2report β€” LogReport's Lire Documentation, bestie edition ✨

okay so real talk: this is lr_log2report from the Lire docs, and she generates a report from a log file. That's the whole vibe. Let's get into it 🫢


🌸 NAME 🌸

lr_log2report β€” literally generates a report from a log file, no cap πŸ’–


✨ SYNOPSIS ✨

lr_log2report [options] dlf_converter [ logfile ] [ output_file ]

lr_log2report --version

lr_log2report --help [dlf-converters|output-formats|report-templates]

πŸŽ€ OPTIONS πŸŽ€

  • --help [section] β€” if you don't give her an argument, she prints usage info and dips. But the argument can be one of these iconic little numbers:
    • dlf-converters β€” prints the list of available DLF converters and exits πŸ‘‘
    • output-formats β€” prints the list of available output formats and exits 🌈
    • report-templates β€” prints the list of available report templates and exits πŸŽ€
  • --version β€” prints Lire's version and exits. that's it, that's the whole job πŸ’…
  • --output-format|-o output format β€” selects the output format she's gonna generate the report in ✨
  • --template|-t name β€” uses the report configuration named name to generate the report πŸ¦‹

πŸ’– DESCRIPTION πŸ’–

So lr_log2report reads a log file from STDIN, or from the argument you passed her, and outputs a formatted Lire report on STDOUT or into the output_file argument. The format of the log file gets specified using the dlf_converter argument. And if you wanna see a list of all the currently available DLF converters, just hit her with the --help dlf-converters option, iykyk πŸ’«

If your log comes in compressed, no worries bestie β€” she uncompresses it on the fly, using gzip(1). slay 🧚

WARNING βš οΈπŸ’€: this command outputs binary data on the terminal for all output formats except txt and xml. So when you're using those other formats, you should redirect stdout to a file. not me warning you twice, fr fr.

In the case where the output format is html, the output_file argument gets interpreted as a directory name. That directory gets created if needed, and it'll hold the various html files. And in case this argument is omitted, a tar(1) file should be output on STDOUT β€” but see the BUGS section below, because πŸ‘€

WARNING ⚠️πŸ”₯: running this command on big logfiles generally means you'll need lots of free diskspace. See Lire::LrCommand(3pm) for the details, bestie 🌸

⭐ EXAMPLES ⭐

To process a Postfix log and display the report as text, use:

$ lr_log2report postfix /var/log/mail.log

To process a Postfix log and create an HTML report in a directory, use:

$ lr_log2report -o html postfix /var/log/mail.log postfix-report

ate, no crumbs πŸ’…


πŸ™ˆ BUGS πŸ™ˆ

If

--output html

is specified, then both logfile and output_file need to be specified. And specifying "-" (or "/dev/stdin") as logfile is supported, so this:

$ tai64nfrac < /var/log/qmail-send/current | \
   lr_log2report qmail --output html - /tmp/report

will work. periodt πŸ’œ


πŸ¦‹ SEE ALSO πŸ¦‹

lr_log2mail(1), lr_xml2report(1), lr_xml2mail(1), lire(1), lire(7), Lire::LrCommand(3pm), and the documentation in the Lire User Manual πŸ“šβœ¨


πŸ‘‘ AUTHORS πŸ‘‘

  • Joost van Baal <joostvb@logreport.org>
  • Francis J. Lacoste <flacoste@logreport.org>

🌈 VERSION 🌈

$Id: lr_log2report.in,v 1.100 2006/10/04 10:19:17 vanbaal Exp $

Copyright (C) 2000-2004 Stichting LogReport Foundation LogReport@LogReport.org

This program is part of Lire.

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.

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.

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.


and that's the whole page, bestie πŸ«ΆπŸ’– this was Lire 2.1.1, dated 2025-09-28 β€” main character documentation energy only, mwah πŸ’‹βœ¨

πŸ“¦ where this page comes from