sms_serv.1
上传用户:eo_sii
上传日期:2007-01-05
资源大小:91k
文件大小:7k
源码类别:

手机短信编程

开发平台:

Unix_Linux

  1. .TH SMS_SERV 1 "Project SMSLink" "Les Ateliers du Heron" " -*- nroff -*-
  2. .SH NAME
  3. sms_serv - SMS gateway server module
  4. .SH SYNOPSIS
  5. .B sms_serv
  6. .SH DESCRIPTION
  7. .B sms_serv
  8. implements a client / server gateway to the SMS protocol, and relies
  9. on the use of dedicated hardware (a GSM voice modem module). It 
  10. allows client programs, connecting through TCP sockets, to send SMS
  11. messages to mobile phones. A future extension will also permit
  12. receiving SMS messages and storing them in a text file.
  13. .PP
  14. This manual page
  15. will cover the functionalities and use of
  16. .BR sms_serv .
  17. For installation and configuration instructions, please refer to the 
  18. INSTALL document, provided in the sources directory.
  19. .SS OPTIONS
  20. .TP
  21. None at the present time.
  22. .SH COMMAND LANGUAGE
  23. When telnetting to the port the server is listening on (TCP port 
  24. .B 6701
  25. by default), the user is greeted by a few lines of announce and 
  26. a prompt. It is possible from there to send SMS messages interactively.
  27. Those are the commands recognized by the interpreter.
  28. .SS COMMANDS
  29. .TP
  30. .I "he |  help [command]"
  31. When used without parameters, this command displays a list of all
  32. available commands. When used with a parameter, it displays a short
  33. help text if the parameter is a word of the language.
  34. .TP
  35. .I "clear [item]"
  36. Clears the requested item (or reverts it back to its default value when
  37. there is one).
  38. .B item
  39. can be one of:
  40. .br
  41. - user: sender identification (user name) for logging purposes
  42. .br
  43. - smsc: SMS Message Center (see your provider or use default value)
  44. .br
  45. - dest: destination GSM Network Address (i.e. phone number)
  46. .br
  47. - message | msg: message text to be sent to destination
  48. .sp 1
  49. When used without parameter, this commands clears all items.
  50. .TP
  51. .I "set item = value"
  52. Sets the requested item to the specified value.
  53. .B item
  54. can be one of:
  55. .br
  56. - user: sender identification (user name) for logging purposes
  57. .br
  58. - smsc: SMS Message Center (see your provider or use default value)
  59. .br
  60. - dest: destination GSM Network Address (i.e. phone number)
  61. .br
  62. - message | msg: message text to be sent to destination
  63. .sp 1
  64. .BR user ", " dest " and " message
  65. are required and have no default value.
  66. .B smsc
  67. is optional and defaults to whatever value is set by the administrator
  68. in the
  69. .B /etc/gsmdevices
  70. file.
  71. .sp 1
  72. .BR user " and " message
  73. values have to be quoted.
  74. .BR dest " and " smsc
  75. items expect a phone number as value. Phone numbers can be quoted but don't
  76. have to be. In addition to numbers, they can contain a "+" (international call
  77. symbol) and any of the following separation characters: [/.-]. Those separation
  78. characters are purely cosmetics and will be stripped off before being sent to
  79. the GSM module for transmission.
  80. .sp 1
  81. .B message
  82. value can be maximum 160 characters long (surrounding quotes not included).
  83. Longer messages will be truncated to the first 160 characters, and the user will
  84. be warned about it.
  85. .sp 1
  86. Maximum length for
  87. .B user
  88. is 12 characters.
  89. .TP
  90. .I "send"
  91. When all parameters are filled in as required, use this command to send
  92. the SMS message. The user will have to wait during the time it takes to
  93. send the message, and all commands sent to the module and their responses
  94. will be echoed, so the user is immediately aware of any problem and of its
  95. nature. An acknowledgment will be returned when done, including the message 
  96. ID given to this job by the GSM module (cyclic counter, from 0 to 255).
  97. .TP
  98. .I "exit | quit | bye"
  99. Closes the connection and leaves the program.
  100. .TP
  101. .I "sh | show [item]"
  102. Displays the current setting for the specified
  103. .BR item ,
  104. where
  105. .B item
  106. is one of:
  107. .br
  108. - user: sender identification (user name) for logging purposes
  109. .br
  110. - smsc: SMS Message Center (see your provider or use default value)
  111. .br
  112. - dest: destination GSM Network Address (i.e. phone number)
  113. .br
  114. - message | msg: message text to be sent to destination (and its length)
  115. .sp 1
  116. When used without parameter,
  117. .B show
  118. displays the current settings for all parameters.
  119. .TP
  120. .I "dl | devicelist"
  121. Lists registered GSM devices. Those are configured through the
  122. .B /etc/gsmdevices
  123. file. The fields provided in the output are the following:
  124. .br
  125. - Device: Unix device name
  126. .br
  127. - CallerID: the GSM network address (its phone number)
  128. .br
  129. - Def SCA: default Service Center Address (or SMSC)
  130. .br
  131. - Provider: Network Provider name
  132. .sp 1
  133. A first column, titled
  134. .BR L ,
  135. holds the current lock status of the device.
  136. .TP
  137. .I "ut | uptime"
  138. Displays the server uptime in days, hours, minutes and seconds.
  139. .TP
  140. .I "acl | aclist"
  141. Lists all the ACL entries successfully loaded from the configuration file
  142. (see
  143. .B gsmaccess
  144. (5)). Since the order of the entries is used to grant or reject access,
  145. this order is preserved in the listing. Usefull for debugging configuration
  146. issues.
  147. .SH FILES
  148. .B /etc/gsmdevices
  149. .br
  150. Contains the configuration parameters for each GSM device instance.
  151. .PP
  152. .B /etc/gsmaccess
  153. .br
  154. Defines IP-based access rules to the service (ACL).
  155. .PP
  156. .B /var/spool/smslink/inbox
  157. .br
  158. File where the incoming messages will be stored. The file format is plain
  159. text with Comma Separated Values (CSV) to make it easily parsable by any
  160. external application (such as
  161. .B sms2mailgw
  162. (1)). The records are separated by the newline character.
  163. The fields are as follows:
  164. .br
  165. - GSM device: The full Unix device name of the GSM module that received
  166. the message. In case your server is configured with multiple GSM instances,
  167. this allows an external application to discriminate between instances when
  168. needed.
  169. .br
  170. - Message ID: The ID assigned by the SIM to the message. Increments
  171. sequentially from 0 to 255, then reverts back to 0.
  172. .br
  173. - Sender number: The sender's network address (GSM dialing number).
  174. .br
  175. - Date: The date the message was sent.
  176. .br
  177. - Time: The time the message was sent.
  178. .br
  179. - Message text: The message text. It will always be quoted to protect
  180. special characters such as field separators (commas) in the text.
  181. .PP
  182. .B /var/spool/smslink/checkpoint
  183. .br
  184. Empty file "touched" by the server module (in order to alter its timestamp)
  185. after a mailbox check. The timestamp info of this file is used by
  186. .B sms2mailgw
  187. (1) to synchronize its runs with the server module's checks.
  188. .SH BUGS
  189. Quite a few of them, but still less bugs than lacking features at this
  190. stage.
  191. See the BUGS document, in the sources directory.
  192. .SH SEE ALSO
  193. .BR sendsms "(1), " sms2mailgw "(1), " gsmdevices "(5), " gsmaccess "(5)"
  194. .PP
  195. The INSTALL, TODO and README documents in the sources tree.
  196. .SH COPYRIGHT
  197. SMSLink is (c) Les Ateliers du Heron, 1998 by Philippe Andersson
  198. <philippe_andersson@ste.scitex.com>. It has been originally written for
  199. Scitex Europe, S.A.
  200. .PP
  201. Part of the code is (c) Riccardo Facchetti.
  202. .PP
  203. The code also includes contributions from Philipp Klaus <pklaus@access.ch>.
  204. .PP
  205. SMSLink has been released to the public under the GNU GPL.