/usr/share/doc/lire/dev-manual/index.html is in lire-devel-doc 2:2.1.1-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Lire Developer's Manual</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="Lire Developer's Manual"><link rel="next" href="pr01.html" title="Preface"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Lire Developer's Manual</th></tr><tr><td width="20%" align="left"> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="pr01.html">Next</a></td></tr></table><hr></div><div class="book" title="Lire Developer's Manual"><div class="titlepage"><div><div><h1 class="title"><a name="dev-manual"></a>Lire Developer's Manual</h1></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Joost</span> <span class="surname">van Baal</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Egon</span> <span class="othername">L.</span> <span class="surname">Willighagen</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Francis</span> <span class="othername">J.</span> <span class="surname">Lacoste</span></h3></div></div></div><div><p class="copyright">Copyright © 2000, 2001, 2002, 2003, 2004 Stichting LogReport Foundation</p></div><div><div class="legalnotice" title="Legal Notice"><a name="id393101"></a><p>
This manual 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.
</p><p>
This is distributed in the hope that it will be useful,
but <span class="emphasis"><em>without any warranty</em></span>; without even the
implied warranty of <span class="emphasis"><em>merchantability</em></span> or
<span class="emphasis"><em>fitness for a particular purpose</em></span>. See the
GNU General Public License for more details.
</p><p>
You should have received a copy of the GNU General Public License
along with this manual (see COPYING); if not, check with
<a class="ulink" href="http://www.gnu.org/copyleft/gpl.html" target="_top">
http://www.gnu.org/copyleft/gpl.html</a> or write to the Free
Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
MA 02111, USA.
</p></div></div><div><div class="revhistory"><table border="1" width="100%" summary="Revision history"><tr><th align="left" valign="top" colspan="2"><b>Revision History</b></th></tr><tr><td align="left">Revision 2.1.1
</td><td align="left">$Date: 2008/03/03 06:30:02 $</td></tr><tr><td align="left" colspan="2">
$Id: dev-manual.dbx,v 1.90 2008/03/03 06:30:02 vanbaal Exp $
</td></tr></table></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="preface"><a href="pr01.html">Preface</a></span></dt><dd><dl><dt><span class="section"><a href="pr01.html#sect:what-contains">What This Book Contains</a></span></dt><dt><span class="section"><a href="pr01s02.html">How Is This Book Organized?</a></span></dt><dt><span class="section"><a href="pr01s03.html">Conventions Used</a></span></dt><dt><span class="section"><a href="pr01s04.html">If You Don't Find Something In This Manual</a></span></dt></dl></dd><dt><span class="part"><a href="pt01.html">I. <span class="application">Lire</span> Architecture</a></span></dt><dd><dl><dt><span class="chapter"><a href="ch01.html">1. Architecture Overview</a></span></dt><dd><dl><dt><span class="section"><a href="ch01.html#sect:design-patterns">Lire's Design Patterns</a></span></dt><dt><span class="section"><a href="ch01s02.html">Log File Normalisation</a></span></dt><dt><span class="section"><a href="ch01s03.html">Log Analysis</a></span></dt><dt><span class="section"><a href="ch01s04.html">Report Generation</a></span></dt><dt><span class="section"><a href="ch01s05.html">Report Formatting and Other Post-Processing</a></span></dt><dt><span class="section"><a href="ch01s06.html">Going Further</a></span></dt></dl></dd></dl></dd><dt><span class="part"><a href="pt02.html">II. Using the <span class="application">Lire</span> Framework</a></span></dt><dd><dl><dt><span class="chapter"><a href="ch02.html">2. Writing a New DLF Converter</a></span></dt><dd><dl><dt><span class="section"><a href="ch02.html#id402415">Prerequisites</a></span></dt><dt><span class="section"><a href="ch02s02.html">The <span class="type">common_syslog</span> Log Format</a></span></dt><dt><span class="section"><a href="ch02s03.html">Creating the DLF Converter Skeleton</a></span></dt><dt><span class="section"><a href="ch02s04.html">Adding a Constructor</a></span></dt><dt><span class="section"><a href="ch02s05.html">The Meta-Data Methods</a></span></dt><dd><dl><dt><span class="section"><a href="ch02s05.html#id402633">The DLF Converter Name</a></span></dt><dt><span class="section"><a href="ch02s05.html#id402670">Providing Information To Users</a></span></dt><dt><span class="section"><a href="ch02s05.html#id402727">Providing Information to the Framework</a></span></dt><dt><span class="section"><a href="ch02s05.html#id402797">The Conversion Methods</a></span></dt></dl></dd><dt><span class="section"><a href="ch02s06.html">Registering Your DLF Converter with the <span class="application">Lire</span> Framework</a></span></dt><dt><span class="section"><a href="ch02s07.html">DLF Converter API</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch03.html">3. Writing a DLF Schema</a></span></dt><dd><dl><dt><span class="section"><a href="ch03.html#sect:ftpproto-schema">Designing the <span class="type">ftpproto</span> schema</a></span></dt><dd><dl><dt><span class="section"><a href="ch03.html#id403395">Creating The Schema File</a></span></dt><dt><span class="section"><a href="ch03.html#id403478">Adding the Schema's Description</a></span></dt><dt><span class="section"><a href="ch03.html#id403514">Defining the Schema's Fields</a></span></dt><dt><span class="section"><a href="ch03.html#schema-installation">Installing The Schema</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch04.html">4. Writing a New DLF Analyser</a></span></dt><dd><dl><dt><span class="section"><a href="ch04.html#sect:writing-categoriser">Writing a Categoriser</a></span></dt><dd><dl><dt><span class="section"><a href="ch04.html#id403947">Defining The Extended Schema </a></span></dt><dt><span class="section"><a href="ch04.html#id404012">Defining the Categoriser</a></span></dt><dt><span class="section"><a href="ch04.html#id404050">Categoriser Configuration</a></span></dt><dt><span class="section"><a href="ch04.html#id404101">Categoriser Implementation</a></span></dt></dl></dd><dt><span class="section"><a href="ch04s02.html">Writing an Analyser</a></span></dt><dt><span class="section"><a href="ch04s03.html">DLF Analyser API</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch05.html">5. Writing a New Report</a></span></dt><dd><dl><dt><span class="section"><a href="ch05.html#sect:filter-spec">Filter Specification</a></span></dt></dl></dd></dl></dd><dt><span class="part"><a href="pt03.html">III. Developer's Reference</a></span></dt><dd><dl><dt><span class="chapter"><a href="ch06.html">6. Lire Data Types</a></span></dt><dd><dl><dt><span class="section"><a href="ch06.html#id404758">Lire Textual Elements</a></span></dt><dd><dl><dt><span class="section"><a href="ch06.html#id404779"><code class="sgmltag-element">title</code> element</a></span></dt><dt><span class="section"><a href="ch06.html#id404810">DocBook Elements</a></span></dt><dt><span class="section"><a href="ch06.html#id404854"><code class="sgmltag-element">description</code> element</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch07.html">7. Common Textual Elements to All XML Formats </a></span></dt><dd><dl><dt><span class="section"><a href="ch07.html#id405096">Lire Data Types Parameter Entities</a></span></dt><dd><dl><dt><span class="section"><a href="ch07.html#id405111">Boolean Type</a></span></dt><dt><span class="section"><a href="ch07.html#id405162">Integer Type</a></span></dt><dt><span class="section"><a href="ch07.html#id405181">Number Type</a></span></dt><dt><span class="section"><a href="ch07.html#id405201">String Type</a></span></dt><dt><span class="section"><a href="ch07.html#id405220">Timestamp type</a></span></dt><dt><span class="section"><a href="ch07.html#id405241">Time Type</a></span></dt><dt><span class="section"><a href="ch07.html#id405261">Date Type</a></span></dt><dt><span class="section"><a href="ch07.html#id405282">Duration Type</a></span></dt><dt><span class="section"><a href="ch07.html#id405338">IP Type</a></span></dt><dt><span class="section"><a href="ch07.html#id405357">Port Type</a></span></dt><dt><span class="section"><a href="ch07.html#id405384">Hostname Type</a></span></dt><dt><span class="section"><a href="ch07.html#id405404">URL Type</a></span></dt><dt><span class="section"><a href="ch07.html#id405423">Email Type</a></span></dt><dt><span class="section"><a href="ch07.html#id405443">Bytes Type</a></span></dt><dt><span class="section"><a href="ch07.html#id405477">Filename Type</a></span></dt><dt><span class="section"><a href="ch07.html#id405497">Field Type</a></span></dt><dt><span class="section"><a href="ch07.html#id405525">Superservice Type</a></span></dt><dt><span class="section"><a href="ch07.html#id405546">Related Types</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch08.html">8. The Lire Report Configuration Specification Markup Language</a></span></dt><dd><dl><dt><span class="section"><a href="ch08.html#id406131">The Lire Report Configuration Specification Markup Language</a></span></dt><dd><dl><dt><span class="section"><a href="ch08.html#id406254"><code class="sgmltag-element">config-spec</code> element</a></span></dt><dt><span class="section"><a href="ch08.html#id406280"><code class="sgmltag-element">summary</code> element</a></span></dt><dt><span class="section"><a href="ch08.html#id406305">Parameter Specifiations Elements</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch09.html">9. The Lire Report Configuration Markup Language</a></span></dt><dd><dl><dt><span class="section"><a href="ch09.html#id407898">The Lire Report Configuration Markup Language</a></span></dt><dd><dl><dt><span class="section"><a href="ch09.html#id407951"><code class="sgmltag-element">config</code> element</a></span></dt><dt><span class="section"><a href="ch09.html#id407980"><code class="sgmltag-element">global</code> element</a></span></dt><dt><span class="section"><a href="ch09.html#id408003"><code class="sgmltag-element">param</code> element</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch10.html">10. The Lire DLF Schema Markup Language</a></span></dt><dd><dl><dt><span class="section"><a href="ch10.html#id407863">The Lire DLF Schema Markup Language</a></span></dt><dd><dl><dt><span class="section"><a href="ch10.html#id408452">The <code class="sgmltag-element">dlf-schema</code> element</a></span></dt><dt><span class="section"><a href="ch10.html#id408546"><code class="sgmltag-element">extended-schema</code> element</a></span></dt><dt><span class="section"><a href="ch10.html#id408650"><code class="sgmltag-element">derived-schema</code> element</a></span></dt><dt><span class="section"><a href="ch10.html#id408259"><code class="sgmltag-element">field</code> element</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch11.html">11. The Lire Report Specification Markup Language</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#id409522">The Lire Report Specification Markup Language</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#id409600"><code class="sgmltag-element">report-spec</code> element</a></span></dt><dt><span class="section"><a href="ch11.html#id409725"><code class="sgmltag-element">global-filter-spec</code> element</a></span></dt><dt><span class="section"><a href="ch11.html#id409843"><code class="sgmltag-element">display-spec</code> element</a></span></dt><dt><span class="section"><a href="ch11.html#id409870"><code class="sgmltag-element">param-spec</code> element</a></span></dt><dt><span class="section"><a href="ch11.html#id409892"><code class="sgmltag-element">param</code> element</a></span></dt><dt><span class="section"><a href="ch11.html#id409975"><code class="sgmltag-element">chart-configs</code> element</a></span></dt><dt><span class="section"><a href="ch11.html#id409998">Filter expression elements</a></span></dt><dt><span class="section"><a href="ch11.html#id410341">Report Calculation Elements</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch12.html">12. The Lire Report Markup Language</a></span></dt><dd><dl><dt><span class="section"><a href="ch12.html#id414186">The Report Markup Language</a></span></dt><dd><dl><dt><span class="section"><a href="ch12.html#id414285"><code class="sgmltag-element">report</code> element</a></span></dt><dt><span class="section"><a href="ch12.html#id414344">Meta-information elements</a></span></dt><dt><span class="section"><a href="ch12.html#id414485"><code class="sgmltag-element">section</code> element</a></span></dt><dt><span class="section"><a href="ch12.html#id414523"><code class="sgmltag-element">subreport</code> element</a></span></dt><dt><span class="section"><a href="ch12.html#id414667"><code class="sgmltag-element">missing-subreport</code> element</a></span></dt><dt><span class="section"><a href="ch12.html#id414765"><code class="sgmltag-element">table</code> element</a></span></dt><dt><span class="section"><a href="ch12.html#id414839"><code class="sgmltag-element">table-info</code> element</a></span></dt><dt><span class="section"><a href="ch12.html#id414873"><code class="sgmltag-element">group-info</code> element</a></span></dt><dt><span class="section"><a href="ch12.html#id414938"><code class="sgmltag-element">column-info</code> element</a></span></dt><dt><span class="section"><a href="ch12.html#id415180"><code class="sgmltag-element">group-summary</code> element</a></span></dt><dt><span class="section"><a href="ch12.html#id415270"><code class="sgmltag-element">group</code> element</a></span></dt><dt><span class="section"><a href="ch12.html#id415344"><code class="sgmltag-element">entry</code> element</a></span></dt><dt><span class="section"><a href="ch12.html#id415429"><code class="sgmltag-element">name</code> element</a></span></dt><dt><span class="section"><a href="ch12.html#id415538"><code class="sgmltag-element">value</code> element</a></span></dt><dt><span class="section"><a href="ch12.html#id415663"><code class="sgmltag-element">chart-configs</code> element</a></span></dt></dl></dd></dl></dd></dl></dd><dt><span class="part"><a href="pt04.html">IV. <span class="application">Lire</span> Developers' Conventions</a></span></dt><dd><dl><dt><span class="chapter"><a href="ch13.html">13. Contributing Code to <span class="application">Lire</span></a></span></dt><dt><span class="chapter"><a href="ch14.html">14. Developers' Toolbox</a></span></dt><dd><dl><dt><span class="section"><a href="ch14.html#sect:required-build-tools">Required Tools To Build From CVS</a></span></dt><dt><span class="section"><a href="ch14s02.html">Accessing <span class="application">Lire</span>'s CVS</a></span></dt><dd><dl><dt><span class="section"><a href="ch14s02.html#id417339">CVS primer</a></span></dt></dl></dd><dt><span class="section"><a href="ch14s03.html">SourceForge</a></span></dt><dt><span class="section"><a href="ch14s04.html">Mailing Lists</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch15.html">15. Coding Standards</a></span></dt><dd><dl><dt><span class="section"><a href="ch15.html#sect:shell-coding-standards">Shell Coding Standards</a></span></dt><dt><span class="section"><a href="ch15s02.html">Perl Coding Standards</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch16.html">16. Making Lire <span class="quote">“<span class="quote">Test-infected</span>”</span></a></span></dt><dd><dl><dt><span class="section"><a href="ch16.html#id417573">Unit Tests in Lire</a></span></dt><dd><dl><dt><span class="section"><a href="ch16.html#id417578">PerlUnit</a></span></dt></dl></dd><dt><span class="section"><a href="ch16s02.html">Writing Tests</a></span></dt><dt><span class="section"><a href="ch16s03.html">Running Tests</a></span></dt><dt><span class="section"><a href="ch16s04.html">Some <span class="quote">“<span class="quote">Best Practices</span>”</span> on Unit Testing</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch17.html">17. Commit Policy</a></span></dt><dd><dl><dt><span class="section"><a href="ch17.html#id417848">CVS Branches</a></span></dt><dd><dl><dt><span class="section"><a href="ch17.html#id417877">Hands-on example</a></span></dt><dt><span class="section"><a href="ch17.html#id417938">Naming, what it looks like</a></span></dt><dt><span class="section"><a href="ch17.html#id417989">Creating a Branch</a></span></dt><dt><span class="section"><a href="ch17.html#id418063">Accessing a Branch</a></span></dt><dt><span class="section"><a href="ch17.html#id418194">Merging Branches on the Trunk</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch18.html">18. Testing and debugging</a></span></dt><dd><dl><dt><span class="section"><a href="ch18.html#id418257">Test before releasing</a></span></dt><dt><span class="section"><a href="ch18s02.html">Test-installations and test-runs</a></span></dt><dt><span class="section"><a href="ch18s03.html">Using the Perl debugger on Lire code</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch19.html">19. Making a Release</a></span></dt><dd><dl><dt><span class="section"><a href="ch19.html#sect:versionnews">Setting version in NEWS file, checking ChangeLog</a></span></dt><dt><span class="section"><a href="ch19s02.html">Tagging the CVS</a></span></dt><dt><span class="section"><a href="ch19s03.html">Building The Tarball</a></span></dt><dt><span class="section"><a href="ch19s04.html">Building The Debian Package</a></span></dt><dt><span class="section"><a href="ch19s05.html">Building The RPM Package</a></span></dt><dt><span class="section"><a href="ch19s06.html">Making sure the FreeBSD port gets updated</a></span></dt><dt><span class="section"><a href="ch19s07.html">Uploading The Release</a></span></dt><dd><dl><dt><span class="section"><a href="ch19s07.html#id419052">The LogReport Webserver</a></span></dt></dl></dd><dt><span class="section"><a href="ch19s08.html">Advertising The Release</a></span></dt><dd><dl><dt><span class="section"><a href="ch19s08.html#id419178">SourceForge</a></span></dt><dt><span class="section"><a href="ch19s08.html#id419264">Freshmeat.net</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch20.html">20. Website Maintenance</a></span></dt><dd><dl><dt><span class="section"><a href="ch20.html#id419334">Documentation on the LogReport Website</a></span></dt><dd><dl><dt><span class="section"><a href="ch20.html#id419370">Publishing the DTD's</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch21.html">21. Writing Documentation</a></span></dt><dd><dl><dt><span class="section"><a href="ch21.html#sect:plain-text">Plain Text</a></span></dt><dt><span class="section"><a href="ch21s02.html">Perl's Plain Old Documentation: maintaining manpages</a></span></dt><dt><span class="section"><a href="ch21s03.html">Docbook XML: Reference Books and Extensive User Manuals</a></span></dt></dl></dd></dl></dd><dt><span class="part"><a href="pt05.html">V. Implementation Details</a></span></dt><dd><dl><dt><span class="chapter"><a href="ch22.html">22. Adding a New Superservice in <span class="application">Lire</span>'s Distribution</a></span></dt><dt><span class="chapter"><a href="ch23.html">23. Issues with Report Merging</a></span></dt><dt><span class="chapter"><a href="ch24.html">24. Overview of <span class="application">Lire</span> scripts</a></span></dt><dt><span class="chapter"><a href="ch25.html">25. Source Tree Layout</a></span></dt></dl></dd><dt><span class="glossary"><a href="go01.html">Glossary</a></span></dt></dl></div><div class="list-of-figures"><p><b>List of Figures</b></p><dl><dt>1.1. <a href="ch01.html#fig:flow-overview">Log Processing in the <span class="application">Lire</span>'s Framework</a></dt><dt>1.2. <a href="ch01s02.html#fig:flow-normalisation">The Log Normalisation Process</a></dt><dt>1.3. <a href="ch01s03.html#fig:flow-analysis">The Log Analysis Process</a></dt><dt>1.4. <a href="ch01s04.html#fig:flow-generation">Report Generation Process</a></dt><dt>1.5. <a href="ch01s05.html#fig:flow-report">Processing of the XML Report Using The APIs</a></dt></dl></div><div class="list-of-tables"><p><b>List of Tables</b></p><dl><dt>11.1. <a href="ch11.html#id410681">weekly overview</a></dt></dl></div><div class="list-of-examples"><p><b>List of Examples</b></p><dl><dt>11.1. <a href="ch11.html#id410666">timeslot with 1d unit</a></dt><dt>11.2. <a href="ch11.html#id410737">timeslot with 2m unit</a></dt><dt>3. <a href="go01.html#ex:dns.dlf">DNS DLF Excerpts</a></dt></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="pr01.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"> </td><td width="40%" align="right" valign="top"> Preface</td></tr></table></div></body></html>
|