clean up comments

4 files changed, 53 insertions, 42 deletions

diff --git a/fml/bin/fmldoc b/fml/bin/fmldoc
deleted file mode 100755
index 48552a86..00000000
--- a/fml/bin/fmldoc
+++ /dev/null
@@ -1,27 +0,0 @@
-#!/usr/local/bin/perl
-#-*- perl -*-
-#
-# Copyright (C) 2000 Ken'ichi Fukamachi
-#          All rights reserved. 
-#
-# $FML$
-#
-
-=head1 NAME
-
-fmldoc -- wrapper for pod2man
-
-=head1 SYNOPSIS
-
-fmldoc filename
-
-=head1 DESCRIPTION
-
-=cut
-
-for $file (@ARGV) {
-    $file =~ s@::@/@g;
-    system "pod2man $file | nroff -man |less";
-}
-
-1;
diff --git a/fml/bin/show_hierarchy.pl b/fml/bin/show_hierarchy.pl
index ce6cd775..7f819cb0 100755
--- a/fml/bin/show_hierarchy.pl
+++ b/fml/bin/show_hierarchy.pl
@@ -99,15 +99,15 @@ sub load
 	    if (/(use|require)\s+([A-Z]\S+[a-zA-Z0-9])/) {
 		unless ( $function_hach{ $current_function } ) {
 		    if ($verbose) {
-			&P();
-			&P( "${name}::". $current_function );
+			&Print();
+			&Print( "${name}::". $current_function );
 		    }
 		    $function_hach{ $current_function } = 1;
 		}
 
-		&P() if $Count == 1;
-		&P() if $Count == 2;
-		$verbose ? &P( $_ , $. ) : &P( $_ );
+		&Print() if $Count == 1;
+		&Print() if $Count == 2;
+		$verbose ? &Print( $_ , $. ) : &Print( $_ );
 		$file = $2;
 		$file =~ s/\"//g;
 		$file =~ s/\'//g;
@@ -128,7 +128,7 @@ sub load
 }
 
 
-sub P
+sub Print
 {
     my ($s, $lc) = @_;
 
diff --git a/fml/bin/show_modules.sh b/fml/bin/show_modules.sh
index c95c6532..b9d036e7 100755
--- a/fml/bin/show_modules.sh
+++ b/fml/bin/show_modules.sh
@@ -1,6 +1,11 @@
 #!/bin/sh
+#
+# $Id$
+#
 
 for x in libexec/[a-z]* FML/*pm
 do
 	sed '/=head1/,/=cut/d' $x |less
 done
+
+exit 0
diff --git a/fml/etc/main.cf b/fml/etc/main.cf
index 486b033a..f3272e4a 100644
--- a/fml/etc/main.cf
+++ b/fml/etc/main.cf
@@ -1,34 +1,67 @@
+# fml version
+#   This is important
+# Example: fml 5.0
+#          fml-current YYYYMMDD
+#          fml-devel YYYYMMDD
 fml_version	=	__fml_version__
 
+
+###
+### DIRECTORIES
+###
+
+
+# $config_dir holds the global main configuration and 
+# several version-dependent default configurations
+# Example: /etc/fml
 config_dir	= 	__config_dir__
 
+
+# 
+# Example: /usr/local
 default_prefix  = 	__default_prefix__
 
+
+# Example: /usr/local/libexec/fml
 libexec_prefix	=	$default_prefix
 
+# Example: /usr/local/lib/fml
 lib_prefix	=	$default_prefix
 
+# Example: /usr/local/libexec/fml/$fml_version
 libexec_dir	= 	$libexec_prefix/libexec/fml/$fml_version
 
+# Example: /usr/local/lib/fml/$fml_version
 lib_dir		=	$lib_prefix/lib/fml/$fml_version
 
-# site local
+# site local library location
+# which is prepared but not used by fml itself
 local_lib_dir	=	$default_prefix/lib/fml/site_local
 
 
-# default_config.cf
-default_config	=	$config_dir/defaults/$fml_version/default_config.cf
+# ml's home directories
+# $ml_home_dir (e.g. /var/spool/ml/elena ) is taken from loader's @ARGV.
+# This is compatible with fml 4.0.
+# Example: /var/spool/ml
+ml_home_prefix	= /var/spool/ml
+
+
+
+###
+### CONFIGURATION FILES AND DEFAULT PARAMETERS
+###
 
 
 # default domain
 default_domain	=	fml.org
 
 
-# domain specific configurations
-domain_default_config = $config_dir/domains/__domain__/config.cf
+# version dependent default_config.cf location
+# whic holds
+# Example: /etc/fml/defaults/5.0/default_config.cf
+default_config	=	$config_dir/defaults/$fml_version/default_config.cf
 
 
-# ml's home directories
-# $ml_home_dir (e.g. /var/spool/ml/elena ) is taken from loader's @ARGV.
-
-ml_home_prefix	= /var/spool/ml
+# domain specific configurations
+# Example: /etc/fml/domains/fml.org/default_config.cf
+domain_default_config = $config_dir/domains/$default_domain/config.cf