r5881 - in trunk: gnue-appserver/doc/man gnue-common/utils

[reinhard]

Author: reinhard
Date: 2004-06-10 07:59:28 -0500 (Thu, 10 Jun 2004)
New Revision: 5881

Added:
   trunk/gnue-appserver/doc/man/gnue-gcd2sql.1
Modified:
   trunk/gnue-common/utils/update-tool-docs
Log:
New man page for gnue-gcd2sql.


Added: trunk/gnue-appserver/doc/man/gnue-gcd2sql.1
===================================================================
--- trunk/gnue-appserver/doc/man/gnue-gcd2sql.1 2004-06-10 12:57:46 UTC (rev 
5880)
+++ trunk/gnue-appserver/doc/man/gnue-gcd2sql.1 2004-06-10 12:59:28 UTC (rev 
5881)
@@ -0,0 +1,113 @@
+.TH GCD2SQL 1 "10 Juni 2004" "gcd2sql"
+.SH NAME
+gcd2sql \- gcd2sql
+.SH SYNOPSIS
+.ll +8
+.B gcd2sql
+[
+.I options
+]
+[
+.I OPTIONS
+]
+.I file
+.SH DESCRIPTION
+A tool to create a SQL script from a GNUe Class Definition (gcd) file
+
+.SH OPTIONS
+.TP
+.B GENERAL OPTIONS
+.TP
+.TP
+.B \-\-connections <loc>
+Specifies the location of the connection definition file. <loc> may 
+specify a file name (/usr/local/gnue/etc/connections.conf),or a URL 
+location (http://localhost/connections.conf).If this option is not 
+specified, the environent variable GNUE_CONNECTIONS is checked.If 
+neither of them is set, "/home/reinhard/gnue/etc/connections.conf" 
+is used as a default.
+.TP
+.B \-\-debug-file <filename>
+Sends all debugging messages to a specified file (e.g., 
+"\-\-debug\-file trace.log" sends all output to "trace.log")
+.TP
+.B \-\-debug-level <level>
+Enables debugging messages.  Argument specifies the level of 
+messages to display (e.g., "\-\-debug\-level 5" displays all 
+debugging messages at level 5 or below.)
+.TP
+.B \-\-encoding <encoding>, \-e
+The generated SQL script will be encoded using <encoding>. Default 
+encoding is UTF\-8
+.TP
+.B \-\-help
+Displays this help screen.
+.TP
+.B \-\-help-config
+Displays a list of valid configuration file entries, their purpose, 
+and their default values.
+.TP
+.B \-\-help-connections
+Display help information related to database connections, including 
+a list of available drivers.
+.TP
+.B \-\-help-dev
+Display all options of interest to core developers.
+.TP
+.B \-\-output <dest>, \-o
+to be added later
+.TP
+.B \-\-vendor <vendor>, \-v
+The vendor to create a script for. If <vendor> is 'all', then 
+scripts for all supported vendors will be created. <vendor> can also 
+be a comma\-separated list.
+.TP
+.B \-\-version
+Zeigt die Version dieses Programms an.
+.TP
+.B DEVELOPER OPTIONS
+.TP
+.TP
+.B \-\-interactive-debugger
+Run the app inside Python's built\-in debugger
+.TP
+.B \-\-profile
+Run Python's built\-in profiler and display the resulting run 
+statistics.
+.TP
+.B \-\-selfdoc <type[,subtype]>
+Generates self\-documentation.
+.TP
+.B \-\-selfdoc-file <filename>
+Specifies the filename that selfdoc should write to. If not provided,
+ output is sent to stdout.
+.TP
+.B \-\-selfdoc-format <format>
+Format to output the self\-documentation in. Supported formats are 
+dependent on the type of selfdoc being created.
+.TP
+.B \-\-selfdoc-options <options>
+Options specific to individual selfdoc types.
+.SH AUTHOR
+GNU Enterprise Project <address@hidden>
+.SH BUGS
+Please report any bugs to address@hidden
+Include a complete, self-contained example
+that will allow the bug to be reproduced,
+and say which version of this tool you are using.
+.SH COPYRIGHT
+Copyright \(co 2000-2004 Free Software Foundation, Inc.
+.LP
+gcd2sql 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, or (at your option) any later
+version.
+.LP
+gcd2sql 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.
+.LP
+You should have received a copy of the GNU General Public License along
+with gcd2sql; see the file COPYING.  If not, write to the Free Software
+Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Modified: trunk/gnue-common/utils/update-tool-docs
===================================================================
--- trunk/gnue-common/utils/update-tool-docs    2004-06-10 12:57:46 UTC (rev 
5880)
+++ trunk/gnue-common/utils/update-tool-docs    2004-06-10 12:59:28 UTC (rev 
5881)
@@ -25,6 +25,7 @@
 # Appserver 
 (cd gnue-appserver/doc/man && gacvs --selfdoc manpage --selfdoc-file 
gnue-appserver.1)
 (cd gnue-appserver/doc/man && ggcvs --selfdoc manpage --selfdoc-file 
gnue-gsdgen.1)
+(cd gnue-appserver/doc/man && gcdcvs --selfdoc manpage --selfdoc-file 
gnue-gcd2sql.1)
 
 # Navigator
 gcvs $GDTD navigator gnue-navigator/doc/gnue-navigator.dtd