home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 550a.lha / NComm_v1.921 / Script.doc.pp / Script.doc
Encoding:
Text File  |  1991-09-08  |  17.7 KB  |  593 lines
  1. The NComm V1.92 scriptlanguage
  2. ==============================
  3.  
  4. A scriptfile is an ASCII textfile that consists of different commands,
  5. separated by  one or more  linefeeds.  Edit the  scriptfiles with your
  6. favourite  editor.  Only  one  command is  allowed per line, but blank
  7. lines are also OK. A line can consist of blanks before the command and
  8. between parameters.  Comments can be added by entering a semicolon.  A
  9. label is marked with a colon as its last character, e.g. "quit:".  The
  10. script  commands  are case independent,  but strings within quotes are
  11. not.
  12.  
  13. Scripts  are mainly used to automate logons, or to companion you while
  14. you  are  online.   Scripts  can also perform more advanced functions,
  15. like  grabbing  mail  and perhaps posting it on another board (or even
  16. printing it!).  You set the limits...
  17.  
  18. One example  script and  one  Host-Mode script have been included with
  19. the NComm package.  Take a look at them if you don't understand how to
  20. use the commands.
  21.  
  22. Important:   The  filenames  specified in a scriptfile are relative to
  23. the   current   directory,   NOT   the  default  upload  and  download
  24. directories!
  25.  
  26.  
  27. Summary of Script commands
  28. --------------------------
  29.  
  30.         ASCSEND
  31. Starts ASCII text send of the filename given. Example:
  32.  
  33. ASCSEND "df1:text/msg"
  34.  
  35. The  TIMEOUT command also concerns ASCSEND.  If ASCSEND is halted by a
  36. ^S  and  no  ^Q  has  been  received within the timelimit specified by
  37. TIMEOUT,  the  script  will  go on with the next command.  XON will be
  38. turned on before ASCSEND.
  39.  
  40. ----------------------------------------------------------------------
  41.  
  42.         BEEP
  43. Will  cause  an audible 'beep' of the terminal and / or will flash the
  44. screen  and / or will bring the screen to front, depending on what you
  45. have  configured  in  the  SCREEN  menu.   Nothing is sent through the
  46. serial port.
  47.  
  48. ----------------------------------------------------------------------
  49.  
  50.         BREAK
  51. Sends a break to the host machine. Equivalent to SEND "\l".
  52.  
  53. ----------------------------------------------------------------------
  54.  
  55.         CAPTURE
  56. Toggles ASCII capture on/off. Examples:
  57.  
  58. CAPTURE "filename"
  59. Will  open the capture file and turn on capture.  It will be opened in
  60. 'append mode' if the file exists...
  61.  
  62. CAPTURE SUS
  63. Will suspend capture.  Capture can be turned on again with the command
  64. CAPTURE ON
  65.  
  66. CAPTURE OFF
  67. Will  turn  capture off and close the file.  The file cannot be opened
  68. again with the CAPTURE ON command.
  69.  
  70. ----------------------------------------------------------------------
  71.  
  72.         CD
  73. Problems  occur  when  the "CD" command is used with the CLI function.
  74. The  "CD"  command  has  therefore  been  made a special function.  It
  75. simply  changes  the directory that is to be used for commands started
  76. with the "CLI" function.
  77.  
  78. Example:
  79.  
  80. CD "RAM:"       ;Will change the current working directory to 'RAM:'
  81.  
  82. ----------------------------------------------------------------------
  83.  
  84.         CHAIN
  85. Will start a new script.  The control will never return to the calling
  86. script.   This  is  useful  when  you need extremely long scripts that
  87. won't fit in memory.
  88.  
  89. Example:
  90.  
  91. CHAIN "NComm:ReadNews.script"
  92.  
  93. ----------------------------------------------------------------------
  94.  
  95.         CLI
  96. Will  execute  a program or a command.  The output from these programs
  97. and  commands  will  occur  in the NComm window.  This command will be
  98. relative to the directory you were standing in when you started NComm.
  99.  
  100. Please  note;  Current  Directory can not be set with the CLI command,
  101. probably  due  to  problems with the Amiga operating system.  The "CD"
  102. function must therefore be used for this purpose.
  103.  
  104. Examples:
  105.  
  106. CLI "dir dh0:comms"
  107. CLI "type ram:foo.bar"
  108. CLI "pkax ram:grabfile.arc"
  109.  
  110. ----------------------------------------------------------------------
  111.  
  112.         CLRSTACK
  113. This  command  clears  the  RETURN  stack,  i.e.   it  forgets  active
  114. subroutine  calls (gosubs).  The command is handy at error situations,
  115. when  you  wish to "jump out" of the program and start over again, for
  116. example in conjunction with TIMEOUT or WHEN commands.
  117.  
  118. ----------------------------------------------------------------------
  119.  
  120.         CONFIG
  121. Will read a new configuration file.  Example:
  122.  
  123. CONFIG "NComm:MBBS.config"
  124.  
  125. ----------------------------------------------------------------------
  126.  
  127.         CONVERSE
  128. Will wait for a prompt from the host machine and answer it.
  129.  
  130. Examples:
  131.  
  132. CONVERSE "Enter your name:" "Name\n"   ;Waits for 'Enter your name:'
  133. CONVERSE "enter your password:" "\p\n" ;Sends phonebook password + CR
  134. CONVERSE "Command:" "G\n"              ;Sends 'G' and newline
  135.  
  136. ----------------------------------------------------------------------
  137.  
  138.         DELAY
  139. The  script  program  will take a break.  The program will function as
  140. normal.
  141.  
  142. Examples:
  143.  
  144. DELAY 5                 ;Wait 5 seconds
  145. DELAY UNTIL 12:00       ;Wait until 12 o'clock.
  146.  
  147. ----------------------------------------------------------------------
  148.  
  149.         DIAL
  150. Will  dial  one  or  more  phonenumbers.  Can also dial entries in the
  151. phonebook.   If  you  choose  to  dial  phonenumbers,  use the command
  152. 'DIAL#'.   The  numbers must be placed within quotation marks.  If you
  153. choose to dial more than one number, the numbers can be separated by a
  154. comma.
  155.  
  156. Examples:
  157.  
  158. DIAL# "454143"
  159. DIAL# "380949", "493210", "454143"
  160.  
  161. Named  entries  in  the  phonebook  can  be  dialled by specifying the
  162. boardname within quotation marks.  You only have to specify the number
  163. of  letters  required  to  separate  the  board  from the others.  The
  164. name is not case sensitive.
  165.  
  166. Examples:
  167.  
  168. DIAL "AmigaBBS"
  169. DIAL "rode", "Mike's", "media"
  170. DIAL "Rodeløkka (M)BBS"
  171.  
  172. ----------------------------------------------------------------------
  173.  
  174.         DLWHEN
  175. Deletes  the last defined WHEN command.  Repeated usage will succesive
  176. delete the "previous" WHEN command.  See:  WHEN.
  177.  
  178. ----------------------------------------------------------------------
  179.  
  180.         DOWNLOAD
  181. Will download a file from the host machine.  The protocol specified in
  182. the  TRANSFER  menu will be used as long as nothing else is specified.
  183. If you want to specify another protocol, enter a comma and a letter.
  184. The filename is "dummy" when using Zmodem.
  185.  
  186. X == Xmodem, Y == Ymodem, B == Ymodem-B, G == Ymodem-G, Z == Zmodem,
  187. K == Kermit, E == External XPR (as defines in config file)
  188.  
  189. Examples:
  190.  
  191. DOWNLOAD "df1:junk"             ;Will use the default protocol
  192. DOWNLOAD "df0:trash",X          ;Will always use Xmodem
  193.  
  194. ----------------------------------------------------------------------
  195.  
  196.         DTENTHS
  197. This  is  a much more precise delay command, but only use this command
  198. when  this  accuracy is needed, since it will lock up the system.  The
  199. DTENTHS parameter is the number of tenth seconds to wait.
  200.  
  201. Examples:
  202.  
  203. DTENTHS 2       ;Wait 0.2 seconds
  204. DTENTHS 16      ;Wait 1.6 seconds
  205.  
  206. ----------------------------------------------------------------------
  207.  
  208.         DUMP
  209. Command  for debugging a script.  It dumps a list of all variables and
  210. what they contain, on screen.
  211.  
  212. ----------------------------------------------------------------------
  213.  
  214.         DWHENS
  215. Will disable all previously used WHEN commands. See: WHEN.
  216.  
  217. ----------------------------------------------------------------------
  218.  
  219.         ECHO
  220. This  command defines if characters read by the INPUT command shall be
  221. echoed.   ECHO ON should be used when input is read from a user in the
  222. other  end. ECHO OFF should be used when input is read from a Bulletin
  223. Board  System, or when the user is not supposed to see what he writes.
  224.  
  225. ECHO  should  be  turned  ON  if the functions ASCSEND and MSGSEND are
  226. supposed  to  echo text locally.  The output from the CLI command will
  227. be sent to the serial port if ECHO has been turned on.
  228.  
  229. ----------------------------------------------------------------------
  230.  
  231.         END
  232. Will  stop  the  execution  of the script.  This command is especially
  233. useful in front of subroutines.
  234.  
  235. Example:
  236.  
  237. WHEN "Read>" GOSUB next
  238. WAIT "No more unread."
  239. END
  240.  
  241. Next: SEND "\n"
  242.       MESSAGE "(Skipping to next unread)\n"
  243.       RETURN
  244.  
  245. ----------------------------------------------------------------------
  246.  
  247.         GOSUB
  248. Will  call  a  named subroutine.  Useful when you want to use the same
  249. command  many  times  within  a  script, or in connection with WHEN or
  250. TIMEOUT.   The  subroutine  is ended with 'RETURN', and the control is
  251. passed to the line following the GOSUB afterwards.
  252.  
  253. Example:
  254.  
  255. GOSUB myRoutine
  256. END
  257.  
  258. MyRoutine: MESSAGE "Fooo\n"
  259.            BEEP
  260.            RETURN
  261.  
  262. ----------------------------------------------------------------------
  263.  
  264.         GOTO
  265. Ever heard of this? Will jump to a named place in the script.
  266.  
  267. Example:
  268.  
  269. GOTO quit
  270. ...
  271. quit: CAPTURE OFF
  272.       HANGUP
  273.       END
  274.  
  275. ----------------------------------------------------------------------
  276.  
  277.         HANGUP
  278. Will send the hangup string to the modem.
  279.  
  280. ----------------------------------------------------------------------
  281.  
  282.         IF <expression> THEN <operation>
  283.  
  284. It  should be obvious what this command does.  A valid expression can
  285. be either a comparison of two strings or a check for a file.  The
  286. exclamation mark ('!') works as a boolean 'NOT' operator.
  287.  
  288. String comparisons are performed with the "==" operator, which tests for
  289. case independent equality, i.e.  "foo" == "FOO" is TRUE; 
  290. !"bar" == "yum" is TRUE (because of the '!' (NOT) operator)
  291.  
  292. EXISTS  checks  if a file exists.  The following are examples on valid
  293. IF commands:
  294.  
  295.         IF $password == "abcdef" THEN MESSAGE "Access granted\n"
  296.         IF !$password == "xyz" THEN GOTO KillUser
  297.         IF EXISTS "NComm:host.config" THEN CONFIG "NComm:host.config"
  298.         IF !EXISTS $file THEN SEND "File not found!\n"
  299.  
  300. The whole command must be placed on a single line, including the 'THEN'
  301. part...
  302.  
  303. ----------------------------------------------------------------------
  304.  
  305.         INPUT
  306. This  command  reads  input  from  the  serial port and places it in a
  307. variable  until  a  specific string has been received.  ^H (backspace)
  308. deletes  the  last  character,  ^U  deletes  the  whole  string.   The
  309. searchstring  will  not  be added to the variable.  Control characters
  310. will not be added.  Example:
  311.  
  312.         SEND "Enter your first name: "
  313.         INPUT $name "\r" ;Input will be placed in the variable 'name'
  314.                          ;until carriage return is received.
  315.  
  316. The  TIMEOUT  command  also  concerns  the INPUT command.  The timeout
  317. defines  how long INPUT shall wait for the terminating string ("\r" in
  318. the mentioned example).  Example:
  319.  
  320.         TIMEOUT 180 Goto BiBi
  321.         SEND "Enter a command: "
  322.         INPUT $cmd "\r"
  323.         ...
  324.  
  325. BiBi:   SEND "\n\nLooks like you fell asleep!!  Bye-bye!\n"
  326.         HANGUP
  327.         END
  328.  
  329. It is also possible to read a single character without having to
  330. wait for ENTER or other strings:
  331.  
  332.         INPUT $char ""
  333.  
  334. INPUT  can  both  be  used for reading input from a user in connection
  335. with  "Host  Mode",  or  grabbing pieces of text from a Bulletin Board
  336. System;
  337.  
  338.         WAIT "Bulletins have been updated: "
  339.         INPUT $bull " "
  340.  
  341. ----------------------------------------------------------------------
  342.  
  343.         LOADKEYS
  344. Will read a new macrokeys file.
  345.  
  346. Example:
  347.  
  348. LOADKEYS "NComm:dec.Keys"
  349.  
  350. ----------------------------------------------------------------------
  351.  
  352.         LOADPHONE
  353. Will read a new phonebook file.
  354.  
  355. Example:
  356.  
  357. LOADPHONE "NComm:dialdir.phone"
  358.  
  359. ----------------------------------------------------------------------
  360.  
  361.         MESSAGE
  362. Will  write  a  message  on  the  screen.  Nothing is sent through the
  363. serial port.
  364.  
  365. Example:
  366.  
  367. MESSAGE "\fReading mail...\n"
  368. MESSAGE "Storing mail in file \"DF1:Mail.txt\"\n"
  369.  
  370. ----------------------------------------------------------------------
  371.  
  372.         MSGSEND
  373. Same  as the "message send" function in the TRANSFER menu, will upload
  374. a message.
  375.  
  376. Example:
  377.  
  378. MSGSEND "DF1:tekst/msg"
  379.  
  380. ----------------------------------------------------------------------
  381.  
  382.         PRINTER
  383. Turns the printer ON or OFF.
  384.  
  385. Example:
  386.  
  387. PRINTER ON      ;Will turn on the printer
  388. PRINTER OFF     ;Will turn off the printer
  389.  
  390. ----------------------------------------------------------------------
  391.  
  392.         QUIT
  393. Exits NComm.
  394.  
  395. ----------------------------------------------------------------------
  396.         REPEAT<->UNTIL <expression> ...
  397. This  command  performs what is situated between REPEAT and UNTIL.  If
  398. the  expression  is  FALSE/TRUE,  the procedure will be repeated.  See
  399. "IF...THEN" for a discussion of valid expressions. The command has the
  400. same restrictions as WHILE/ENDWHILE.
  401.  
  402. Example:
  403.  
  404. REPEAT
  405.         SEND "Enter command: "
  406.         INPUT $cmd "\r"
  407.         GOSUB DoCommand
  408. UNTIL $cmd == "quit"
  409.  
  410.  
  411. ----------------------------------------------------------------------
  412.  
  413.         REQUEST
  414. This  function  is  used  when  the  scriptfile  is  run without human
  415. presence.   It  will  then  be  unpreferable  that  AmigaDOS puts up a
  416. requester  if  problems  occur (disk full, read / write error etc.) By
  417. turning request OFF, this is disabled.
  418.  
  419. Example:
  420.  
  421. REQUEST OFF     ;Turns requesters off
  422. REQUEST ON      ;Will turn the requesters back on again
  423.  
  424. ----------------------------------------------------------------------
  425.  
  426.         RETURN
  427. Returns from a subroutine. See GOSUB.
  428.  
  429. ----------------------------------------------------------------------
  430.  
  431.         SEND
  432. Sends a string to the host machine.
  433.  
  434. Examples:
  435.  
  436. SEND "\n"       ;Linefeed
  437. SEND "Read\n"   ;'Read' plus a CR
  438. SEND "\m1^z"    ;Macro #1 plus a 'Control-Z'
  439. SEND "\p\n"     ;The password stored in the phonebook plus a CR
  440.  
  441. ----------------------------------------------------------------------
  442.  
  443.         SET
  444. This  command  is  used  for assigning values to variables.  Variables
  445. have  name  in  the form $name where 'name' starts with a letter.  The
  446. value  must be of type string, either a literal (with quotation marks)
  447. or another variable.
  448.  
  449. Examples:
  450.  
  451.         SET $name = "Daniel"
  452.         SEND $name
  453.  
  454.         SET $filename = "RAM:foo"
  455.         CAPTURE $filename
  456.  
  457.         SET $UserName = $name
  458.  
  459. Variables  can  be  used  everywhere  where  strings  are expected.  A
  460. pre-defined  variable  $date  contains the current date and time.  The
  461. variable  $ncomm  contains  the  current  version  number.  The variable
  462. $baud contains the current baud rate. It is also possible to concatenate
  463. several variables and/or literals;
  464.  
  465.         SEND $name"\n"
  466.         SET $directory = "NComm:files/"
  467.         INPUT $filename "\r"
  468.         UPLOAD $directory$filename
  469.  
  470. It is not valid referring to variables having no value assigned.
  471.  
  472. ----------------------------------------------------------------------
  473.  
  474.         TIMEOUT
  475. This  command lets you configure how long NComm should wait in a WAIT,
  476. CONVERSE  or INPUT command.  Default timeout is 'forever', but this is
  477. not  preferable if the script is running without human assistance.  If
  478. the  host machine does not answer, it is reasonable to believe that it
  479. has  hung,  and a scriptfile should then automatically disconnect from
  480. the system.  The TIMEOUT command can be used in many ways.
  481.  
  482. Examples:
  483.  
  484. TIMEOUT 10
  485. Means  that  NComm shall wait a maximum of 10 seconds.  If no text has
  486. been  received  within  the  timelimit, NComm will go on with the next
  487. command.
  488.  
  489. TIMEOUT 10 SEND "\n"
  490. Specifies  that NComm is to wait a maximum of 10 seconds for each WAIT
  491. or  CONVERSE  command.   If  the  specified text has not been received
  492. within  10 seconds, NComm will send a linefeed to the host machine and
  493. will  continue  waiting  for  the  text.   NComm will continue sending
  494. linefeeds every 10th second until the host machine has answered.
  495.  
  496. TIMEOUT 0
  497. NComm is to go back to the default mode, i.e. wait forever.
  498.  
  499. Example of typical usage:
  500.  
  501. TIMEOUT 30 GOTO quit
  502. CONVERSE "Enter your name:" "Daniel Bloch\n"
  503. CONVERSE "Enter your password:" "gruff\n"
  504. CONVERSE "Command:" "GRAB\n"
  505. ...
  506. ...
  507. END
  508.  
  509. quit: MESSAGE "\n\nThe board has hung, call the SysOp!!!\n"
  510.       BEEP
  511.       HANGUP ;Hang up so that we won't get a shock when
  512.       END    ;the next phonebill arrives!
  513.  
  514. ----------------------------------------------------------------------
  515.  
  516.         UPLOAD
  517. Uploads  a  file to the host machine.  See the 'DOWNLOAD' function for
  518. the correct syntax.
  519.  
  520. ----------------------------------------------------------------------
  521.  
  522.         WAIT
  523. Waits  for  a  special  text to be received.  Will wait forever if the
  524. TIMEOUT command has not been used.
  525.  
  526. Examples:
  527.  
  528. WAIT ""         ;Wait for 'anything'
  529. WAIT "\n"       ;Wait for a linefeed
  530. WAIT "Command:" ;Wait for 'Command:'
  531.  
  532. ----------------------------------------------------------------------
  533.  
  534.         WHILE <expression> DO ... ENDWHILE
  535. This  function  performs what is situated within DO and ENDWHILE until
  536. the expression is TRUE/FALSE.
  537.  
  538. Example:
  539.  
  540. SET $cmd = ""
  541. WHILE !$cmd == "quit" DO
  542.         SEND "Enter command: "
  543.         INPUT $cmd "\r"
  544.         GOSUB DoCommand
  545. ENDWHILE
  546.  
  547. It  is  not  valid  jumping out of a WHILE/ENDWHILE loop using GOTO or
  548. RETURN.   It  is  still  possible  to exit the loop using GOTO and the
  549. command   CLRSTACK. 
  550.  
  551. ----------------------------------------------------------------------
  552.  
  553.         WHEN
  554. Defines what to do when a special text is received.
  555.  
  556. Typical example:
  557.  
  558. WHEN "--more--" SEND " "
  559.  
  560. This  command  will  make  NComm  send  a  'blank'  line every time it
  561. receives the 'more' prompt from the host machine.  This is independent
  562. of  where  in the script  you reside.  It is possible to specify up to
  563. ten such textstrings.
  564.  
  565. Example:
  566.  
  567. WHEN "--more--" SEND " "
  568. WHEN "NO CARRIER" END
  569. WHEN "Sysop is coming online!" GOSUB ShutUp
  570. WHEN "No more unread" GOTO Quit
  571.  
  572. Loop: CONVERSE "Command:" "\n"
  573.       GOTO loop
  574.  
  575. Quit: SEND "G;Y\n"
  576.       END
  577.  
  578. ShutUp: SEND "I'm not at home! You are chatting with a scriptfile!\n"
  579.         SEND "Send BIBI at the speed of light!!!\n\n"
  580.         RETURN
  581.  
  582. ----------------------------------------------------------------------
  583.  
  584.         WRITE
  585. This command writes a textstring to a file. If the file exists, the
  586. string will be appended to the file. Example:
  587.  
  588.         WRITE "NComm:host/log" "Logged in: "$username"\n"
  589.               |                |
  590.               Name of file     String
  591.  
  592. ----------------------------------------------------------------------
  593.