add descriptions and regen()

7 files changed, 264 insertions, 39 deletions

diff --git a/fml/etc/default_config.cf.ja b/fml/etc/default_config.cf.ja
index b56f7338..a4a8cc78 100644
--- a/fml/etc/default_config.cf.ja
+++ b/fml/etc/default_config.cf.ja
@@ -1,21 +1,26 @@
 =head1	基本的なパラメータ
 
-# domain	= fml.org
-# fqdn		= mx0.fml.org
-
-
 =head2	ＭＬの管理者
 
 # Descriptions: いわゆるＭＬの管理者、エラーメールの返る先
 #      History: fml 4.0 の $MAINTAINER
 #        Value: rfc822_address
+#     Examples: elena-admin@fml.org
 maintainer	=
 
 
 =head2	default modes
 
+# Descriptions: ファイルを作成する時のデフォルトモード
+#      History:
+#        Value:
+#     Examples:
 default_file_mode	=	0600
 
+# Descriptions: ディレクトリを作成する時のデフォルトモード
+#      History:
+#        Value:
+#     Examples:
 default_directory_mode	=	0755
 
 =head1	ディレクトリ
@@ -130,15 +135,26 @@ system_accounts		=	root
 
 =head1		MTA の設定
 
-# ひとつの SMTP トランザクションで MTA に渡す受信者の数の上限
-# デフォルトは postfix にあわせて 1000
+# Descriptions: ひとつの SMTP トランザクションで MTA に渡す受信者の数の上限
+#               デフォルトは postfix にあわせて 1000
+#      History: 4.0 で直接対応するものはない。
+#               $MCI_SMTP_HOSTS は似ているがちょっと違う
+#        Value: number
+#     Examples: 
 recipient_limit		=	1000
 
-# デフォールトの MTA は自分自身( localhost ) 
+# Descriptions: デフォールトの MTA は自分自身( localhost ) 
+#               IPv6 の loopback がデフォルトなのがおしゃれ :-)
+#      History: fml 4.0 の $HOST
+#        Value: host:port
+#     Examples:
 smtp_servers		=	[::1]:25
 				127.0.0.1:25
 
-# MAIL FROM:<$smtp_sender>
+# Descriptions: SMTP の MAIL FROM:<$smtp_sender> で使うパラメータ
+#      History: fml 4.0 の $SMTP_SENDER
+#        Value: mail_address (RFC822 の addrspec)
+#     Examples: elena-admin@fml.org
 smtp_sender		=	$maintainer
 
 =head1	ヘッダの操作
@@ -328,25 +344,58 @@ available_commands		=	help
 					unsubscribe
 					chaddr
 
-=head1	Tickets / Trouble Tickets System
-
+=head1	チケットシステム
 
+# Descriptions: チケットシステムを使うか
+#      History: fml 5.0 new
+#        Value: yes / no
+#     Examples:
 use_ticket		=	yes
 
+# Descriptions: チケットシステムのモデル
+#               ドライバ名ともいう
+#      History: fml 5.0 new
+#        Value: string
+#     Examples:
 ticket_model		=	toymodel
 
+# Descriptions: チケットにつけるＭＬ名
+#               複数のＭＬにまたがったチケットを追跡するために
+#               必要
+#      History: fml 5.0 new
+#        Value: string
+#     Examples: elena
 ticket_subject_tag_name	=	$ml_name
 
+# Descriptions: チケット番号のシンタックス
+#      History: fml 5.0 new
+#        Value:
+#     Examples: elena_#00001010
 ticket_id_syntax	=	$ml_name_#%08d
 
-# please use [] or () or {} for the ends
+# Descriptions: Subject につけるチケット番号のシンタックス
+#               []  ()  {} などを $ticket_id_syntax の
+#               前後につけてもらうとわかりやすそう
+#      History: fml 5.0 new
+#        Value:
+#     Examples: [elena_#00001010]
 ticket_subject_tag	=	[$ticket_id_syntax]
 
+# Descriptions: チケット番号を保存するファイル
+#      History: fml 5.0 new
+#        Value: filename
+#     Examples: /var/spool/ml/elena/ticket.seq
 ticket_sequence_file	=	$ml_home_dir/ticket.seq
 
-# top directory
+# Descriptions: チケット関連データを保存するディレクトリ
+#               実際にはこの下に elena/article.db のように
+#               サブディレクトリがおかれる
+#      History: fml 5.0 new
+#        Value: directory
+#     Examples: /var/spool/ml/@db@/ticket
 ticket_db_dir		=	$shared_db_dir/ticket
 
+
 =head1	データベース管理システムとの連携
 
 ###
@@ -436,8 +485,16 @@ ldap_query_filter	=
 
 =head1	CGI 関連の設定
 
+# Descriptions: デフォルトの CHARSET 
+#      History:
+#        Value:
+#     Examples:
 cgi_default_charset	=	euc-jp
 
+# Descriptions: CGI の表示の CHARSET 
+#      History:
+#        Value:
+#     Examples:
 cgi_charset		=	$cgi_default_charset
 
 =head1	プログラムのパス名
@@ -502,18 +559,36 @@ path_pgps	=
 path_pgpv	=	
 
 
-=head1	システム依存
+=head1	システム依存 (主に BSD との非互換性を記述している)
 
 #
 # 注意: デフォールトは NetBSD
 #
 
+# Descriptions: getpwuid(2) があるか？
+#      History:
+#        Value: yes / no
+#     Examples:
 has_getpwuid	=	yes
 
+# Descriptions: getpwgid(2) があるか？
+#      History:
+#        Value: yes / no
+#     Examples:
 has_getpwgid	=	yes
 
+# Descriptions: alarm(2) があるか？
+#      History:
+#        Value: yes / no
+#     Examples:
 has_alarm	=	yes
 
+# Descriptions: select(2) があるか？
+#      History:
+#        Value: yes / no
+#     Examples:
+has_select	=	yes
+
 
 =head1 フック's
 
diff --git a/fml/etc/defaults/basic.cf.ja b/fml/etc/defaults/basic.cf.ja
index fcd23ff7..f1dae330 100644
--- a/fml/etc/defaults/basic.cf.ja
+++ b/fml/etc/defaults/basic.cf.ja
@@ -1,19 +1,24 @@
 =head1	基本的なパラメータ
 
-# domain	= fml.org
-# fqdn		= mx0.fml.org
-
-
 =head2	ＭＬの管理者
 
 # Descriptions: いわゆるＭＬの管理者、エラーメールの返る先
 #      History: fml 4.0 の $MAINTAINER
 #        Value: rfc822_address
+#     Examples: elena-admin@fml.org
 maintainer	=
 
 
 =head2	default modes
 
+# Descriptions: ファイルを作成する時のデフォルトモード
+#      History:
+#        Value:
+#     Examples:
 default_file_mode	=	0600
 
+# Descriptions: ディレクトリを作成する時のデフォルトモード
+#      History:
+#        Value:
+#     Examples:
 default_directory_mode	=	0755
diff --git a/fml/etc/defaults/cgi.cf.ja b/fml/etc/defaults/cgi.cf.ja
index 61be7437..36427977 100644
--- a/fml/etc/defaults/cgi.cf.ja
+++ b/fml/etc/defaults/cgi.cf.ja
@@ -1,5 +1,13 @@
 =head1	CGI 関連の設定
 
+# Descriptions: デフォルトの CHARSET 
+#      History:
+#        Value:
+#     Examples:
 cgi_default_charset	=	euc-jp
 
+# Descriptions: CGI の表示の CHARSET 
+#      History:
+#        Value:
+#     Examples:
 cgi_charset		=	$cgi_default_charset
diff --git a/fml/etc/defaults/delivery.cf.ja b/fml/etc/defaults/delivery.cf.ja
index 39c93c7e..e6d48b09 100644
--- a/fml/etc/defaults/delivery.cf.ja
+++ b/fml/etc/defaults/delivery.cf.ja
@@ -1,12 +1,23 @@
 =head1		MTA の設定
 
-# ひとつの SMTP トランザクションで MTA に渡す受信者の数の上限
-# デフォルトは postfix にあわせて 1000
+# Descriptions: ひとつの SMTP トランザクションで MTA に渡す受信者の数の上限
+#               デフォルトは postfix にあわせて 1000
+#      History: 4.0 で直接対応するものはない。
+#               $MCI_SMTP_HOSTS は似ているがちょっと違う
+#        Value: number
+#     Examples: 
 recipient_limit		=	1000
 
-# デフォールトの MTA は自分自身( localhost ) 
+# Descriptions: デフォールトの MTA は自分自身( localhost ) 
+#               IPv6 の loopback がデフォルトなのがおしゃれ :-)
+#      History: fml 4.0 の $HOST
+#        Value: host:port
+#     Examples:
 smtp_servers		=	[::1]:25
 				127.0.0.1:25
 
-# MAIL FROM:<$smtp_sender>
+# Descriptions: SMTP の MAIL FROM:<$smtp_sender> で使うパラメータ
+#      History: fml 4.0 の $SMTP_SENDER
+#        Value: mail_address (RFC822 の addrspec)
+#     Examples: elena-admin@fml.org
 smtp_sender		=	$maintainer
diff --git a/fml/etc/defaults/system_dependence.cf.ja b/fml/etc/defaults/system_dependence.cf.ja
index 1cc97c7b..017e6cd3 100644
--- a/fml/etc/defaults/system_dependence.cf.ja
+++ b/fml/etc/defaults/system_dependence.cf.ja
@@ -1,12 +1,30 @@
-=head1	システム依存
+=head1	システム依存 (主に BSD との非互換性を記述している)
 
 #
 # 注意: デフォールトは NetBSD
 #
 
+# Descriptions: getpwuid(2) があるか？
+#      History:
+#        Value: yes / no
+#     Examples:
 has_getpwuid	=	yes
 
+# Descriptions: getpwgid(2) があるか？
+#      History:
+#        Value: yes / no
+#     Examples:
 has_getpwgid	=	yes
 
+# Descriptions: alarm(2) があるか？
+#      History:
+#        Value: yes / no
+#     Examples:
 has_alarm	=	yes
 
+# Descriptions: select(2) があるか？
+#      History:
+#        Value: yes / no
+#     Examples:
+has_select	=	yes
+
diff --git a/fml/etc/defaults/tickets.cf.ja b/fml/etc/defaults/tickets.cf.ja
index 9f290ff6..e47212b0 100644
--- a/fml/etc/defaults/tickets.cf.ja
+++ b/fml/etc/defaults/tickets.cf.ja
@@ -1,18 +1,51 @@
-=head1	Tickets / Trouble Tickets System
-
+=head1	チケットシステム
 
+# Descriptions: チケットシステムを使うか
+#      History: fml 5.0 new
+#        Value: yes / no
+#     Examples:
 use_ticket		=	yes
 
+# Descriptions: チケットシステムのモデル
+#               ドライバ名ともいう
+#      History: fml 5.0 new
+#        Value: string
+#     Examples:
 ticket_model		=	toymodel
 
+# Descriptions: チケットにつけるＭＬ名
+#               複数のＭＬにまたがったチケットを追跡するために
+#               必要
+#      History: fml 5.0 new
+#        Value: string
+#     Examples: elena
 ticket_subject_tag_name	=	$ml_name
 
+# Descriptions: チケット番号のシンタックス
+#      History: fml 5.0 new
+#        Value:
+#     Examples: elena_#00001010
 ticket_id_syntax	=	$ml_name_#%08d
 
-# please use [] or () or {} for the ends
+# Descriptions: Subject につけるチケット番号のシンタックス
+#               []  ()  {} などを $ticket_id_syntax の
+#               前後につけてもらうとわかりやすそう
+#      History: fml 5.0 new
+#        Value:
+#     Examples: [elena_#00001010]
 ticket_subject_tag	=	[$ticket_id_syntax]
 
+# Descriptions: チケット番号を保存するファイル
+#      History: fml 5.0 new
+#        Value: filename
+#     Examples: /var/spool/ml/elena/ticket.seq
 ticket_sequence_file	=	$ml_home_dir/ticket.seq
 
-# top directory
+# Descriptions: チケット関連データを保存するディレクトリ
+#               実際にはこの下に elena/article.db のように
+#               サブディレクトリがおかれる
+#      History: fml 5.0 new
+#        Value: directory
+#     Examples: /var/spool/ml/@db@/ticket
 ticket_db_dir		=	$shared_db_dir/ticket
+
diff --git a/fml/etc/defaults/variablelist.ja.html b/fml/etc/defaults/variablelist.ja.html
index 79867338..d5c4a701 100644
--- a/fml/etc/defaults/variablelist.ja.html
+++ b/fml/etc/defaults/variablelist.ja.html
@@ -12,22 +12,27 @@ default_config.cf.ja
 <PRE>
 =head1	基本的なパラメータ
 
-# domain	= fml.org
-# fqdn		= mx0.fml.org
-
-
 =head2	ＭＬの管理者
 
 # Descriptions: いわゆるＭＬの管理者、エラーメールの返る先
 #      History: fml 4.0 の $MAINTAINER
 #        Value: rfc822_address
+#     Examples: elena-admin@fml.org
 maintainer	=
 
 
 =head2	default modes
 
+# Descriptions: ファイルを作成する時のデフォルトモード
+#      History:
+#        Value:
+#     Examples:
 default_file_mode	=	0600
 
+# Descriptions: ディレクトリを作成する時のデフォルトモード
+#      History:
+#        Value:
+#     Examples:
 default_directory_mode	=	0755
 
 =head1	ディレクトリ
@@ -142,15 +147,26 @@ system_accounts		=	root
 
 =head1		MTA の設定
 
-# ひとつの SMTP トランザクションで MTA に渡す受信者の数の上限
-# デフォルトは postfix にあわせて 1000
+# Descriptions: ひとつの SMTP トランザクションで MTA に渡す受信者の数の上限
+#               デフォルトは postfix にあわせて 1000
+#      History: 4.0 で直接対応するものはない。
+#               $MCI_SMTP_HOSTS は似ているがちょっと違う
+#        Value: number
+#     Examples: 
 recipient_limit		=	1000
 
-# デフォールトの MTA は自分自身( localhost ) 
+# Descriptions: デフォールトの MTA は自分自身( localhost ) 
+#               IPv6 の loopback がデフォルトなのがおしゃれ :-)
+#      History: fml 4.0 の $HOST
+#        Value: host:port
+#     Examples:
 smtp_servers		=	[::1]:25
 				127.0.0.1:25
 
-# MAIL FROM:<$smtp_sender>
+# Descriptions: SMTP の MAIL FROM:<$smtp_sender> で使うパラメータ
+#      History: fml 4.0 の $SMTP_SENDER
+#        Value: mail_address (RFC822 の addrspec)
+#     Examples: elena-admin@fml.org
 smtp_sender		=	$maintainer
 
 =head1	ヘッダの操作
@@ -340,25 +356,58 @@ available_commands		=	help
 					unsubscribe
 					chaddr
 
-=head1	Tickets / Trouble Tickets System
-
+=head1	チケットシステム
 
+# Descriptions: チケットシステムを使うか
+#      History: fml 5.0 new
+#        Value: yes / no
+#     Examples:
 use_ticket		=	yes
 
+# Descriptions: チケットシステムのモデル
+#               ドライバ名ともいう
+#      History: fml 5.0 new
+#        Value: string
+#     Examples:
 ticket_model		=	toymodel
 
+# Descriptions: チケットにつけるＭＬ名
+#               複数のＭＬにまたがったチケットを追跡するために
+#               必要
+#      History: fml 5.0 new
+#        Value: string
+#     Examples: elena
 ticket_subject_tag_name	=	$ml_name
 
+# Descriptions: チケット番号のシンタックス
+#      History: fml 5.0 new
+#        Value:
+#     Examples: elena_#00001010
 ticket_id_syntax	=	$ml_name_#%08d
 
-# please use [] or () or {} for the ends
+# Descriptions: Subject につけるチケット番号のシンタックス
+#               []  ()  {} などを $ticket_id_syntax の
+#               前後につけてもらうとわかりやすそう
+#      History: fml 5.0 new
+#        Value:
+#     Examples: [elena_#00001010]
 ticket_subject_tag	=	[$ticket_id_syntax]
 
+# Descriptions: チケット番号を保存するファイル
+#      History: fml 5.0 new
+#        Value: filename
+#     Examples: /var/spool/ml/elena/ticket.seq
 ticket_sequence_file	=	$ml_home_dir/ticket.seq
 
-# top directory
+# Descriptions: チケット関連データを保存するディレクトリ
+#               実際にはこの下に elena/article.db のように
+#               サブディレクトリがおかれる
+#      History: fml 5.0 new
+#        Value: directory
+#     Examples: /var/spool/ml/@db@/ticket
 ticket_db_dir		=	$shared_db_dir/ticket
 
+
 =head1	データベース管理システムとの連携
 
 ###
@@ -448,8 +497,16 @@ ldap_query_filter	=
 
 =head1	CGI 関連の設定
 
+# Descriptions: デフォルトの CHARSET 
+#      History:
+#        Value:
+#     Examples:
 cgi_default_charset	=	euc-jp
 
+# Descriptions: CGI の表示の CHARSET 
+#      History:
+#        Value:
+#     Examples:
 cgi_charset		=	$cgi_default_charset
 
 =head1	プログラムのパス名
@@ -514,18 +571,36 @@ path_pgps	=
 path_pgpv	=	
 
 
-=head1	システム依存
+=head1	システム依存 (主に BSD との非互換性を記述している)
 
 #
 # 注意: デフォールトは NetBSD
 #
 
+# Descriptions: getpwuid(2) があるか？
+#      History:
+#        Value: yes / no
+#     Examples:
 has_getpwuid	=	yes
 
+# Descriptions: getpwgid(2) があるか？
+#      History:
+#        Value: yes / no
+#     Examples:
 has_getpwgid	=	yes
 
+# Descriptions: alarm(2) があるか？
+#      History:
+#        Value: yes / no
+#     Examples:
 has_alarm	=	yes
 
+# Descriptions: select(2) があるか？
+#      History:
+#        Value: yes / no
+#     Examples:
+has_select	=	yes
+
 
 =head1 フック's