[COMMIT LOGREPORT] service/all/man lire.pod,1.3,1.4
Joost van Baal
vanbaal at users.sourceforge.net
Thu Jul 20 14:30:23 CEST 2006
Update of /cvsroot/logreport/service/all/man
In directory sc8-pr-cvs6.sourceforge.net:/tmp/cvs-serv6393
Modified Files:
lire.pod
Log Message:
update to current situation (actually to situation since 2.0rc1 - August 30 2004):
the Lire platform-specific faq is gone; We ship lr_cron; Lots of lr_* scripts are
now maintained as Perl modules; Lots of Dlf convertors are now shipped as Perl
modules.
Index: lire.pod
===================================================================
RCS file: /cvsroot/logreport/service/all/man/lire.pod,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- lire.pod 7 Apr 2004 20:44:59 -0000 1.3
+++ lire.pod 20 Jul 2006 12:30:21 -0000 1.4
@@ -16,12 +16,6 @@
with the Lire tarball, lire-I<version>.tar.gz. It is available from the World
Wide Web at http://logreport.org/pub/current/INSTALL.
-Some platform-specific hints are documented in the B<Frequently Asked Question
-About Lire>, which gets installed - in various different formats - in
-/usr/[local/]share/doc/lire/faq*. In the Lire tarball, it resides in /doc/faq*
-. It is available online too, at http://logreport.org/pub/current/doc/faq/ .
-
-
=head2 Documentation for users
Read the Lire B<README> file for a quick start on Lire's usage. This file is
@@ -34,15 +28,13 @@
/usr/[local/]share/doc/lire/user-manual* . It is available online, at
http://logreport.org/pub/current/doc/user-manual/ .
-The main Lire commands (lire(1), lr_log2mail(1), lr_log2report(1),
-lr_run(1), lr_xml2report(1), ...) should be in your PATH. The usage of these
+The main Lire commands (lire(1), lr_cron(1), lr_log2mail(1), lr_log2report(1),
+lr_xml2report(1), ...) should be in your PATH. The usage of these
commands is documented in man pages; running e.g.
man lr_log2report
-should show you the lr_log2report manpage. All these commands have a leading
-`lr_' in their names. (So, if your shell does tab-completion, type `lr_I<tab>'
-to see them all.)
+should show you the lr_log2report manpage.
=head2 Documentation for developers
@@ -50,26 +42,25 @@
you should consult the B<Lire Developer's Manual>. This document is available
in various formats, and installed in /usr/[local/]share/doc/lire/dev-manual* .
-A lot of B<Lire internal scripts> get installed in /usr/[local/]libexec/lire/.
-They all have a leading `lr_' in their name. These all come with their own man
-page. B<Lire convertors>, which take care of log file specific processing, are
-installed in /usr/[local/]libexec/lire/convertors/. These scripts are named
-I<service>2dlf, and all come with their own man page. If you're looking for
-information, specifically for your log file type, you should look here.
-
-The Lire internal scripts use B<Perl modules> to do the real work. These come
-with their own manpages. They're installed in /usr[/local]/share/perl5/Lire/ .
+A lot of B<Lire Perl modules> get installed in the Lire:: namespace in the Perl
+module hierarchy. Likely, this is something like
+/usr/[local/]share/perl5/Lire/. Most of these come with their own man page.
If you plan to write customized Lire extensions, you should read these
manpages.
-If you plan to cooperate with the LogReport team, or you're just interested in
-what the team is up to, development wise, you should consult
-B<The Lire Roadmap>; installed in /usr/[local/]share/doc/lire/roadmap* .
-The B<BUGS> file, as distributed with the Lire tarball, is interesting too.
+B<Lire convertors>, which take care of log file specific processing, are
+installed as Perl modules, named something like I<Foo>DlfConvertor.pm, and come
+with their own man page. (Some old-style convertors come with their own
+script, in /usr/[local/]libexec/lire/convertors/I<foo>2dlf). If you're looking
+for information, specifically for your log file type, you should look here.
+
+If you plan to cooperate with the LogReport team, you might want to take a look
+at the B<BUGS> file, as distributed with the Lire tarball, too.
The file B<COPYING> documents terms and conditions for copying, distribution
and modification of Lire. Some extra explanation about this is given in
-B<Frequently Asked Question About Lire>.
+B<Frequently Asked Question About Lire>, online at
+http://logreport.org/lire/faq.php .
=head2 Other sources of information
@@ -89,7 +80,7 @@
=head1 COPYRIGHT
-Copyright (C) 2002 Stichting LogReport Foundation LogReport at LogReport.org
+Copyright (C) 2002, 2003, 2004 Stichting LogReport Foundation LogReport at LogReport.org
This manpage is part of Lire.
--
To UNSUBSCRIBE, email to commit-request at logreport.org with a subject of
"unsubscribe". Trouble? Send an email with subject "help" to
commit-request at logreport.org
More information about the Commit
mailing list