home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 17 / CD_ASCQ_17_101194.iso / vrac / gohom10a.zip / GOSCRIPT.HLP < prev    next >
Text File  |  1994-04-30  |  37KB  |  933 lines
  1. Help file for GoScript.
  2.  
  3. @@Contents
  4. HelpOnHelp   : `1Help on Help`0   How to use the help facility.
  5. Overview     : `1Overview`0       Describes what the script editor is used for.
  6. Variables    : `1Variables`0      Describes the variables used in scripts.
  7. @@SectionHdr :
  8. @@SectionHdr :                    `2Menu Items`0
  9. @@SectionHdr :
  10. File         : `1File`0 menu contains of the following menu items:
  11. New          :   `1New`0          Create a new script file.
  12. Open...      :   `1Open`0         Open an existing script file for editing.
  13. Save         :   `1Save`0         Save the current script to a file.
  14. SaveAs...    :   `1Save As`0      Save the script to a different file.
  15. Insert File  :   `1Insert File`0  Insert a script file at the current line.
  16. Print...     :   `1Print`0        Print the script file.
  17. Exit         :   `1Exit`0         Quit the script editor.
  18. @@SectionHdr :
  19. Edit         : `1Edit`0 menu contains the following menu items
  20. Cut          :   `1Cut`0          Move the current command to the clipboard.
  21. Copy         :   `1Copy`0         Copy the current command to the clipboard.
  22. Paste        :   `1Paste`0        Insert clipboard's script command.
  23. Delete Line  :   `1Delete Line`0  Remove the command from the script.
  24. Labels...    :   `1Labels`0       Display the `1Label Maintenance`0 dialog
  25. @@SectionHdr :
  26. Add          : `1Add`0            Menu used to add a script command to script.
  27. @@SectionHdr :
  28. Detail       : `1Detail`0         Display the script command's detail dialog box.
  29. @@SectionHdr :
  30. Help         : `1Help`0           Menu to get help for using `1GoScript`0.
  31. Topics       :   `1Topics`0        Displays help's table of contents.
  32. Help On Help :   `1Help On Help`0 Expains how to use the help facility.
  33. About        :   `1About`0        Displays information about `1GoScript`0.
  34. @@SectionHdr :
  35. @@SectionHdr :                   `2Script Commands`0
  36. Beeper       : `1Beeper`0         Sound the computer's internal speaker.
  37. BlankScreen  : `1BlankScreen`0    Cause the screen to blank.
  38. Chain        : `1ChainTo`0        Start executing another scriptfile.
  39. KeySpeed     : `1KeySpeed`0       Change the speed at which keys are played back.
  40. Comment      : `1Comment`0        Add a text description.
  41. CopyTo       : `1Copy`0           Copy a script variable or string.
  42. Date         : `1DateStamp`0      Insert a date stamp.
  43. Delay        : `1Delay`0          Pause execution of script for a specified period of time.
  44. DoMenu       : `1DoMenu`0         Create a pop-up menu.
  45. GetArg       : `1GetArgument`0    Get an argument from the command line or prompt.
  46. GetKey       : `1GetKey`0         Wait for a key to be pressed.
  47. Goto         : `1Goto`0           Always transfer execution the the label specified.
  48. IfGoto       : `1IfGoto`0         Execute a conditional branch.
  49. Keystrokes   : `1Keys`0           Type the specified keys.
  50. LabelScript  : `1Label`0          Insert a marker that can be jumped to.
  51. MessageBox   : `1MessageBox`0     Display a message box.
  52. PrintScrn    : `1PrintScreen`0    Print the contents of the screen.
  53. PutSnapShot  : `1PutSnapShot`0    Display a snapshot file.
  54. Reboot       : `1Reboot`0         Reboot the computer.
  55. RunTask      : `1RunTask`0        Run a scheduled task.
  56. Debug        : `1ScriptDebug`0    Turn on/off script debugging.
  57. SetStuff     : `1StuffMethod`0    Modify the method used to stuff keys.
  58. TakeSnapShot : `1TakeSnapSht`0    Save a portion of the display to file.
  59. Time         : `1TimeStamp`0      Insert a time stamp.
  60. ToggleKeys   : `1ToggleKeys`0     Toggle Caps, NumLock, and Ins keys.
  61. WaitPrompt   : `1WtDOSPrompt`0    Wait until returned to DOS prompt.
  62. WaitAt       : `1WaitAtPos`0      Wait for text to appear in a region on the screen.
  63. WaitRel      : `1WaitRelCrs`0     Wait for text to appear relative to the cursor.
  64. EmptyBuff    : `1WaitKeyBuff`0    Wait until all keys have been accepted.
  65. @@EndContents
  66.  
  67. KeyFile      : `1KeyFile`0        Playback keys stored in a file.
  68.  
  69.  
  70. @@Help
  71. [HelpOnHelp]
  72. To use help, select the topic you want help on from the topics
  73. list (enter 'T' to get back to the topics list). Use the
  74. cursor and page keys to scroll through the text. The `2 Next`0
  75. and `2 Previous `0 buttons move to the next and previous
  76. topic, respectively.
  77.  
  78. All of the buttons in `1GoHelp`0 can be executed by simply
  79. pressing the key that is highlighted on the button. You can
  80. also TAB to the button or press it's accelerator key (press
  81. <ALT> + key hightlighted on button label).
  82.  
  83. To get help on a particular program, run `1GoHelp`0 with the
  84. first argument on the command line set: `1GoHome`0,
  85. `1GoScript`0, `1GoSched`0, or `1GoEd`0. You can also run
  86. `1GoHelp`0 with no arguments, in which case you will be
  87. presented with a menu to select the program you want help on.
  88.  
  89. ■
  90.  
  91.  
  92. [Overview]
  93. `1GoScript`0 is used to modify or create scripts that
  94. `1GoHome`0 can play back. `1GoHome`0 allows you to create new
  95. scripts and to record keystrokes, add `2WaitAtPos`0 and
  96. `2WaitRelCrs`0 commands, and a number of other commands while
  97. running the program you want to automate. 
  98.  
  99. `1GoScript`0 makes modifying and adding commands simple
  100. because it doesn't require you to remember all the commands
  101. and the parameters they require. Instead, `1GoScript`0 uses
  102. menus and dialog boxes that prompt you for the needed data. In
  103. addition, `1GoScript`0 doesn't require a seperate "compile"
  104. phase that other script languages need - scripts are compiled
  105. automatically.  
  106.  
  107. ■
  108.  
  109. [Variables]
  110. GoHome uses five program variables. A program variable is used
  111. to store a specific piece of data. Depending on the variable,
  112. the data may be numeric or a text string. Two of the variables
  113. contain numeric values that are set and maintained by GoHome,
  114. the other three variables contain text strings that can be
  115. modified by the script in any manner it sees fit to. The
  116. following table lists the names and purposes of these
  117. variables.
  118.  
  119.   Variable Name     Purpose
  120. ----------------------------------------------------------------------
  121.  
  122.   `2Result`0      : Set to "OK", "Not OK", or "timed-out" depending
  123.                 on whether the last script command was 
  124.                 successful, not successful, or timed-out, 
  125.                 respectively.
  126.  
  127.   `2MenuItemSel`0 : Contains the last menu item selected from a 
  128.                 `1DoMenu`0 script command. Valid values are 
  129.                 'None' if user canceled menu (ie. hit ESC key),
  130.                 and 1, 2, ..., 9.
  131.  
  132.   `2StringA`0     
  133.   `2StringB`0     
  134.   `2StringC`0     : These are general purpose string variables. 
  135.                 Each may contain up to 80 characters. Any 
  136.                 strings that are copied to these variables
  137.                 may contain two of GoHome's embeded macros.
  138.                 An embeded macro is either another string
  139.                 variable or an environment varialbe. These
  140.                 macros are denoted by prefacing them with
  141.                 percent signs ('%'). For example, if
  142.                 StringA contains the string "Hello", and
  143.                 there's an environment variable 'COMSPEC' 
  144.                 that contains "C:\command.com" then:
  145.                     
  146.         "%StringA, World!"    => "Hello, World!" 
  147.         "Say %StringA to all" => "Say Hello to all"
  148.         "Comspec is %comspec  => "Comspec is C:\command.com"
  149.  
  150. GoHome also allows the following macro characters to be used
  151. within strings:
  152.   `2%CR`0    : Carriage return character
  153.   `2%NL`0    : New-line character
  154.   `2%CN`0    : Both a carriage return and new-line characters
  155.   `2%FF`0    : Form-feed character
  156.   `2%TB`0    : tab character
  157.   `2%#n`0    : character represented by ASCII number, 'n'
  158.  
  159. These macros are especially useful when writing strings to the
  160. printer or a file. For example, the following could be used to
  161. send the value of variable StringA to the printer:
  162.  
  163.   `1"%stringa%CN"`0
  164.  
  165. All the variables and macro characters are case insensitive.
  166. ■
  167.  
  168. [RunTask]
  169. `1RunTask`0 will run the specified task that is in GoSched's
  170. Task List. Before running the specified task, GoHome 
  171. terminates the current script file (when the specified task 
  172. finishes, the script does NOT continue).
  173.  
  174. ■
  175.  
  176. [Comment]
  177. The `1Comment`0 statement has no effect during playback of the 
  178. script. It can be used to document what the script does, how it 
  179. works, or anything else you feel is important.
  180. ■
  181.  
  182. [Keystrokes]
  183. The keystrokes entered will be played back just as if you 
  184. where typing them in manually.  To enter an edit key (ie. 
  185. '─', '', <Enter>) press the <Shift><Ins> keys simultaneously.
  186. From this point on, `2all`0 keys pressed will be entered
  187. into the script.  When you're done, press <Shift><Ins> to 
  188. return to normal edit mode.
  189.  
  190. To modify the time interval between keystrokes, bring up the
  191. detail dialog for `1Keys`0 by pressing <Alt><D>. Position
  192. the cursor over the key whose interval you want to change.
  193. Tab to the "Delay Interval" field and modify the interval.
  194. The interval entered is expressed in `1timer ticks`0 where
  195. 1 timer tick is 1/18 secs.
  196.  
  197. The keyboard `1status/toggle`0 keys are entered using the 
  198. `2<F10>`0 key. Before pressing the <F10> key, hold down all
  199. status/toggle keys. For example, if you want to enter the
  200. <Alt> key, press and hold the <Alt> key, then press <F10>, and
  201. release both keys. 
  202.  
  203. The keyboard `1status/toggle`0 keys are displayed as "<Flags:?>" 
  204. where '?' is a hexadecimal number indicated by the following
  205. table:
  206.  
  207.       8 4 2 1 8 4 2 1
  208.       x . . . . . . .   Lock <Ins>
  209.       . x . . . . . .   Lock <Caps Lock>
  210.       . . x . . . . .   Lock <Num Lock>
  211.       . . . x . . . .   Lock <Scroll Lock>
  212.       . . . . x . . .   <Alt> key is pressed
  213.       . . . . . x . .   <Ctrl> key is pressed
  214.       . . . . . . x .   <Left Shift> key is pressed
  215.       . . . . . . . x   <Right Shift> key is pressed
  216.  
  217.  
  218. For example, `2Keys`0 might display the following:
  219.     `1<Flags:8>`0  : The <Alt> is pressed
  220.     `1<Flags:84>`0 : The <Ctrl> is down and the <Ins> key
  221.                      is locked (enabled)
  222.     `1<Flags:a8>`0 : The <Ins> key is locked, the <Num Lock>
  223.                      key is locked, and the <Alt> key is 
  224.                      pressed.
  225.     `1<Flags:a0>`0 : Same as above but with <Alt> key 
  226.                      released.
  227.  
  228.  
  229. When `1GoHome`0 is used to record keystrokes, it will record
  230. all <Alt> key presses and releases. Some applications don't
  231. care if the <Alt> key flags are set but other do. If the 
  232. keystrokes were not recorded, you may have to enter the 
  233. Alt key flag before and Alt key is pressed and then enter
  234. the Alt key release after the Alt Key. For example, if you
  235. press <Alt><F>, it may be necessary to record the Alt key
  236. flags such as: <Flags:8><Alt-F><Flags:0>
  237.  
  238. It if VERY `1Important`0 that the Flag keys are entered 
  239. and removed in pairs. If this is not done, the application
  240. may get confused and not work properly.
  241.  
  242. Note: `1GoScript`0 will break up long keystroke sequences 
  243. into multiple lines.
  244. ■
  245.  
  246. [SetStuff]
  247. The `1StuffMethod`0 is used to modify the way that 
  248. keystrokes are played back. It should only be used if a
  249. program doesn't seem to accept the keystrokes played back
  250. by GoHome. 
  251.  
  252. Technically, this method will generate an interrupt 9 
  253. whenever a keystroke is stuffed into the keyboard's 
  254. type-ahead buffer.
  255.  
  256. ■
  257.  
  258. [WaitAt]
  259. Use `1WaitAtPos`0 when you want to pause execution of the script
  260. until a specific pattern of characters appears on the screen. 
  261. You define a region of the screen to 'look' at by specifying
  262. the top-left row and column, width, and height of the region.
  263. You also must specify the pattern of characters that you
  264. want GoHome to wait for.  When the script is played back, GoHome
  265. will search for the text in the region specified twice 
  266. a second until either the text is found to match or a
  267. timeout occurs.
  268.  
  269. The search string may be up to 40 characters.
  270.  
  271. `1Result`0 variable is set to: 
  272.         `3OK`0       : if match was found
  273.         `3TimedOut`0 : if a match wasn't found within the given 
  274.                    timeout period.
  275.                              
  276. Note: The search string may be one of the three GoHome 
  277.       internal strings (ie. %StringA), an environment 
  278.       variable (ie. %SHELL) or any of the 'macro'
  279.       characters (see `2Script Variables`0).
  280. ■
  281.  
  282. [WaitRel]
  283. Use `1WaitRelCrs`0 when you want to pause execution of the script
  284. until a specific pattern of characters appears on the screen. 
  285. `1WaitRelCrs`0 is similar to `1WaitAtPos`0 except the region that
  286. is searched is `2relative`0 to the current cursor position.
  287.  
  288. The search string may be up to 40 characters.
  289.  
  290. `1Result`0 variable is set to: 
  291.         `3OK`0       : if match was found
  292.         `3TimedOut`0 : if a match wasn't found within the given 
  293.                    timeout period.
  294.                             
  295. Note: The search string may be one of the three GoHome 
  296.       internal strings (ie. %StringA), an environment 
  297.       variable (ie. %SHELL) or any of the 'macro'
  298.       characters (see `2Script Variables`0).
  299. ■
  300.  
  301. [Delay]
  302. `1Delay`0 will pause the execution of the script for the 
  303. specified number of minutes and seconds. The maximum number 
  304. of minutes that can be delayed is 1,092 (18.2 hours). If for
  305. some reason you need a longer delay, use multiple delay 
  306. statements.
  307. ■
  308.  
  309. [DoMenu]
  310. `1DoMenu`0 will pop-up a menu and allow the user to make a
  311. selection. The menu is defined by selecting `2Detail...`0 from
  312. the menu bar (<Alt>D). You can give the menu a title and up
  313. to 10 menu items. The item selected by the user is stored in
  314. the variable `2Menu Item Sel`0. This variable can be used in
  315. an `2IfGoto`0 statement to determine which item was selected 
  316. and perform whatever is necessary.  If the user hit the `3ESC`0
  317. key to abort the menu, `2Menu Item Sel`0 will contain a 0.
  318.  
  319. `1Result`0 variable is set to: 
  320.         `3OK`0       : if user selected a menu item.
  321.         `3Not OK`0   : if user canceled menu.
  322.         `3TimedOut`0 : if a menu selection wasn't entered within
  323.                    the given timeout period.
  324.  
  325.  
  326. Note: Set the `1Timeout`0 value to `10`0 to keep the menu
  327.       from timing-out (i.e. an <Enter> MUST be pressed).
  328.       
  329.  
  330.            ╔════════════ DoMenu Edit ═══════════╗
  331.            ║                                    ║
  332.            ║       ╒════   Macro Menu·· ══╕     ║
  333.            ║     1 │ N  Name              │     ║
  334.            ║     2 │ A  Address           │     ║
  335.            ║     3 │ D  Today's Date      │     ║
  336.            ║     4 │ W  Start Word Proc   │     ║
  337.            ║     5 │ R  Run Task 1        │     ║
  338.            ║     6 │ T  Date/Time Stamp   │     ║
  339.            ║     7 │                      │     ║
  340.            ║     8 │                      │     ║
  341.            ║     9 │                      │     ║
  342.            ║       └──────────────────────┘     ║
  343.            ║         ^── Enter HotKey char      ║
  344.            ║                                    ║
  345.            ║           Timeout  0     ▄         ║
  346.            ║           ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀         ║
  347.            ║           OK    ▄    Cancel  ▄     ║
  348.            ║        ▀▀▀▀▀▀▀▀▀▀   ▀▀▀▀▀▀▀▀▀▀     ║
  349.            ╚════════════════════════════════════╝
  350.  
  351. ■
  352.  
  353. [IfGoto]
  354. `1IfGoto`0 allows conditional processing of script commands. If
  355. the test condition is true, then the next script command to be 
  356. executed will be the statement at the specified label. 
  357.  
  358.   ╔══════════════════════════ If Goto ════════════════════════╗
  359.   ║                                                           ║
  360.   ║    Variable:            Test Condition:    Value:         ║
  361.   ║ If Result           ▄   Not Equal      ▄   Timed out▄     ║
  362.   ║    ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀   ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀   ▀▀▀▀▀▀▀▀▀▀     ║
  363.   ║    then goto Label   END             ▄    Labels... ▄     ║
  364.   ║                      ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀    ▀▀▀▀▀▀▀▀▀▀▀     ║
  365.   ║                                                           ║
  366.   ║                   OK    ▄     Cancel  ▄                   ║
  367.   ║                ▀▀▀▀▀▀▀▀▀▀    ▀▀▀▀▀▀▀▀▀▀                   ║
  368.   ╚═══════════════════════════════════════════════════════════╝
  369.  
  370. ■
  371.  
  372. [Goto]
  373. `1Goto`0 will transfer execution to the script command which 
  374. immediately follows the label specified.
  375. ■
  376.  
  377. [LabelScript]
  378. A `1Label`0 acts as a marker in the script to which a `1Goto`0
  379. or `1IfGoto`0 statement can jump to. The detail dialog for 
  380. `1Label`0s, allows for a label to be selected from a list
  381. of all labels referenced by `1IfGoto`0 and `1Goto`0 commands
  382. that have not yet been entered.
  383.  
  384. If a label is modified, all `1IfGoto`0 and `1Goto`0 commands
  385. that reference it will be updated to use the modified label.
  386.  
  387.  
  388.      ╔════════════ Label Maintenance ═══════════╗
  389.      ║                                          ║
  390.      ║  ┌────── Label ──────┐                   ║
  391.      ║  │- END              ▓        Add... ▄   ║
  392.      ║  │                   ▓      ▀▀▀▀▀▀▀▀▀▀   ║
  393.      ║  │                   ▓       Remove  ▄   ║
  394.      ║  │                   ▓      ▀▀▀▀▀▀▀▀▀▀   ║
  395.      ║  │                   ▓        Use    ▄   ║
  396.      ║  │                   ▓      ▀▀▀▀▀▀▀▀▀▀   ║
  397.      ║  │                   ▓        Done   ▄   ║
  398.      ║  └──────────────────        ▀▀▀▀▀▀▀▀▀▀   ║
  399.      ║   -: label not in script                 ║
  400.      ╚══════════════════════════════════════════╝
  401.  
  402. ■
  403.  
  404. [CopyTo]
  405. The `1Copy`0 command is very versatile. It allows for the
  406. values of script variables, text strings, and environment
  407. variables to be copied to a script variable, typed
  408. automatically at the keyboard, copied to an environment
  409. variable, copied to a file, displayed on the screen, or sent
  410. to a printer.  
  411.  
  412. You indicate what to copy "From" and "To" by selecting the
  413. proper radio button in the Copy dialog box.  
  414.  
  415. Options for `1From`0
  416.   `1Variable`0   : The contents of any of the three String
  417.                variables.
  418.   `1String`0     : Can be any text. Macro characters and
  419.                strings may also be used. For example,
  420.                "Contents of StringA is %StringA"
  421.                see `2Variables`0 for macro characters.
  422.   `1Env Var`0    : Enter the name of the environment variable
  423.                to be copied (i.e. "PATH").
  424.                The string is retrieved from the current 
  425.                program's enviroment table.
  426.  
  427. Options for `1To`0 
  428.   `1Variable`0   : The contents of any of the three String
  429.                variables.
  430.   `1Keyboard`0   : Copy from field to the keyboard buffer.
  431.   `1Environment Table`0 : The `1From`0 field MUST contain
  432.                a properly formated environment variable
  433.                and value (i.e. "HOME=C:\DOS"). The
  434.                string is NOT checked for validity.
  435.                The string is inserted into the current 
  436.                program's envirionment table.
  437.   `1File`0       : Appends the string to the file specified.
  438.   `1Display`0    : Writes the string to the display screen.
  439.   `1Printer`0    : Sends the string out to a parellel printer
  440.                port.
  441.  
  442. Examples:
  443.   To set a new environment variable, 'NEWVAR' to 'ADDED', 
  444.   select `1String`0 in the `2From`0 box and type in the field
  445.   to its right, "NEWVAR=ADDED". Then select `1Environment Table`0
  446.   in the `2To`0 box.
  447.  
  448.   To retrieve the value of environment variable 'NEWVAR' into
  449.   variable `1StringA`0, select `1Env Var`0 in the `2From`0 box
  450.   and select `1Variable StringA`0 in the `2 To`0 box.
  451.  
  452.   To copy the string "Downloaded files:" to file "newfiles.txt",
  453.   select `1String`0 in `2From`0 box and enter 
  454.   "Downloaded files:%CN" in the field beside it (note that %CN 
  455.   is used to write a carriage-return/newline pair to the file).
  456.   In the `2To`0 box, select the `1File`0 radio button and enter
  457.   "c:\new\newfiles.txt" in the field beside it.
  458.  
  459.   TIP: You can use the copy command to display text on the
  460.        screen. This may be useful when debugging a script.
  461.  
  462.  
  463.  see also: `4Variables`0
  464.  
  465.    ╔═════════════════════ Copy ════════════════════════╗
  466.    ║                                                   ║
  467.    ║      ┌ From ───────────────────────────────┐▄     ║
  468.    ║      │( ) Variable   String A             │█     ║
  469.    ║      │() String     Stock Quotes current  │█     ║
  470.    ║      │( ) Env Var                          │█     ║
  471.    ║      └─────────────────────────────────────┘█     ║
  472.    ║       ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀     ║
  473.    ║      ┌ To ─────────────────────────────────┐▄     ║
  474.    ║      │( ) Variable   String A             │█     ║
  475.    ║      │( ) Keyboard                         │█     ║
  476.    ║      │( ) Environment Table                │█     ║
  477.    ║      │() File       c:\stckqtes.txt·····  │█     ║
  478.    ║      │( ) Display   row=      col=         │█     ║
  479.    ║      │( ) Printer                         │█     ║
  480.    ║      └─────────────────────────────────────┘█     ║
  481.    ║       ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀     ║
  482.    ║                OK   ▄       Cancel  ▄           ║
  483.    ║              ▀▀▀▀▀▀▀▀▀▀      ▀▀▀▀▀▀▀▀▀▀           ║
  484.    ╚═══════════════════════════════════════════════════╝
  485.  
  486. ■
  487.  
  488. [GetKey]
  489. The `1GetKey`0 command is used to wait until the user presses
  490. a key before continuing with the next script command. The
  491. `1GetKey`0 command will halt any program that is running. 
  492.  
  493. A timeout value may be specified. It the timeout is non-zero,
  494. `1GetKey`0 will wait until either a key is hit or the 
  495. specified timeout value is reached.
  496.  
  497. `1Result`0 variable is set to: 
  498.         `3OK`0       : if user hit a key.
  499.         `3TimedOut`0 : if user didn't hit a key within the 
  500.                    given timeout period.
  501. ■
  502.  
  503. [EmptyBuff]
  504. `1WaitKeyBuff`0 will wait until all keys in the keyboard's
  505. type ahead buffer have been retrieved by the running program.
  506. ■
  507.  
  508. [WaitPrompt]
  509. `1WtDOSPrompt`0 will pause execution of the script until it
  510. returns to the DOS prompt.
  511.  
  512. ■
  513.  
  514. [MessageBox]
  515. `1MessageBox`0 is used to display up to four lines of text
  516. in a window. The message box can be positioned at any row 
  517. and column. The default is to center the window on the screen.
  518.  
  519. A timeout value may also be specified.
  520.  
  521. `1Result`0 variable is set to: 
  522.     `3OK`0       : if user acknowledged the message box by
  523.                    pressing ENTER.
  524.     `3Not OK`0   : if user canceled (hit ESC) message box.
  525.     `3TimedOut`0 : if message box wasn't acknowledged within
  526.                the given timeout period.
  527. ■
  528.  
  529. [Beeper]
  530. `1Beeper`0 will beep the computer's internal speaker.  The 
  531. sound heard depends on which type of beep is selected:
  532.  
  533.         Alarm
  534.         Peep
  535.         Whoop
  536.         Phasor
  537.         Error
  538. ■
  539.  
  540. [Reboot]
  541. `1Reboot`0 will cause the computer to reboot itself.
  542. A message box will appear and state that the computer
  543. is about to be rebooted. Pressing <Esc> will abort
  544. the reboot, pressing <Enter> will continue the reboot
  545. process. If a key is not pressed within 60 seconds,
  546. the `1GoHome`0 will go ahead and reboot the PC.
  547. ■
  548.  
  549. [PrintScrn]
  550. `1PrintScreen`0 will execute the computers print screen
  551. command. This will, usually, print the screen to the LPT1
  552. printer port.
  553.  
  554. `1Result`0 variable is set to: 
  555.         `3OK`0     : if screen printed succesfully
  556.         `3Not OK`0 : if a printer error was detected.
  557. ■
  558.  
  559. [Date]
  560. The `1DateStamp`0 command allows for a number of different date
  561. formats. The first edit field, "Enter the date format string",
  562. is used to specify how the date should be displayed. The text
  563. below the edit fields show what characters to use when
  564. specifying the date format.  The formatted date can be copied
  565. to any of the `1Script Variables`0 or the keyboard.
  566.  
  567. For example, say we want the date to appear in mm/dd/yy format
  568. (i.e.  03/19/94). Therefore, we would enter "M/D/y" in the
  569. date format field.  When GoHome plays this script, it will
  570. substitute the actual month, day, and year in place of the "M"
  571. "D" and, "y" characters.  Note that any characters other than
  572. "W" "m" "M" "D" "Y" and "y" will be displayed normally.  If
  573. you prefer the date to use dashes instead of slashes, type in
  574. "M-D-y".
  575.  
  576.      ╔═══════════════════ Date Edit ═════════════════════╗
  577.      ║                                                   ║
  578.      ║  Enter the date format string  W m D, Y        ▄  ║
  579.      ║  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀  ║
  580.      ║  Copy to  Keyboard  ▄      OK    ▄   Cancel  ▄    ║
  581.      ║  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀   ▀▀▀▀▀▀▀▀▀▀  ▀▀▀▀▀▀▀▀▀▀    ║
  582.      ║  The following characters have special meaning    ║
  583.      ║  W  -> Week day (ie sun, mon, etc.)               ║
  584.      ║  M  -> Month as digits                            ║
  585.      ║  m  -> Month as 3 letter abrev.                   ║
  586.      ║  D  -> Day as digits.                             ║
  587.      ║  Y  -> Year as 4 digits                           ║
  588.      ║  y  -> Year as 2 digits                           ║
  589.      ║  $  -> To print the special characters above.     ║
  590.      ║  any other char is passed through.                ║
  591.      ║  For example,                                     ║
  592.      ║  W m D, y     =>  Tue Mar 19, 1993                ║
  593.      ║  M-D-y        =>  03-19-93                        ║
  594.      ║  Toda$y is m D, Y =>  Today is Mar 19, 1994       ║
  595.      ╚═══════════════════════════════════════════════════╝
  596. ■
  597.  
  598. [Time]
  599. The `1TimeStamp`0 command will copy a formatted time string to any 
  600. of the `1Script Variables`0 or the keyboard. The format for
  601. the time is specified by selecting the appropriate radio
  602. buttons in the `1TimeStamp`0 dialog box.
  603.  
  604.      ╔═══════════════════ Time Edit ════════════════════╗
  605.      ║                                                  ║
  606.      ║   ┌ Time Format ──┐▄   ┌ Time Modifier ──────┐▄  ║
  607.      ║   │  ( ) HH       │█   │  ( ) 12 hour        │█  ║
  608.      ║   │  (.) HH:MM    │█   │  (.) 12 hour AM/PM  │█  ║
  609.      ║   │  ( ) HH:MM:SS │█   │  ( ) 24 hour        │█  ║
  610.      ║   └───────────────┘█   └─────────────────────┘█  ║
  611.      ║    ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀    ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀  ║
  612.      ║               Copy to  Keyboard  ▄               ║
  613.      ║               ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀               ║
  614.      ║                                                  ║
  615.      ║               OK    ▄       Cancel  ▄            ║
  616.      ║            ▀▀▀▀▀▀▀▀▀▀      ▀▀▀▀▀▀▀▀▀▀            ║
  617.      ╚══════════════════════════════════════════════════╝
  618. ■
  619.  
  620. [KeySpeed]
  621. The `1KeySpeed`0 command affects the rate at which keys are
  622. played back. If the value for `1KeySpeed`0 is -1, then the
  623. keys are played back at the same rate as they were recorded or
  624. entered. A value of 0 will play the keys back as fast as a
  625. program will accept them. Any other value indicates the number
  626. of timer ticks (1/18 of a second) to wait between keys. Note
  627. that for values other than -1, the recorded rate is ignored.
  628.  
  629. ■
  630.  
  631. [TakeSnapShot]
  632. The `1TakeSnapsht`0 command is used to save a portion of the 
  633. screen to a file.
  634.  
  635. `1TakeSnapsht`0 requires seven parameters.  You specify the
  636. top-most row, left-most column, width, and height for the
  637. section of the screen that should be saved, whether to save the
  638. video attributes (i.e. colors), allow the section of the
  639. screen to be selected interactively, and the name of the file
  640. to save the screen to. 
  641.  
  642. `1TakeSnapsht`0 doesn't have a detail dialog box because the
  643. parameters can be entered next to the command.  Rows (r) range
  644. from 1 to the number of lines on the screen, typically 25. 
  645. Columns (c) range from 1 to the number of columns that can be
  646. displayed, usually 80.  The width and height are denoted on
  647. the edit line by a "w" and "h" respectively.  If attributes
  648. are to be saved, enter a 1 the attrs field; to save just the
  649. text, enter 0.  Similarly, enter a 1 in the "i" (or
  650. interactive) field to allow the user to designate the portion
  651. of the screen interactively.  Finally, the file field is for
  652. the file name which accepts a string variable or a specific
  653. file name.
  654.  
  655. `1Result`0 variable is set to: 
  656.         `3OK`0       : if snapshot sucessfully taken.
  657.         `3Not OK`0   : if snapshot was unsucessful. This may
  658.                    be due to a disk error while attempting
  659.                    to save the screen or the user canceled an
  660.                    interactive snapshot by pressing ESC.
  661. ■
  662.  
  663. [PutSnapShot]
  664. The `1PutSnapShot`0 command is used to restore or display a 
  665. previous snapshot. 
  666.  
  667. `1Result`0 variable is set to: 
  668.         `3OK`0       : if snapshot sucessfully restored.
  669.         `3Not OK`0   : if snapshot was unsucessful in trying to
  670.                    restore the screen image. This may be 
  671.                    due to a corrupt snapshot file or the
  672.                    snapshot file wasn't found.
  673. ■
  674.  
  675.  
  676. [BlankScreen]
  677. The `1BlankScreen`0 command is used to set the number of 
  678. minutes of keyboard inactivity before the screen is blanked.
  679. A value of `10`0 for the minutes will disable screen 
  680. blanking.
  681.  
  682. ■
  683.  
  684. [Debug]
  685. The `1ScriptDebug`0 command will either turn off or on GoHome's
  686. debug display. If `1ScriptDebug`0 is on, GoHome will display the 
  687. current script command on the first row of the screen. It
  688. will also display the screen region selected for the 
  689. `1WaitAtPos`0 and `1WaitRelCrs`0 commands.
  690.  
  691. To turn `1ScriptDebug`0 on, enter a `21`0, else enter a `20`0.
  692.  
  693. ■
  694.  
  695. [Chain]
  696. `1ChainTo`0 to script allows you to run another script while playing
  697. back the current script.  As an example, you may have a simple
  698. script that just pop-ups a menu and depending on what menu item
  699. was selected, it will chain to another script file.
  700.  
  701. It is possible to pass parameters with the chain command just
  702. like you can do when initially starting a script. You can also
  703. pass data to the new script file throught the script strings.
  704.  
  705. Control does NOT return to the script that executed the chain.
  706. If the script file cannot be found, then the current script is
  707. aborted. 
  708.  
  709. `1Result`0 variable is set to: 
  710.         `3Not OK`0   : if file to chain to wasn't found or was
  711.                    not a valid GoHome script file.
  712.  
  713. ■
  714.  
  715. [ToggleKeys]
  716. The `1ToggleKeys`0 command is used to change the status of the
  717. `2Caps Lock`0, `2Num Lock`0, and `2Insert`0 keys.
  718.  
  719. ■
  720.  
  721.  
  722. [GetArg]
  723. `1GetArgument`0 gets a specified argument from the command line. 
  724. If an argument wasn't provided, then you will be prompted
  725. for the argument.  A timeout value may be specified in which
  726. if an argument isn't provided within 'timeout' seconds, the
  727. prompt dialog box is brought down and the script continues
  728. with the next script statement. 
  729.  
  730. Arguments may be specifed when prompted for the script file 
  731. to run or within `1GoSched`0 on the file name line. Arguments
  732. are separated by `1commas`0 (,).  The 0-th argument is the
  733. name of the script file.  Argument 1 is the value entered
  734. after the script file name.  For example, if you specify the
  735. following:
  736.  
  737.   `1backup.scr  c: d: e:, incremental`0
  738.  
  739. then
  740.   Argument 0 =>  backup.scr
  741.   Argument 1 =>  c: d: e:
  742.   Argument 2 =>  incremental
  743.   any other number will result in a dialog box being 
  744.   displayed and prompting the user for the argument.
  745.  
  746. If prompted and timeout occurs or ESC if entered, the
  747. argument will be assigned the `2Empty Str`0 value.
  748.  
  749. The maximum number of characters that can be entered for the
  750. script file name and all of its arguments is 80 from GoSched
  751. and 60 if the Playback script command is selected from
  752. `1GoHome's`0 main menu.
  753.  
  754. It is possible to use `1script macros`0 within arguments.
  755.  
  756. `1Result`0 variable is set to: 
  757.         `3OK`0       : if argument gotten from command line or
  758.                        from user.
  759.         `3Not OK`0   : if user canceled prompt dialog box
  760.         `3TimedOut`0 : if data wasn't entered at the prompt 
  761.                    dialog within the given timeout period
  762.  
  763.         ╔═══════════ Get Argument ═════════════╗
  764.         ║                                      ║
  765.         ║    Argument Number  1· ▄             ║
  766.         ║    ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀             ║
  767.         ║    Prompt   Save to file         ▄   ║
  768.         ║    ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀   ║
  769.         ║    Copy to  String A  ▄              ║
  770.         ║    ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀              ║
  771.         ║    Timeout  0     ▄                  ║
  772.         ║    ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀                  ║
  773.         ║                                      ║
  774.         ║           OK    ▄     Cancel  ▄      ║
  775.         ║        ▀▀▀▀▀▀▀▀▀▀    ▀▀▀▀▀▀▀▀▀▀      ║
  776.         ╚══════════════════════════════════════╝
  777. ■
  778.  
  779.  
  780. [File]
  781. The `1File`0 menu is used to execute all script file related
  782. commands.  Script files can be created, opened, saved, saved
  783. to another file, inserted into the current script, or
  784. printed to a printer.
  785.  
  786. ■
  787.  
  788. [New]
  789. The `1New`0 menu item in the `1File`0 menu is used to create 
  790. a new script file. You will be prompted for a file name when
  791. the file is saved.
  792. ■
  793.  
  794. [Open...]
  795. The `1Open`0 menu item in the `1File`0 menu is used to edit
  796. a script file that already exists. The current script file
  797. will be saved to disk, if necessary.
  798.  
  799. ■
  800.  
  801. [Save]
  802. The `1Save`0 menu item in the `1File`0 menu is used to save
  803. changes that were made to the script.
  804. ■
  805.  
  806. [SaveAs...]
  807. The `1SaveAs...`0 menu item in the `1File`0 menu is used to save
  808. the current script to a file with a different name.
  809. ■
  810.  
  811. [Insert File]
  812. The `1Insert File`0 menu item in the `1File`0 menu is used to 
  813. insert the contents of another script file into the current
  814. script. The contents are added into the current script at the
  815. row that is currently highlighted.
  816.  
  817. `1GoScript`0 will attempt to merge all labels and label 
  818. references of the script being inserted with those of the
  819. script currently being edited. If the same label is defined
  820. by both scripts, `1GoScript`0 will notify you of the
  821. situation. It will not attempt to rename the labels, it is
  822. up to you to do so.  
  823.  
  824. ■
  825.  
  826. [Print...]
  827. The `1Print...`0 menu item in the `1File`0 menu is used to print
  828. the script to a file. When selected, you will be prompted to 
  829. select the printer port that you printer is using.
  830. ■
  831.  
  832. [Exit]
  833. The `1Exit`0 menu item in the `1File`0 menu is used to quit
  834. `1GoScript`0. If the script was modified, `1GoScript`0 will 
  835. prompt to save the file before exiting. 
  836. ■
  837.  
  838. [Edit]
  839. The `1Edit`0 menu is used to cut/paste script items to/from
  840. the Clipboard, delete the current script item, and to add
  841. and delete labels used in the script.
  842. ■
  843.  
  844. [Cut]
  845. The `1Cut`0 menu item in the `1Edit`0 menu will delete the
  846. current script item from the script and copy it to the 
  847. Clipboard. Once it is in the Clipboard, use `1Paste`0 to
  848. copy it to the current location in the script.
  849. ■
  850.  
  851. [Copy]
  852. The `1Copy`0 menu item in the `1Edit`0 menu will copy the
  853. current script item from the script and copy it to the 
  854. Clipboard. Once it is in the Clipboard, use `1Paste`0 to
  855. copy it to the current location in the script. Note this 
  856. `1Copy`0 is different from `1Cut`0 in that it does not delete
  857. the script item from the script.
  858. ■
  859.  
  860. [Paste]
  861. The `1Paste`0 menu item in the `1Edit`0 menu is used to insert
  862. copy the contents of the Clipboard into the script at the 
  863. current location.
  864. ■
  865.  
  866. [Delete Line]
  867. The `1Delete`0 menu item in the `1Edit`0 menu is used to remove
  868. the current script item from the script. The script item is 
  869. not saved in the Clipboard.
  870.  
  871. see also `4Cut`0, `4Copy`0, and `4Paste`0
  872. ■
  873.  
  874. [Labels...]
  875. The `1Labels...`0 menu item in the `1Edit`0 menu is used to edit
  876. the list of labels used in the script. The `1Labels Maintenance`0
  877. dialog box will be presented so that labels may be added or 
  878. deleted.
  879.  
  880.      ╔════════════ Label Maintenance ═══════════╗
  881.      ║                                          ║
  882.      ║  ┌────── Label ──────┐                   ║
  883.      ║  │- END              ▓        Add... ▄   ║
  884.      ║  │                   ▓      ▀▀▀▀▀▀▀▀▀▀   ║
  885.      ║  │                   ▓       Remove  ▄   ║
  886.      ║  │                   ▓      ▀▀▀▀▀▀▀▀▀▀   ║
  887.      ║  │                   ▓        Use    ▄   ║
  888.      ║  │                   ▓      ▀▀▀▀▀▀▀▀▀▀   ║
  889.      ║  │                   ▓        Done   ▄   ║
  890.      ║  └──────────────────        ▀▀▀▀▀▀▀▀▀▀   ║
  891.      ║   -: label not in script                 ║
  892.      ╚══════════════════════════════════════════╝
  893.  
  894. ■
  895.  
  896.  
  897. [Add]
  898. The `1Add`0 menu is used to add script commands.
  899. ■
  900.  
  901. [Detail]
  902. The `1Detail`0 menu is used to modify a script command. Not
  903. all script commands have a detail dialog box. A `2+`0 sign
  904. will be displayed to the right of the current script command
  905. if it has a detail dialog box.
  906.  
  907. ■
  908.  
  909. [Help]
  910. The `1Help`0 menu consists of commands to invoke the help 
  911. system or to display program information.
  912. ■
  913.  
  914. [Topics]
  915. The `1Topics`0 menu item will display the `1Help`0 topics for
  916. `1GoScript`0.
  917. ■
  918.  
  919. [Help On Help]
  920. The `1Help On Help`0 menu item will display help for the
  921. current script command. Pressing `2F1`0 will also do the same.
  922.  
  923. ■
  924.  
  925.  
  926. [About]
  927. The `1About`0 menu item displays information about `1GoScript`0
  928. and the number of lines in the script and how much memory is
  929. left for the script.
  930. ■
  931.  
  932. @@EndHelp
  933.