sms_serv.1
上传用户:eo_sii
上传日期:2007-01-05
资源大小:91k
文件大小:7k
- .TH SMS_SERV 1 "Project SMSLink" "Les Ateliers du Heron" " -*- nroff -*-
- .SH NAME
- sms_serv - SMS gateway server module
- .SH SYNOPSIS
- .B sms_serv
- .SH DESCRIPTION
- .B sms_serv
- implements a client / server gateway to the SMS protocol, and relies
- on the use of dedicated hardware (a GSM voice modem module). It
- allows client programs, connecting through TCP sockets, to send SMS
- messages to mobile phones. A future extension will also permit
- receiving SMS messages and storing them in a text file.
- .PP
- This manual page
- will cover the functionalities and use of
- .BR sms_serv .
- For installation and configuration instructions, please refer to the
- INSTALL document, provided in the sources directory.
- .SS OPTIONS
- .TP
- None at the present time.
- .SH COMMAND LANGUAGE
- When telnetting to the port the server is listening on (TCP port
- .B 6701
- by default), the user is greeted by a few lines of announce and
- a prompt. It is possible from there to send SMS messages interactively.
- Those are the commands recognized by the interpreter.
- .SS COMMANDS
- .TP
- .I "he | help [command]"
- When used without parameters, this command displays a list of all
- available commands. When used with a parameter, it displays a short
- help text if the parameter is a word of the language.
- .TP
- .I "clear [item]"
- Clears the requested item (or reverts it back to its default value when
- there is one).
- .B item
- can be one of:
- .br
- - user: sender identification (user name) for logging purposes
- .br
- - smsc: SMS Message Center (see your provider or use default value)
- .br
- - dest: destination GSM Network Address (i.e. phone number)
- .br
- - message | msg: message text to be sent to destination
- .sp 1
- When used without parameter, this commands clears all items.
- .TP
- .I "set item = value"
- Sets the requested item to the specified value.
- .B item
- can be one of:
- .br
- - user: sender identification (user name) for logging purposes
- .br
- - smsc: SMS Message Center (see your provider or use default value)
- .br
- - dest: destination GSM Network Address (i.e. phone number)
- .br
- - message | msg: message text to be sent to destination
- .sp 1
- .BR user ", " dest " and " message
- are required and have no default value.
- .B smsc
- is optional and defaults to whatever value is set by the administrator
- in the
- .B /etc/gsmdevices
- file.
- .sp 1
- .BR user " and " message
- values have to be quoted.
- .BR dest " and " smsc
- items expect a phone number as value. Phone numbers can be quoted but don't
- have to be. In addition to numbers, they can contain a "+" (international call
- symbol) and any of the following separation characters: [/.-]. Those separation
- characters are purely cosmetics and will be stripped off before being sent to
- the GSM module for transmission.
- .sp 1
- .B message
- value can be maximum 160 characters long (surrounding quotes not included).
- Longer messages will be truncated to the first 160 characters, and the user will
- be warned about it.
- .sp 1
- Maximum length for
- .B user
- is 12 characters.
- .TP
- .I "send"
- When all parameters are filled in as required, use this command to send
- the SMS message. The user will have to wait during the time it takes to
- send the message, and all commands sent to the module and their responses
- will be echoed, so the user is immediately aware of any problem and of its
- nature. An acknowledgment will be returned when done, including the message
- ID given to this job by the GSM module (cyclic counter, from 0 to 255).
- .TP
- .I "exit | quit | bye"
- Closes the connection and leaves the program.
- .TP
- .I "sh | show [item]"
- Displays the current setting for the specified
- .BR item ,
- where
- .B item
- is one of:
- .br
- - user: sender identification (user name) for logging purposes
- .br
- - smsc: SMS Message Center (see your provider or use default value)
- .br
- - dest: destination GSM Network Address (i.e. phone number)
- .br
- - message | msg: message text to be sent to destination (and its length)
- .sp 1
- When used without parameter,
- .B show
- displays the current settings for all parameters.
- .TP
- .I "dl | devicelist"
- Lists registered GSM devices. Those are configured through the
- .B /etc/gsmdevices
- file. The fields provided in the output are the following:
- .br
- - Device: Unix device name
- .br
- - CallerID: the GSM network address (its phone number)
- .br
- - Def SCA: default Service Center Address (or SMSC)
- .br
- - Provider: Network Provider name
- .sp 1
- A first column, titled
- .BR L ,
- holds the current lock status of the device.
- .TP
- .I "ut | uptime"
- Displays the server uptime in days, hours, minutes and seconds.
- .TP
- .I "acl | aclist"
- Lists all the ACL entries successfully loaded from the configuration file
- (see
- .B gsmaccess
- (5)). Since the order of the entries is used to grant or reject access,
- this order is preserved in the listing. Usefull for debugging configuration
- issues.
- .SH FILES
- .B /etc/gsmdevices
- .br
- Contains the configuration parameters for each GSM device instance.
- .PP
- .B /etc/gsmaccess
- .br
- Defines IP-based access rules to the service (ACL).
- .PP
- .B /var/spool/smslink/inbox
- .br
- File where the incoming messages will be stored. The file format is plain
- text with Comma Separated Values (CSV) to make it easily parsable by any
- external application (such as
- .B sms2mailgw
- (1)). The records are separated by the newline character.
- The fields are as follows:
- .br
- - GSM device: The full Unix device name of the GSM module that received
- the message. In case your server is configured with multiple GSM instances,
- this allows an external application to discriminate between instances when
- needed.
- .br
- - Message ID: The ID assigned by the SIM to the message. Increments
- sequentially from 0 to 255, then reverts back to 0.
- .br
- - Sender number: The sender's network address (GSM dialing number).
- .br
- - Date: The date the message was sent.
- .br
- - Time: The time the message was sent.
- .br
- - Message text: The message text. It will always be quoted to protect
- special characters such as field separators (commas) in the text.
- .PP
- .B /var/spool/smslink/checkpoint
- .br
- Empty file "touched" by the server module (in order to alter its timestamp)
- after a mailbox check. The timestamp info of this file is used by
- .B sms2mailgw
- (1) to synchronize its runs with the server module's checks.
- .SH BUGS
- Quite a few of them, but still less bugs than lacking features at this
- stage.
- See the BUGS document, in the sources directory.
- .SH SEE ALSO
- .BR sendsms "(1), " sms2mailgw "(1), " gsmdevices "(5), " gsmaccess "(5)"
- .PP
- The INSTALL, TODO and README documents in the sources tree.
- .SH COPYRIGHT
- SMSLink is (c) Les Ateliers du Heron, 1998 by Philippe Andersson
- <philippe_andersson@ste.scitex.com>. It has been originally written for
- Scitex Europe, S.A.
- .PP
- Part of the code is (c) Riccardo Facchetti.
- .PP
- The code also includes contributions from Philipp Klaus <pklaus@access.ch>.
- .PP
- SMSLink has been released to the public under the GNU GPL.