summaryrefslogtreecommitdiff
path: root/mysqlc
diff options
context:
space:
mode:
authorLionel Elie Mamane <lionel@mamane.lu>2014-08-11 15:47:13 +0200
committerLionel Elie Mamane <lionel@mamane.lu>2014-08-11 15:48:01 +0200
commit0816b00d06eceee3e601177bce1c61e367bbabee (patch)
tree3948fe7456f88189f70c3d9fa68fa0ee08470d89 /mysqlc
parentd9c2eb046c7827d7c1fcf78593a5b450d5ee68ab (diff)
update mysqlc README
Change-Id: I832c31d760d4cc0cb7fcb0c5dfef7b06010d7a3a
Diffstat (limited to 'mysqlc')
-rw-r--r--mysqlc/README67
1 files changed, 41 insertions, 26 deletions
diff --git a/mysqlc/README b/mysqlc/README
index abc5b980d50a..8d0968f0751c 100644
--- a/mysqlc/README
+++ b/mysqlc/README
@@ -5,15 +5,17 @@ It ships as an extension (.oxt file).
== Requirements ==
The MySQL driver for LibreOffice (MySQL Connector/LibreOffice - C/LibO)
-requires two external libraries to be build:
+requires two external libraries to be built:
- 1) The MySQL Client Library (libmysql)
+ 1) The MySQL Client Library (libmysql) or MariaDB Client library
2) The MySQL Connector/C++ Library (libmysqlcppconn)
-libmysql is not included as an external and needs to be provided by
-the build environment, but libmysqlcppconn is provided as an external
-and will be automatically compiled if you pass
-"--without-system-mysql-cppconn" to autogen.sh.
+The MariaDB client library is provided as an external and will be
+automatically built if you pass "--without-system-mariadb" to
+autogens.sh.
+
+libmysqlcppconn is provided as an external and will be automatically
+compiled if you pass "--without-system-mysql-cppconn" to autogen.sh.
The MySQL driver for LibreOffice does not reimplement the MySQL
Client/Server communication protocol. The protocol implementation is
@@ -24,20 +26,24 @@ the C based MySQL Client Library.
== Variants ==
-If configured with --with-system-mysql, the driver will *not* ship a
-copy of the MySQL client C library and will expect it to be installed
-in a standard location on each system that it runs on. That is usually
-the right choice to create a native package/port for GNU/Linux, BSD,
-etc, where the packaging system handles dependencies and will ensure
-the availability of the MySQL client C library in the standard
-location.
-
-If configured with --with-libmysql-path, the driver will ship a copy
-of the MySQL client C library so that it works "out of the box" on any
-system. That is usually the right choice to create a stand-alone .oxt
-file that users can just install through the LibreOffice extensions
-manager, as is typical for Microsoft Windows and Apple MacOS X native
-(as opposed to MacPorts/fink/pkgsrc/...).
+If configured with --with-system-mariadb --disable-bundle-mariadb, the
+driver will *not* ship a copy of the MySQL client C library and will
+expect it to be installed in a standard location on each system that
+it runs on. That is usually the right choice to create a native
+package/port for GNU/Linux, BSD, etc, where the packaging system
+handles dependencies and will ensure the availability of the MySQL
+client C library in the standard location.
+
+If configured with--with-system-mariadb --enable-bundle-mariadb, the
+driver will ship a copy of the MariaDB (or MySQL) client C library so
+that it works "out of the box" on any system. That (or
+--without-system-mariadb) is usually the right choice to create a
+stand-alone .oxt file that users can just install through the
+LibreOffice extensions manager, as is typical for Microsoft Windows
+and Apple MacOS X native (as opposed to MacPorts / fink / pkgsrc /
+...).
+
+--disable-bundle-mariadb is the default.
== Installing the Requirements ==
@@ -45,16 +51,25 @@ On modern/free-as-in-free-speech Unices, libmysql and libmysqlcppconn
are probably available as a package/port. Install them using your
distribution's tools. Make sure to install the development packages
(whose name usually ends with -dev or -devel), and not only the
-libraries themselves. You can use --with-system-mysql or
---with-libmysql-path=/usr/ (but not both).
+libraries themselves.
-Else you can install the MySQL Client Library from official MySQL
-packages at http://dev.mysql.com/downloads/connector/c/ .
+Else you can install the MariaDB Client Library from official MariaDB
+packages at https://downloads.mariadb.org/client-native/ .
+At least series 2.0 is recommended, as series 1.0 are known to be too
+buggy.
They have source and binary distributions for several platforms.
+Alternativaly, MySQL Client Library from official MySQL
+packages are at http://dev.mysql.com/downloads/connector/c/ .
+
You can also install the MySQL Client Library (libmysql) as part of
-the MySQL Server, version 5.0 or later. Check the MySQL manual for
-instructions: http://dev.mysql.com/doc/refman/5.5/en/installing.html
+the MariaDB or MySQL Server, version 5.0 or later. Check the MariaDB
+or MySQL manual for instructions:
+https://mariadb.com/kb/en/mariadb/documentation/getting-started/getting-installing-and-upgrading-mariadb/
+http://dev.mysql.com/doc/refman/5.5/en/installing.html
The typical installation path of the libmysql.so on Unix is
/usr/local/mysql/lib/mysql/ .
+
+Official packages for libmysqlcppconn can be downloaded from
+http://dev.mysql.com/downloads/connector/cpp/