home *** CD-ROM | disk | FTP | other *** search
/ PC-Online 1998 February / PCOnline_02_1998.iso / filesbbs / os2 / ssms204.arj / SSMS204.ZIP / readme.txt < prev    next >
Text File  |  1997-11-14  |  17KB  |  457 lines
  1. Description of SendSMS
  2. ======================
  3.  
  4.  
  5. Licence
  6. -------
  7.  
  8. This program is shareware. Every user has to aggree to the following licence-conditions:
  9.  
  10. 1. This program may only be distributed in this package.
  11.  
  12. 2. All rights for commercial-use will belong to the author.
  13.  
  14. 3. For a periode of 20 days you may use the program free. To use this software
  15.    after this periode of 20 days you have to register SendSMS.
  16.    If you doesn't register SendSMS you are not allowed to continue using
  17.    the software.
  18.  
  19. 4. To register please fill out the form (order.txt) and send it to the following address:
  20.  
  21.              B÷cherer Angewandte Informatik
  22.              Wolfgang B÷cherer
  23.              Im Grⁿn 9
  24.              D-76316 Malsch
  25.  
  26.              Tel.: +49 (0)7246/942484
  27.              Fax.: +49 (0)7246/942485
  28.              EMail: wobo@bai.de
  29.              WWW: http://www.bai.de
  30.  
  31.  
  32.    The fee for one licence (installation on one computer) is:
  33.  
  34.                      230,-- DM (incl. tax)
  35.  
  36.    (transfers from foreign countrys plus   20,-- DM)
  37.    (please ask for multiple licences)
  38.  
  39.    A T T E N T I O N!!! For registering it is important to specify your
  40.    operating-system and the phonenumber of the line to use with
  41.    SendSMS.
  42.  
  43. 5. In response to your order you get a bill and after we have got the money we
  44.    will send you a registration-key with which you are allowed to use SendSMS
  45.    on one computer. It is forbitten to distribute this registration-key.
  46.  
  47. 6. The use of SendSMS will result on your own risk. I am not responsible for
  48.    any damage through the use of SendSMS (neighter damage through errors nor
  49.    through wrong usage).
  50.  
  51.  
  52. ------------------------------------------------------------------------------
  53.  
  54. SendSMS is a shareware-program to send ShortMessages (SMS) to GSM-phones or pagers
  55. via the protocols TAP or UCP. SendSMS has following topics:
  56.  
  57. - UCP- and TAP-Protocol (ex.: D1, D2, EPlus, Quix, TeLMI, CityRuf, Scall, Skyper)
  58. - completly configurable for providers which use TAP or UCP
  59. - preconfigured fpr differnet providers in Germany, Autrich, England,
  60.   Danmark and Finland
  61. - message can be specified on the commandline (batch-processing)
  62. - easy to configure
  63. - evaluatable returncodes (errorcode or count of successfully sent messages)
  64. - can be used in server-mode and/or standalone (*)
  65. - phonebook: insted of numbers you can use aliases (*)
  66. - sending messages to multiple reciptients through different providers (*)
  67. - sending multiple messages to one or more reciptients within one connection (*)
  68. - messages can be spooled and sent in servermode with a minimum number of
  69.   connections (*)
  70. - event-logging (Logfile) or logging through syslogd (*)
  71. - configurable redialing (*)
  72. - definiton of header- and/or footer-line (*)
  73. - configurable delay between dial-attempts (*)
  74. - modem will not be locked between dial-attempts
  75. - configurable for the most common modems
  76. - available on many operating-systems
  77.  
  78. Topics marked with (*) are only available in the registered version.
  79.  
  80. ------------------------------------------------------------------------------
  81.  
  82. Installation
  83. ------------
  84.  
  85. You have only to decompress the ZIP-file (alternativly the tar.Z-file) in any
  86. directory. After that this directory should contain at least the following files:
  87.  
  88.  
  89.   readme.txt          - this file
  90.   sendsms[.exe]       - program-file
  91.   sendsms.cfg         - configuration-file
  92.   sendsms.err         - error-codes
  93.   sendsms.pro         - definition of providers
  94.   sendsms.pbk         - phonebook
  95.   group               - example for a group-definition (to send messages to
  96.                         multiple reciptients)
  97.  
  98. If you are using Unix you have to set the execute-permission for SendSMS
  99. (chmod u+x sendsms).
  100. (the OS/2-version requires the EMX-runtime-environment
  101. http://www.leo.org/pub/comp/os/os2/leo/index.html)
  102.  
  103. (the DOS-version requires a Fossil-driver,
  104. for Example adf.exe http://www.digsys.se)
  105.  
  106. ------------------------------------------------------------------------------
  107.  
  108. Configuration
  109. -------------
  110.  
  111. To configure SendSMS, edit the file sendsms.cfg.
  112.  
  113. In the file sendsms.pro you can define the different providers (which provider uses
  114. TAP or UCP, which phonenumbers are to be used for them and what is the predial-code
  115. for them).
  116.  
  117. Your personal phonebook with aliases can be defined in the file sendsms.pbk.
  118.  
  119. Comments are always prefixed by ';' or '#'.
  120.  
  121.  
  122. ------------------------------------------------------------------------------
  123. sendsms.cfg
  124. -----------
  125.  
  126. In this file you can configure SendSMS in the chapter [SendSMS]. In the
  127. chapter [Modem] you can configure your modem(-device). In the registered
  128. version you can define as many modems as you want. In the
  129. connection-phase SendSMS tries to use the first defined modem. If this went
  130. wrong (modem is locked) the next one is used. If no modem can be used there
  131. will be a delay (REDIALDELAY) and then the whole will be repeated (REDIALCOUNT).
  132.  
  133.  
  134. In the chapter [SendSMS] you can specify the following keywords to configure
  135. SendSMS. Every keyword has to be entered in an own line.
  136.  
  137. LOCKDIR=/var/spool/uucp
  138. Specifies the directory to look for and to generate a lock-file
  139. (only unix).
  140.  
  141. BINLOCKS=0
  142. Specifies whether the lockfile should be binary or ascii (only unix).
  143.  
  144. SPOOLDIR=/var/spool/sendsms
  145. Specifies the directory to spool messages.
  146. [only available in the registered version]
  147.  
  148. LOGFILE=sendsms.log
  149. Specifies a file in which all actions will be logged. If you specify
  150. 'syslog' (only unix) the logging will be handled through the syslog-daemon.
  151. [only available in the registered version]
  152.  
  153. HEADER=
  154. Specifies an optional headerline (text which will preceed every message)
  155. [only available in the registered version]
  156.  
  157. FOOTER=
  158. Specifies an optional footerline (text which will be appended to every message)
  159. [only available in the registered version]
  160.  
  161. REDIALCOUNT=1
  162. Specifies the count of redial-attempts. In servermode this specifies the max.
  163. count of leaving the message in the spooldirectory (after faulty transmission)
  164. [only available in the registered version]
  165.  
  166. REDIALDELAY=60
  167. Specifies the count of seconds to wait between two dial-attempts. While this
  168. time the modem will not be locked.
  169. [only available in the registered version]
  170.  
  171. PHONE=
  172. Your own phonenumber, from which the message will be submitted.
  173.  
  174. MAXERRORS=
  175. Specifies the count of errors (not transmitted messages) to accept until SendSMS
  176. will be terminated. If this parameter isn't set or is set to 0 the program will
  177. not terminate after an error. This parameter has only sense if you send messages
  178. to multiple reciptients.
  179.  
  180. BAUD=4800
  181. Specifies the baudrate (300, 600, 1200, 2400, 4800 or 9600). This value is
  182. only used if it isn't defined in sendsms.pro for the provider to be called.
  183.  
  184. DATABITS=8
  185. Specifies the count of databits (7 or 8). This value is
  186. only used if it isn't defined in sendsms.pro for the provider to be called.
  187.  
  188. STOPBITS=1
  189. Specifies the count of stopbits (1 or 2). This value is
  190. only used if it isn't defined in sendsms.pro for the provider to be called.
  191.  
  192. PARITY=NONE
  193. Specifies the kind of parity (NONE, EVEN or ODD). This value is
  194. only used if it isn't defined in sendsms.pro for the provider to be called.
  195.  
  196. TIMEOUT=40
  197. Specifies the time (in seconds) to wait for the CONNECT-Message after the
  198. dial-command.
  199.  
  200. WAITAFTERWRITE=1
  201. Specifies the count of seconds to wait after writing to the modem
  202. (normaly 0)
  203.  
  204.  
  205. In the chapter [Modem] you can specify the following keywords to configure
  206. your modem. Every keyword has to be entered in an own line.
  207. (Please check your modem-description (if you have one) for the corresponding
  208. modem-commands)
  209.  
  210. DEVICE=COM1
  211. Specifies the device to which your modem is connected.
  212. (Attention: on unix you have to take notice that you are allowed to use
  213. the device)
  214.  
  215. RESET=ATZ
  216. Specifies the command to reset your modem (normaly ATZ). If the standard
  217. profile of your modem sets the modem to 'answer off' (see below)
  218. then you have to leave this blank or to load another profile (ATZ1).
  219.  
  220. INIT=ATL1E1Q0V1
  221. Specifies the initialisation-command for your modem. You have to set your
  222. modem to:
  223.    echo on
  224.    answer on
  225.    answer as text
  226.  
  227. DIAL=ATDT0w
  228. Specifies the command to dial a number.
  229.  
  230. ESCAPE=+++
  231. Specifies the escapesequence to switch the modem from data- to command-mode.
  232.  
  233. HANGUP=ATH
  234. Specifies the comman to hang up.
  235.  
  236. RTSCTS=1
  237. Specifies to use the hardware-flowcontrol.
  238.  
  239.  
  240. sendsms.pro
  241. -----------
  242.  
  243. In this file you can define different providers (in the unregistered version
  244. a maximum of three providers). For every provider you have to enter a
  245. chapter by entering a line of the form:
  246. [<provider>]
  247. In every chapter you can specify the following parameters:
  248.  
  249. PHONE=
  250. Specifies the phonenumber of the provider. If the last character of the number
  251. is a '&', this means that the specified number will be appended by the number
  252. of the reciptient.
  253.  
  254. PROTOCOL=
  255. Specifies the protocol (TAP, UCP, Scall or Skyper) which the provider uses.
  256.  
  257. PREFIX=
  258. Specifies the predialcode for the corresponding provider. With this prefix
  259. SendSMS tries to identify the provider to which the phonenumber of the
  260. reciptient belongs.
  261.  
  262. REMOVEPREFIX=
  263. The number of the reciptient will be send together with the corresponding message.
  264. Because for some providers the number has to be send without any prefix you can
  265. specify with this parameter (=1) that the PREFIX (if defined) will be discarded.
  266.  
  267. MSGTYPE=
  268. Specifies the kind of message: NUMERIC (only digits), ALPHANUMERIC
  269. (characters and digits) or TONE (no characters, only beeping). If the
  270. protocol is SKYPER or SCALL (German pagers) then this parameter is
  271. set automatically.
  272.  
  273. MSGLEN=
  274. Specifies the max. length of a message. If the protocol is SKYPER or SCALL
  275. (German pagers) then this parameter is set automatically.
  276.  
  277. MAXMSG=
  278. Specifies the max. count of messages which can be send in a single connection.
  279. If this parameter is specified the connection is canceld after the
  280. corresponding count of messages is sent and if required a new connection
  281. will be established. This is neccesary because some providers have a limit
  282. for sending muliple messages per connection.
  283.  
  284. BAUD=4800
  285. Specifies the baudrate (300, 600, 1200, 2400, 4800 or 9600). If this parameter
  286. isn't specified the value from sendsms.cfg will be used.
  287.  
  288. DATABITS=8
  289. Specifies the count of databits (7 or 8).  If this parameter
  290. isn't specified the value from sendsms.cfg will be used.
  291.  
  292. STOPBITS=1
  293. Specifies the count of stopbits (1 or 2).  If this parameter
  294. isn't specified the value from sendsms.cfg will be used.
  295.  
  296. PARITY=NONE
  297. Specifies the kind of parity (NONE, EVEN or ODD).  If this parameter
  298. isn't specified the value from sendsms.cfg will be used.
  299.  
  300. WAITAFTERCONNECT=
  301. For some providers (using the UCP-protocol) there must be a delay between the
  302. Connect-message of the modem and the first outgoing message (this dependes on
  303. the modem-settings, too). This parameter specifies the duration in seconds of
  304. this delay.
  305.  
  306. MODEMINIT=
  307. Specifies an additional initializecommand for the modem. This command is called
  308. after the initializecommand deffined in sendsms.cfg and doesn't substitute
  309. it. Commonly this command can be left blank. It is only needed, if you want
  310. to force your modem to use a specific protocol. For eample you should use
  311. V.42/LAPM for providers using UCP (that is AT&Q5 for my modem).
  312.  
  313. for example:
  314. [D1]
  315. PHONE=01712092522
  316. PROTOCOL=TAP
  317. PREFIX=0171
  318. MSGTYPE=ALPHANUMERIC
  319. MSGLEN=160
  320.  
  321.  
  322. sendsms.pbk
  323. -----------
  324.  
  325. In this file you can enter a chapter for every in sendsms.pro
  326. defined provider with aliases. Every chapter starts with
  327. a line of the form:
  328. [<provider>]
  329. Every alias has to be entered in an own line and has to be of the
  330. form:
  331. <alias>=<phone>
  332. The phonebook is only available in the registered version!!!!
  333.  
  334. for example:
  335. [D1]
  336. wobo=01714160598        ; Wolfgang B÷cherer
  337.  
  338.  
  339. ------------------------------------------------------------------------------
  340.  
  341. Calling syntax
  342. --------------
  343.  
  344. SendSMS will be executed as follows:
  345.  
  346.    sendsms [options] {phoneNo | alias | @<inputFile>} [{message | < msgFile}]
  347.  
  348.    options are:
  349.       -P<provider>      specifies the provider for the corresponding phonenumber
  350.       -F<msgFile>       specifies a filename which contents will be send as the message
  351.       -C<cfgFile>       specifies the configuration-file (sendsms.cfg)
  352.       -R<proFile>       specifies the provider-definition-file (sendsms.pro)
  353.       -B<pbkFile>       specifies the phonebook-file (sendsms.pbk)
  354.       -q<n>             start SendSMS as a server and check queue every <n> minutes
  355.       -s                spool messages (even if there runs no server)
  356.       -n                start SendSMS standalone (even if there runs a server)
  357.  
  358. Ex.: sendsms 0171xxxxx "I am testing SendSMS"
  359.  
  360.  
  361. You have to specify at least one parameter - the phonenumber of the
  362. recipient or an alias (form the phonebook). If this first parameter starts with a
  363. masterspace (@), the parameter specifies the name of a file which contains
  364. multiple phonenumbers. With such a file it is possible to send one or multiple
  365. messages to multiple reciptients. The specified file must have the following
  366. format:
  367.  
  368. [<provider1>]
  369. SMS=<message1>
  370. PHONE=<number1>
  371. PHONE=<number2>
  372. SMS=<message2>
  373. PHONE=<number3>
  374. PHONE=<alias1>
  375. PHONE=<alias2>
  376.  
  377. [<provider2>]
  378. PHONE=<number4>
  379.  
  380. Inclosed in brackets ([]) you have to specify providers (which are defined in
  381. sendsms.pro), followed by multiple lines with phonenumbers of reciptients or
  382. messages. Every line contains a new message (SMS=...), which should be sent to the
  383. following reciptients or the phonenumber (PHONE=...) of a reciptient (number
  384. or alias), which belongs to the corresponding provider and to which the message should
  385. be send in one connection. In the above example the message <message1> will be
  386. send to 2 reciptients and the message <message2> to 3 reciptients of
  387. <provider1> using the same connection. The second message will be send to one
  388. reciptient of <provider2>, too. If that file doesn't contain any message, the
  389. message entered on the commandline will be send to all reciptients.
  390.  
  391. The second parameter is the message, enclosed by ' (ATTENTION: depending on the
  392. shell you are using some characters are substituted by the shell (for example '!')
  393. or you have to enclose the message by " insted of '). Alternativly you
  394. can specify the message by redirecting it from a file (< msgFile) or with the
  395. Parameter -F<msgFile>, where <msgFile> is the name of the file that will be
  396. send (at least the first n characters). If you specify only one parameter
  397. on the commandline (the reciptient), the message will be read from the console
  398. until you enter a line only consisting of a single '.'.
  399. If you want to send a message to a provider, which can't be identified by
  400. the predial-code of the reciptients phonenumber you have to specify the
  401. corresponding provider (as defined in sendsms.pro) with the parameter
  402. -P<provider>.
  403. For Example: you want to send a message to a Quix-Pager. SendSMS can't recognize
  404. the provider (Quix_News), because the number has no predialcode. Thatswhy you
  405. have to specify -PQuix_News.
  406.  
  407. If you start SendSMS with the parameter -q<n> (in that case all other parameters
  408. are ignored), SendSMS works as a server and checks every <n> minutes the
  409. spooldirectory (<n> = 0 means to check only one time and terminate). If there
  410. are spooled messages thay will be sent with a minimum number of connections.
  411. If there runs a server every new instance will be started in spoolmode. This
  412. can be manipulated with the parameters -s (always spool) and -n (never spool).
  413.  
  414. ------------------------------------------------------------------------------
  415.  
  416. Returncodes
  417. -----------
  418. SendSMS returns the count of successfully sent Messages. If the returncode is
  419. negative then this is an errorcode, which is described in the
  420. file sendsms.err.
  421.  
  422. ------------------------------------------------------------------------------
  423.  
  424. Where can I get the newest version?
  425. ===================================
  426.  
  427. You can always get the newest version under:
  428.  
  429.         http://www.bai.de/
  430.  
  431. ------------------------------------------------------------------------------
  432.  
  433. Problems/Questions
  434. ==================
  435.  
  436. Please send an Email including the following informations
  437.  
  438. - error-/problem-description
  439. - hardcopy of the screen (commandline and errormessage)
  440. - your sendsms.cfg
  441. - your sendsms.pro
  442. - used operating-system
  443. - used version of SendSMS
  444. - used modem
  445.  
  446. to:
  447.  
  448. wobo@bai.de
  449.  
  450. ------------------------------------------------------------------------------
  451. B÷cherer Angewandte Informatik
  452. Wolfgang B÷cherer, Im Grⁿn 9, D-76316 Malsch
  453. Tel.: +49 (0)7246/942484, Fax.: +49 (0)7246/942485
  454.  
  455. EMail: wobo@bai.de
  456. WWW: http://www.bai.de
  457.