The Datafile PD-CD 5

home *** CD-ROM | disk | FTP | other *** search

/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / c / comlink / Manual / Script_Man / 3_Commands < prev

Wrap

Text File | 1993-11-22 | 33.6 KB | 939 lines

Script Command Descriptions (Alphabetical order) ================================================ ---------------------------------------------------------------------------- APPEND:<text> ---------------------------------------------------------------------------- Purpose: Adds some text to the end of an upload file. Use: The <text> will be sent at the end of each upload file. The upload file must NOT contain the end of message code, eg /ex or CTRL/Z, these MUST be put at the end of the APPEND: command. Note the /ex must be sent as a separate line, hence the carriage return codes [13] in the example below. System variables may be added to date the file etc, they must be put in {} brackets as shown in the example. More than one APPEND: command can be used, the text strings will all be "added" to form one string. This gets around the limitation that the script command lines must be less than 100 characters long. The total length of the appended string must not be more than 255 characters after system variables have been expanded. Examples: APPEND:73 de Alan (G7ALN @ GB7IMB)[13] APPEND: *** Sent on {sys$date} {sys$year} at {sys$time} ***[13]/ex[13] Related commands: UPLOAD: ---------------------------------------------------------------------------- BREAK:<comment> ---------------------------------------------------------------------------- Purpose: Sends a 50 millisecond "break" to the TNC. Use: Use this command to force the TNC out of transparent mode. Examples: BREAK: Related commands: None ---------------------------------------------------------------------------- CHAIN:<filepath> ---------------------------------------------------------------------------- Purpose: Runs another script Use: The filepath must specify a script to be run. The current script will stop and the newly specified script will be run. Example: CHAIN:{ComMail$Dir}.Scripts.MyScript Related commands: None ---------------------------------------------------------------------------- DAYTIME:<text> ---------------------------------------------------------------------------- Purpose: Sets the TNC clock. Use: The <text> must be either 10 or 12. The number sets the length of the time command string to be sent to the TNC. If it is 10 then the string sent will be of the form:- DA yymmddhhmm Where yy=year, mm=month, dd=day, hh=hour and mm=minutes If the number is 12 then the string sent to the TNC will also include seconds:- DA yymmddhhmmss Use the number that is appropriate to you TNC. Of course the TNC must be in command mode to accept the time, so position the command appropriately! Example: DAYTIME:10 Related commands: None ---------------------------------------------------------------------------- DELAY:<delay> ---------------------------------------------------------------------------- Purpose: Sets the time-out delay in seconds. Use: Commands TYPE:, WAITFOR:, READ:, UPLOAD: and SCANLIST: will cause a time-out to be generated if certain actions have not happened within a period of <delay> seconds. In the case of the TYPE command, all characters in the specified string must be output within <delay> seconds, the "timer" is started when the command execution has begun. The WAITFOR: command when executing, similarly starts a timer, after <delay> seconds a time-out will occur if the specified string has not been read in. The SCANLIST: and READ: commands start and stop the timer several times, the worst situation that must be allowed for, is during the reading of a message, where the whole message must have been read in, saved and a new "prompt" received. (The prompt is setup using the command MYPROMPT:) UPLOAD: sets the timer going when it is trying to send files, the timer starts when the file is opened and stops when the last character in the file has been sent. The timer is then reset and ComLink waits again for the prompt. A time-out will cause the program to stop if no ONERROR: command is used, otherwise execution of the script will continue with the instruction after the ONERROR: command. Only one ONERROR: jump can be performed, jumps will only be performed in a forwards direction. ie a jump back to any previous line will not be allowed and the script program will end. The delay command can be used many times within a script, indeed, it is sensible to do so. If you are talking only to your TNC, then a long delay is not required, since the response will be fast. Typically set DELAY: to:- 20 when communicating just with the TNC. 200 when linked to a BBS but not reading messages. 900 when linked to a BBS and reading messages. (Yes, it did take nearly 15 minutes one day to read a message!) Example: DELAY:600 Related commands: TYPE: READ: WAITFOR: ONERROR: SCANLIST: ---------------------------------------------------------------------------- DIRDOWN:<text> ---------------------------------------------------------------------------- Purpose: Sets the download directory for received text files. Use: The command allows the download directory to be specified. If a script is run and the commands SCANLIST: or READ: used, then any text received will be saved in the specified directory. If the command is not used in the script then the default directory used will be Download within the ComLink application. The directory specified must exist. System variables may be used in <> or {} brackets. If this command is not used in a script, downloaded files will be placed in the default directory "Download" in the !ComLink application. The command may be used more then once if files are to be saved in several directories, in this case, use it before each SCANLIST: or READ: command. See the section on ComMail near the end of the "2_Scripts" manual. Example: SAVELIST: DIRDOWN:RAM:$.Lists SCANLIST:ARCHIM:G7ALN DIRDOWN:adfs::BBS_files.$.ReadFiles READ: Related commands: SCANLIST: READ: DIRUP: SAVELIST: ---------------------------------------------------------------------------- DIRUP:<text> ---------------------------------------------------------------------------- Purpose: Sets the upload directory for text files. Use: The command allows the upload directory to be specified. If a script is run and the command UPLOAD: used, then any files in the specified directory will be sent to the serial port. If the command is not used in the script then the default directory used will be For_Upload within the ComLink application. The directory specified must exist. System variables may be used in <> or {} brackets. If this command is not used in a script, uploaded files will be taken from the default directory "For_Upload" in the !ComLink application. The command may be used more then once if files from several directories are to be sent, in this case, use it before each UPLOAD: command. See the section on ComMail near the end of this manual. Example: DIRUP:RAM:$.ToSend Related commands: UPLOAD: ---------------------------------------------------------------------------- FILESCAN:<text> ---------------------------------------------------------------------------- Purpose: Scans a specified file for marked message numbers, subsequently these may be read/killed using the READ:/KILL: commands. Also sets a system variable "OldList$Num". Use: Allows an old "List" file to be scanned for numbers to be read or killed. The command causes the file to be examined, if a "+" is present after a message number, then the number before it (up to 6 digits) is assumed to be a message number. That message number will be read later if the READ: command is used, the messages that are marked will be saved in the download directory in a file called "-General-". If the character after the message number is made a "-" then that message will be "killed" if the KILL: command is subsequently used. The command also sets a system variable "OldList$Num" which can be used in the TYPE: command. The number taken is the largest one seen in the file. This is particularly useful for BBSs that need you to specify the last listed message. Use:- TYPE:L {OldList$Num} The command may be used on its own before READ:/KILL: commands, or before a SCANLIST: command. If used before a SCANLIST:, both sets of messages will be read, ie those marked in the FILESCAN: command and those meeting the criteria specified in the SCANLIST:. Only messages which have been marked with a "-" will be killed when KILL: is invoked. The <text> in the SCANLIST command should be a valid filepath. An efficient way to use the command is to point to a previously downloaded list from a BBS/PMS, in which you have marked the messages to be read. The message list can be marked using !Edit, simply put a + after the message number. Eg. in the following example list, message 23456 is marked:- MsgNo TS Size To At From Date Subject 23456+ B$ 443 ARCHIM GB7BNM G6DEN 17-Mar ComLink 46813 BN 926 SATTV GBR G8XZD 17-Mar Sendz LNB\Mod for Telecom Band 46802- B$ 807 ALL GBR G7ALN 17-Mar What is VT220 please. Any text after the + or - character in a line will be ignored, so you don't need to remove anything from a BBS list. Of course you can always create a list of messages to be read yourself. Eg. the file could contain:- 1245+ 23+ 34- Note that spaces are ignored. Remember that ComLink can save a message list with filename "List" in the download directory. so you can mark the messages you want to be read the next time the relevant ComLink script is run. Once ComLink has performed a FILESCAN: on the specified file, the file is re-named with a + at the beginning, this ensures that if ComLink is run again, the same messages will not be read! Example: FILESCAN:adfs::Disc_1.$.!ComLink.Download.List System variables may be used as part of the file path and may be enclosed in <> or {} brackets. eg FILESCAN:<ComLink$Dir>.Download.List ---------------------------------------------------------------------------- FINISH:<comment> ---------------------------------------------------------------------------- Purpose: Stops a script. Use: Can be used at any point in the script, need not be used at the end. Normally only required before the ONERROR: command (if used), to prevent the commands after the ONERROR: line from being executed. The text <comment> is ignored by ComLink. Examples: FINISH:****This is where the script ends!**** Related commands: None ---------------------------------------------------------------------------- FLUSH:<text> ---------------------------------------------------------------------------- Purpose: Allows the serial input buffer to be flushed. Use: This command is handy if you are not interested in what is coming from your TNC. When ON the command causes the input buffer to be repeatedly flushed during the execution of the script, this ensures the input buffer in the Archimedes does not become full and stop the TNC operating. In general this command is only useful when ComLink is conversing directly with the TNC, ie when no connection has been made. The command has a built in side effect, a delay is introduced before each line of text is sent to the TNC. I found that this was necessary as it is possible to "overload" my TNC with commands, and it just "freezes" on me. A typical use would be when you are setting lots of TNC options and don't want to wait for the "cmd:" prompt after every one. The text must be "ON" or "OFF". You must be careful with this command and remember to switch it OFF before the script needs input again. Example: FLUSH:ON TYPE:CONMODE CONV .... .... TYPE:ECHO OFF FLUSH:OFF Related commands: None ---------------------------------------------------------------------------- ICON:<colour> ---------------------------------------------------------------------------- Purpose: Changes the background colour of the ComLink icon on the bar. Use: Lets the user know when a certain part of the script has been reached. Valid colours are :- BLUE,YELLOW,GREEN,RED,WHITE,CREAM,AMBER The colours must be specified in upper case, an unrecognised or unspecified colour will set the icon colour to grey. The colour can be abbreviated to 3 letters. Examples: ICON:AMBER ICON:YEL Related commands: None ---------------------------------------------------------------------------- IGNORE:<text>|<num> ---------------------------------------------------------------------------- Purpose: Makes SCANLIST: ignore lines containing <text> at position <num>. Use: This comand can be used so that a SCANLIST: will ignore lines that have the specified text at a certain character position in a line. Typically this would be used to prevent your own uploaded messages being read back during the READ: command. Assume the following snippet of a script is executed:- ... IGNORE:G7ALN|31 TYPE:L SCANLIST:G7ALN:ARCHIM READ: ... If the list returned by the BBS is say:- MsgNo TS Size To At From Date Subject 60008 B$ 1221 G7ALN GBR G4NZK 07-Mar New !ComLink is brill! 60007 B$ 1245 ARCHIM GBR G7ALN 07-Mar !ComLink 4.51 out now! 60006 B$ 1245 ALL GBR G1IVG 07-Mar G7ALN 1 2 3 1234567890123456789012345678901234567890 <-- character positions There is a G7ALN starting at character position 31 in message 60007 so it will not be read by the READ command, despite the fact that the message otherwise meets the ARCHIM and G7ALN search strings in the SCANLIST command. Examples: IGNORE:ALL|17 IGNORE:EU|24 Related commands: SCANLIST: ---------------------------------------------------------------------------- KILL:<text> ---------------------------------------------------------------------------- Purpose: Kills messages. Use: Messages in a list can be marked with a "-" and a FILESCAN: performed. If a KILL: command is used later, then the marked messages will be deleted. The <text> must be the BBS or PMS kill command, for a PMS it is usually "Kill" but for a BBS "K". Note: On a BBS it is best to kill "read" messages to you, using the "KM" BBS command. eg. TYPE:KM WAITFOR:Alan >[13] *** IMPORTANT *** If both FILESCAN: and SCANLIST: commands are used in a script, the FILESCAN: must come first. Examples: KILL:Kill KILL:K Related commands: FILESCAN: ---------------------------------------------------------------------------- LOOPIF:<text1> ---------------------------------------------------------------------------- See command TRYAFTER:<number> ---------------------------------------------------------------------------- MONITOR:<text> ---------------------------------------------------------------------------- Purpose: Allows incoming text to be displayed in the bottom of the status window. Use: The <text> can be ON or OFF. When ON, the status window will be updated whenever new text arrives at the serial port. When OFF, the incoming text is not displayed or updated. The command can be used at any point in the program, typically during script program testing it would be used at the beginning of the script. The ON/OFF text must be in upper case. The status window is not popped up automatically by this command, but may be either manually popped up using the ComLink menu, or, may be popped up using the REPORT: command. Example: MONITOR:ON Related commands: REPORT: ---------------------------------------------------------------------------- MORE:<query>|<response> ---------------------------------------------------------------------------- Purpose: To automatically send a response to the BBS during a SCANLIST: Use: This command must precede a SCANLIST: command, it specifies the text that if seen, should result in a repsonse being sent to the BBS. eg the prompt may be:- More Alan Y/N?> So the BBS would expect a "Y" response to continue the list. This facility is only active during a SCANLIST: and allows list commands available from some BBSs which result in 'More....' prompts. eg LD 123, to list down to message number 123. When the text in the MORE command is seen in the list a response will automatically be sent to the BBS. The use of an LD type BBS command is useful if normal scan of a list has failed, due to a link failure and the BBS has reset the "last listed number". Both the query string that would be recieved from the BBS and the response sent back to the BBS can be defined, a | character is used to separate these. A carraige return is automatically added to the end of the response string by ComLink. Examples: To send a "Y" response followed by a carraige return use: MORE:More Alan Y/N?>|Y To send just a carriage return use: MORE:More Alan Y/N?>| Related commands: SCANLIST: ---------------------------------------------------------------------------- MYPROMPT:<string>|<length> ---------------------------------------------------------------------------- Purpose: Tells ComLink what character sequence to look for to recognise a command prompt from the PMS/BBS and optionally the length. Use: Normally used near the beginning of a program. When a READ: command is used, ComLink requests messages one at a time. ComLink needs to know how to recognise the end of a message so this command tells it what to look for. The complete prompt does not need to be specified, just the last few characters, in practice just > could be specified, but this character could occur in a message, so it is best to specify as many characters as you can. Most BBSs send the time as part of the prompt.... don't try to include this as it changes, to cater for this wild card characters # are allowed. Control codes can be incorporated but [13] (carraige return) can ONLY be used at the end of the line. If your prompt is short, then the chance of it occurring in read messages is significant. To reduce the probability of it being seen in a message you can specify the total length of your prompt from the start of the prompt line to the end, INCLUDING the carraige return (if a part of your prompt!). The length can be added after your prompt string preceded by the | character (ASCII 124). eg if your prompt is just:- >[13] where [13] represents "Carraige return":- then use:- MYPROMPT:>[13]|2 Note that the characters specified do not have to be the whole prompt, just the last bit, but the length must be that of the whole prompt. eg. for:- GB7SUT - >[13] you can use MYPROMPT:- >[13]|11 With a PMS a carraige return is NOT added to the end of the prompt so the command would be:- MYPROMPT:cmd:|4 Examples: MYPROMPT:Alan > MYPROMPT:##:## Alan >[13] MYPROMPT:>[13]|2 Related commands: READ: ---------------------------------------------------------------------------- ONERROR:<comment> ---------------------------------------------------------------------------- Purpose: Allows a single jump to be made in the script. Use: If a time-out occurs in the program when it is waiting for a certain character sequence or cannot output any more characters, then when the time previously specified in the DELAY: command has elapsed, a time-out will occur. If no ONERROR: command has been used and a time-out occurs then the script will finish. If an ONERROR: command has been used, execution of the next command after the ONERROR will occur, ie a jump will be made. Use of this command can allow a script to exit cleanly, if for instance the link to the BBS fails, the ONERROR: command can then be followed by script to disconnect and put the TNC in a defined state. The commands than can cause a time-out error are:- TYPE: if the serial buffer remains full and does not empty. UPLOAD: if the serial buffer remains full and does not empty. WAITFOR: if the specified string is not received. SCANLIST: if any line takes longer than the delay set. READ: if it takes longer than <delay> seconds to read a whole message. Only one ONERROR: command can be used in each script. If more than one is present, only the last one will be recognised. If there is not a FINISH: command before the ONERROR: command then execution of the script with no time-out occurring will continue on past it as though it were not there. Examples: ONERROR: The script will jump to here if a time-out occurs Related commands: TYPE: WAITFOR: SCANLIST: READ: (if a time-out occurs) ---------------------------------------------------------------------------- OSCLI:<text> ---------------------------------------------------------------------------- Purpose: Executes a * command. Use: Allows command line commands to be executed within the script. In one of the example script programs the command is used to open directory windows. System variables such as ComLink$Dir may be used BUT MUST be enclosed in curly brackets, eg {ComLink$Dir}. ComLink will then substitute the appropriate string before passing to the CLI. I found this was necessary since some CLI commands don't like system variables in the normal <> brackets. Example: OSCLI:Filer_OpenDir {ComLink$Dir}.Download OSCLI:sound 1 340 200 6 Nb. {} BRACKETS MUST BE USED AROUND SYSTEM VARIABLES. Related commands: None ---------------------------------------------------------------------------- READ:<text> ---------------------------------------------------------------------------- Purpose: If any of the strings were found during a SCANLIST: then those messages will subsequently be read if the READ: command is used. The text is optional but if used it defines the character sequence that marks the start of the message. Use: Used at some point in the script program after a SCANLIST: command. Read messages are saved in directory "Download" within the !ComLink application directory or within !ComMail. They are saved as text type files in a directory with the same name as the <string> that was found during the previous SCANLIST: and/or FILESCAN: command. The saved file will be given a filename which is the reverse of that days date. (This ensures an alpha- numeric sort, as in a directory display, lists the files in chronological order). Subsequent connections to the BBS on the SAME day, will result in new messages being appended to the end of that days file, a new file is created every day ComLink is used and mail etc can be sorted at your leisure without being overwritten. On some BBSs, the message can start with a character sequence that looks like a prompt! To get around this you can put <text> after the read command which will identify a message start. eg READ:>[13] The READ: command ends when a prompt has been seen and no more messages are to be read. ****IMPORTANT**** The READ: command MUST be preceded by the command FILESCAN: and/or SCANLIST: to determine which messages are to be read. The last delay command before the READ: command, must allow sufficient time for a complete message to be read, set DELAY: to at least 600seconds (10 minutes) if communicating with a BBS. DO NOT include spaces in the <text> parameters. Examples: TYPE:L SCANLIST:ARCHIM:AMSAT:G7ALN READ: Related commands: FILESCAN: SCANLIST: MYPROMPT: TYPE: DELAY: ---------------------------------------------------------------------------- REPORT:<ON/OFF> ---------------------------------------------------------------------------- Purpose: Pops up a status window. Use: Useful to force the status window to appear. A status window can be popped up at any time by using the menu option. Examples: REPORT: Related commands: None ---------------------------------------------------------------------------- SAVELIST:<filename> ---------------------------------------------------------------------------- Purpose: Forces the program to save the next message list to a file. Use: Normally placed at the start of the script program but only has an effect if a SCANLIST command is used. The saved list is put in the ComLink application's download directory in !ComMail and called "List" or <Filename>. If <filename> is blank or contains a space the filename will be set to "List". A separate SAVELIST: must be inserted before every instance of SCANLIST: if the list from every SCANLIST: is to be saved. Examples: SAVELIST:BBS_List Related commands: SCANLIST: ---------------------------------------------------------------------------- SCANLIST:<string1>:<string2>..... ---------------------------------------------------------------------------- Purpose: Examines a message list from the BBS or PMS, and looks for <string1>,<string2> etc. in each line. If any of the strings are found then that message will subsequently be read if the READ: command is used. Use: Use this command after initiating a "List" from the TNC or BBS by using the command TYPE:L (or equivalent), where sending "L" causes the BBS to list the messages. The <string> is case sensitive, ie if ARCHI is the string, then a match will be found in MARCHING, but not for Archimedes. Up to 10 <string>s may be specified, each must not be longer than 10 characters. Listed messages seem to have a standard format, this has been assumed by the ComLink program. The message list must be in the form:- NNNNNN....................... Where .... indicates any text up to 100 charecters long, and NNNNNN is a message number which may contain spaces. A preceding SAVELIST: command will force ComLink to save the list in a default or specified directory, with filename "List". The last delay command before the SCANLIST: command, must allow sufficient time for each listed line to be read, set DELAY: to at least 120 seconds. The SCANLIST: command finishes having seen your prompt, as defined in the MYPROMPT: command so a WAITFOR: command MUST NOT be used after the SCANLIST: command. See example 3 below. Example: (for a PMS/BBS): TYPE:L SCANLIST:G7ALN:ARCHI:SAT READ: Related commands: SAVELIST: READ: TYPE: DELAY: ---------------------------------------------------------------------------- START:<time> ---------------------------------------------------------------------------- Purpose: Waits until a given time before continuing with the script. Use: Normally placed at the beginning of the program. The time specified must be in 24hr format. Another terminal program must not be running when a script starts, otherwise characters may be stolen from the serial port and the operation of ComLink will be upset. A colon must be used to separate the hours and minutes. Examples: START:23:00 Related commands: None ---------------------------------------------------------------------------- TRYAFTER:<number> LOOPIF:<text> and UNTIL:<text> ---------------------------------------------------------------------------- Purpose: Allows loops conditional on the text received. Use: Typically used to check if the BBS is busy and try again later if it is. These commands setup a conditional loop. The LOOPIF: command specifies the text which will cause a loop back from the UNTIL: command. A pause equal to the TRYAFTER: value will be made on each loop back. The text specified in the UNTIL: command, when seen will allow the script to continue with the following command. No delay is made on the first pass through the loop, only when a loop-back is made. Choose the text by looking at the BBS output when it is busy. GB7IMB sends *** IMBBBS busy so I can specify all or part of this in the LOOPIF: command. When a successful connection is made I get back the prompt, so I can use Alan > as the text in the UNTIL: command. (Wildcards are NOT allowed!) In the example below the TRYAFTER: command defines a 360 second (6 minute) pause on loop back. A connection to the BBS will be attempted and the text "Alan >" OR "busy" waited for. If "Alan >" is received the script will continue with TYPE:L but if "busy" is seen then the next script command executed will be LOOPIF: again and a pause of 6 minutes made. The last used DELAY: command sets the time-out limit to see one of the text strings (in the example "busy" or "Alan >") while the UNTIL: command is executing. There is no limit to the number of loop backs! More than one loop can be setup in the script but you can't have nested loops. Examples: TRYAFTER:360 LOOPIF:busy TYPE:C IMBBBS UNTIL:Alan > TYPE:L Related commands: DELAY: ---------------------------------------------------------------------------- TYPE:<string>[control code] ---------------------------------------------------------------------------- Purpose: Sends the text in the string to the serial port. Use: Sends the string just as though it were typed into a terminal program. Control codes may be sent by specifying the decimal number of the code in square brackets. A carraige return code will automatically be added to the end of the line by !ComLink. System variables can be used in {} brackets. This feature is useful when a BBS requires the last listed message number in the list command since a FILESCAN: will extract this for you from an old saved "List" file and save it as {OldList$Num}. See the FILESCAN: command for further details. ComLink will try to send the whole string within a time period set by delay. A time-out will be generated if the string cannot be sent (due to the output buffer on the serial port failing to empty). See the DELAY: command. Examples: TYPE:C GB7IMB TYPE:CONM TRANS[13]MON OFF (Note [13] is the code for a carriage return) Related commands: DELAY: ---------------------------------------------------------------------------- UNTIL:<text2> ---------------------------------------------------------------------------- See command TRYAFTER: ---------------------------------------------------------------------------- UPLOAD:<comment> ---------------------------------------------------------------------------- Purpose: Sends up to 10 files in the upload directory to the serial port. Use: Normally this command would be used as soon as a link to the BBS has been made. All files in the upload directory within will be sent to the serial port providing the filename does not start with a +. No characters are added to or removed from the files, but all line feeds are converted to carraige returns. You can specify the upload directory in your script using DIRUP: but if you don't use this command ComLink will look in the For_Upload directory within the !ComLink application directory. The command ends having seen your prompt, the PMS/BBS is therefore ready to receive the next command. When each file has been sent and the prompt received, the uploaded file will be re-named with a "+" added to the beginning of the filename. Filenames starting with a "+" will not be sent, this prevents files being sent twice accidentally. The files must be put in the directory by yourself. Text files must contain all information for the BBS to save/send on the message. The message can be created with !Edit and typically would contain:- SP G7ALN @ GB7IMB Re. ComLink... Hi Alan, your !ComLink program is ...... ........ 73 de Me /ex IMPORTANT: WHEN CREATING THE TEXT FILE, "RETURN" MUST HAVE BEEN PRESSED AFTER THE /ex. You can check this has been done, by using the mouse/caret in !Edit. You should be able to put the caret on the line below the /ex. If the APPEND: command is used at the start of the script, then that can contain the /ex to end the message and it therefore need not be put in the text file for upload. Only one message per file should be used, since only when the whole file has been sent does ComLink start looking for your prompt (as set by the MYPROMPT: command) Example: UPLOAD: Any old text here, program ignores it! Related commands: MYPROMPT: DELAY: APPEND: ---------------------------------------------------------------------------- WAITFOR:<text> ---------------------------------------------------------------------------- Purpose: Waits for a period (set by the DELAY: command) for the text <string> to be seen. Use: Pauses the script to wait for the <text>. The "case" of the text must be correct. The command reads in all characters until the <string> is found. Examples: WAITFOR:Alan > Related commands: DELAY: ---------------------------------------------------------------------------- WKEY:nX:<label>:<text> ---------------------------------------------------------------------------- Purpose: Programs WimpKey "n" Use: Wimpkeys are sort of "on screen" function keys. There are two sets of keys in the window which have different functions these consist of 8 yellow wimpkeys and 8 white ones, there are also some control icons. Wimpkeys provide a significant enhancement to the operation of !ComLink, in particular, they make operation on "HF" a doddle! The terminal instructions in file "TermInstr" provides a full description of WimpKey operation. The 'WimpKey Edit' facility in the ComLink menu provides the simplest method of changing the wimpkeys, the following description is provided for the hardened script writer! Use values of "n" is in the range 1 to 8 for the yellow wimpkeys and 11 to 18 for the white ones. (Keys are numbered from left to right). X is the key 'type', valid types are N.F,S,T, where the meaning of the letter is:- N - None, ie the <label> and <text> are ignored F - File, <text> specifies a file to be uploaded S - Script, <text> specifies a script to be run T - Text, <text> specifies the text to be sent to the TNC The <label> of any key can be up to 9 characters. The <text> can be up to 128 characters. The <text> is optional and can be ommitted if the <label> and <text> would be the same. Only the currently visible wimpkey set can be altered using this command. Examples: The following line programs the label of wimpkey 1 to be "BBS", when the wimpkey is clicked a script called "Read_BBS" will be run, this will be in the WimpKeys directroy within the !ComLink application. WKEY:1S:BBS:Read_BBS The following line programs key 2 to send file "My_address" to the TNC. WKEY:2F:Address:My_address The following line programs wimpkey 6 to send 'Ctrl C'+'D'+'Return' to the TNC, hence causing a disconnect. WKEY:6T:Disconn:[3]D[13] Related commands: None ============================================================================