From 915f48ccb78a125d1e160de11b3dd9b035a55ccd Mon Sep 17 00:00:00 2001 From: octo Date: Wed, 20 Apr 2005 19:19:52 +0000 Subject: [PATCH] Fixed user config: User `ignore' is ignored again. Added much dokumentation to the (main) onis file. Added rules to automagically create a manpage. --- CHANGELOG | 8 ++ debian/control | 2 +- debian/rules | 6 +- lib/Onis/Data/Core.pm | 2 + onis | 219 +++++++++++++++++++++++++++++++++++++++++++++++++- 5 files changed, 232 insertions(+), 5 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index 0839194..e2e36f3 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -2,6 +2,14 @@ ================== http://verplant.org/onis/ + 0.8.1 - + ========= + - Ignoring users (using the special user-name ``ignore'') has been fixed. + - A manpage for onis has been written. It can be generated out of the ``onis'' + file using pod2man. + + + 0.8.0 - All new persistency ============================= - This release features a complete rewrite of the persistency-code. The diff --git a/debian/control b/debian/control index 858d365..9ad08e1 100644 --- a/debian/control +++ b/debian/control @@ -2,7 +2,7 @@ Source: onis Section: unknown Priority: optional Maintainer: Florian Forster -Build-Depends: debhelper (>= 4.0.0) +Build-Depends: debhelper (>= 4.0.0), pod2man Standards-Version: 3.6.1 Package: onis diff --git a/debian/rules b/debian/rules index 98d0dd2..4ba4482 100755 --- a/debian/rules +++ b/debian/rules @@ -36,9 +36,7 @@ build: build-stamp build-stamp: configure-stamp dh_testdir - # Add here commands to compile the package. - #$(MAKE) - #docbook-to-man debian/onis.sgml > onis.1 + pod2man -r $(egrep '^\$VERSION' onis | cut -d "'" -f 2) onis >onis.1 touch build-stamp @@ -47,6 +45,7 @@ clean: dh_testroot rm -f build-stamp configure-stamp + rm -f onis.1 patch -p1 -R {$this_nick}{$ident}; + + next if ($name eq 'ignore'); $this_total += $num; diff --git a/onis b/onis index 5c2bb2e..6e2e860 100755 --- a/onis +++ b/onis @@ -32,12 +32,30 @@ BEGIN use strict; use warnings; +use vars qw/$VERSION $REVISION/; use Onis::Config qw/get_config parse_argv read_config/; use File::Basename qw/dirname/; use Fcntl qw/:flock/; -use vars qw/$VERSION $REVISION/; +=head1 NAME + +onis - onis not irs stats + +=head1 SYNOPSIS + +B [I] I... + +=head1 DESCRIPTION + +onis is a script that converts IRC logfiles into an HTML statistics page. It +provides information about daily channel usage, user activity, and channel +trivia. It provides a configurable customization and supports Dancer, +dircproxy, eggdrop, irssi, mIRC, and XChat logs. Persistent data (history +files) and automatic log purging make onis applicable for a large number of +logfiles. It also features a powerful translation infrastructure. + +=cut $VERSION = ''; $REVISION = '$LastChangedRevision$'; @@ -342,3 +360,202 @@ END { print $/ if ($::DEBUG); } + +=head1 OPTIONS + +=head2 Core options + +=over 4 + +=item B: I; + +Load the config from this file. B<(command line only)> + +=item B: I; + +Sets the file from which to read the user configuration. + +=item B: I; + +Sets the language file/translation to use. + +=item B: I; + +Sets the plugins to load. The plugin B will always be loaded. + +=item B: I; + +Read and parse this file(s). B<(config file only)> + +=item B: I; + +Sets the parser to use for parsing the input file. + +=item B: I; + +Write the generated output to this file. + +=item B: I; + +Sets wether or not to overwrite the output-file if it exists. + +=item B: "I" | "I" | "I"; + +Sets wether logs should be truncated or even removes after they have been +parsed. + +=item B: I; + +Sets the user generating the stats if it's not detected right. + +=item B: I; + +Sets the name of the channel being parsed. Normally this is auto-detected. + +=item B: "I" | "I" | "I" | "I"; + +Sets how to do unsharping. What each setting actually does is described in the +readme and in L. + +=back + +=head2 Appearance + +=over 4 + +=item B: I; + +Theme file to load. + +=item B: I; + +Sets the stylesheet (.css file) to use. This should be set in a theme file. + +=item B: I; + +Wether to print mIRC color-codes or filter them. + +=item B: I; + +Sets if user-images should be displayed. + +=item B: I; + +Sets the default image to use if no user-defined image is available. + +=item B: "I" | "I" | "I" | "I"; + +=item B: "I" | "I" | "I" | "I"; + +=item B: "I" | "I" | "I" | "I"; + +Sets if and how lines, words and/or characters should be displayed. + +=item B: "I" | "I" | "I"; + +Sets wether to sort by lines, words or characters written. + +=item B: I; + +Wether or not to display a fixed width bar that shows when a user is most +active. + +=item B: I; + +=item B: I; + +Sets the width of horizontal bars and the height of vertical bars. + +=item B: I, I, I, I; + +=item B: I, I, I, I; + +Sets the images to use for horizontal and vertical bars. This should be used in +the theme-file. + +=item B: I; + +Sets the encoding for the output file. This is merely the string that will be +included in the generated HTML file. + +=item B: I; + +Wether or not this is a public page. Public pages may be linked on the onis +homepage at some point in the fututre.. + +=back + +=head2 Storage / Persistency + +=over 4 + +=item B: I; + +Sets the storage-module to use. + +=item B: I; + +Sets the directory to store persistency information under. + +=item B: I; + +Sets the file to write persistency data to, if applicable by the +storage-module. + +=back + +=head2 Plugins + +=over 4 + +=item B: I; + +Substring containing only word-characters needs to be this long to be +considered a word. + +=item B: I; + +Sets the number of "most referenced nicks", "most used words" and the like to +be displayed. This option will be removed in the future. + +=item B: I; + +=item B: I; + +The number of lines in the big and the small table. While in the big table one +line is dedicated for one person the small table displays six persons per line. + +=item B: I; + +Sets how many quotes are to be cached for each nick. At the end of the run one +of the quotes in the cache will be chosen at random and displayed. + +=item B: I; + +=item B: I; + +Sets the minimum and maximum length of a quote. Too short quotes may be not +very typical for a person, too long quotes may clutter the layout. + +=item B: I; + +Sets how many lines without interruption are considered a soliloquy. + +=item B: I; + +=item B: I; + +Sets the number of days shown in the longterm-plugin (or the longter-section of +the userdetails-plugin). + +=item B: I; + +The Words-Plugin will ignore words with less than this characters. + +=back + +=head1 AUTHOR + +Florian Forster Eocto at verplant.orgE + +=cut -- 2.11.0