Changeset 4359 for trunk/glueforge/glueforge.in

Timestamp:

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

Author:

jhoblitt

Message:

pod corrections and improvements

File:

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

trunk/glueforge/glueforge.in

@@ -3 +3 @@
 # Copyright (C) 2005  Joshua Hoblitt
 #
-# $Id: glueforge.in,v 1.25 2005-06-23 01:34:31 jhoblitt Exp $
+# $Id: glueforge.in,v 1.26 2005-06-23 01:56:56 jhoblitt Exp $
 
 use strict;
@@ -190 +190 @@
 =head1 SYNOPSIS
 
-    md2db.pl --input <filename> [--output <filename>] [--template <dirname> ]
+    md2db.pl --input <filename> [--output <dirname>] [--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.
+This program generates a set of database table specific bindings in the ANSI C
+language.  The code generated is largely just wrapper functions around the
+C<pslib> C<DB> API.  A simple table description is read in and a directory
+containing a complete, distributable software package is created.
 
 =head2 Features
@@ -213 +213 @@
 =item * Builds both shared and static libraries by default.
 
-=item * Generates man pages and HTML documentation with doxygen.
+=item * Generates man pages and HTML documentation with Doxygen.
 
 =item * Header files should be C++ safe.
 
+=item * Functions to open and close database connections.
+
+=item * Functions to create and destroy a table of the appropriate format.
+
+=item * Functions to insert and pop a row.
+
+=item * Functions to insert and pop a simple object representing a row.
+
+=item * Functions to insert, select, and pop to/from FITS files.
+
+=item * Functions to convert between row structs and C<psMetadata>s.
+
 =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.
+=head1 TABLE DESCRIPTION FORMAT
+
+A simple config files specifies the name of the table, the name and types of
+all columns, and can optional specify which column are to be used as indexes.
+These C<Table Description> files are in the C<Configuration files> format as
+described in C<PSDC-430-007>.
 
 =head2 Example table description
@@ -233 +247 @@
     zot     BOOL    t       # Key
 
+The key name C<table> is reserved and specifies the name of the database table.
+It may appear any where in the file but it is most I<convenient> to have it as
+the first line of the table description.
+
+The value of a C<STR> column specifies the maximum number of characters that
+the database is required to store for that field.  The values for C<S32>,
+C<F32>, C<F64>, & C<BOOL> columns are ignored.
+
+Keys maybe specified as a C<Primary Key> or C<Key>.  Only one C<Primary Key>
+may be specified per table.
+
+The key name C<position> is also reserved as it is used internally by the
+database bindings.
+
 =head1 OPTIONS