clean up doc & codes, FNF-ify

18 files changed, 56 insertions, 59 deletions

diff --git a/fml/lib/FML/Command/Admin/add.pm b/fml/lib/FML/Command/Admin/add.pm
index 624cdab7..66970a3a 100644
--- a/fml/lib/FML/Command/Admin/add.pm
+++ b/fml/lib/FML/Command/Admin/add.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: add.pm,v 1.4 2001/12/22 09:53:08 fukachan Exp $
+# $FML: add.pm,v 1.5 2002/02/18 14:24:11 fukachan Exp $
 #
 
 package FML::Command::Admin::add;
@@ -37,7 +37,7 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
-same as C<subscribe>.
+an alias of C<FML::Command::Admin::subscribe>.
 
 =head1 AUTHOR
 
diff --git a/fml/lib/FML/Command/Admin/addadmin.pm b/fml/lib/FML/Command/Admin/addadmin.pm
index 135c04e3..5bcbb604 100644
--- a/fml/lib/FML/Command/Admin/addadmin.pm
+++ b/fml/lib/FML/Command/Admin/addadmin.pm
@@ -1,10 +1,10 @@
 #-*- perl -*-
 #
-#  Copyright (C) 2001,2002 Ken'ichi Fukamachi
+#  Copyright (C) 2002 Ken'ichi Fukamachi
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: addadmin.pm,v 1.1 2002/03/19 10:31:51 fukachan Exp $
+# $FML: addadmin.pm,v 1.2 2002/03/30 11:08:35 fukachan Exp $
 #
 
 package FML::Command::Admin::addadmin;
@@ -15,7 +15,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Command::Admin::addadmin - addadmin a new administrator
+FML::Command::Admin::addadmin - add a new administrator
 
 =head1 SYNOPSIS
 
@@ -23,7 +23,7 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
-addadmin a new address.
+add a new administrator address.
 
 =head1 METHODS
 
@@ -86,7 +86,7 @@ sub process
 }
 
 
-# Descriptions: addadmin a new user
+# Descriptions: cgi menu to add a new user
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: update $member_map $recipient_map
 # Return Value: none
@@ -112,7 +112,7 @@ Ken'ichi Fukamachi
 
 =head1 COPYRIGHT
 
-Copyright (C) 2001,2002 Ken'ichi Fukamachi
+Copyright (C) 2002 Ken'ichi Fukamachi
 
 All rights reserved. This program is free software; you can
 redistribute it and/or modify it under the same terms as Perl itself.
diff --git a/fml/lib/FML/Command/Admin/addpriv.pm b/fml/lib/FML/Command/Admin/addpriv.pm
index 9a8bf1f2..233658a5 100644
--- a/fml/lib/FML/Command/Admin/addpriv.pm
+++ b/fml/lib/FML/Command/Admin/addpriv.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: add.pm,v 1.5 2002/02/18 14:24:11 fukachan Exp $
+# $FML: addpriv.pm,v 1.1 2002/03/19 11:34:37 fukachan Exp $
 #
 
 package FML::Command::Admin::addpriv;
@@ -29,7 +29,7 @@ sub process
 
 =head1 NAME
 
-FML::Command::Admin::add - add a new member
+FML::Command::Admin::add - add a new administrator
 
 =head1 SYNOPSIS
 
@@ -37,7 +37,7 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
-same as C<addadmin>.
+an alias of C<FML::Command::Admin::addadmin>.
 
 =head1 AUTHOR
 
diff --git a/fml/lib/FML/Command/Admin/bye.pm b/fml/lib/FML/Command/Admin/bye.pm
index 3c9c2f67..a6946a28 100644
--- a/fml/lib/FML/Command/Admin/bye.pm
+++ b/fml/lib/FML/Command/Admin/bye.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: bye.pm,v 1.5 2001/12/22 09:53:09 fukachan Exp $
+# $FML: bye.pm,v 1.6 2002/02/18 14:24:12 fukachan Exp $
 #
 
 package FML::Command::Admin::bye;
@@ -30,7 +30,7 @@ sub process
 
 =head1 NAME
 
-FML::Command::Admin::bye - remove the specified member
+FML::Command::Admin::bye - remove the specified user from ML members
 
 =head1 SYNOPSIS
 
@@ -38,7 +38,7 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
-save as C<unsubscribe>.
+alias of C<FML::Command::Admin::unsubscribe>.
 
 =head1 AUTHOR
 
diff --git a/fml/lib/FML/Command/Admin/byeadmin.pm b/fml/lib/FML/Command/Admin/byeadmin.pm
index 39f795ce..099365fa 100644
--- a/fml/lib/FML/Command/Admin/byeadmin.pm
+++ b/fml/lib/FML/Command/Admin/byeadmin.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: byeadmin.pm,v 1.1 2002/03/19 10:31:52 fukachan Exp $
+# $FML: byeadmin.pm,v 1.2 2002/03/30 11:08:35 fukachan Exp $
 #
 
 package FML::Command::Admin::byeadmin;
@@ -15,7 +15,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Command::Admin::byeadmin - remove the specified member
+FML::Command::Admin::byeadmin - remove the specified administrator
 
 =head1 SYNOPSIS
 
@@ -52,7 +52,7 @@ sub new
 sub need_lock { 1;}
 
 
-# Descriptions: byeadmin a new user
+# Descriptions: remove the specified administrator
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: update $member_map $recipient_map
 # Return Value: none
@@ -86,7 +86,7 @@ sub process
 }
 
 
-# Descriptions: subscribe a new user
+# Descriptions: show cgi menu to remove the administrator
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: update $member_map $recipient_map
 # Return Value: none
diff --git a/fml/lib/FML/Command/Admin/byepriv.pm b/fml/lib/FML/Command/Admin/byepriv.pm
index 3c11c3c7..a86bcde6 100644
--- a/fml/lib/FML/Command/Admin/byepriv.pm
+++ b/fml/lib/FML/Command/Admin/byepriv.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: bye.pm,v 1.5 2002/02/18 14:24:11 fukachan Exp $
+# $FML: byepriv.pm,v 1.1 2002/03/19 11:34:37 fukachan Exp $
 #
 
 package FML::Command::Admin::byepriv;
@@ -17,7 +17,7 @@ use FML::Command::Admin::byeadmin;
 @ISA = qw(FML::Command::Admin::byeadmin);
 
 
-# Descriptions: bye a new admin user
+# Descriptions: remove the specified administrator
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: forward request to byeadmin module
 # Return Value: none
@@ -29,7 +29,7 @@ sub process
 
 =head1 NAME
 
-FML::Command::Admin::bye - bye a new member
+FML::Command::Admin::bye - remove the specified administrator
 
 =head1 SYNOPSIS
 
@@ -37,7 +37,7 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
-same as C<byeadmin>.
+an alias of C<FML::Command::Admin::byeadmin>.
 
 =head1 AUTHOR
 
diff --git a/fml/lib/FML/Command/Admin/dir.pm b/fml/lib/FML/Command/Admin/dir.pm
index 6ee36ff7..0a6d5a81 100644
--- a/fml/lib/FML/Command/Admin/dir.pm
+++ b/fml/lib/FML/Command/Admin/dir.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: dir.pm,v 1.1 2002/03/19 11:13:45 fukachan Exp $
+# $FML: dir.pm,v 1.1 2002/03/24 11:26:46 fukachan Exp $
 #
 
 package FML::Command::Admin::dir;
@@ -15,7 +15,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Command::Admin::dir - dir file operations
+FML::Command::Admin::dir - show "ls" results
 
 =head1 SYNOPSIS
 
@@ -23,7 +23,7 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
-dir a new address.
+show "ls" results
 
 =head1 METHODS
 
@@ -52,7 +52,7 @@ sub new
 sub need_lock { 0;}
 
 
-# Descriptions: dir a new user
+# Descriptions: show result by "ls -l"
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: update $member_map $recipient_map
 # Return Value: none
@@ -82,7 +82,7 @@ sub process
 }
 
 
-# Descriptions: log a new user
+# Descriptions: cgi menu (dummy)
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: update $member_map $recipient_map
 # Return Value: none
diff --git a/fml/lib/FML/Command/Admin/file.pm b/fml/lib/FML/Command/Admin/file.pm
index f4841d7b..2850dad1 100644
--- a/fml/lib/FML/Command/Admin/file.pm
+++ b/fml/lib/FML/Command/Admin/file.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: file.pm,v 1.1 2002/03/26 04:01:36 fukachan Exp $
+# $FML: file.pm,v 1.1 2002/03/30 10:18:34 fukachan Exp $
 #
 
 package FML::Command::Admin::file;
@@ -15,7 +15,7 @@ use Carp;
 
 =head1 NAME
 
-FML::Command::Admin::file - file file operations
+FML::Command::Admin::file - functions for file operations
 
 =head1 SYNOPSIS
 
@@ -52,16 +52,16 @@ sub new
 sub need_lock { 1;}
 
 
-# Descriptions: this command needs "command subcommand parameters" style or not
+# Descriptions: needs "command subcommand parameters" style or not
 #    Arguments: none
 # Side Effects: none
 # Return Value: NUM( 1 or 0)
 sub is_subcommand_style { 1;}
 
 
-# Descriptions: file a new user
+# Descriptions: wrapper for file operations
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
-# Side Effects: update $member_map $recipient_map
+# Side Effects: file is created, renamed and removed
 # Return Value: none
 sub process
 {
@@ -95,7 +95,7 @@ sub process
 }
 
 
-# Descriptions: log a new user
+# Descriptions: show cgi menu (dummy)
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: update $member_map $recipient_map
 # Return Value: none
diff --git a/fml/lib/FML/Command/Admin/remove.pm b/fml/lib/FML/Command/Admin/remove.pm
index 640771b6..8d670312 100644
--- a/fml/lib/FML/Command/Admin/remove.pm
+++ b/fml/lib/FML/Command/Admin/remove.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: remove.pm,v 1.5 2002/02/18 14:24:12 fukachan Exp $
+# $FML: remove.pm,v 1.6 2002/02/20 14:10:37 fukachan Exp $
 #
 
 package FML::Command::Admin::remove;
@@ -38,7 +38,7 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
-same as C<unsubscribe>.
+an alias of C<FML::Command::Admin::unsubscribe>.
 
 =head1 AUTHOR
 
diff --git a/fml/lib/FML/Command/Admin/resign.pm b/fml/lib/FML/Command/Admin/resign.pm
index 4b2096a8..22dd0a2f 100644
--- a/fml/lib/FML/Command/Admin/resign.pm
+++ b/fml/lib/FML/Command/Admin/resign.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: resign.pm,v 1.5 2001/12/22 09:53:09 fukachan Exp $
+# $FML: resign.pm,v 1.6 2002/02/18 14:24:12 fukachan Exp $
 #
 
 package FML::Command::Admin::resign;
@@ -29,7 +29,7 @@ sub process
 
 =head1 NAME
 
-FML::Command::Admin::resign - alias of "unsubscribe" command
+FML::Command::Admin::resign - remove the specified user
 
 =head1 SYNOPSIS
 
diff --git a/fml/lib/FML/Command/Admin/signoff.pm b/fml/lib/FML/Command/Admin/signoff.pm
index 9751c436..663fb35e 100644
--- a/fml/lib/FML/Command/Admin/signoff.pm
+++ b/fml/lib/FML/Command/Admin/signoff.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: signoff.pm,v 1.5 2002/02/18 14:24:12 fukachan Exp $
+# $FML: signoff.pm,v 1.6 2002/02/20 14:10:37 fukachan Exp $
 #
 
 package FML::Command::Admin::signoff;
@@ -30,7 +30,7 @@ sub process
 
 =head1 NAME
 
-FML::Command::Admin::signoff - signoff the specified member
+FML::Command::Admin::signoff - remove the specified member
 
 =head1 SYNOPSIS
 
diff --git a/fml/lib/FML/Command/Admin/subscribe.pm b/fml/lib/FML/Command/Admin/subscribe.pm
index fc65cff9..25da9fa6 100644
--- a/fml/lib/FML/Command/Admin/subscribe.pm
+++ b/fml/lib/FML/Command/Admin/subscribe.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: subscribe.pm,v 1.14 2002/03/19 10:12:45 fukachan Exp $
+# $FML: subscribe.pm,v 1.15 2002/03/30 11:08:35 fukachan Exp $
 #
 
 package FML::Command::Admin::subscribe;
@@ -88,7 +88,7 @@ sub process
 }
 
 
-# Descriptions: subscribe a new user
+# Descriptions: show cgi menu for subscribe
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: update $member_map $recipient_map
 # Return Value: none
diff --git a/fml/lib/FML/Command/Admin/unsubscribe.pm b/fml/lib/FML/Command/Admin/unsubscribe.pm
index bf2e1c28..c5f9708e 100644
--- a/fml/lib/FML/Command/Admin/unsubscribe.pm
+++ b/fml/lib/FML/Command/Admin/unsubscribe.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: unsubscribe.pm,v 1.11 2002/03/19 10:12:45 fukachan Exp $
+# $FML: unsubscribe.pm,v 1.12 2002/03/30 11:08:35 fukachan Exp $
 #
 
 package FML::Command::Admin::unsubscribe;
@@ -88,7 +88,7 @@ sub process
 }
 
 
-# Descriptions: subscribe a new user
+# Descriptions: show cgi menu for unsubscribe
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: update $member_map $recipient_map
 # Return Value: none
diff --git a/fml/lib/FML/Command/User/add.pm b/fml/lib/FML/Command/User/add.pm
index 45e818d6..c676b8c7 100644
--- a/fml/lib/FML/Command/User/add.pm
+++ b/fml/lib/FML/Command/User/add.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: add.pm,v 1.5 2001/12/22 16:10:51 fukachan Exp $
+# $FML: add.pm,v 1.6 2002/02/18 14:14:52 fukachan Exp $
 #
 
 package FML::Command::User::add;
@@ -38,7 +38,7 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
-forward request to C<subscribe> module.
+forward request to C<FML::Command::User::subscribe> module.
 
 =head1 AUTHOR
 
diff --git a/fml/lib/FML/Command/User/bye.pm b/fml/lib/FML/Command/User/bye.pm
index 4a7b3f50..1ecebb66 100644
--- a/fml/lib/FML/Command/User/bye.pm
+++ b/fml/lib/FML/Command/User/bye.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: bye.pm,v 1.6 2001/12/22 09:53:09 fukachan Exp $
+# $FML: bye.pm,v 1.7 2002/02/18 14:14:52 fukachan Exp $
 #
 
 package FML::Command::User::bye;
@@ -38,7 +38,7 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
-same as C<unsubscribe>.
+alias of C<FML::Command::User::unsubscribe>.
 
 =head1 AUTHOR
 
diff --git a/fml/lib/FML/Command/User/remove.pm b/fml/lib/FML/Command/User/remove.pm
index 5af07598..88e76921 100644
--- a/fml/lib/FML/Command/User/remove.pm
+++ b/fml/lib/FML/Command/User/remove.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: remove.pm,v 1.6 2002/02/18 14:14:53 fukachan Exp $
+# $FML: remove.pm,v 1.7 2002/02/20 14:10:38 fukachan Exp $
 #
 
 package FML::Command::User::remove;
@@ -30,7 +30,7 @@ sub process
 
 =head1 NAME
 
-FML::Command::User::remove - remove the specified member
+FML::Command::User::remove - unsubscribe
 
 =head1 SYNOPSIS
 
@@ -38,7 +38,7 @@ See C<FML::Command> for more details.
 
 =head1 DESCRIPTION
 
-same as C<unsubscribe>.
+alias of C<FML::Command::User::unsubscribe>.
 
 =head1 AUTHOR
 
diff --git a/fml/lib/FML/Command/User/resign.pm b/fml/lib/FML/Command/User/resign.pm
index 850bef8b..d8c08761 100644
--- a/fml/lib/FML/Command/User/resign.pm
+++ b/fml/lib/FML/Command/User/resign.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: resign.pm,v 1.6 2002/02/18 14:14:53 fukachan Exp $
+# $FML: resign.pm,v 1.7 2002/02/20 14:10:38 fukachan Exp $
 #
 
 package FML::Command::User::resign;
@@ -29,7 +29,7 @@ sub process
 
 =head1 NAME
 
-FML::Command::User::resign - alias of "unsubscribe" command
+FML::Command::User::resign - unsubscribe
 
 =head1 SYNOPSIS
 
diff --git a/fml/lib/FML/Command/User/subscribe.pm b/fml/lib/FML/Command/User/subscribe.pm
index f5a3e5b8..ac423f6b 100644
--- a/fml/lib/FML/Command/User/subscribe.pm
+++ b/fml/lib/FML/Command/User/subscribe.pm
@@ -4,23 +4,19 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself.
 #
-# $FML: subscribe.pm,v 1.10 2002/02/17 08:13:25 fukachan Exp $
+# $FML: subscribe.pm,v 1.11 2002/02/18 14:14:53 fukachan Exp $
 #
 
 package FML::Command::User::subscribe;
 use strict;
 use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
 use Carp;
-
-
-
 use FML::Log qw(Log LogWarn LogError);
 
 
-
 =head1 NAME
 
-FML::Command::User::subscribe - subscribe a new member
+FML::Command::User::subscribe - subscribe
 
 =head1 SYNOPSIS
 
@@ -58,7 +54,8 @@ sub new
 sub need_lock { 1;}
 
 
-# Descriptions: subscribe adapter: confirm before subscribe
+# Descriptions: subscribe adapter.
+#               we confirm it before real subscribe process.
 #    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
 # Side Effects: update database for confirmation.
 #               prepare reply message.