The following commit has been merged in the master branch:
commit 1dc5a3eb37ba849520e8b4a0ce39fa9013b42101
Author: Michal Čihař <mci...@novell.com>
Date: Thu Mar 3 14:02:11 2011 +0100
ODBC driver documentation
diff --git a/ChangeLog b/ChangeLog
index a195149..ca5ee2a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -24,6 +24,7 @@ ChangeLog
[-] * Documentation improvements and fixes.
[-] * Saner error handling in Windows serial driver.
[-] * Cleanup in SMSD internals.
+[+] * Added ODBC driver to SMSD.
20110225 - 1.29.91
diff --git a/docs/man/gammu-backup.5 b/docs/man/gammu-backup.5
index 1f30260..47563d2 100644
--- a/docs/man/gammu-backup.5
+++ b/docs/man/gammu-backup.5
@@ -1,4 +1,4 @@
-.TH "GAMMU-BACKUP" "5" "February 28, 2011" "1.29.92" "Gammu"
+.TH "GAMMU-BACKUP" "5" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammu-backup \- gammu(1) backup file format.
.
diff --git a/docs/man/gammu-config.1 b/docs/man/gammu-config.1
index 8ae35dd..deb5cc2 100644
--- a/docs/man/gammu-config.1
+++ b/docs/man/gammu-config.1
@@ -1,4 +1,4 @@
-.TH "GAMMU-CONFIG" "1" "February 28, 2011" "1.29.92" "Gammu"
+.TH "GAMMU-CONFIG" "1" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammu-config \- Gammu configurator
.
diff --git a/docs/man/gammu-detect.1 b/docs/man/gammu-detect.1
index 0bf3cbc..07c56f3 100644
--- a/docs/man/gammu-detect.1
+++ b/docs/man/gammu-detect.1
@@ -1,4 +1,4 @@
-.TH "GAMMU-DETECT" "1" "February 28, 2011" "1.29.92" "Gammu"
+.TH "GAMMU-DETECT" "1" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammu-detect \- Gammu device detection
.
diff --git a/docs/man/gammu-smsbackup.5 b/docs/man/gammu-smsbackup.5
index 8b53873..13576da 100644
--- a/docs/man/gammu-smsbackup.5
+++ b/docs/man/gammu-smsbackup.5
@@ -1,4 +1,4 @@
-.TH "GAMMU-SMSBACKUP" "5" "February 28, 2011" "1.29.92" "Gammu"
+.TH "GAMMU-SMSBACKUP" "5" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammu-smsbackup \- gammu(1) SMS backup file format.
.
diff --git a/docs/man/gammu-smsd-dbi.7 b/docs/man/gammu-smsd-dbi.7
index cc56f06..b583cc6 100644
--- a/docs/man/gammu-smsd-dbi.7
+++ b/docs/man/gammu-smsd-dbi.7
@@ -1,4 +1,4 @@
-.TH "GAMMU-SMSD-DBI" "7" "February 28, 2011" "1.29.92" "Gammu"
+.TH "GAMMU-SMSD-DBI" "7" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammu-smsd-dbi \- gammu-smsd(1) backend using DBI abstraction layer to use any
supported database as a message storage
.
diff --git a/docs/man/gammu-smsd-files.7 b/docs/man/gammu-smsd-files.7
index 4153bb4..d670425 100644
--- a/docs/man/gammu-smsd-files.7
+++ b/docs/man/gammu-smsd-files.7
@@ -1,4 +1,4 @@
-.TH "GAMMU-SMSD-FILES" "7" "February 28, 2011" "1.29.92" "Gammu"
+.TH "GAMMU-SMSD-FILES" "7" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammu-smsd-files \- gammu-smsd(1) backend using filesystem as a message storage
.
diff --git a/docs/man/gammu-smsd-inject.1 b/docs/man/gammu-smsd-inject.1
index 61b8f12..e37f2bb 100644
--- a/docs/man/gammu-smsd-inject.1
+++ b/docs/man/gammu-smsd-inject.1
@@ -1,4 +1,4 @@
-.TH "GAMMU-SMSD-INJECT" "1" "February 28, 2011" "1.29.92" "Gammu"
+.TH "GAMMU-SMSD-INJECT" "1" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammu-smsd-inject \- Inject messages into queue of SMS daemon for Gammu
.
diff --git a/docs/man/gammu-smsd-monitor.1 b/docs/man/gammu-smsd-monitor.1
index bac6bf2..ca06ea2 100644
--- a/docs/man/gammu-smsd-monitor.1
+++ b/docs/man/gammu-smsd-monitor.1
@@ -1,4 +1,4 @@
-.TH "GAMMU-SMSD-MONITOR" "1" "February 28, 2011" "1.29.92" "Gammu"
+.TH "GAMMU-SMSD-MONITOR" "1" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammu-smsd-monitor \- Monitor state of SMS daemon for Gammu
.
diff --git a/docs/man/gammu-smsd-mysql.7 b/docs/man/gammu-smsd-mysql.7
index 6e591c8..aa23b6e 100644
--- a/docs/man/gammu-smsd-mysql.7
+++ b/docs/man/gammu-smsd-mysql.7
@@ -1,4 +1,4 @@
-.TH "GAMMU-SMSD-MYSQL" "7" "February 28, 2011" "1.29.92" "Gammu"
+.TH "GAMMU-SMSD-MYSQL" "7" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammu-smsd-mysql \- gammu-smsd(1) backend using MySQL database server as a
message storage
.
diff --git a/docs/man/gammu-smsd-null.7 b/docs/man/gammu-smsd-null.7
index 33a2c22..46d1f61 100644
--- a/docs/man/gammu-smsd-null.7
+++ b/docs/man/gammu-smsd-null.7
@@ -1,4 +1,4 @@
-.TH "GAMMU-SMSD-NULL" "7" "February 28, 2011" "1.29.92" "Gammu"
+.TH "GAMMU-SMSD-NULL" "7" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammu-smsd-null \- gammu-smsd(1) backend not storing messages
.
diff --git a/docs/man/gammu-smsd-odbc.7 b/docs/man/gammu-smsd-odbc.7
new file mode 100644
index 0000000..9926506
--- /dev/null
+++ b/docs/man/gammu-smsd-odbc.7
@@ -0,0 +1,67 @@
+.TH "GAMMU-SMSD-ODBC" "7" "March 03, 2011" "1.29.92" "Gammu"
+.SH NAME
+gammu-smsd-odbc \- gammu-smsd(1) backend using ODBC abstraction layer to use
any supported database as a message storage
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructeredText.
+.
+.sp
+New in version 1.29.92.
+.sp
+ODBC backend stores all data in any database supported by \fI\%ODBC\fP, which
+parameters are defined by configuration (see \fIgammu\-smsdrc\fP for
description of
+configuration options).
+.sp
+For tables description see \fIgammu\-smsd\-tables\fP.
+.sp
+This backend is based on \fIgammu\-smsd\-sql\fP.
+.SH SUPPORTED DRIVERS
+.sp
+On Microsoft Windows, Gammu uses native ODBC, on other platforms,
\fI\%unixODBC\fP
+can be used.
+.SH LIMITATIONS
+.sp
+Due to limits of the ODBC interface, you might have to tweak SQL queries to
+work in used SQL server, see \fIgammu\-smsd\-sql\fP for more details.
+.SH CONFIGURATION
+.sp
+You specify data source name (DSN) as \fBHost\fP in
+\fIgammu\-smsdrc\fP. The data source is configured depending on your platform.
+.sp
+On Microsoft Windows, you can find instructions on Microsoft website:
+\fI\%http://support.microsoft.com/kb/305599\fP
+.sp
+For unixODBC this is documented in user manual:
+\fI\%http://www.unixodbc.org/doc/UserManual/\fP
+.SH AUTHOR
+Michal Čihař <mic...@cihar.com>
+.SH COPYRIGHT
+2009-2011, Michal Čihař <mic...@cihar.com>
+.\" Generated by docutils manpage writer.
+.\"
+.
diff --git a/docs/man/gammu-smsd-pgsql.7 b/docs/man/gammu-smsd-pgsql.7
index 97316b7..2bc219e 100644
--- a/docs/man/gammu-smsd-pgsql.7
+++ b/docs/man/gammu-smsd-pgsql.7
@@ -1,4 +1,4 @@
-.TH "GAMMU-SMSD-PGSQL" "7" "February 28, 2011" "1.29.92" "Gammu"
+.TH "GAMMU-SMSD-PGSQL" "7" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammu-smsd-pgsql \- gammu-smsd(1) backend using PostgreSQL database server as
a message storage
.
diff --git a/docs/man/gammu-smsd-run.7 b/docs/man/gammu-smsd-run.7
index ca1c5e4..973e145 100644
--- a/docs/man/gammu-smsd-run.7
+++ b/docs/man/gammu-smsd-run.7
@@ -1,4 +1,4 @@
-.TH "GAMMU-SMSD-RUN" "7" "February 28, 2011" "1.29.92" "Gammu"
+.TH "GAMMU-SMSD-RUN" "7" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammu-smsd-run \- documentation for RunOnReceive directive
.
diff --git a/docs/man/gammu-smsd-sql.7 b/docs/man/gammu-smsd-sql.7
index 832bc30..c61208b 100644
--- a/docs/man/gammu-smsd-sql.7
+++ b/docs/man/gammu-smsd-sql.7
@@ -1,4 +1,4 @@
-.TH "GAMMU-SMSD-SQL" "7" "February 28, 2011" "1.29.92" "Gammu"
+.TH "GAMMU-SMSD-SQL" "7" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammu-smsd-sql \- gammu-smsd(1) backend using SQL abstraction layer to use any
supported database as a message storage
.
@@ -41,6 +41,9 @@ SQL service stores all its data in database. It can use one
of these SQL backend
.
\fBnative_pgsql\fP for \fIgammu\-smsd\-pgsql\fP
.IP \(bu 2
+.
+\fBodbc\fP for \fIgammu\-smsd\-odbc\fP
+.IP \(bu 2
.INDENT 2.0
.TP
.B drivers supported by DBI for \fIgammu\-smsd\-dbi\fP, which include:
@@ -72,7 +75,7 @@ Common for all backends:
\fBPassword\fP \- password for connecting to database
.IP \(bu 2
.
-\fBHost\fP \- database host
+\fBHost\fP \- database host or data source name
.IP \(bu 2
.
\fBDatabase\fP \- database name
diff --git a/docs/man/gammu-smsd-tables.7 b/docs/man/gammu-smsd-tables.7
index ede42bc..e37a0bf 100644
--- a/docs/man/gammu-smsd-tables.7
+++ b/docs/man/gammu-smsd-tables.7
@@ -1,4 +1,4 @@
-.TH "GAMMU-SMSD-TABLES" "7" "February 28, 2011" "1.29.92" "Gammu"
+.TH "GAMMU-SMSD-TABLES" "7" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammu-smsd-tables \- description of tables for database backends of
gammu-smsd(1)
.
diff --git a/docs/man/gammu-smsd.1 b/docs/man/gammu-smsd.1
index 33f7313..cc73155 100644
--- a/docs/man/gammu-smsd.1
+++ b/docs/man/gammu-smsd.1
@@ -1,4 +1,4 @@
-.TH "GAMMU-SMSD" "1" "February 28, 2011" "1.29.92" "Gammu"
+.TH "GAMMU-SMSD" "1" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammu-smsd \- SMS daemon for Gammu
.
diff --git a/docs/man/gammu-smsdrc.5 b/docs/man/gammu-smsdrc.5
index 162625d..095df99 100644
--- a/docs/man/gammu-smsdrc.5
+++ b/docs/man/gammu-smsdrc.5
@@ -1,4 +1,4 @@
-.TH "GAMMU-SMSDRC" "5" "February 28, 2011" "1.29.92" "Gammu"
+.TH "GAMMU-SMSDRC" "5" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammu-smsdrc \- gammu-smsd(1) configuration file
.
@@ -491,6 +491,8 @@ Password used for connection to a database.
Database server address. It can also contain port or socket path after
semicolon, for example \fBlocalhost:/path/to/socket\fP.
.sp
+For ODBC this is used as Data source name.
+.sp
New in version 1.28.92.
.UNINDENT
.INDENT 0.0
diff --git a/docs/man/gammu.1 b/docs/man/gammu.1
index f016aaf..fcad8ff 100644
--- a/docs/man/gammu.1
+++ b/docs/man/gammu.1
@@ -1,4 +1,4 @@
-.TH "GAMMU" "1" "February 28, 2011" "1.29.92" "Gammu"
+.TH "GAMMU" "1" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammu \- Does some neat things with your cellular phone or modem.
.
diff --git a/docs/man/gammurc.5 b/docs/man/gammurc.5
index d877476..d163f41 100644
--- a/docs/man/gammurc.5
+++ b/docs/man/gammurc.5
@@ -1,4 +1,4 @@
-.TH "GAMMURC" "5" "February 28, 2011" "1.29.92" "Gammu"
+.TH "GAMMURC" "5" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammurc \- gammu(1) configuration file
.
diff --git a/docs/man/jadmaker.1 b/docs/man/jadmaker.1
index 85ea739..44fdaf8 100644
--- a/docs/man/jadmaker.1
+++ b/docs/man/jadmaker.1
@@ -1,4 +1,4 @@
-.TH "JADMAKER" "1" "February 28, 2011" "1.29.92" "Gammu"
+.TH "JADMAKER" "1" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
jadmaker \- JAD File Generator
.
diff --git a/docs/manual/conf.py b/docs/manual/conf.py
index acab06a..613045c 100644
--- a/docs/manual/conf.py
+++ b/docs/manual/conf.py
@@ -239,6 +239,7 @@ man_pages = [
('smsd/mysql', 'gammu-smsd-mysql', 'gammu-smsd(1) backend using MySQL
database server as a message storage', u'Michal Čihař <mic...@cihar.com>', 7),
('smsd/pgsql', 'gammu-smsd-pgsql', 'gammu-smsd(1) backend using PostgreSQL
database server as a message storage', u'Michal Čihař <mic...@cihar.com>', 7),
('smsd/dbi', 'gammu-smsd-dbi', 'gammu-smsd(1) backend using DBI
abstraction layer to use any supported database as a message storage', u'Michal
Čihař <mic...@cihar.com>', 7),
+ ('smsd/odbc', 'gammu-smsd-odbc', 'gammu-smsd(1) backend using ODBC
abstraction layer to use any supported database as a message storage', u'Michal
Čihař <mic...@cihar.com>', 7),
('smsd/sql', 'gammu-smsd-sql', 'gammu-smsd(1) backend using SQL
abstraction layer to use any supported database as a message storage', u'Michal
Čihař <mic...@cihar.com>', 7),
('smsd/run', 'gammu-smsd-run', 'documentation for RunOnReceive directive',
u'Michal Čihař <mic...@cihar.com>', 7),
('smsd/null', 'gammu-smsd-null', 'gammu-smsd(1) backend not storing
messages', u'Michal Čihař <mic...@cihar.com>', 7),
diff --git a/docs/manual/smsd/backends.rst b/docs/manual/smsd/backends.rst
index a8836ab..80cd67b 100644
--- a/docs/manual/smsd/backends.rst
+++ b/docs/manual/smsd/backends.rst
@@ -14,6 +14,7 @@ outgoing ones).
mysql
pgsql
dbi
+ odbc
null
tables
diff --git a/docs/manual/smsd/config.rst b/docs/manual/smsd/config.rst
index 88d0bbc..8cecb07 100644
--- a/docs/manual/smsd/config.rst
+++ b/docs/manual/smsd/config.rst
@@ -362,6 +362,8 @@ supports same options for configuring connection to a
database:
Database server address. It can also contain port or socket path after
semicolon, for example ``localhost:/path/to/socket``.
+ For ODBC this is used as Data source name.
+
.. versionadded:: 1.28.92
.. config:option:: PC
diff --git a/docs/manual/smsd/odbc.rst b/docs/manual/smsd/odbc.rst
new file mode 100644
index 0000000..d1f9014
--- /dev/null
+++ b/docs/manual/smsd/odbc.rst
@@ -0,0 +1,41 @@
+.. _gammu-smsd-odbc:
+
+ODBC Backend
+============
+
+.. versionadded:: 1.29.92
+
+ODBC backend stores all data in any database supported by `ODBC`_, which
+parameters are defined by configuration (see :ref:`gammu-smsdrc` for
description of
+configuration options).
+
+For tables description see :ref:`gammu-smsd-tables`.
+
+This backend is based on :ref:`gammu-smsd-sql`.
+
+Supported drivers
+-----------------
+
+On Microsoft Windows, Gammu uses native ODBC, on other platforms, `unixODBC`_
+can be used.
+
+.. _ODBC: http://en.wikipedia.org/wiki/Open_Database_Connectivity
+.. _unixODBC: http://www.unixodbc.org/
+
+Limitations
+-----------
+
+Due to limits of the ODBC interface, you might have to tweak SQL queries to
+work in used SQL server, see :ref:`gammu-smsd-sql` for more details.
+
+Configuration
+-------------
+
+You specify data source name (DSN) as :config:option:`Host` in
+:ref:`gammu-smsdrc`. The data source is configured depending on your platform.
+
+On Microsoft Windows, you can find instructions on Microsoft website:
+http://support.microsoft.com/kb/305599
+
+For unixODBC this is documented in user manual:
+http://www.unixodbc.org/doc/UserManual/
diff --git a/docs/manual/smsd/sql.rst b/docs/manual/smsd/sql.rst
index f15528e..520b7ca 100644
--- a/docs/manual/smsd/sql.rst
+++ b/docs/manual/smsd/sql.rst
@@ -8,6 +8,7 @@ SQL service stores all its data in database. It can use one of
these SQL backend
* ``native_mysql`` for :ref:`gammu-smsd-mysql`
* ``native_pgsql`` for :ref:`gammu-smsd-pgsql`
+* ``odbc`` for :ref:`gammu-smsd-odbc`
* drivers supported by DBI for :ref:`gammu-smsd-dbi`, which include:
* ``sqlite3`` - for SQLite 3
* ``mysql`` - for MySQL
@@ -21,7 +22,7 @@ Common for all backends:
* :config:option:`User` - user connecting to database
* :config:option:`Password` - password for connecting to database
-* :config:option:`Host` - database host
+* :config:option:`Host` - database host or data source name
* :config:option:`Database` - database name
* :config:option:`Driver` - ``native_mysql``, ``native_pgsql`` or DBI one
diff --git a/docs/manual/testing/testsuite.rst
b/docs/manual/testing/testsuite.rst
index c6753f9..44c836b 100644
--- a/docs/manual/testing/testsuite.rst
+++ b/docs/manual/testing/testsuite.rst
@@ -168,3 +168,6 @@ Database backends configuration
User to use for MySQL tests (default: ``smsd``)
``MYSQL_PASSWORD``
Password to use for MySQL tests (default: ``smsd``)
+``ODBC_DSN```
+ ODBC DSN to use for ODBC tests (default: ``smsd``).
+ Currently needs to point to MySQL database.
--
Gammu
_______________________________________________
Gammu-svn mailing list
Gammu-svn@lists.cihar.com
https://lists.cihar.com/cgi-bin/mailman/listinfo/gammu-svn
