Added man pages for SMSD backend services.

gammu · Jan 8, 2009 · 64a9f5a · 64a9f5a
1 parent 4b23e85
commit 64a9f5a
Show file tree

Hide file tree

Showing 19 changed files with 4,139 additions and 550 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -54,6 +54,7 @@ ChangeLog
 [+] * Use po4a for translating man pages.
 [+] * Dump more information in dct3trac, thanks to Duncan Salerno.
 [+] * SMSD cal log to Windows Event Log.
+[+] * Added man pages for SMSD backend services.
 
 20081219 - 1.22.1
 

diff --git a/TODO b/TODO
@@ -2,7 +2,6 @@
 $ echo 'aa' | ./gammu/gammu savesms TEXT 123465
 Saving SMS 1/1
 Saved in folder "", location -99999, SIM
-- add man page for gammu-smsd-mysql,... should contain DB structure and FILES information (currently preset in sample config)
 - failing tests on windows
 - move crap like following to gammu config to avoid so heavy usage of gsmstate.h header
 #ifndef GSM_USED_IRDAOBEX

diff --git a/admin/po4a.config b/admin/po4a.config
@@ -6,3 +6,6 @@
 [type: man] docs/user/gammu-smsd-inject.1 $lang:docs/user/$lang/gammu-smsd-inject.1
 [type: man] docs/user/jadmaker.1 $lang:docs/user/$lang/jadmaker.1
 [type: man] docs/user/gammu-config.1 $lang:docs/user/$lang/gammu-config.1
+[type: man] docs/user/gammu-smsd-files.7 $lang:docs/user/$lang/gammu-smsd-files.7
+[type: man] docs/user/gammu-smsd-mysql.7 $lang:docs/user/$lang/gammu-smsd-mysql.7
+[type: man] docs/user/gammu-smsd-pgsql.7 $lang:docs/user/$lang/gammu-smsd-pgsql.7
diff --git a/docs/user/CMakeLists.txt b/docs/user/CMakeLists.txt
@@ -25,6 +25,14 @@ install (
     COMPONENT "man-pages"
     )
 
+file(GLOB MAN5_PAGES "*.7")
+
+install (
+    FILES ${MAN5_PAGES}
+    DESTINATION "${INSTALL_MAN_DIR}/man7"
+    COMPONENT "man-pages"
+    )
+
 # This should match list in admin/po4a.config
 foreach(LANG cs de es id it pl ru)
 
@@ -43,4 +51,12 @@ foreach(LANG cs de es id it pl ru)
         DESTINATION "${INSTALL_MAN_DIR}/${LANG}/man5"
         COMPONENT "man-pages"
         )
+
+    file(GLOB MAN5_PAGES "${LANG}*.7")
+
+    install (
+        FILES ${MAN5_PAGES}
+        DESTINATION "${INSTALL_MAN_DIR}/${LANG}/man7"
+        COMPONENT "man-pages"
+        )
 endforeach(LANG)
diff --git a/docs/user/cs/gammu-smsd.1 b/docs/user/cs/gammu-smsd.1
@@ -47,6 +47,8 @@ Spustí SMSD jako službu ve Windows.
 
 .SH "DALŠÍ INFORMACE"
 gammu\-smsdrc(5), gammu(1), gammu\-smsd\-inject(1)
+
+gammu\-smsd\-files(7), gammu\-smsd\-mysql(7), gammu\-smsd\-pgsql(7)
 .SH AUTOR
 gammu\-smsd a tuto manuálovou stránku napsal Michal Čihař
 <michal@cihar.com>.

diff --git a/docs/user/cs/gammu-smsdrc.5 b/docs/user/cs/gammu-smsdrc.5
@@ -150,8 +150,8 @@ Výchozí je 0, což znamená žádné ladicí informace.
 
 .SS "Parametry pro služby používající databázi"
 
-Obě služby MYSQL a PGSQL podporují stejné parametry pro nastavení připojeník
-databázi:
+Obě služby MYSQL a PGSQL (viz gammu\-smsd\-mysql(7), gammu\-smsd\-pgsql(7))
+podporují stejné parametry pro nastavení připojení k databázi:
 
 .TP 
 \fBUser\fP
@@ -186,9 +186,9 @@ sent SMS.
 
 .SS "Parametry pro službu používající soubory"
 
-The FILES backend accepts following configuration options. Please note that
-all path should contain trailing path separator (na UnixovÃ½ systÃ©mech /):
-
+Služba FILES používá následující konfigurační volby. Podrobnější popis této
+služby je v gammu\-smsd\-files(7). Prosím ujistěte se, že  všechny cestky
+končí oddělovačem cest (na Unixových systémech /):
 
 .TP 
 \fBInboxPath\fP
@@ -286,6 +286,8 @@ Database = smsd
 
 .SH "DALŠÍ INFORMACE"
 gammu\-smsd(1), gammu(1), gammurc(5)
+
+gammu\-smsd\-files(7), gammu\-smsd\-mysql(7), gammu\-smsd\-pgsql(7)
 .SH AUTOR
 gammu\-smsd a tuto manuálovou stránku napsal Michal Čihař
 <michal@cihar.com>.

diff --git a/docs/user/gammu-smsd-files.7 b/docs/user/gammu-smsd-files.7
@@ -0,0 +1,111 @@
+.TH GAMMU-SMSD-FILES 7 "January  8, 2009" "Gammu 1.23.0" "Gammu Documentation"
+.SH NAME
+
+.TP
+.BI gammu-smsdrc-files
+
+gammu-smsd(1) backend using filesystem as a message storage
+
+.SH DESCRIPTION
+gammu-smsd(1) supports several backends. Actual backend is chosen in
+a config file gammu-smsdrc(5).
+
+FILES backend stores all data on a filesystem in folders defined by
+configuration (see gammu-smsd(5) for description of configuration options).
+
+.SS Receiving of messages
+
+Received messages are stored in a folder defined by configuration. The
+filename will be IN<date>_<time>_<serialno>_<phone_number>_<sequence>.<ext>,
+for example NN20021130_021531_00_+45409000931640979_00.txt.
+
+Explanation of fields:
+
+\fB<date>\fR - date in format YYYYMMDD
+.br
+\fB<time>\fR - time in format HHMMSS
+.br
+\fB<serialno>\fR - order of a message (in case more messages were received at
+same time, in format NN
+.br
+\fB<sequence>\fR - part of the message for multipart messages
+is nn (for multi-SMSes), in format NN
+.br
+\fB<ext>\fR - txt for text message, 8-bit messages are stored with bin
+extension
+
+.SS Transmitting of messages
+
+Transmitted messages are read from a folder defined by configuration. The
+filename should be one of the following formats:
+
+- OUT<phone_number>.<ext><options>
+.br
+- OUT<priority>_<phone_number>_<serialno>.<ext><options>
+.br
+- OUT<priority><date>_<time>_<serialno>_<phone_number>_<anything>.<ext><options>
+
+Explanation of fields:
+
+\fB<priority>\fR - an alphabetic character (A-Z) A = highest priority
+.br
+\fB<ext>\fR - txt for normal text SMS
+.br
+\fB<options>\fR - Options appended to the extension applying to text SMS:
+ \fBd\fR - delivery report requested
+ \fBf\fR - flash SMS
+ \fBb\fR - WAP bookmark as name,URL
+
+For example OUTG20040620_193810_123_+4512345678_xpq.txtdf is a flash text SMS
+requesting delivery reports.
+
+Other fields are same as for received messages.
+
+SMSes will be transmitted sequentially based on the file name. The contents of
+the file is the SMS to be transmitted (in Unicode or standard character set).
+
+.SH EXAMPLE
+
+Example of the 'detail' inbox format:
+
+.RS
+.sp
+.nf
+.ne 7
+[SMSBackup000]
+#ABCDEFGHIJKLMNOPQRSTUVWXYZ
+#
+SMSC = "+4540590000"
+SMSCUnicode = 002B0034003500340030003500390030003000300030
+Sent = 20021201T025023
+State = UnRead
+Number = "+4522706947"
+NumberUnicode = 002B0034003500320032003700300036003900340037
+Name = ""
+NameUnicode =
+Text00 = 004100420043004400450046004700480049004A004B004C004D004E004F0050005100520053005400550056005700580059005A000A
+Coding = Default
+Folder = 1
+Length = 27
+Class = -1
+ReplySMSC = False
+RejectDuplicates = True
+ReplaceMessage = 0
+MessageReference = 0
+.fi
+.sp
+.RE
+.PP
+
+.SH SEE ALSO
+gammu-smsd(1), gammu-smsdrc(5), gammu(1), gammurc(5)
+.SH AUTHOR
+gammu-smsd and this manual page were written by Michal Cihar <michal@cihar.com>.
+.SH COPYRIGHT
+Copyright \(co 2009 Michal Cihar and other authors.
+License GPLv2: GNU GPL version 2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>
+.br
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+.SH REPORTING BUGS
+Please report bugs to <http://bugs.cihar.com>.
diff --git a/docs/user/gammu-smsd-mysql.7 b/docs/user/gammu-smsd-mysql.7
@@ -0,0 +1,92 @@
+.TH GAMMU-SMSD-MYSQL 7 "January  8, 2009" "Gammu 1.23.0" "Gammu Documentation"
+.SH NAME
+
+.TP
+.BI gammu-smsdrc-mysql
+
+gammu-smsd(1) backend using MySQL database server as a message storage
+
+.SH DESCRIPTION
+gammu-smsd(1) supports several backends. Actual backend is chosen in
+a config file gammu-smsdrc(5).
+
+MYSQL backend stores all data in a MySQL database server, which parameters are
+defined by configuration (see gammu-smsd(5) for description of configuration
+options).
+
+.SS Receiving of messages
+
+Received messages are stored in inbox table.
+
+.SS Transmitting of messages
+
+Transmitted messages are read from table outbox and possible subsequent parts
+of the same message from outbox_multipart.
+
+.SS Description of tables
+
+.TP
+.BI daemon
+
+Information about running daemons.
+
+.TP
+.BI gammu
+
+Table holding single value - version of a database schema.
+
+.TP
+.BI inbox
+
+Table where received messages will be stored.
+
+.TP
+.BI outbox
+
+Messages enqueued for sending should be placed in this database. If message
+is multipart, subsequent parts are stored in outbox_multipart.
+
+.TP
+.BI outbox_multipart
+
+Data for outgoing multipart messages.
+
+.TP
+.BI phones
+
+Information about connected phones. This table is periodically refreshed and
+you can get information such as battery or signal level from here.
+
+.TP
+.BI sentitems
+
+Log of sent messages, if delivery reports are configured, message state is
+updated here.
+
+.TP
+.BI pbk
+
+Not used by SMSD currently, included only for application usage.
+
+.TP
+.BI pbk_groups
+
+Not used by SMSD currently, included only for application usage.
+
+.SH EXAMPLE
+
+SQL script to create all needed tables is included in Gammu documenation. As
+well as some PHP scripts interacting with the database.
+
+.SH SEE ALSO
+gammu-smsd(1), gammu-smsdrc(5), gammu(1), gammurc(5)
+.SH AUTHOR
+gammu-smsd and this manual page were written by Michal Cihar <michal@cihar.com>.
+.SH COPYRIGHT
+Copyright \(co 2009 Michal Cihar and other authors.
+License GPLv2: GNU GPL version 2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>
+.br
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+.SH REPORTING BUGS
+Please report bugs to <http://bugs.cihar.com>.
diff --git a/docs/user/gammu-smsd-pgsql.7 b/docs/user/gammu-smsd-pgsql.7
@@ -0,0 +1,92 @@
+.TH GAMMU-SMSD-PGSQL 7 "January  8, 2009" "Gammu 1.23.0" "Gammu Documentation"
+.SH NAME
+
+.TP
+.BI gammu-smsdrc-pgsql
+
+gammu-smsd(1) backend using PostgreSQL database server as a message storage
+
+.SH DESCRIPTION
+gammu-smsd(1) supports several backends. Actual backend is chosen in
+a config file gammu-smsdrc(5).
+
+PGSQL backend stores all data in a PostgreSQL database server, which
+parameters are defined by configuration (see gammu-smsd(5) for description of
+configuration options).
+
+.SS Receiving of messages
+
+Received messages are stored in inbox table.
+
+.SS Transmitting of messages
+
+Transmitted messages are read from table outbox and possible subsequent parts
+of the same message from outbox_multipart.
+
+.SS Description of tables
+
+.TP
+.BI daemon
+
+Information about running daemons.
+
+.TP
+.BI gammu
+
+Table holding single value - version of a database schema.
+
+.TP
+.BI inbox
+
+Table where received messages will be stored.
+
+.TP
+.BI outbox
+
+Messages enqueued for sending should be placed in this database. If message
+is multipart, subsequent parts are stored in outbox_multipart.
+
+.TP
+.BI outbox_multipart
+
+Data for outgoing multipart messages.
+
+.TP
+.BI phones
+
+Information about connected phones. This table is periodically refreshed and
+you can get information such as battery or signal level from here.
+
+.TP
+.BI sentitems
+
+Log of sent messages, if delivery reports are configured, message state is
+updated here.
+
+.TP
+.BI pbk
+
+Not used by SMSD currently, included only for application usage.
+
+.TP
+.BI pbk_groups
+
+Not used by SMSD currently, included only for application usage.
+
+.SH EXAMPLE
+
+SQL script to create all needed tables is included in Gammu documenation. As
+well as some PHP scripts interacting with the database.
+
+.SH SEE ALSO
+gammu-smsd(1), gammu-smsdrc(5), gammu(1), gammurc(5)
+.SH AUTHOR
+gammu-smsd and this manual page were written by Michal Cihar <michal@cihar.com>.
+.SH COPYRIGHT
+Copyright \(co 2009 Michal Cihar and other authors.
+License GPLv2: GNU GPL version 2 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>
+.br
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+.SH REPORTING BUGS
+Please report bugs to <http://bugs.cihar.com>.
diff --git a/docs/user/gammu-smsd.1 b/docs/user/gammu-smsd.1
@@ -43,6 +43,8 @@ Starts SMSD Windows service.
 
 .SH SEE ALSO
 gammu-smsdrc(5), gammu(1), gammu-smsd-inject(1)
+
+gammu-smsd-files(7), gammu-smsd-mysql(7), gammu-smsd-pgsql(7)
 .SH AUTHOR
 gammu-smsd and this manual page were written by Michal Cihar <michal@cihar.com>.
 .SH COPYRIGHT