From: octo <octo>
Date: Sat, 16 Apr 2005 08:38:01 +0000 (+0000)
Subject: Added configuration options to pod in Onis::Users
X-Git-Tag: Release-0.8.0~13
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=a079fa409a73daae8465928b8855268a40c9b17c;p=onis.git

Added configuration options to pod in Onis::Users
Added configuration options to pod in Onis::Data::Core
---

diff --git a/lib/Onis/Data/Core.pm b/lib/Onis/Data/Core.pm
index 0eb9230..d1e3fef 100644
--- a/lib/Onis/Data/Core.pm
+++ b/lib/Onis/Data/Core.pm
@@ -58,6 +58,45 @@ our %NickToNick = ();
 our %NickToIdent = ();
 our %IdentToNick = ();
 
+=head1 CONFIGURATION OPTIONS
+
+=over 4
+
+=item B<unsharp>: I<medium>;
+
+Sets the amount of unsharping onis should do. Valid options are I<none>,
+I<light>, I<medium> and I<hard>.
+
+=over 4
+
+=item I<none>
+
+does not do any unsharping.
+
+=item I<light>
+
+Leaves IP-addresses as they are. The deepest subdomains containing numbers have
+those numbers removed. So C<dsl-084-056-107-131.arcor-ip.net> becomes
+C<dsl-*-*-*-*.arcor-ip.net>.
+
+=item I<medium>
+
+Removes the last byte from IP-adresses. So C<84.56.107.131> becomes
+C<84.56.107.*>. Hostnames have the deepest subdomains removed if they contain
+numers, so C<dsl-084-056-107-131.arcor-ip.net> becomes C<*.arcor-ip.net> while
+C<shell.franken.de> is not modified. This is the default and recommended
+behavior.
+
+=item I<hard>
+
+Handles IP-addresses as I<medium>. Hostnames have all subdomains removed, so
+C<p5493EC60.dip.t-dialin.net> becomes C<*.t-dialin.net> and C<shell.franken.de>
+becomes C<*.franken.de>.
+
+=back
+
+=cut
+
 our $UNSHARP = 'MEDIUM';
 if (get_config ('unsharp'))
 {
@@ -78,11 +117,19 @@ if (get_config ('unsharp'))
 	}
 }
 
+=item B<channel>: I<name>;
+
+Sets the name of the channel. This is mostly automatically figured out, use
+this if onis doesn't get it right or you want another name..
+
+=back
+
+=cut
+
 # TODO
 # - lastrun
-# - total lines
 
-my $VERSION = '$Id: Core.pm,v 1.14 2004/10/31 15:00:32 octo Exp $';
+my $VERSION = '$Id$';
 print STDERR $/, __FILE__, ": $VERSION" if ($::DEBUG);
 
 return (1);
@@ -224,8 +271,6 @@ Takes an ident (i.e. a user-host-pair, e.g. I<user@host.domain.com> or
 I<login@123.123.123.123>) and "unsharps it". The unsharp version is then
 returned.
 
-What unsharp exactly does is described in the F<README>.
-
 =cut
 
 sub unsharp
@@ -515,8 +560,7 @@ Returns the name of the channel we're generating stats for.
 
 sub get_channel
 {
-	my $chan = '#unknown'
-	;
+	my $chan = '#unknown';
 	if (get_config ('channel'))
 	{
 		$chan = get_config ('channel');
@@ -537,9 +581,9 @@ sub get_channel
 	}
 
 	# Fix network-safe channel named (RFC 2811)
-	if ($chan =~ m/^![A-Z0-9]{5}.+/)
+	if ($chan =~ m/^![A-Z0-9]{5}(.+)/)
 	{
-		$chan =~ s/[A-Z0-9]{5}//;
+		$chan = '!' . $1;
 	}
 
 	return ($chan);
diff --git a/lib/Onis/Users.pm b/lib/Onis/Users.pm
index 89c6caa..8699be7 100644
--- a/lib/Onis/Users.pm
+++ b/lib/Onis/Users.pm
@@ -45,13 +45,25 @@ our $IdentToName = {};
 our $NameToIdent = {};
 
 
-my $VERSION = '$Id: Users.pm,v 1.2 2004/08/01 13:45:27 octo Exp $';
+my $VERSION = '$Id$';
 print STDERR $/, __FILE__, ": $VERSION" if ($::DEBUG);
 
 read_config ();
 
 return (1);
 
+=head1 CONFIGURATION OPTIONS
+
+=over 4
+
+=item B<users_config>: I<users.conf>;
+
+Sets the file from which to read the user configuration.
+
+=back
+
+=cut
+
 sub read_config
 {
 	my $config_file = 'users.conf';