releasing package mysqltcl version 3.052-3
[sven/mysqltcl.git] / README-msqltcl
1
2 Msqltcl --   Tcl interface to the Mini SQL (mSQL) database server
3              by David J. Hughes
4
5 Author:      Hakan Soderstrom, hs@soderstrom.se
6 Affiliation: Soderstrom Programvaruverkstad AB, Bandhagsvagen 51,
7              S-122 42 Enskede, Sweden
8
9 -------------------------------------------
10 Copyright (c) 1994, 1995 Hakan Soderstrom and Tom Poindexter
11 Additional details at end of this file.
12 -------------------------------------------
13
14
15 VERSIONS, PORTS
16
17 This is release 1.50 of msqltcl. It has been tested with Tcl 7.3,
18 Tk 3.6p1, TclX 7.3a-p2; Tcl 7.4b2, Tk 4.0b2, TclX 7.4a-b2, mSQL 1.0.6
19 under SunOS 4.1.3. Successful ports to several other platforms have
20 been reported. I would expect msqltcl to run wherever Tcl/Tk and mSQL
21 succeed.
22
23
24 WHAT IS MSQLTCL?
25
26 Msqltcl is an extension to the Tool Command Language (Tcl) that
27 provides high-level access to a Mini SQL (mSQL) database server. Mini
28 SQL (mSQL) is a freely available, lightweight database engine.
29
30 Msqltcl features:
31    -- supports multiple connections to one or more database servers,
32    -- supports all Mini-SQL statements,
33    -- returns SELECT query results either as Tcl lists, or iterates
34       a script over the resulting rows,
35    -- accesses information about databases, tables, columns.
36
37 The package also contains a useful Mini-Monitor (mmon) written in
38 Tcl/Tk. It requires TclX and is currently limited to pre-4.0 Tk.
39
40
41 ACKNOWLEDGEMENTS
42
43 Obviously msqltcl is just a small addition to a much greater work done
44 by John Ousterhout (Tcl/Tk) and David J. Hughes (mSQL).
45
46 Msqltcl is derived from work by Tom Poindexter (tpoindex@nyx.cs.du.edu)
47 whose Sybtcl and Oratcl are useful patterns for Tcl database extensions.
48
49
50 DOCUMENTATION
51
52 Yes, a decent man page.
53
54
55 REQUIREMENTS
56
57 You must have Tcl/Tk and Mini SQL.
58
59 ** Tcl/Tk by John Ousterhout is available from numerous FTP sites. For
60 one-stop retrieval, look in ftp.aud.alcatel.com:/tcl. You will find
61 the Tcl/Tk distribution in /tcl/ftp.cs.berkeley.edu, extensions (one
62 of which is msqltcl) in /tcl/extensions. You may want to get the file
63 /tcl/MIRRORS to discover a mirror site near you.
64
65 The Tcl/Tk Book is "Tcl and the Tk Toolkit" by John K. Ousterhout,
66 Addison-Wesley 1994, ISBN 0-201-63337-X.
67
68 ** Mini SQL (mSQL) is a freely available, lightweight database engine
69 developed by David J. Hughes, Bond University, Australia. The source
70 code can be obtained by FTP from Bond.edu.au:/pub/Minerva/msql.
71
72 There is an mSQL mailing list. Join it by sending a message to
73 msql-list-request@Bond.edu.au.
74
75
76 INSTALLATION
77
78 See the file INSTALL.
79
80
81 BUG REPORTS
82
83 Although I have made a conscientious effort to provide zero-defect
84 software and documentation, this release of msqltcl may still contain
85 blunders of varying magnitudes.
86
87 Comments, suggestions, bug reports (maybe even encouragement!) should be
88 mailed to me at the E-mail address above. Please include some
89 information about your environment (platform, OS version, Tcl/Tk
90 version, mSQL version, msqltcl version). Please include enough
91 information for me to be able to reproduce any suspect behaviour. If you
92 have a solution to a problem, please include a patch.
93
94 I can't guarantee that I will fix your bug, but I'll do my best.
95
96
97 COPYRIGHT & LICENSE
98
99 Copyright (c) 1994, 1995 Hakan Soderstrom, Enskede, Sweden
100 and Tom Poindexter, Denver, Colorado
101
102 Permission to use, copy, modify, distribute, and sell this software
103 and its documentation for any purpose is hereby granted without fee,
104 provided that the above copyright notice and this permission notice
105 appear in all copies of the software and related documentation.
106
107 THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
108 EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
109 WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
110
111 IN NO EVENT SHALL HAKAN SODERSTROM OR SODERSTROM PROGRAMVARUVERKSTAD
112 AB BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL
113 DAMAGES OF ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
114 OF USE, DATA OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY
115 OF DAMAGE, AND ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN
116 CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
117
118 $Revision: 1.1.1.1 $