home *** CD-ROM | disk | FTP | other *** search
/ APDL Public Domain 1 / APDL_PD1A.iso / am_radio / comlink350 / Manual / Script_Man / part4 < prev    next >
Encoding:
Text File  |  1991-12-15  |  5.5 KB  |  160 lines
  1.  
  2. START:<time>
  3. ------------
  4.  
  5. Purpose: Waits until a given time before continuing with the script.
  6.  
  7. Use: Normally placed at the beginning of the program. The 24hr clock must be
  8. used. A terminal program must not be running when a script starts, otherwise
  9. characters may be stolen from the serial port and the operation of ComLink
  10. will be upset.
  11.  
  12. A colon must be used to separate the hours and minutes.
  13.  
  14. Examples:  START:23:00
  15.  
  16. Related commands: None
  17.  
  18.  
  19. FINISH:<comment>
  20. -------
  21.  
  22. Purpose: Stops a script.
  23.  
  24. Use: Can be used at any point in the script, need not be used at the end.
  25. Normally only required before the ONERROR: command (if used), to prevent the
  26. commands after the ONERROR: line from being executed. The text <comment> is
  27. ignored by ComLink.
  28.  
  29. Examples: FINISH:****This is where the script ends!****
  30.  
  31. Related commands: None
  32.  
  33. SCANLIST:<string1>:<string2>.....
  34. ---------------------------------
  35.  
  36. Purpose: Examines a message list from the BBS or PMS, and looks for
  37. <string1>,<string2> etc. in each line. If any of the strings are found then
  38. that message will subsequently be read if the READ: command is used.
  39.  
  40. Use: Use this command after initiating a "List" from the TNC or BBS by using
  41. the command TYPE:L (or equivalent), where sending "L" causes the BBS to list
  42. the messages.
  43.  
  44. The <string> is case sensitive, ie if ARCHI is the string, then a match will
  45. be found in MARCHING, but not for Archimedes. Up to 10 <string>s may be
  46. specified, each must not be longer than 10 characters.
  47.  
  48. Listed messages seem to have a standard format, this has been assumed by the
  49. ComLink program. The message list must be in the form:-
  50.  
  51. NNNNN.......................
  52.  
  53. Where .... indicates any text up to 100 charecters long, and NNNNN is a
  54. message number which may contain spaces.
  55.  
  56. The command SAVELIST: near the start of the Script program will force
  57. ComLink to save the list in a default or specified directory, with filename
  58. "List".
  59.  
  60. The last delay command before the SCANLIST: command, must allow sufficient
  61. time for each listed line to be read, set DELAY: to at least 120 seconds.
  62.  
  63. The SCANLIST: command finishes having seen your prompt, as defined in the
  64. MYPROMPT: command so a WAITFOR: command MUST NOT be used after the SCANLIST:
  65. command. See example 3 below.
  66.  
  67. Example: (for a PMS/BBS):  TYPE:L
  68.                            SCANLIST:G7ALN
  69.                            READ:
  70.  
  71. Related commands: SAVELIST: READ: TYPE: DELAY:
  72.  
  73.  
  74. READ:<text>
  75. --------------
  76.  
  77. Purpose: If any of the strings were found during a SCANLIST: then those
  78. messages will subsequently be read if the READ: command is used. The text is
  79. optional but if used it defines the character sequence that marks the start
  80. of the message.
  81.  
  82. Use: Used at some point in the script program after a SCANLIST: command.
  83.  
  84. Read messages are saved in directory "Download" within the !ComLink
  85. apllication directory or within !ComMail. They are saved as text type files
  86. with the same filename as the <string> that was found during the
  87. previous SCANLIST: and/or FILESCAN: command.
  88.  
  89. On some BBSs, the message can start with a character sequence that looks
  90. like a prompt! To get around this you can put <text> after the read command
  91. which will identify a message start. eg
  92.  
  93. READ:>[13]
  94.  
  95. The READ: command ends when a prompt has been seen but no more messages are
  96. to be read.
  97.  
  98. ****IMPORTANT**** The READ: command MUST be preceded by the command
  99. FILESCAN: and/or SCANLIST: to determine which messages are to be read.
  100. The last delay command before the READ: command, must allow sufficient time
  101. for a complete message to be read, set DELAY: to at least 600seconds
  102. (10 minutes) if communicating with a BBS.
  103.  
  104. Examples:   TYPE:L
  105.             SCANLIST:ARCHIM:AMSAT:G7ALN
  106.             READ:
  107.  
  108. Related commands: FILESCAN: SCANLIST: MYPROMPT: TYPE: DELAY:
  109.  
  110.  
  111. UPLOAD:<comment>
  112. ----------------
  113.  
  114. Purpose: Sends up to 10 files in the upload directory to the serial port.
  115.  
  116. Use: Normally this command would be used as soon as a link to the BBS has
  117. been made. All files in the upload directory within will be sent to the
  118. serial port providing the filename does not start with a +. No characters
  119. are added to or removed from the files, but all line feeds are converted to
  120. carraige returns.
  121.  
  122. You can specify the upload directory in your script using DIRUP: but if you
  123. don't use this command ComLink will look in the For_Upload directory within
  124. the !ComLink application directory.
  125.  
  126. The command ends having seen your prompt, the PMS/BBS is therefore ready to
  127. receive the next command.
  128.  
  129. When each file has been sent and the prompt received, the uploaded file will
  130. be renamed with a "+" added to the begining of the filename. Filenames
  131. starting with a "+" will not be sent, this prevents files being sent twice
  132. accidentally.
  133.  
  134. The files must be put in the directory by yourself. Text files must contain
  135. all information for the BBS to save/send on the message. The message can be
  136. created with !Edit and typically would contain:-
  137.  
  138. SP G7ALN @ GB7IMB
  139. Re. ComLink...
  140. Hi Alan, your !ComLink program is ......
  141. ........
  142.  
  143. 73 de Me
  144. /ex 
  145.  
  146. IMPORTANT: WHEN CREATING THE TEXT FILE, "RETURN" MUST HAVE BEEN PRESSED
  147. AFTER THE /ex. You can check this has been done, by using the mouse/caret in
  148. !Edit. You should be able to put the caret on the line below the /ex.
  149.  
  150. If the APPEND: command is used at the start of the script, then that can
  151. contain the /ex to end the message.
  152.  
  153. Only one message per file should be used, since only when the whole file has
  154. been sent does ComLink start looking for your prompt (as set by the
  155. MYPROMPT: command)
  156.  
  157. Example:  UPLOAD: Any old text here, program ignores it!
  158.  
  159. Related commands: MYPROMPT: DELAY: APPEND:
  160.