implement help() method

4 files changed, 106 insertions, 4 deletions

diff --git a/fml/lib/FML/Process/Command.pm b/fml/lib/FML/Process/Command.pm
index 1ff1484b..8ebc6ed6 100644
--- a/fml/lib/FML/Process/Command.pm
+++ b/fml/lib/FML/Process/Command.pm
@@ -4,7 +4,7 @@
 # Copyright (C) 2000,2001 Ken'ichi Fukamachi
 #          All rights reserved. 
 #
-# $FML: Command.pm,v 1.20 2001/10/14 03:31:10 fukachan Exp $
+# $FML: Command.pm,v 1.21 2001/11/04 03:44:46 fukachan Exp $
 #
 
 package FML::Process::Command;
@@ -101,6 +101,27 @@ sub run
 }
 
 
+=head2 help()
+
+=cut
+
+
+# Descriptions: show help
+#    Arguments: none
+# Side Effects: none
+# Return Value: none
+sub help
+{
+print <<"_EOF_";
+
+Usage: $0 \$ml_home_prefix/\$ml_name [options]
+
+   For example, process command of elena ML
+   $0 /var/spool/ml/elena
+_EOF_
+}
+
+
 =head2 C<finish($args)>
 
     $curproc->inform_reply_messages();
diff --git a/fml/lib/FML/Process/Configure.pm b/fml/lib/FML/Process/Configure.pm
index 7809efcf..e5cbb0e7 100644
--- a/fml/lib/FML/Process/Configure.pm
+++ b/fml/lib/FML/Process/Configure.pm
@@ -4,7 +4,7 @@
 # Copyright (C) 2000,2001 Ken'ichi Fukamachi
 #          All rights reserved. 
 #
-# $FML: Configure.pm,v 1.27 2001/10/14 03:08:59 fukachan Exp $
+# $FML: Configure.pm,v 1.28 2001/11/04 03:44:46 fukachan Exp $
 #
 
 package FML::Process::Configure;
@@ -116,6 +116,36 @@ sub run
 }
 
 
+=head2 help()
+
+=cut
+
+
+# Descriptions: show help
+#    Arguments: none
+# Side Effects: none
+# Return Value: none
+sub help
+{
+    my $name = $0;
+    eval {
+	use File::Basename;
+	$name = basename($0);
+    };
+
+print <<"_EOF_";
+
+Usage: $name \$command \$ml_name [options]
+
+$name help         \$ml_name                   show this help
+
+$name subscribe    \$ml_name ADDRESS
+$name unsubscribe  \$ml_name ADDRESS
+
+_EOF_
+}
+
+
 =head2 C<_fmlconf($args)> (INTERNAL USE)
 
 run dump_variables of C<FML::Config>.
diff --git a/fml/lib/FML/Process/Distribute.pm b/fml/lib/FML/Process/Distribute.pm
index e47b0bdd..06671273 100644
--- a/fml/lib/FML/Process/Distribute.pm
+++ b/fml/lib/FML/Process/Distribute.pm
@@ -4,7 +4,7 @@
 # Copyright (C) 2000,2001 Ken'ichi Fukamachi
 #          All rights reserved. 
 #
-# $FML: Distribute.pm,v 1.51 2001/11/04 04:42:52 fukachan Exp $
+# $FML: Distribute.pm,v 1.52 2001/11/11 13:37:41 fukachan Exp $
 #
 
 package FML::Process::Distribute;
@@ -130,6 +130,27 @@ sub run
 }
 
 
+=head2 help()
+
+=cut
+
+
+# Descriptions: show help
+#    Arguments: none
+# Side Effects: none
+# Return Value: none
+sub help
+{
+print <<"_EOF_";
+
+Usage: $0 \$ml_home_prefix/\$ml_name [options]
+
+   For example, distribute of elena ML
+   $0 /var/spool/ml/elena
+_EOF_
+}
+
+
 =head2 C<finish($args)>
 
 Finalize the current process.
diff --git a/fml/lib/FML/Process/DocViewer.pm b/fml/lib/FML/Process/DocViewer.pm
index c1ae768d..1a517d87 100644
--- a/fml/lib/FML/Process/DocViewer.pm
+++ b/fml/lib/FML/Process/DocViewer.pm
@@ -4,7 +4,7 @@
 # Copyright (C) 2000,2001 Ken'ichi Fukamachi
 #          All rights reserved. 
 #
-# $FML: DocViewer.pm,v 1.3 2001/05/29 16:21:16 fukachan Exp $
+# $FML: DocViewer.pm,v 1.4 2001/11/04 03:44:46 fukachan Exp $
 #
 
 package FML::Process::DocViewer;
@@ -103,6 +103,36 @@ sub run
 }
 
 
+=head2 help()
+
+=cut
+
+
+# Descriptions: show help
+#    Arguments: none
+# Side Effects: none
+# Return Value: none
+sub help
+{
+    my $name = $0;
+    eval {
+	use File::Basename;
+	$name = basename($0);
+    };
+
+print <<"_EOF_";
+
+Usage: $name \$command \$ml_name [options]
+
+$name help         \$ml_name                   show this help
+
+$name subscribe    \$ml_name ADDRESS
+$name unsubscribe  \$ml_name ADDRESS
+
+_EOF_
+}
+
+
 # Descriptions: fmldoc wrapper / top level dispacher
 #    Arguments: $self $args
 # Side Effects: none