From 26e324ded666a81b9d98c830bd35bc9c2bd2ed4c Mon Sep 17 00:00:00 2001 From: fukachan Date: Sun, 23 Dec 2001 03:50:26 +0000 Subject: update documents, comments --- fml/lib/FML/Command/Admin/edit.pm | 10 ++++++---- fml/lib/FML/Command/Admin/htmlify.pm | 25 +++++++++++++++++++++---- fml/lib/FML/Command/Admin/newml.pm | 19 ++++++++++++++++--- fml/lib/FML/Command/Admin/subscribe.pm | 10 ++++++++-- fml/lib/FML/Command/Admin/unsubscribe.pm | 8 +++++++- 5 files changed, 58 insertions(+), 14 deletions(-) (limited to 'fml/lib/FML/Command/Admin') diff --git a/fml/lib/FML/Command/Admin/edit.pm b/fml/lib/FML/Command/Admin/edit.pm index db3b2646..ec4f07ae 100644 --- a/fml/lib/FML/Command/Admin/edit.pm +++ b/fml/lib/FML/Command/Admin/edit.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: edit.pm,v 1.3 2001/10/14 00:44:39 fukachan Exp $ +# $FML: edit.pm,v 1.4 2001/12/22 09:21:03 fukachan Exp $ # package FML::Command::Admin::edit; @@ -17,15 +17,17 @@ use FML::Command::Utils; =head1 NAME -FML::Command::Admin::edit - edit a new member +FML::Command::Admin::edit - edit config.cf =head1 SYNOPSIS +See C for more details. + =head1 DESCRIPTION -See C for more details. +Tool to edit config.cf. -=head1 METHODS + not implemented =head1 METHODS diff --git a/fml/lib/FML/Command/Admin/htmlify.pm b/fml/lib/FML/Command/Admin/htmlify.pm index 15080cfb..de1d694f 100644 --- a/fml/lib/FML/Command/Admin/htmlify.pm +++ b/fml/lib/FML/Command/Admin/htmlify.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: htmlify.pm,v 1.2 2001/10/22 11:04:50 fukachan Exp $ +# $FML: htmlify.pm,v 1.3 2001/12/22 09:21:03 fukachan Exp $ # package FML::Command::Admin::htmlify; @@ -25,19 +25,36 @@ FML::Command::Admin::htmlify - htmlify $spool_dir See C. +=head1 DESCRIPTION + =head2 makefml usage -For example, make htmlified articles in /var/www/htdocs/mlarchives/elena +For example, make HTMLified articles in +/var/www/htdocs/mlarchives/elena - makefml htmlify elena outdir=/var/www/htdocs/mlarchives/elena + makefml htmlify elena \ + srcdir=/var/spool/ml/elena/spool \ + outdir=/var/www/htdocs/mlarchives/elena -=head1 DESCRIPTION +C +This options format is irregular, isn't it? +We should normalized it in the following way? + + makefml htmlify elena \ + --srcdir=/var/spool/ml/elena/spool \ + --outdir=/var/www/htdocs/mlarchives/elena + +Hmm, ... but it is strange. =head1 METHODS =cut +# Descriptions: htmlify articles +# Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args) +# Side Effects: none +# Return Value: none sub process { my ($self, $curproc, $command_args) = @_; diff --git a/fml/lib/FML/Command/Admin/newml.pm b/fml/lib/FML/Command/Admin/newml.pm index 518016c1..0179c8b8 100644 --- a/fml/lib/FML/Command/Admin/newml.pm +++ b/fml/lib/FML/Command/Admin/newml.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: newml.pm,v 1.6 2001/12/11 15:38:01 fukachan Exp $ +# $FML: newml.pm,v 1.7 2001/12/22 09:21:03 fukachan Exp $ # package FML::Command::Admin::newml; @@ -19,7 +19,7 @@ use FML::Command::Utils; =head1 NAME -FML::Command::Admin::newml - make a new mailing list +FML::Command::Admin::newml - set up a new mailing list =head1 SYNOPSIS @@ -31,6 +31,10 @@ See C for more details. =head1 DESCRIPTION +set up a new mailing list +create mailing list directory, +install config.cf, include, include-ctl et. al. + =head1 METHODS =head2 C @@ -38,6 +42,11 @@ See C for more details. =cut +# Descriptions: set up a new mailing list +# Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args) +# Side Effects: create mailing list directory, +# install config.cf, include, include-ctl et. al. +# Return Value: none sub process { my ($self, $curproc, $command_args) = @_; @@ -56,7 +65,7 @@ sub process }; # fundamental check - croak("\$ml_name is not specified") unless $ml_name; + croak("\$ml_name is not specified") unless $ml_name; unless (-d $ml_home_dir) { eval q{ @@ -83,6 +92,10 @@ sub process } +# Descriptions: install $dst with variable expansion of $src +# Arguments: STR($src) STR($dst) HASH_REF($config) +# Side Effects: create $dst +# Return Value: none sub _install { my ($src, $dst, $config) = @_; diff --git a/fml/lib/FML/Command/Admin/subscribe.pm b/fml/lib/FML/Command/Admin/subscribe.pm index 652ab477..dbdd14d1 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.6 2001/10/14 00:44:40 fukachan Exp $ +# $FML: subscribe.pm,v 1.7 2001/12/22 09:21:04 fukachan Exp $ # package FML::Command::Admin::subscribe; @@ -23,9 +23,11 @@ FML::Command::Admin::subscribe - subscribe a new member =head1 SYNOPSIS +See C for more details. + =head1 DESCRIPTION -See C for more details. +subscribe a new address. =head1 METHODS @@ -34,6 +36,10 @@ See C for more details. =cut +# Descriptions: subscribe a new user +# Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args) +# Side Effects: update $member_map $recipient_map +# Return Value: none sub process { my ($self, $curproc, $command_args) = @_; diff --git a/fml/lib/FML/Command/Admin/unsubscribe.pm b/fml/lib/FML/Command/Admin/unsubscribe.pm index 6bfc3364..94326fc1 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.3 2001/10/14 00:44:40 fukachan Exp $ +# $FML: unsubscribe.pm,v 1.4 2001/12/22 09:21:04 fukachan Exp $ # package FML::Command::Admin::unsubscribe; @@ -26,6 +26,8 @@ See C for more details. =head1 DESCRIPTION +unsubscribe a new user. + =head1 METHODS =head2 C @@ -33,6 +35,10 @@ See C for more details. =cut +# Descriptions: unsubscribe a new user +# Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args) +# Side Effects: update $member_map $recipient_map +# Return Value: none sub process { my ($self, $curproc, $command_args) = @_; -- cgit v1.2.1