home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / zsys / znode-12 / s / ybbat489.arc / SCRIPT.DOC < prev    next >
Encoding:
Text File  |  1989-04-12  |  4.3 KB  |  150 lines
  1.  
  2. This file is included at the request of one of our beta testers.  It
  3. describes the previously undocumented (and still unsupported) KSmail
  4. scripter.  It is a combination of the TASL scripter and a subset of the
  5. Opus/Binkley script language.  It is under development and is evolving
  6. more and more in the direction of the latter.
  7.  
  8. Try this strictly at your own risk.  This may or may not be included
  9. in the version you now have and may or may not be supported in versions
  10. to follow.
  11.  
  12. The method now used is crude, I admit, and inconvenient since it now
  13. requires a separate .TAM file for each node to be reached via PCP.
  14. This method will be replaced with a more convenient one Real Soon Now.
  15.  
  16.  
  17. Two caveats, though, for those of you who want to try this out.
  18.  
  19. 1. Since your script files will often have your PCP account number and
  20.    password unencoded and in human-readable form, it is advisable to
  21.    make all .TAM files unavailable to your users and to flag them as being
  22.    unavailable for download.
  23.  
  24. 2. If you use PCP on a second machine while your BBS is in operation,
  25.    keep in mind that any outgoing mail event may cause KSmail to access
  26.    PCP with your account and passwords.  To avoid duplicate use and
  27.    subsequent hassles with Big Daddy Telenet, be sure to take steps to
  28.    insure usage will not be duplicated.
  29.  
  30.    Similarly, be sure that all of your mail events are totally contained
  31.    within PCP's non-prime-time.
  32.  
  33.  
  34. The primary purpose of the scripter is to allow KSmail to send netmail
  35. by way of PC Pursuit and similar services.  If you have a working KSmail
  36. system and feel like a snappy game of adventure, feel free to try it.
  37. I know there are some major holes in this.  As I said, it is still under
  38. development.
  39.  
  40. I haven't spent too much time on this document as I didn't plan on
  41. supporting the scripter until it was more mature.  You might find the
  42. notes in recent Binkleyterm packages to be of some help as well.
  43.  
  44. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
  45.  
  46. Script files are (currently) noted with the familiar net/node
  47. designation with the extension .TAM.  If the appropriate .TAM file
  48. is found when a network is to be called, the script is executed in
  49. lieu of the default dialing mechanism.  (crude, I admit)
  50.  
  51. KSmail scripts are currently a subset of the Opus/Binkley scripts.
  52. The valid keywords are as follows with restrictions noted.
  53.  
  54.  
  55. "wait"
  56.  
  57. ^C during a 'wait' cancels the KSmail session.  'C' (upper or lower)
  58. during a 'wait' skips the current call and continues with the next.
  59. (^C may cause a skip; 'C' no effect in some versions.)
  60.  
  61. The script 'fails' if a wait period expires without a valid match
  62. or over 10 'tries' at any point in the script are used.  A 'try' is
  63. defined as a matched pattern (BUSY, etc.) that causes a backwards
  64. jump to a label.  (20 tries in some releases)
  65.  
  66.  
  67. "abort"
  68.  
  69. Does just that.  Time arguments are not permitted.
  70.  
  71.  
  72. "baud"
  73.  
  74. Baud rate must be explicitly declared.  This should be one of the
  75. first, if not the first, lines in the script.
  76.  
  77.  
  78. "carrier"
  79.  
  80. Aborts if carrier absent.  Continues if present.
  81.  
  82.  
  83. "goto"
  84.  
  85. 'It's not the GOTOs that get you.  It's the COME FROMs.'
  86.  
  87.  
  88. "if"
  89.  
  90. Note that KSmail scripts are limited to 10 labels maximum.  The label
  91. may contain up to 10 characters.
  92.  
  93.  
  94. "pattern"
  95.  
  96. Up to 9 patterns may be specified.  Patterns may be up to 12 characters
  97. in length.  Note that ALL PATTERNS ARE RESET TO NULL FOLLOWING A
  98. SUCCESSFUL 'IF' JUMP.  This follows the TASL and not Opus/Binkley logic.
  99.  
  100.  
  101. "session"
  102.  
  103. This should be the last statement in the script.  Control is returned to
  104. KSmail and a FTSC netmail session is attempted.
  105.  
  106.  
  107. "xmit"
  108.  
  109.  
  110.  
  111. Rather than rewrite the whole thing, I will direct your attention to the
  112. current Binkley docs.  Please note the differences above.
  113.  
  114.  
  115.  
  116. EXAMPLE:  Here is the script I use for dialing the OZ zonegate (1/3)
  117.           via PCP.  It is 00010003.TAM on the disk.  It works.
  118.  
  119.  
  120. baud 1200
  121. xmit ~~~ATZ|
  122. pattern 0 CONNECT
  123. xmit ~ATDT3417733|
  124. wait
  125.  
  126. xmit ~|~|~|
  127. xmit ~d1|
  128. :city
  129. pattern 0 CONNECT
  130. pattern 1 BUSY
  131. xmit ~~C D/ORPOR/12,PCP00000,ABCD0000|
  132. wait
  133.  
  134. if 1 city
  135. xmit |~I~|
  136. pattern 0 OK
  137. xmit ~ATZ|
  138. wait
  139.  
  140. :dial
  141. pattern 0 CONNECT
  142. pattern 1 BUSY
  143. pattern 2 NO CARRIER
  144. xmit ~ATDT2979145|
  145. wait 60
  146.  
  147. if 1 dial
  148. if 2 dial
  149. session
  150.