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
|
.\" libmsql - Mini SQL Programming API
.\" Copyright (c) 1996 Martin Schulze <joey@office.individual.net>
.\"
.\" This program 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 of the License, or
.\" (at your option) any later version.
.\"
.\" This program 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.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc.,59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
.\"
.\" This manual page is written especially for Debian GNU/Linux.
.\"
.TH LIBMSQL 3 "5 Sep 1996" "Mini SQL" "mSQL Programmer's Manual"
.SH NAME
libmsql \- Mini SQL Programming API
.SH DESCRIPTION
Included in the distribution is the Mini SQL API library,
.IR libmsql.a " or libmsql.so.1.0.16
respectively. The API allows any C program to communicate with the
database engine. The API functions are accessed
by including the
.I <msql.h>
header file into your program and by linking against the Mini SQL
library (using
.B -lmsql
as an argument to your C compiler). The library and header file is
installed by default into
.IR /lib " and " /usr/include
respectively.
.SH ENVIRONMENT
The mSQL library may be controlled by some environment variables. They
override compiled-in default values and they are used when not
arguments are spcified. They may be overridden by arguments
(i.e. msqlConnect()).
.TP
.I MSQL_TCP_PORT
Specifies the TCP port on which the database engine listen to
requests.
.TP
.I MSQL_UNIX_PORT
Specifies the unix domain socket that shall be used to contact the
engine if it runs on the local host.
.TP
.I MSQL_DEBUG
Specify debuging. See section DEBUGGING for a list of possible values.
.SH DEBUGGING
If you wish to debug the API you may set
.I MSQL_DEBUG
to one or more of the folowing values, separated by a colon ``:''.
The values are the same as described in
.BR msqld (8)
with the modification that they are prefixed by ``msql_''.
.TP
.B msql_api
Display internal information, such as connection details.
.TP
.B msql_query
Display each query as it is sent to the engine. This is very useful
especially if you're programming an appliction but queries fail.
.TP
.B msql_malloc
Display details of memory allocation.
.SH NOTE
As an addition to the standard behaviour of the API library the Debian
Linux release also accepts an extented form of a hostname, typical for
IRC. It consists of either a hostname or a hostname followed by a
colon and a port number (e.g. finlandia:4321). By adding this feature
you get an easy way to handle different database engines on different
hosts and different ports. You may also use the
.IR MSQL_HOST " and " MSQL_TCP_PORT
environment variable to specify a database engine.
.SH AUTHOR
Mini SQL has been written by David Hughes of Bond University,
Australia as part of the Minerva Network Management
Environment. He may be reached via electronic mail using
bambi@Bond.edu.au.
.SH "SEE ALSO"
.BR msqlConnect (3),
.BR msqlSelectDB (3),
.BR msqlQuery (3),
.BR msqlStoreResult (3),
.BR msqlFreeResult (3),
.BR msqlFetchRow (3),
.BR msqlDataSeek (3),
.BR msqlNumRows (3),
.BR msqlFetchField (3),
.BR msqlFieldSeek (3),
.BR msqlNumFields (3),
.BR msqlListDB (3),
.BR msqlListTables (3),
.BR msqlListFields (3),
.BR msqlClose (3),
.BR msqld (8),
.BR msql (5).
.\" msqlConnect msqlSelectDB msqlQuery msqlStoreResult msqlFreeResult
.\" msqlFetchRow msqlDataSeek msqlNumRows msqlFetchField msqlFieldSeek
.\" msqlNumFields msqlListDB msqlListTables msqlListFields msqlClose
|
