.\" 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 "LIRE.IN 1" .TH LIRE.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" lire \- Lire interface .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBlire\fR .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBlire\fR has two purposes: it configures Lire, and it enables automatic report generation. .PP \&\fBlire\fR is a menu driven application. You should use the \s-1TAB\s0 key to navigate across the various interface elements. The arrow keys should be used to navigate menus. The main menubar can be accessed at all times using F10. The mouse might be available depending on your terminal and the implementation of the Curses::UI module of your system. .SS "configuring Lire" .IX Subsection "configuring Lire" The 'Preferences' menu item in the 'Lire' menu will give you access to all the Lire settings. The lire command edits or creates ~/.lire/config.xml. .SS "automatic report generation" .IX Subsection "automatic report generation" \&\fBlire\fR enables automatic report generation by creating and managing \s-1DLF\s0 stores. A \fI\s-1DLF\s0 store\fR is a log repository. In a \s-1DLF\s0 store, you can configure ImportJobs and ReportJobs that will be executed regularly. Store configuration is saved in store/config.xml. .PP An \fIImportJob\fR is a job that will import log data into the \s-1DLF\s0 store. This data will be used later to generate the reports. .PP \&\fIReportJobs\fR should be used to generate periodical reports. Reports are generated from the \s-1DLF\s0 streams available in your \s-1DLF\s0 store. The report can be generated for different schedules. Lire supports 5 different schedules: hourly, daily, weekly, monthly and yearly. .PP You will need to select the report configuration file to use for each schedule. Defaults are located in /lire/, which you should use as templates that you need to customize according to your purpose. .PP The reports can be generated either from the log data imported in the database or from previously generated \fBdaily\fR reports. This is useful when you have lots of log data and you don't want to keep all the raw data available. The source is selected automatically based on data availability. You should note however that only 'daily' reports are considered as a data source for other reports (making that possible only with weekly or longer schedules). .PP When executed, a ReportSchedule will only generate the report and save it in the \s-1DLF\s0 store. If you want to obtain a formatted copy of the report, you will need to configure one or more \fIOutputJobs\fR. .PP Two types of OutputJob are supported: .PP 1\- The report can be sent by email to one or more address; .PP 2\- or it can saved in a file on the disk. A useful configuration is to generate \s-1HTML\s0 reports in a directory published on a web site. When using a \*(L"file\*(R" OutputJob you will probably want to use \fBstrftime\fR\|(3) expansion so that the filename is different each time the report is generated. The most common expansions are: .PP .Vb 5 \& %Y \- fou digits year (2000); \& %m \- two\-digits month number (01 for january); \& %V \- ISO week number; \& %d \- day of the month number; \& %H \- hour of day (01\-23). .Ve .PP Also, contrary to the lr_log2report command, \s-1HTML\s0 reports are generated into a directory (not as a tar file). .PP To run the scheduled jobs, you will need to setup cron jobs. Use \fBlr_cron\fR\|(1) to process the configured jobs in a store. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBlire\fR\|(7), \fBlr_cron\fR\|(1), Lire User's Manual .SH "AUTHORS" .IX Header "AUTHORS" Francis J. Lacoste Wolfgang Sourdeau .SH "VERSION" .IX Header "VERSION" \&\f(CW$Id:\fR lire.in,v 1.10 2006/07/23 13:16:32 vanbaal Exp $ .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 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 \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.