Many modifications for mdsms -> sms9110 branch transition.

diff --git a/mdsms.1.in b/mdsms.1.in
index d645d68..b23cdbb 100644 (file)
--- a/mdsms.1.in
+++ b/mdsms.1.in
@@ -1,27 +1,29 @@
-.TH MDSMS 1 "17 May 1999" ~    VERSION ~ "SendSMS Manual"
+.TH SMS9110 1 "7 Sep 1999" ~   VERSION ~ "SMS9110 Manual"
 
 .\~ $Id$
 
 .SH NAME
-mdsms \- send SMSes through MobilDock
+sms9110 \- send SmartMessaging SMSes through Nokia 9110
 
 .SH SYNOPSIS
-.B mdsms
+.B sms9110
 .RB [ "-c <cfgfile>" ]
 .RB [ "-d <device>" ]
 .RB [ "-L <file>" ]
+.RB [ "-b <rate>" ]
 .RB [ "-l <lockfile>" ]
 .RB [ "-s <smsc #>" ]
 .RB [ "-m <#>" ]
 .RB [ "-r <sec>" ]
 .RB [ "-t <msec>" ]
 .RB [ "-T <msec>" ]
-.RB [ "\-fvhV" ]
+.RB [ "\-vhV" ]
 .RB [ "<dest. phone>" ]
-.RB [ "<msg text>" ]
+.RB [ "<logo filename>" ]
+.RB [ "<GSMnet id>" ]
 
 .SH DESCRIPTION
-Program sends one SMS message through MobilDock device.
+Program sends one SmartMessaging SMS through Nokia 9110 device.
 
 .SH OPTIONS
 .TP
@@ -31,7 +33,7 @@ Process recursively this file and read all options from it. See the section
 for more information.
 .TP
 .BR -d | --device\  < device >
-Specify serial device to communicate with MobilDock. If only bare name is
+Specify serial device to communicate with Nokia. If only bare name is
 specified, "\fB/dev/\fP" is prepended automatically. This device name is used
 subsequently with
 .BR -l | --lockfile
@@ -44,6 +46,15 @@ etc., similar to output of
 If set to empty string (which is default - ~\fB        DEF_LOGNAME     \fP~), nothing
 is logged anywhere.
 .TP
+.BR -b | --baud\  < rate >
+Sets custom baudrate for accessing Nokia modem. Supported speeds are currently:
+\fB2400\fP,
+\fB4800\fP,
+\fB9600\fP,
+\fB19200\fP,
+\fB38400\fP,
+\fB57600\fP. Default is \fB    DEF_BAUD        \fP.
+.TP
 .BR -l | --lockfile\  < lockfile >
 Prior to accessing serial device specified above the lockfile should be
 acquired for correct concurrent processes behaviour. Although this name
@@ -56,7 +67,7 @@ Default name for lockfile is ~\fB     DEF_LOCKFILE    \fP~.
 .BR -s | --smsc\  < smsc\ # >
 Specify custom SMS center number. If not specified (or overriden as empty
 string by \fB-s ""\fP)
-.B mdsms
+.B sms9110
 asks by "\fBAT+CSCA?\fP"
 Siemens A1 for its default SMS center. Situation with undeterminable SMS center
 is unrecoverable and casues immediate fail. It is a common practice to use
@@ -72,22 +83,17 @@ Known SMS centers as of May 1999:
 .BR -m | --maxretry\  < # >
 Maximum retries of any \fBAT\fP-style command during the session. All the
 retries are summed during one run of
-.B mdsms
+.B sms9110
 and no more retries of the command are permitted. After exceeding this
 value the program is terminated.
 .TP
 .BR -r | --readtime\  < sec >
 Maximum response read timeout before give up.
-.B mdsms
+.B sms9110
 sends the requested \fBAT\fP-style command to
-.B MobilDock
-and expects response. Unfortunately when the voice call is in progress,
-.B MobilDock
-will block any serial device communication and it is impossible to differentiate
-between calling
-.B MobilDock
-and stucked/disconnected one. After exceeding this time interval,
-.B mdsms
+.B Nokia
+and expects response. After exceeding this time interval,
+.B sms9110
 is terminated immediately,
 .B maxretry
 parameter notwithstanding. Standard value is
@@ -106,23 +112,27 @@ waiting a bit after character sent to give relax time to these devices.
 When full rate communication was used, occasional longer SMS data corruption
 was observed. Argument is given in milliseconds and its default value is
 .BR DEF_CHARTIME ms.
+\fB(This paragraph\fP
+.BR "doesn't"
+\fBapply to Nokia 9110 but the functionality has been
+retained just to be on the safe side.)\fP
 .TP
 .BR -T | --cmdtime\  < msec >
 This delay is given before sending any
 .B AT-style
-command to MobilDock/Siemens A1.
+command to Nokia.
 Its primary purpose is to let any previous entered commands to finish and
 to clear any input before actually sending our own command. Also all Siemens
 devices are known that they strongly dislike fast edge-to-edge communication
 and to satisfy these requirements this delay was considered as the best
-approach. The default value is
+approach.
+\fB(This sentence\fP
+.BR "doesn't"
+\fBapply to Nokia 9110 but the functionality has been
+retained just to be on the safe side.)\fP
+The default value is
 .BR DEF_CMDTIME ms.
 .TP
-.BR -f | --file
-When parameter <\fBmsg text\fP> has been specified, by using this option
-\fBmdsms\fP will read the file with the <\fBmsg text\fP> filename instead
-and send its \fBcontents\fP as the SMS message.
-.TP
 .BR -v | --verbose
 Increase verbosity level by one. Currently the maximum defined level is
 .BR 3 ,
@@ -139,7 +149,7 @@ Print the version number and exit.
 .TP
 .RB < "dest. phone" >
 This mandatory parameter specifies the telephone number of the recipient
-of SMS message. International prefix character plus
+of SmartMessaging message. International prefix character plus
 .RB ( + )
 is supported the national mode without plus
 .RB ( + )
@@ -151,19 +161,29 @@ This number can be made default in system configuration files, see below
 for section
 .BR CONFIGURATION .
 .TP
-.RB < "msg text" >
-Here you write the exact body of the message. This parameter should be
-specified only as one component, although if more found they are concatenated
-with separating space (" "). But this practice is discouraged as
-your shell will probably remove any multiple spaces found and also other
-metacharacters may be incorrectly interpreted. To prevent any escaping
-mess, you may prefer to omit this parameter and the the message text is
-then read from
-.I stdin
-(standard input stream).
+.RB < "logo filename" >
+Here you specifify the filename of the logo file to be uploaded. Currently
+recognized file formats are \fBNOL\fP (Nokia logo?) and \fBNGG\fP (Nokia
+Group Graphics). These formats are proprietary by \fBKESSLER Wireless Design\fP
+and \fBsms9110\fP currently "can't" edit them. More info can be found on:
+.RS
+.B http:/      /www.kessler-design.com/wireless/operatorlogo.php3
+.RE
+.TP
+.RB < "GSMnet id" >
+Specify GSM network code to be set on the logo being uploaded. Upon upload to
+Nokia phone each operator logo has a GSM network code binded with it. When
+you are registered (even roamed) into such network the logo is displayed on
+the phone. Current Nokia mobile phones can handle only one logo loaded
+simultaneously, it will be rewritten by any other upload. You can also
+specify string ~\fB    WORD_GROUP      \fP~ to send the logo as group graphics
+(even from \fBNOL\fP format) or string ~\fB    WORD_NET        \fP~ to force detection
+of network code from \fBNOL\fP. The default if this parameter is not specified
+is ~\fB        WORD_NET        \fP~ for \fBNOL\fP files and ~\fB       WORD_GROUP      \fP~ for
+\fBNGG\fP files.
 
 .SH CONFIGURATION
-.B mdsms
+.B sms9110
 reads ~\fB     CONFIG_MAIN     \fP~ followed by ~\fB$HOME      CONFIG_HOME     \fP~
 configuration files. The content of these files (and also any file read by
 .BR -c | --config
@@ -187,23 +207,23 @@ to see details of option processing with more complex configuration setups.
 
 .SH OPERATION
 Upon startup
-.B mdsms
+.B sms9110
 locks the port (see option
 .BR -l | --lockfile
-for details) and opens the serial device with hardcoded parameters of
-19200 baud, software handshaking (XON/XOFF style), 8 bits, no parity.
-Then issues the following commands:
+for details) and opens the serial device with specified baudrate (default
+\fB    DEF_BAUD        \fP baud), software handshaking (XON/XOFF style), 8 bits,
+no parity. Then issues the following commands:
 .TP
-.BR AT <CTRL-Z>
+.BR AT <ESCAPE>
 .B AT
-is used to fool MobilDock and pass the following
-.B <CTRL-Z>
-(ascii decimal code 26) character to Siemens A1 and break it from eventual
+is used to fool Nokia and pass the following
+.B <ESCAPE>
+(ascii decimal code 27) character to Nokia and break it from eventual
 .B AT+CMGS
 mode in which it may errorneously remain from previous sessions.
 .TP
 .B AT
-Test the responsiveness of Siemens A1.
+Test the responsiveness of Nokia.
 .TP
 \fBAT+CSCA="\fPsmc # from user\fB"\fP
 This command is omitted if
@@ -211,30 +231,38 @@ This command is omitted if
 is not specified by user (or specified/overriden as empty string \fB""\fP
 .TP
 \fBAT+CSCA?\fP
-Query the currently set SMC center number to include it later to the
-header of SMS PDU format where it is required. If \fBAT+CSCA="\fP...\fB"\fP
-was issued before, this number should match it but no sanity checks are
-currently do so.
+Query the currently set SMC center number to detect possibly unset SMS center.
 .TP
-\fBAT+CMGF=0\fP
-Set the default SMS message format to PDU type. Currently Siemens A1
-.RB "doesn't"
-support any other SMS format anyway.
+\fBAT+CSMP=81,,0,245\fP
+Sets PDU type to 81 (\fBSMS-SUBMIT\fP + integer-type for \fBvalidity\fP
++ \fBUDHI\fP - user data header indicator), PID (protocol identifier) to
+0 (standard non-converted SMS) and DCS (data coding scheme) to 0xF5
+(\fBdata coding\fP/\fBmessage class\fP, \fB8-bit data\fP + \fBmobile-equipment\fP
+specific).
 .TP
-\fBAT+CMGS=\fP# chars
+\fBAT+CMGS="\fPphone # from user\fB"\fP
 This command physically sends the message and the resulting "\fB+CMGS:\fP" output
 is catched and returned as
 .B MR
 (message reference) number to the user.
 .TP
+\fBAT+CSMP=17,,0,0\fP
+Resets back PDU type to 17 (\fBSMS-SUBMIT\fP + integer-type for \fBvalidity\fP),
+PID (protocol identifier) to 0 (standard non-converted SMS) and DCS (data coding
+scheme) to 0 (\fBalphabet indication\fP, \fBdefault 7-bit alphabet\fP).
+.TP
 \fBAT\fP
-Check that Siemens A1 survived the sending of the message.
+Check that Nokia survived the sending of the message.
 
 .SH SEE ALSO
 .TP
 .B GSM 03.40
 ETSI documentation for SMS messages in GSM networks
 .TP
+.B GNokii, tools and drivers for Nokia mobile phones
+Nokia logo data format was read from its sources:
+.B http:/      www.gnokii.org/
+.TP
 .B "Developers'" Guide: SMS with the A1
 Tech note on PDU SMS format etc:
 .B http:/              /www.siemens.se/telefoner/ovrigtgsm/fragorsvar/a1_sms.pdf
@@ -252,7 +280,7 @@ Main configuration file
 User personalized local configuration file
 
 .SH AUTHOR
-.B mdsms
+.B sms9110
 was written by Jan Kratochvil who should be responsible for all the bugs
 included. Please see the file "\fBAUTHORS\fP"
 shipped with the original distribution archive for more details.