Document CMake options for DB2 and Firebird (#85)

Add minor other updates and formatting [ci skip]
SOCI · Mar 5, 2013 · 6692b51 · 6692b51
1 parent aab394b
commit 6692b51
Showing 1 changed file with 78 additions and 9 deletions.
diff --git a/doc/installation.html b/doc/installation.html
@@ -35,6 +35,8 @@ <h3 id="requirements">Requirements</h3>
 
 <p>and backend-specific dependencies:</p>
 <ul>
+<li><a href="http://pic.dhe.ibm.com/infocenter/db2luw/v10r1/topic/com.ibm.swg.im.dbclient.install.doc/doc/c0023452.html">DB2 Call Level Interface (CLI)</a>
+<li><a href="http://www.firebirdsql.org/manual/ufb-cs-clientlib.html">Firebird client library</a>
 <li><a href="http://dev.mysql.com/doc/refman/5.6/en/c.html">mysqlclient</a> - C API to MySQL</li>
 <li><a href="">ODBC (Open Database Connectivity)</a> implementation: <a href="http://msdn.microsoft.com/en-us/library/windows/desktop/ms710252.aspx">Microsoft ODBC</a>,  <a href="http://www.iodbc.org/">iODBC</a>, <a href="http://www.unixodbc.org/">unixODBC</a></li>
 <li><a href="http://www.oracle.com/technetwork/database/features/oci/index.html">Oracle Call Interface (OCI)</a></li>
@@ -47,9 +49,9 @@ <h3 id="downloading">Downloading</h3>
 
 <p>Download package with latest release of the SOCI source code: <a href="https://sourceforge.net/projects/soci/files/soci/">soci-X.Y.Z</a>, where X.Y.Z is the version number. Unpack the archive.</p>
 
-<p>If you intend to hack SOCI, you can clone the Git repository:</p>
+<p>You can always clone SOCI from the Git repository:</p>
 
-<pre>git clone git://soci.git.sourceforge.net/gitroot/soci/soci </pre>
+<pre>git clone git://github.com/SOCI/soci.git</pre>
 
 <h3 id="cmake">Building using CMake</h3>
 
@@ -83,15 +85,82 @@ <h3 id="cmake">Building using CMake</h3>
 <table class="cmake-variables" cellpadding="2" cellspacing="2" summary="SOCI Core configuration">
 <caption class="cmake-variables">List of variables to control common SOCI features and dependencies</caption>
 <tr>
-  <td class="variable-name">WITH_BOOST</td>
+  <td class="variable-name">SOCI_STATIC</td>
   <td class="variable-type">boolean</td>
-  <td>Should CMake try to detect <a href="http://www.boost.org/">Boost C++ Libraries</a>. If ON, CMake will try to find Boost headers and binaries of <a href="http://www.boost.org/doc/libs/release/doc/html/date_time.html">Boost.Date_Time</a> library.</td>
+  <td>Request to build static libraries, along with shared, of SOCI core and all successfully configured backends.</td>
 </tr>
 <tr>
   <td class="variable-name">SOCI_TESTS</td>
   <td class="variable-type">boolean</td>
   <td>Request to build regression tests for SOCI core and all successfully configured backends.</td>
 </tr>
+<tr>
+  <td class="variable-name">WITH_BOOST</td>
+  <td class="variable-type">boolean</td>
+  <td>Should CMake try to detect <a href="http://www.boost.org/">Boost C++ Libraries</a>. If ON, CMake will try to find Boost headers and binaries of <a href="http://www.boost.org/doc/libs/release/doc/html/date_time.html">Boost.Date_Time</a> library.</td>
+</tr>
+</table>
+
+<h4 id="H2">IBM DB2</h4>
+
+<table class="cmake-variables" cellpadding="2" cellspacing="2" summary="SOCI DB2 configuration">
+<caption class="cmake-variables">SOCI DB2 backend configuration</caption>
+<tr>
+  <td class="variable-name">WITH_DB2</td>
+  <td class="variable-type">boolean</td>
+  <td>Should CMake try to detect IBM DB2 Call Level Interface (CLI) library.</td>
+</tr>
+<tr>
+  <td class="variable-name">DB2_INCLUDE_DIR</td>
+  <td class="variable-type">string</td>
+  <td>Path to DB2 CLI include directories where CMake should look for <code>sqlcli1.h</code> header.</td>
+</tr>
+<tr>
+  <td class="variable-name">DB2_LIBRARIES</td>
+  <td class="variable-type">string</td>
+  <td>Full paths to  <code>db2</code> or <code>db2api </code> libraries to link SOCI against to enable the backend support.</td>
+</tr>
+<tr>
+  <td class="variable-name">SOCI_DB2</td>
+  <td class="variable-type">boolean</td>
+  <td>Requests to build <a href="backends/db2.html">DB2</a> backend. Automatically switched on, if <code>WITH_DB2</code> is set to ON.</td>
+</tr>
+<tr>
+  <td class="variable-name">SOCI_DB2_TEST_CONNSTR</td>
+  <td class="variable-type">string</td>
+  <td>See <a href="backends/db2.html">DB2 backend refernece</a> for details. Example: <code>-DSOCI_DB2_TEST_CONNSTR:STRING="DSN=SAMPLE;Uid=db2inst1;Pwd=db2inst1;autocommit=off"</code></td>
+</tr>
+</table>
+
+<h4 id="H1">Firebird</h4>
+
+<table class="cmake-variables" cellpadding="2" cellspacing="2" summary="SOCI Firebird configuration">
+<caption class="cmake-variables">SOCI Firebird backend configuration</caption>
+<tr>
+  <td class="variable-name">WITH_FIREBIRD</td>
+  <td class="variable-type">boolean</td>
+  <td>Should CMake try to detect Firebird client library.</td>
+</tr>
+<tr>
+  <td class="variable-name">FIREBIRD_INCLUDE_DIR</td>
+  <td class="variable-type">string</td>
+  <td>Path to Firebird include directories where CMake should look for <code>ibase.h</code> header.</td>
+</tr>
+<tr>
+  <td class="variable-name">FIREBIRD_LIBRARIES</td>
+  <td class="variable-type">string</td>
+  <td>Full paths to Firebird <code>fbclient</code> or <code>fbclient_ms</code> libraries to link SOCI against to enable the backend support.</td>
+</tr>
+<tr>
+  <td class="variable-name">SOCI_FIREBIRD</td>
+  <td class="variable-type">boolean</td>
+  <td>Requests to build <a href="backends/firebird.html">Firebird</a> backend. Automatically switched on, if <code>WITH_FIREBIRD</code> is set to ON.</td>
+</tr>
+<tr>
+  <td class="variable-name">SOCI_FIREBIRD_TEST_CONNSTR</td>
+  <td class="variable-type">string</td>
+  <td>See <a href="backends/firebird.html">Firebird backend refernece</a> for details. Example: <code>-DSOCI_FIREBIRD_TEST_CONNSTR:STRING="service=LOCALHOST:/tmp/soci_test.fdb user=SYSDBA password=masterkey"</code></td>
+</tr>
 </table>
 
 <h4 id="mysql">MySQL</h4>
@@ -111,7 +180,7 @@ <h4 id="mysql">MySQL</h4>
 <tr>
   <td class="variable-name">MYSQL_INCLUDE_DIR</td>
   <td class="variable-type">string</td>
-  <td>Path to MySQL include directory where CMake should look for mysql.h header.</td>
+  <td>Path to MySQL include directory where CMake should look for <code>mysql.h</code> header.</td>
 </tr>
 <tr>
   <td class="variable-name">MYSQL_LIBRARIES</td>
@@ -142,7 +211,7 @@ <h4 id="odbc">ODBC</h4>
 <tr>
   <td class="variable-name">ODBC_INCLUDE_DIR</td>
   <td class="variable-type">string</td>
-  <td>Path to ODBC implementation include directories where CMake should look for sql.h header.</td>
+  <td>Path to ODBC implementation include directories where CMake should look for <code>sql.h</code> header.</td>
 </tr>
 <tr>
   <td class="variable-name">ODBC_LIBRARIES</td>
@@ -173,7 +242,7 @@ <h4 id="oracle">Oracle</h4>
 <tr>
   <td class="variable-name">ORACLE_INCLUDE_DIR</td>
   <td class="variable-type">string</td>
-  <td>Path to Oracle include directory where CMake should look for oci.h header.</td>
+  <td>Path to Oracle include directory where CMake should look for <code>oci.h</code> header.</td>
 </tr>
 <tr>
   <td class="variable-name">ORACLE_LIBRARIES</td>
@@ -204,7 +273,7 @@ <h4 id="postgresql">PostgreSQL</h4>
 <tr>
   <td class="variable-name">POSTGRESQL_INCLUDE_DIR</td>
   <td class="variable-type">string</td>
-  <td>Path to PostgreSQL include directory where CMake should look for libpq-fe.h header.</td>
+  <td>Path to PostgreSQL include directory where CMake should look for <code>libpq-fe.h</code> header.</td>
 </tr>
 <tr>
   <td class="variable-name">POSTGRESQL_LIBRARIES</td>
@@ -235,7 +304,7 @@ <h4 id="sqlite">SQLite 3</h4>
 <tr>
   <td class="variable-name">SQLITE_INCLUDE_DIR</td>
   <td class="variable-type">string</td>
-  <td>Path to SQLite 3 include directory where CMake should look for sqlite3.h header.</td>
+  <td>Path to SQLite 3 include directory where CMake should look for <code>sqlite3.h</code> header.</td>
 </tr>
 <tr>
   <td class="variable-name">SQLITE_LIBRARIES</td>