path: root/docs/man/gammu-smsdrc.5

.TH "GAMMU-SMSDRC" "5" "March 03, 2011" "1.29.92" "Gammu"
.SH NAME
gammu-smsdrc \- gammu-smsd(1) configuration file
.
.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.
.
.SH DESCRIPTION
.sp
gammu\-smsd reads configuration from a config file. It\(aqs location can be
specified on command line, otherwise default path \fB/etc/gammu\-smsdrc\fP
is used.
.sp
This file use ini file syntax, see \fIini\fP.
.sp
Configuration file of gammu\-smsd consists of at least two sections \-
\fB[gammu]\fP and \fI\%[smsd]\fP. For \fIgammu\-smsd\-sql\fP
you can also use \fI\%[sql]\fP.
.sp
The \fB[gammu]\fP section is configuration of a phone connection
and is same as described in \fIgammurc\fP with the only exception that
\fI\%LogFile\fP is ignored and common logging for gammu library and
SMS daemon is used. However the \fBLogFormat\fP directive still
configures how much messages gammu emits.
.INDENT 0.0
.TP
.B [smsd]
.
The \fI\%[smsd]\fP section configures SMS daemon itself, which are described in
following subsections. First general parameters of SMS daemon are listed and
then specific parameters for storage backends.
.UNINDENT
.INDENT 0.0
.TP
.B [include_numbers]
.
List of numbers from which accept messages, see \fI\%Message filtering\fP.
.UNINDENT
.INDENT 0.0
.TP
.B [exclude_numbers]
.
List of numbers from which reject messages, see \fI\%Message filtering\fP.
.UNINDENT
.INDENT 0.0
.TP
.B [include_smsc]
.
List of SMSC numbers from which accept messages, see \fI\%Message filtering\fP.
.UNINDENT
.INDENT 0.0
.TP
.B [exclude_smsc]
.
List of SMSC numbers from which reject messages, see \fI\%Message filtering\fP.
.UNINDENT
.INDENT 0.0
.TP
.B [sql]
.
Configure SQL queries used by \fIgammu\-smsd\-sql\fP, you usually don\(aqt have to modify them.
.IP "See also"
.sp
\fIConfigurable queries\fP
.RE
.UNINDENT
.SH GENERAL PARAMETERS OF SMS DAEMON
.INDENT 0.0
.TP
.B Service
.
SMSD service to use, one of following choices:
.INDENT 7.0
.TP
.B \fBFILES\fP
.sp
stores messages in files, see \fIgammu\-smsd\-files\fP for details
.TP
.B \fBNULL\fP
.sp
does not store messages at all, see \fIgammu\-smsd\-null\fP for details
.TP
.B \fBSQL\fP
.sp
stores messages in SQL database, see \fIgammu\-smsd\-sql\fP for details
.sp
New in version 1.28.93.
.TP
.B \fBMYSQL\fP
.sp
synonym for \fI\%Service\fP = \fBSQL\fP and \fI\%Driver\fP = \fBnative_mysql\fP
.sp
stores messages in MySQL database, see \fIgammu\-smsd\-mysql\fP for details
.sp
Deprecated since version 1.28.93.
.TP
.B \fBPGSQL\fP
.sp
synonym for \fI\%Service\fP = \fBSQL\fP and \fI\%Driver\fP = \fBnative_mysql\fP
.sp
stores messages in PostgreSQL database, see \fIgammu\-smsd\-pgsql\fP for details
.sp
Deprecated since version 1.28.93.
.TP
.B \fBDBI\fP
.sp
synonym for \fI\%Service\fP = \fBSQL\fP and \fI\%Driver\fP = DBI driver
.sp
stores messages in any database supported by libdbi, this includes
MSSQL, MySQL, PostgreSQL or SQLite databases, see \fIgammu\-smsd\-dbi\fP for
details
.sp
Deprecated since version 1.28.93.
.UNINDENT
.IP Note
.
Availability of backends depends on platform and compile time configuration.
.RE
.UNINDENT
.INDENT 0.0
.TP
.B PIN
.
PIN for SIM card. This is optional, but you should set it if your phone after
power on requires PIN.
.UNINDENT
.INDENT 0.0
.TP
.B NetworkCode
.
Network personalisation password. This is optional, but some phones require it
after power on.
.UNINDENT
.INDENT 0.0
.TP
.B PhoneCode
.
Phone lock password. This is optional, but some phones require it after power
on.
.UNINDENT
.INDENT 0.0
.TP
.B LogFile
.
File where SMSD actions are being logged. You can also use special value
\fBsyslog\fP which will send all messages to syslog daemon. On Windows another
special value \fBeventlog\fP exists, which will send logs to Windows Event Log.
.sp
If you run SMSD as a system daemon (or service), it is recommended to use
absolute path to log file as startup directory might be different than you
expect.
.sp
Default is to provide no logging.
.UNINDENT
.INDENT 0.0
.TP
.B DebugLevel
.
Debug level for SMSD. The integer value should be sum of all flags you
want to enable.
.INDENT 7.0
.TP
.B 1
.
enables basic debugging information
.TP
.B 2
.
enables logging of SQL queries of service backends
.TP
.B 4
.
enables logging of gammu debug information
.UNINDENT
.sp
Generally to get as much debug information as possible, use 255.
.sp
Default is 0, what should mean no extra information.
.UNINDENT
.INDENT 0.0
.TP
.B CommTimeout
.
How many seconds should SMSD wait after there is no message in outbox.
.sp
Default is 30.
.UNINDENT
.INDENT 0.0
.TP
.B SendTimeout
.
Shows how many seconds SMSD should wait for network answer during sending
sms. If nothing happen during this time, sms will be resent.
.sp
Default is 30.
.UNINDENT
.INDENT 0.0
.TP
.B MaxRetries
.
How many times will SMSD try to resend message if sending fails.
.sp
Default is 1.
.UNINDENT
.INDENT 0.0
.TP
.B ReceiveFrequency
.
The number of seconds between testing for received SMSes, when the phone is
busy sending SMSes. Normally a test for received SMSes is done every
\fI\%CommTimeout\fP seconds and after each sent SMS.
.sp
Default is 0 (not used).
.UNINDENT
.INDENT 0.0
.TP
.B StatusFrequency
.
The number of seconds between refreshing phone status (battery, signal) stored
in shared memory and possibly in service backends. Use 0 to disable.
.sp
Default is 15.
.UNINDENT
.INDENT 0.0
.TP
.B LoopSleep
.
The number of seconds how long will SMSD sleep before checking for some
activity. Please note that setting this to higher value than 1 will have
effects to other time based configurations, because they will be effectively
rounded to multiply of this value.
.sp
Default is 1.
.UNINDENT
.INDENT 0.0
.TP
.B MultipartTimeout
.
The number of seconds how long will SMSD wait for all parts of multipart
message. If all parts won\(aqt arrive in time, parts will be processed as separate
messages.
.sp
Default is 600 (10 minutes).
.UNINDENT
.INDENT 0.0
.TP
.B CheckSecurity
.
Whether to check if phone wants to enter PIN.
.sp
Default is 1 (enabled).
.UNINDENT
.INDENT 0.0
.TP
.B CheckBattery
.
Whether to check phone battery state periodically.
.sp
Default is 1 (enabled).
.UNINDENT
.INDENT 0.0
.TP
.B CheckSignal
.
Whether to check signal level periodically.
.sp
Default is 1 (enabled).
.UNINDENT
.INDENT 0.0
.TP
.B ResetFrequency
.
The number of seconds between performing a preventive soft reset in order to
minimize the cases of hanging phones e.g. Nokia 5110 will sometimes freeze to
a state when only after unmounting the battery the phone will be functional
again.
.sp
Default is 0 (not used).
.UNINDENT
.INDENT 0.0
.TP
.B HardResetFrequency
.
New in version 1.28.92.
.IP Warning
.
For some phones hard reset means deleting all data in it. Use
\fI\%ResetFrequency\fP, unless you know what you are doing.
.RE
.sp
The number of seconds between performing a preventive hard reset in order to
minimize the cases of hanging phones.
.sp
Default is 0 (not used).
.UNINDENT
.INDENT 0.0
.TP
.B DeliveryReport
.
Whether delivery reports should be used, one of \fBno\fP, \fBlog\fP, \fBsms\fP.
.INDENT 7.0
.TP
.B \fBlog\fP
.sp
one line log entry,
.TP
.B \fBsms\fP
.sp
store in inbox as a received SMS
.TP
.B \fBno\fP
.sp
no delivery reports
.UNINDENT
.sp
Default is \fBno\fP.
.UNINDENT
.INDENT 0.0
.TP
.B DeliveryReportDelay
.
Delay in seconds how long is still delivery report considered valid. This
depends on brokeness of your network (delivery report should have same
timestamp as sent message). Increase this if delivery reports are not paired
with sent messages.
.sp
Default is 600 (10 minutes).
.UNINDENT
.INDENT 0.0
.TP
.B PhoneID
.
String with info about phone used for sending/receiving. This can be useful if
you want to run several SMS daemons.
.sp
When you set PhoneID, all messages (including injected ones) will be marked
by this string (stored as SenderID in the database) and it allows more SMS
daemons to share a single database.
.sp
This option has actually no effect with \fIgammu\-smsd\-files\fP.
.UNINDENT
.INDENT 0.0
.TP
.B RunOnReceive
.
Executes a program after receiving message.
.sp
This parameter is executed through shell, so you might need to escape some
special characters and you can include any number of parameters. Additionally
parameters with identifiers of received messages are appended to the command
line. The identifiers depend on used service backend, typically it is ID of
inserted row for database backends or file name for file based backends.
.sp
Gammu SMSD waits for the script to terminate. If you make some time consuming
there, it will make SMSD not receive new messages. However to limit breakage
from this situation, the waiting time is limited to two minutes. After this
time SMSD will continue in normal operation and might execute your script
again.
.sp
The process has available lot of information about received message in
environment, check \fIsmsd_run\fP for more details.
.UNINDENT
.INDENT 0.0
.TP
.B RunOnFailure
.
New in version 1.28.93.
.sp
Executes a program on failure.
.sp
This can be used to proactively react on some failures or to interactively
detect failure of sending message.
.sp
The program will receive optional parameter, which can currently be either
\fBINIT\fP (meaning failure during phone initialization) or message ID,
which would indicate error while sending the message.
.IP Note
.
The environment with message (as is in \fI\%RunOnReceive\fP) is not passed to the command.
.RE
.UNINDENT
.INDENT 0.0
.TP
.B IncludeNumbersFile
.
File with list of numbers which are accepted by SMSD. The file contains one
number per line, blank lines are ignored. The file is read at startup and is
reread only when configuration is being reread. See Message filtering for
details.
.UNINDENT
.INDENT 0.0
.TP
.B ExcludeNumbersFile
.
File with list of numbers which are not accepted by SMSD. The file contains
one number per line, blank lines are ignored. The file is read at startup and
is reread only when configuration is being reread. See Message filtering for
details.
.UNINDENT
.INDENT 0.0
.TP
.B IncludeSMSCFile
.
File with list of SMSC numbers which are accepted by SMSD. The file contains
one number per line, blank lines are ignored. The file is read at startup and
is reread only when configuration is being reread. See Message filtering for
details.
.UNINDENT
.INDENT 0.0
.TP
.B ExcludeSMSCFile
.
File with list of SMSC numbers which are not accepted by SMSD. The file
contains one number per line, blank lines are ignored. The file is read at
startup and is reread only when configuration is being reread. See Message
filtering for details.
.UNINDENT
.INDENT 0.0
.TP
.B BackendRetries
.
How many times will SMSD backend retry operation.
.sp
The implementation on different backends is different, for database backends
it generally means how many times it will try to reconnect to the server.
.sp
Default is 10.
.UNINDENT
.INDENT 0.0
.TP
.B Send
.
Whether to enable sending of messages.
.sp
Default is True.
.UNINDENT
.INDENT 0.0
.TP
.B Receive
.
Whether to enable receiving of messages.
.sp
Default is True.
.UNINDENT
.SH DATABASE BACKENDS OPTIONS
.sp
All DBI, MYSQL and PGSQL backends (see \fIgammu\-smsd\-mysql\fP,
\fIgammu\-smsd\-pgsql\fP, \fIgammu\-smsd\-dbi\fP for their documentation)
supports same options for configuring connection to a database:
.INDENT 0.0
.TP
.B User
.
User name used for connection to a database.
.UNINDENT
.INDENT 0.0
.TP
.B Password
.
Password used for connection to a database.
.UNINDENT
.INDENT 0.0
.TP
.B Host
.
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
.TP
.B PC
.
Synonym for \fI\%Host\fP.
.sp
Deprecated since version 1.28.92.
.UNINDENT
.INDENT 0.0
.TP
.B Database
.
Name of database to use. Please note that you should create tables in this
database before using gammu\-smsd. SQL files for creating needed tables are
included in documentation.
.UNINDENT
.INDENT 0.0
.TP
.B SkipSMSCNumber
.
When you send sms from some SMS centere you can have delivery reports from
other SMSC number. You can set here number of this SMSC used by you and Gammu
will not check it\(aqs number during assigning reports to sent SMS.
.UNINDENT
.INDENT 0.0
.TP
.B Driver
.
SQL driver to use.
.sp
Can be either one of native drivers (\fBnative_mysql\fP or \fBnative_pgsql\fP) or \fIgammu\-smsd\-dbi\fP driver.
.sp
Depends on what DBI drivers you have installed, DBI
supports: \fBmysql\fP, \fBfreetds\fP (provides access to MS SQL Server and
Sybase), \fBpgsql\fP, \fBsqlite\fP, \fBsqlite3\fP, \fBfirebird\fP and \fBingres\fP,
\fBmsql\fP and \fBoracle\fP drivers are under development.
.UNINDENT
.INDENT 0.0
.TP
.B DriversPath
.
Path, where DBI drivers are stored, this usually does not have to be set if
you have properly installed drivers.
.UNINDENT
.INDENT 0.0
.TP
.B DBDir
.
Database directory for some (currently only sqlite) DBI drivers. Set here path
where sqlite database files are stored.
.UNINDENT
.SS Files backend options
.sp
The FILES backend accepts following configuration options. See
\fIgammu\-smsd\-files\fP for more detailed service backend description. Please note
that all path should contain trailing path separator (/ on Unix systems):
.INDENT 0.0
.TP
.B InboxPath
.
Where the received SMSes are stored.
.sp
Default is current directory.
.UNINDENT
.INDENT 0.0
.TP
.B OutboxPath
.
Where SMSes to be sent should be placed.
.sp
Default is current directory.
.UNINDENT
.INDENT 0.0
.TP
.B SentSMSPath
.
Where the transmitted SMSes are placed, if same as \fI\%OutboxPath\fP transmitted
messages are deleted.
.sp
Default is to delete transmitted messages.
.UNINDENT
.INDENT 0.0
.TP
.B ErrorSMSPath
.
Where SMSes with error in transmission is placed.
.sp
Default is same as \fI\%SentSMSPath\fP.
.UNINDENT
.INDENT 0.0
.TP
.B InboxFormat
.
The format in which the SMS will be stored: \fBdetail\fP, \fBunicode\fP, \fBstandard\fP.
.INDENT 7.0
.TP
.B \fBdetail\fP
.sp
format used for message backup by \fIgammu\fP, see \fIgammu\-smsbackup\fP.
.TP
.B \fBunicode\fP
.sp
message text stored in unicode (UTF\-16)
.TP
.B \fBstandard\fP
.sp
message text stored in system charset
.UNINDENT
.sp
The \fBstandard\fP and \fBunicode\fP settings do not apply for 8\-bit messages, which
are always written raw as they are received with extension .bin.
.sp
Default is \fBunicode\fP.
.IP Note
.
In \fBdetail\fP format, all message parts are stored into signle file,
for all others each message part is saved separately.
.RE
.UNINDENT
.INDENT 0.0
.TP
.B OutboxFormat
.
The format in which messages created by \fIgammu\-smsd\-inject\fP will be stored,
it accepts same values as InboxFormat.
.sp
Default is \fBdetail\fP if Gammu is compiled in with backup functions, \fBunicode\fP
otherwise.
.UNINDENT
.INDENT 0.0
.TP
.B TransmitFormat
.
The format for transmitting the SMS: \fBauto\fP, \fBunicode\fP, \fB7bit\fP.
.sp
Default is \fBauto\fP.
.UNINDENT
.SH MESSAGE FILTERING
.sp
SMSD allows one to process only limited subset of incoming messages. You can define
filters for sender number in \fI\%[include_numbers]\fP and
\fI\%[exclude_numbers]\fP sections or using
\fI\%IncludeNumbersFile\fP and \fI\%ExcludeNumbersFile\fP
directives.
.sp
If \fI\%[include_numbers]\fP section exists, all values (keys are
ignored) from it are used as allowed phone numbers and no other message is
processed. On the other side, in \fI\%[exclude_numbers]\fP you can
specify numbers which you want to skip.
.sp
Lists from both sources are merged together. If there is any number in include
list, only include list is used and only messages in this list are being
accepted. If include list is empty, exclude list can be used to ignore
messages from some numbers. If both lists are empty, all messages are
accepted.
.sp
Similar filtering rules can be used for SMSC number filtering, they just use
different set of configuration options \- \fI\%[include_smsc]\fP and
\fI\%[exclude_smsc]\fP sections or \fI\%IncludeSMSCFile\fP
and \fI\%ExcludeSMSCFile\fP directives.
.SH EXAMPLES
.sp
There is more complete example available in Gammu documentation. Please note
that for simplicity following examples do not include \fB[gammu]\fP
section, you can look into \fIgammurc\fP for some examples how it can look like.
.sp
SMSD configuration file for FILES backend could look like:
.sp
.nf
.ft C
[smsd]
Service = files
PIN = 1234
LogFile = syslog
InboxPath = /var/spool/sms/inbox/
OutboPpath = /var/spool/sms/outbox/
SentSMSPath = /var/spool/sms/sent/
ErrorSMSPath = /var/spool/sms/error/
.ft P
.fi
.sp
If you want to use MYSQL backend, you will need something like this:
.sp
.nf
.ft C
[smsd]
Service = mysql
PIN = 1234
LogFile = syslog
User = smsd
Password = smsd
PC = localhost
Database = smsd
.ft P
.fi
.sp
Process only messages from 123456 number:
.sp
.nf
.ft C
[include_numbers]
number1 = 123456
.ft P
.fi
.sp
Do not process messages from evil number 666:
.sp
.nf
.ft C
[exclude_numbers]
number1 = 666
.ft P
.fi
.sp
Enabling debugging:
.sp
.nf
.ft C
[smsd]
debuglevel = 255
logfile = smsd.log
.ft P
.fi
.SH AUTHOR
Michal Čihař <michal@cihar.com>
.SH COPYRIGHT
2009-2011, Michal Čihař <michal@cihar.com>
.\" Generated by docutils manpage writer.
.\" 
.