summaryrefslogtreecommitdiff
path: root/fml/libexec
diff options
context:
space:
mode:
authorfukachan <fukachan>2001-03-09 04:24:39 +0000
committerfukachan <fukachan>2001-03-09 04:24:39 +0000
commitb08b2a5f71053fc4bf87141b84365285e0c90692 (patch)
treebebcc32579a4ddc6d44c761390c4b27c511c5e4f /fml/libexec
parent15776c09375567276f6cbf3321c780d6467540af (diff)
downloadfml8-b08b2a5f71053fc4bf87141b84365285e0c90692.tar.gz
fml8-b08b2a5f71053fc4bf87141b84365285e0c90692.tar.bz2
fml8-b08b2a5f71053fc4bf87141b84365285e0c90692.zip
clean up documents
Diffstat (limited to 'fml/libexec')
-rw-r--r--fml/libexec/.cvsignore1
-rw-r--r--fml/libexec/Makefile15
-rw-r--r--fml/libexec/Standalone.pm61
-rw-r--r--fml/libexec/index.ja.html33
-rwxr-xr-xfml/libexec/loader24
5 files changed, 133 insertions, 1 deletions
diff --git a/fml/libexec/.cvsignore b/fml/libexec/.cvsignore
new file mode 100644
index 00000000..b643ba41
--- /dev/null
+++ b/fml/libexec/.cvsignore
@@ -0,0 +1 @@
+@@doc
diff --git a/fml/libexec/Makefile b/fml/libexec/Makefile
new file mode 100644
index 00000000..441df182
--- /dev/null
+++ b/fml/libexec/Makefile
@@ -0,0 +1,15 @@
+all: anal
+
+anal:
+ @ find . | sort | grep -v CVS | sed 's@./@@'
+
+html: _clean index.ja.html
+
+index.ja.html: *.pm
+ ../../doc/bin/dir2url.pl > index.ja.html
+
+_clean:
+ rm -f index.ja.html */index.ja.html
+
+clean:
+ (cd ../..;make clean)
diff --git a/fml/libexec/Standalone.pm b/fml/libexec/Standalone.pm
index 069e7e3a..e88327b0 100644
--- a/fml/libexec/Standalone.pm
+++ b/fml/libexec/Standalone.pm
@@ -14,6 +14,46 @@ package Standalone;
use strict;
use Carp;
+=head1 NAME
+
+Standalone - minimal parser for libexec/* programs
+
+=head1 SYNOPSIS
+
+ use Standalone;
+ my $main_cf = Standalone::load_cf($main_cf_file, $params);
+
+where $param is optional and the format of it is
+
+ $params = "key1=value1 key2=value2";
+
+=head1 DESCRIPTION
+
+C<load_cf()> reads the C<key = value> style configuration file and
+return the hash. The file format is like this:
+
+ key1 = value1
+
+ key2 = value2
+ value3
+
+key2 is equivalent to
+
+ key2 = value2 value3
+
+A set of space separeted elements is an array of values.
+
+
+=head1 METHODS
+
+=head2 C<load_cf()>
+
+load "key = value" style configuration file and build a hash.
+return the reference to the hash.
+
+=cut
+
+
# Descriptions: load "key = value" style configuration.
# It is available to use the following style.
# key = value1 value2
@@ -121,4 +161,25 @@ sub _parse_params
}
+
+
+=head1 AUTHOR
+
+Ken'ichi Fukamachi
+
+=head1 COPYRIGHT
+
+Copyright (C) 2001 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.
+
+=head1 HISTORY
+
+Standalone appeared in fml5 mailing list driver package.
+See C<http://www.fml.org/> for more details.
+
+=cut
+
+
1;
diff --git a/fml/libexec/index.ja.html b/fml/libexec/index.ja.html
new file mode 100644
index 00000000..4dbc8e55
--- /dev/null
+++ b/fml/libexec/index.ja.html
@@ -0,0 +1,33 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<HTML>
+<HEAD>
+<TITLE>
+exec::* classes
+</TITLE>
+<META http-equiv="Content-Type"
+ content="text/html; charset=EUC-JP">
+</HEAD>
+
+<BODY BGCOLOR="#E6E6FA">
+<CENTER><EM>exec class modules</EM></CENTER>
+<HR>
+<TABLE>
+<TR>
+<TD>
+ Standalone.pm <TD>
+<A HREF="Standalone.pm">[source]</A>
+<TD>
+<A HREF="@@doc/Standalone.txt">[manual]</A>
+<TD>
+<TR>
+<TD>
+ loader <TD>
+<A HREF="loader">[source]</A>
+<TD>
+<A HREF="@@doc/loader.txt">[manual]</A>
+<TD>
+</TABLE>
+</BODY>
+</HTML>
+*** warning ***
+unknown file type boot.ja.html
diff --git a/fml/libexec/loader b/fml/libexec/loader
index bc54f920..7d572642 100755
--- a/fml/libexec/loader
+++ b/fml/libexec/loader
@@ -4,7 +4,7 @@
# Copyright (C) 2000-2001 Ken'ichi Fukamachi
# All rights reserved.
#
-# $Id: loader,v 1.11 2001/02/17 07:39:38 fukachan Exp $
+# $Id: loader,v 1.12 2001/02/17 14:39:16 fukachan Exp $
# $FML$
#
@@ -112,3 +112,25 @@ C<--params>
--params 'key1=value1 key2=value2 ...'
=cut
+
+
+=head1 AUTHOR
+
+Ken'ichi Fukamachi
+
+=head1 COPYRIGHT
+
+Copyright (C) 2001 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.
+
+=head1 HISTORY
+
+libexec/loader appeared in fml5 mailing list driver package.
+See C<http://www.fml.org/> for more details.
+
+=cut
+
+
+1;