Changeset 4358 for trunk/glueforge/glueforge.in

Timestamp:

Jun 22, 2005, 3:34:31 PM (21 years ago)

Author:

jhoblitt

Message:

add pod

File:

• trunk/glueforge/glueforge.in (modified) (2 diffs)

trunk/glueforge/glueforge.in

@@ -3 +3 @@
 # Copyright (C) 2005  Joshua Hoblitt
 #
-# $Id: glueforge.in,v 1.24 2005-06-22 03:09:28 jhoblitt Exp $
+# $Id: glueforge.in,v 1.25 2005-06-23 01:34:31 jhoblitt Exp $
 
 use strict;
@@ -180 +180 @@
 }
 
+__END__
+
+=pod
+
+=head1 NAME
+
+md2db.pl - auto-generate 'meta' database bindings
+
+=head1 SYNOPSIS
+
+    md2db.pl --input <filename> [--output <filename>] [--template <dirname> ]
+
+=head1 DESCRIPTION
+
+This program generates a set table description specific database bindings.  The
+code generated is larger just wrapper functions around the C<pslib> C<DB> API.
+The table description is read in from a file in the C<Metadata Config File>
+format.
+
+=head2 Features
+
+=over 4
+
+=item * Generates a complete autoconf/automake/libtool package.
+
+=item * Generated packages include an C<autogen.sh> script.
+
+=item * Installs a pkgconfig C<.pc> data file.
+
+=item * Includes a table specific autotest test suite.
+
+=item * Builds both shared and static libraries by default.
+
+=item * Generates man pages and HTML documentation with doxygen.
+
+=item * Header files should be C++ safe.
+
+=back
+
+=head1 CONFIG FILE FORMAT
+
+Configuration files specify the name of the table, the name and types of all
+columns, and can optional specify which column are to be used as indexes.
+
+=head2 Example table description
+
+    table   STR     foo
+    foo     STR     60      # Primary Key
+    bar     S32     0
+    baz     F32     0.0
+    boing   F64     0.0
+    zot     BOOL    t       # Key
+
+=head1 OPTIONS
+
+=over 4
+
+=item * --input|-i <filename>
+
+File to read table description from.
+
+=item * --output|-o <dirname>
+
+Send the generate files to this directory name.  Defaults to the name of the
+database table.
+
+Defaults to write to STDOUT.
+
+=item * --template|-t <dirname>
+
+Directory to load template files from.
+
+=back
+
+=head1 CREDITS
+
+Just me, myself, and I.
+
+=head1 SUPPORT
+
+Please contact the author directly via e-mail.
+
+=head1 AUTHOR
+
+Principle authors and contact info.
+
+=head1 COPYRIGHT
+
+Copyright (C) 2005  Joshua Hoblitt.  All rights reserved.
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+this program; if not, write to the Free Software Foundation, Inc., 59 Temple
+Place - Suite 330, Boston, MA  02111-1307, USA.
+
+The full text of the license can be found in the L<perlgpl> Pod as supplied
+with Perl 5.8.1 and later.
+
+=head1 SEE ALSO
+
+L<PS:IPP::Metadata::Config>
+
+=cut