← Back to branch summary

~ubuntu-branches/ubuntu/hardy/gnue-common/hardy

« back to all changes in this revision

Viewing changes to doc/man/gnue-schema.1

  • Committer: Bazaar Package Importer
  • Author(s): Andrew Mitchell
  • Date: 2005-03-09 11:06:31 UTC
  • Revision ID: james.westby@ubuntu.com-20050309110631-8gvvn39q7tjz1kj6
Tags: upstream-0.5.14
Import upstream version 0.5.14

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/gnue-schema.1
 
1
.TH GNUE\-SCHEMA 1 "08 March 2005" "GNUe Schema Scripter"
 
2
.SH NAME
 
3
gnue\-schema \- GNUe Schema Scripter
 
4
.SH SYNOPSIS
 
5
.B gnue\-schema
 
6
[
 
7
.I options
 
8
]
 
9
.I gsd-file
 
10
.I [gsd-file
 
11
.I gsd-file
 
12
.I ...]
 
13
.SH DESCRIPTION
 
14
GNUe Schema Scripter creates database schemas based on GNUe Schema 
 
15
Definitions.
 
16
 
 
17
.SH OPTIONS
 
18
.TP
 
19
.B GENERAL OPTIONS
 
20
.TP
 
21
.TP
 
22
.B \-\-connection <connectionname>, \-c
 
23
Use the connection <connectionname> for creating the schema
 
24
.TP
 
25
.B \-\-connections <loc>
 
26
Specifies the location of the connection definition file. <loc> may 
 
27
specify a file name (/usr/local/gnue/etc/connections.conf),or a URL 
 
28
location (http://localhost/connections.conf).If this option is not 
 
29
specified, the environent variable GNUE_CONNECTIONS is checked.If 
 
30
neither of them is set, "/home/reinhard/gnue/etc/connections.conf" 
 
31
is used as a default.
 
32
.TP
 
33
.B \-\-createdb, \-d
 
34
If this option is set, the database will be created before any 
 
35
schema creation is done. There must be a username either from the 
 
36
given connection\-configuration or from the command line. This user 
 
37
becomes the owner of the database and will be implicitly created.
 
38
.TP
 
39
.B \-\-debug-file <filename>
 
40
Sends all debugging messages to a specified file (e.g., 
 
41
"\-\-debug\-file trace.log" sends all output to "trace.log")
 
42
.TP
 
43
.B \-\-debug-level <level>
 
44
Enables debugging messages.  Argument specifies the level of 
 
45
messages to display (e.g., "\-\-debug\-level 5" displays all 
 
46
debugging messages at level 5 or below.)
 
47
.TP
 
48
.B \-\-file-only, \-f
 
49
If this flag is set, only code is sent to the output file and the 
 
50
schema is not created automatically.
 
51
.TP
 
52
.B \-\-help
 
53
Displays this help screen.
 
54
.TP
 
55
.B \-\-help-config
 
56
Displays a list of valid configuration file entries, their purpose, 
 
57
and their default values.
 
58
.TP
 
59
.B \-\-help-connections
 
60
Display help information related to database connections, including 
 
61
a list of available drivers.
 
62
.TP
 
63
.B \-\-help-dev
 
64
Display all options of interest to core developers.
 
65
.TP
 
66
.B \-\-mode <both|schema|data>, \-m
 
67
Mode of operation. If mode is 'schema', only schema creation is done.
 
68
 If mode is 'data' only data integration is done.
 
69
.TP
 
70
.B \-\-output <filename>, \-o
 
71
Also send the code for creating the schema to this file.
 
72
.TP
 
73
.B \-\-password <password>, \-p
 
74
Set the password for the database.
 
75
.TP
 
76
.B \-\-silent
 
77
Displays no output at all.
 
78
.TP
 
79
.B \-\-username <user>, \-u
 
80
Set the username for the database. If the database is to be created, 
 
81
this username will be it's owner.
 
82
.TP
 
83
.B \-\-version
 
84
Displays the version information for this program.
 
85
.TP
 
86
.B \-\-yes, \-y
 
87
If this option is set, the program runs in batch\-mode, which means 
 
88
all questions are answered with 'yes' automatically.
 
89
.TP
 
90
.B DEVELOPER OPTIONS
 
91
.TP
 
92
.TP
 
93
.B \-\-interactive-debugger
 
94
Run the app inside Python's built\-in debugger
 
95
.TP
 
96
.B \-\-profile
 
97
Run Python's built\-in profiler and display the resulting run 
 
98
statistics.
 
99
.TP
 
100
.B \-\-selfdoc <type[,subtype]>
 
101
Generates self\-documentation.
 
102
.TP
 
103
.B \-\-selfdoc-file <filename>
 
104
Specifies the filename that selfdoc should write to. If not provided,
 
105
 output is sent to stdout.
 
106
.TP
 
107
.B \-\-selfdoc-format <format>
 
108
Format to output the self\-documentation in. Supported formats are 
 
109
dependent on the type of selfdoc being created.
 
110
.TP
 
111
.B \-\-selfdoc-options <options>
 
112
Options specific to individual selfdoc types.
 
113
.SH AUTHOR
 
114
GNU Enterprise Project <info@gnue.org>
 
115
.SH BUGS
 
116
Please report any bugs to info@gnue.org.
 
117
Include a complete, self-contained example
 
118
that will allow the bug to be reproduced,
 
119
and say which version of this tool you are using.
 
120
.SH COPYRIGHT
 
121
Copyright \(co 2000-2005 Free Software Foundation, Inc.
 
122
.LP
 
123
gnue\-schema is free software; you can redistribute it and/or modify it under
 
124
the terms of the GNU General Public License as published by the Free
 
125
Software Foundation; either version 2, or (at your option) any later
 
126
version.
 
127
.LP
 
128
gnue\-schema is distributed in the hope that it will be useful, but WITHOUT ANY
 
129
WARRANTY; without even the implied warranty of MERCHANTABILITY or
 
130
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 
131
for more details.
 
132
.LP
 
133
You should have received a copy of the GNU General Public License along
 
134
with gnue\-schema; see the file COPYING.  If not, write to the Free Software
 
135
Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.