diff options
Diffstat (limited to 'docs/manual')
-rw-r--r-- | docs/manual/config/index.rst | 3 | ||||
-rw-r--r-- | docs/manual/faq/smsd.rst | 4 | ||||
-rw-r--r-- | docs/manual/project/contributing.rst | 2 | ||||
-rw-r--r-- | docs/manual/project/install.rst | 30 | ||||
-rw-r--r-- | docs/manual/project/roadmap.rst | 4 | ||||
-rw-r--r-- | docs/manual/smsd/mysql.rst | 21 | ||||
-rw-r--r-- | docs/manual/smsd/odbc.rst | 4 | ||||
-rw-r--r-- | docs/manual/smsd/pgsql.rst | 2 | ||||
-rw-r--r-- | docs/manual/smsd/sql.rst | 2 |
9 files changed, 50 insertions, 22 deletions
diff --git a/docs/manual/config/index.rst b/docs/manual/config/index.rst index 02bd0af..5b65dab 100644 --- a/docs/manual/config/index.rst +++ b/docs/manual/config/index.rst @@ -406,6 +406,9 @@ bi-directional communication with the phone. device = ssh root@my.router /usr/local/bin/myscript /dev/ttyUSB0 connection = proxyat +You can find sample script which can be used on the remote side in +:file:`contrib/proxy/gammu-backend`. + .. _Fully documented example: Fully documented example diff --git a/docs/manual/faq/smsd.rst b/docs/manual/faq/smsd.rst index 851f8d2..a35f441 100644 --- a/docs/manual/faq/smsd.rst +++ b/docs/manual/faq/smsd.rst @@ -83,7 +83,7 @@ This can occasionally happen and can have several reasons. see hint to adjust the configuration in the log. .. _Kalkun: http://kalkun.sourceforge.net/ -.. _MySQL: http://www.mysql.com/ -.. _PostgreSQL: http://www.postgresql.org/ +.. _MySQL: https://www.mysql.com/ +.. _PostgreSQL: https://www.postgresql.org/ .. _libdbi: http://libdbi.sourceforge.net/ .. _Gammu Phones Database: https://wammu.eu/phones/ diff --git a/docs/manual/project/contributing.rst b/docs/manual/project/contributing.rst index 364e174..036d04a 100644 --- a/docs/manual/project/contributing.rst +++ b/docs/manual/project/contributing.rst @@ -15,7 +15,7 @@ As we use `Git <http://git-scm.com/>`_ for development, the preferred way to get patches is in form which can be directly applied to Git. So start with cloning our Git repository:: - git clone git://github.com/gammu/gammu.git gammu + git clone https://github.com/gammu/gammu.git gammu Once you have done that, do some fixes and commit them (see `Git tutorial <http://www.kernel.org/pub/software/scm/git/docs/gittutorial.html>`_ diff --git a/docs/manual/project/install.rst b/docs/manual/project/install.rst index 539137e..58dc4d5 100644 --- a/docs/manual/project/install.rst +++ b/docs/manual/project/install.rst @@ -20,8 +20,8 @@ Debian Gammu packages are included in Debian (testing versions go to experimental and stable to unstable). If you want to build Debian package on your own, you can find packaging in Git repository at -``git://git.debian.org/git/collab-maint/gammu.git`` (you can browse it on -<http://git.debian.org/?p=collab-maint/gammu.git>). +``https://anonscm.debian.org/git/collab-maint/gammu.git`` (you can browse it on +<https://anonscm.debian.org/git/collab-maint/gammu.git>). RPM +++ @@ -52,7 +52,7 @@ Dependencies You need CMake from <https://cmake.org/> for compiling Gammu. -Additionally pkg-config <http://pkg-config.freedesktop.org/> is used for +Additionally pkg-config <https://www.freedesktop.org/wiki/Software/pkg-config/> is used for detecting available libraries. .. _opt-deps: @@ -82,35 +82,35 @@ libCURL Required for new versions notification (see :option:`gammu checkversion`). -.. seealso:: http://curl.haxx.se/libcurl/ +.. seealso:: https://curl.haxx.se/libcurl/ libiconv ++++++++ Used to support more character sets in AT engine. -.. seealso:: http://www.gnu.org/software/libiconv/ +.. seealso:: https://www.gnu.org/software/libiconv/ Gettext +++++++ Localization of strings. -.. seealso:: http://www.gnu.org/software/gettext/ +.. seealso:: https://www.gnu.org/software/gettext/ MySQL +++++ Required for :ref:`gammu-smsd-mysql` in :ref:`smsd`. -.. seealso:: http://mysql.com/ +.. seealso:: https://www.mysql.com/ PostgreSQL ++++++++++ Required for :ref:`gammu-smsd-pgsql` in :ref:`smsd`. -.. seealso:: http://www.postgresql.org/ +.. seealso:: https://www.postgresql.org/ unixODBC ++++++++ @@ -135,21 +135,21 @@ Python Gammu has a Python bindings, see :ref:`python`. -.. seealso:: http://www.python.org/ +.. seealso:: https://www.python.org/ SQLite + libdbi-drivers with SQLite +++++++++++++++++++++++++++++++++++ Needed for testing of SMSD using libdbi driver (libdbd-sqlite3), see :ref:`testing`. -.. seealso:: http://www.sqlite.org/ +.. seealso:: https://www.sqlite.org/ glib ++++ Currently needed only for :ref:`gammu-detect`. -.. seealso:: http://www.gtk.org/ +.. seealso:: https://www.gtk.org/ gudev +++++ @@ -183,6 +183,9 @@ For openSUSE, the installation all optional packages could look like: mysql-devel python-devel libcurl-devel cmake pkgconfig unixODBC-devel \ glib2-devel libgudev-1_0-devel +Configure like wrapper +++++++++++++++++++++++ + For compatibility reasons, configure like wrapper is provided, if you don't need much specific tuning, you can use usual set of commands: @@ -196,6 +199,9 @@ The configure wrapper will create directory build-configure and build all binaries there (nothing is changed in source tree), for example gammu binary is in build-configure/gammu directory. +Using CMake ++++++++++++ + If you need/want to tweak build a bit more than configure wrapper provides, you have to use `CMake`_ directly. For now, only out of source build is supported, so you have to create separate directory for build: @@ -308,7 +314,7 @@ You will probably need additional SDKs: * For gettext (internationalization) support, you will need gettext packages from GnuWin32 project. * As build is now based on CMake, you will need to get it from - http://cmake.org/. + https://cmake.org/. After downloading and installing them into your system: diff --git a/docs/manual/project/roadmap.rst b/docs/manual/project/roadmap.rst index 5025c5d..f8a5682 100644 --- a/docs/manual/project/roadmap.rst +++ b/docs/manual/project/roadmap.rst @@ -17,7 +17,9 @@ Unicode strings The another major obstacle which is all around Gammu code is own implementation of unicode (UCS-2-BE) strings. This code should be dropped and -wchar_t used instead. +use some standard library for that. Note that wchar_t is probably not a good +choice here as it's 16-bit on Windows and thus can not store emojis and other +supplemental plan unicode chars. Hardcoded length for strings ---------------------------- diff --git a/docs/manual/smsd/mysql.rst b/docs/manual/smsd/mysql.rst index d57f6c0..19b59bf 100644 --- a/docs/manual/smsd/mysql.rst +++ b/docs/manual/smsd/mysql.rst @@ -50,14 +50,22 @@ privileges should be enough: For creating the SQL tables you need more privileges, especially for creating triggers, which are used for some functionality. -.. _MySQL: http://www.mysql.com/ +.. _MySQL: https://www.mysql.com/ .. _mysql-create: Creating tables for MySQL ------------------------- -SQL script for creating tables in MySQL database: +Depending on MySQL version and settings please choose best fitting +script to create tables: + +* :file:`mysql-strict.sql` can be used in strict mode, but requires MySQL 5.6.5 + or newer +* :file:`mysql.sql` supports all MySQL versions, but requires neither of + `NO_ZERO_DATE`, `ANSI` or `STRICT` modes to be set in the server + +SQL script :file:`mysql.sql` for creating tables in MySQL database: .. literalinclude:: ../../sql/mysql.sql :language: mysql @@ -66,6 +74,15 @@ SQL script for creating tables in MySQL database: You can find the script in :file:`docs/sql/mysql.sql` as well. +SQL script :file:`mysql-strict.sql` for creating tables in MySQL database: + +.. literalinclude:: ../../sql/mysql-strict.sql + :language: mysql + +.. note:: + + You can find the script in :file:`docs/sql/mysql-strict.sql` as well. + Upgrading tables ---------------- diff --git a/docs/manual/smsd/odbc.rst b/docs/manual/smsd/odbc.rst index fd78044..e9efe10 100644 --- a/docs/manual/smsd/odbc.rst +++ b/docs/manual/smsd/odbc.rst @@ -22,7 +22,7 @@ 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 +.. _ODBC: https://en.wikipedia.org/wiki/Open_Database_Connectivity .. _unixODBC: http://www.unixodbc.org/ Limitations @@ -51,7 +51,7 @@ You specify data source name (DSN) as :config:option:`Host` in Windows or in global configuration on Linux). On Microsoft Windows, you can find instructions on Microsoft website: -http://support.microsoft.com/kb/305599 +https://support.microsoft.com/kb/305599 For unixODBC this is documented in the user manual: http://www.unixodbc.org/doc/UserManual/ diff --git a/docs/manual/smsd/pgsql.rst b/docs/manual/smsd/pgsql.rst index 021456f..eb55b62 100644 --- a/docs/manual/smsd/pgsql.rst +++ b/docs/manual/smsd/pgsql.rst @@ -14,7 +14,7 @@ For tables description see :ref:`gammu-smsd-tables`. This backend is based on :ref:`gammu-smsd-sql`. -.. _PostgreSQL: http://www.postgresql.org/ +.. _PostgreSQL: https://www.postgresql.org/ Configuration ------------- diff --git a/docs/manual/smsd/sql.rst b/docs/manual/smsd/sql.rst index 190abcf..fd894e0 100644 --- a/docs/manual/smsd/sql.rst +++ b/docs/manual/smsd/sql.rst @@ -37,7 +37,7 @@ Specific for DBI: .. seealso:: The variables are fully described in :ref:`gammurc` documentation. -.. _Custom tables: +.. _Configurable tables: Tables ------ |