1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
.TH DBENGINE 1 "26 May 02" "Debian GNU/Linux" "dbengine manual"
.SH NAME
dbengine \- a plug 'n play Web interface for mySQL, PostgreSQL and Oracle
.SH SYNOPSIS
.B dbengine
.SH "DESCRIPTION"
This manual page documents briefly the
.B dbengine
CGI program.
.P
This manual page was written for the Debian GNU/Linux distribution
because the original program does not have a manual page.
Instead, it has documentation in HTML format; see below.
.PP
.B dbengine
is an interface between the WWW and PostgresSQL, Oracle or mySQL which
provides simple access to any existing database within just a few minutes.
.SH OPTIONS
If anything doesn't work as expected it's most likely that some of the variables internal to
.B dbengine.cgi
are not configured properly.
.P
Therefore open the file you specified during setup as
.I configuration file
and/or the CGI itself in your favorite editor and change the few available variables to values that are valid for your local system as follows:
.TP
.B $config_file
.I (in dbengine.cgi)
.IP
.B default: "/usr/local/httpd/cgi-bin/dbengine/dbengine.conf"
.IP
Location of the configuration file generated by Makefile.PL during setup. This file contains most of the other variable initialisations. Therefor it is absolutely neccessary that this file reference in
.B dbengine.cgi
is correct.
.TP
.B @path_to_local_modules
.I (in dbengine.cgi)
.B default: /usr/local/lib/perl5
.IP
This can hold a reference to the directory where your perl extensions have been installed.
.TP
.B $dbasetype
.IP
.B no default
.IP
This has to be set to either of the values postgres, mysql or oracle.
.TP
.B $server
.IP
.B default: "localhost"
.IP
Domain of the server where your database lives. The default value should most likely work for you.
.I (PostgreSQL only)
.TP
.B $port
.IP
.B default: "5432"
.IP
Port of the database server as specified for the compilation of PostgreSQL. The default value should most likely work for you.
.I (PostgreSQL only)
.TP
.B $user
.IP
.B default: "postgres"
.IP
User to access the database with.
.I (PostgreSQL only)
.TP
.B $passwd
.IP
.B default: ""
.IP
Password (if any) to access the database using $user.
.I (PostgreSQL only)
.TP
.B $defdb
.IP
.B default: "cis" [Oracle: "cis/zwerg"]
.IP
.B Postgres:
Name of the default
.I database
which will be used in case no database is specified when the CGI is called.
.IP
.B Oracle:
Name of the default
.I user
which will be used in case no user
is specified when the CGI is called followed by "/" and the password
which is required to access the tables of this user.
.IP
.TP
.B $descdb
.IP
.B default: "cisinfo" [Oracle: "cisinfo/zwerg"]
.IP
.B Postgres:
Name of default
.I database
with additional display and relation
informations. If there's no such database available and no valid alternative
given wen the CGI is called
.B dbengine
will try to find its information
in the database that conatains your standard data.
.IP
.B Oracle:
Name of default
.I user
with additional display and relation
informations followed by "/" and the password which is required to access
the tables of this user. If there's no such user available and no valid
alternative given wen the CGI is called
.B dbengine
will try to find its
information in the database that conatains your standard data.
.IP
.TP
.B $oraTWOTASK
.IP
.B default: ""
.IP
TWO_TASK environment variable for access to external databases which don't reside on the local machine.
.I (Oracle only)
.TP
.B $oraSID
.IP
.B default: "CIS"
.IP
ORACLE_SID environment variable as reference to the database dbengine shall use.
.I (Oracle only)
.TP
.B $oraSID
.IP
.B default: "/opt/oracle/actual/product/8.0.5"
.IP
ORACLE_HOME environment variable as reference to the local database installation directory.
.I (Oracle only)
.TP
.B $htdocs
.IP
.B default: "/usr/local/httod/htdocs/"
.IP
Absolute UNIX path to the document-root directory of your WWW Server.
.TP
.B $abs_cgi
.IP
.B default: "/usr/local/httpd/cgi-bin/dbengine/"
.IP
Absolute UNIX path to directory where dbengine.cgi shall be installed.
.TP
.B $templ
.IP
.B default: "/usr/local/httpd/cgi-bin/dbengine/template/"
.IP
Absolute UNIX path to folder where template .html files can be stored for processing.
.B dbengine
will use these to create pages with your data on the fly that look nicer then what comes out of the default algorithm.
.TP
.B $tmp
.IP
.B default: "/tmp/"
.IP
.B dbengine
sometimes generates temporary web pages which have to be saved to files. Therefore you'll have to create a folder which is writable for the HTTP server and accessable for our CGI. .P
I simply created a folder called "/tmp" inside my htdocs folder. Set this variable to the "absolute" path to a folder for temporary .html files..P
"Absolute" for this path means always relative to your httpd document root directory since this is "abolute" for any .html files. Therefore this can be considered an "absolute http path".
.TP
.B $language
.IP
.B default: english
.IP
If you want
.B dbengine
to provide German output you should set this to "german".
.TP
.B $bgcol
.IP
.B default: "#C4DDFF"
.IP
Background color for the generated pages. The default is a light blue.
.TP
.B $bgPath
.IP
.B default: "/bgimages/"
.IP
This one has to be set to the absolute http path to the folder where optional background images for the to generated frames are saved. .P
"Absolute" for this path means always relative to your httpd document root directory.
.TP
.B $bgType
.IP
.B default: ".jpeg"
.IP
Filename extension to be used for the automatic generation of backgrund image names..P
If a file "$htdocs$bgPath$dbase$bfType" exists this will be used a background image for the current database with name $dbase.
.TP
.B $menuBackground
.IP
.B default: "menuBG.jpeg"
.IP
Default filename for the optionally integrated backgrund images in the menu frame. The file has to be located in $htdocs$bgPath..P
This one will be overridden if a file "$htdocs$bgPath$dbase$bfType" exists this will be used a background image for the current database with name $dbase.
.TP
.B $mainBackground
.IP
.B default: "mainBG.jpeg"
.IP
Default filename for the optionally integrated backgrund images in the main frame. The file has to be located in $htdocs$bgPath.
.TP
.B $smarttable
.IP
.B default: "1"
.IP
Turn on or off the display of smart tables. Can be set to "0" or "1".
.TP
.B $maxwidth
.IP
.B default: "45"
.IP
Maximum width of an automatically generated text field.
.SH "SEE ALSO"
The programs are documented fully in the HTML documentation.
.SH AUTHOR
This manual page was written by Jeremy Malcolm <terminus@debian.org>,
for the Debian GNU/Linux system (but may be used by others).
|
