home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / ibm1 / do101j1.arj / DOINFO.TXT < prev    next >
Encoding:
Text File  |  1991-12-30  |  10.4 KB  |  284 lines
  1. the DO script processor  SUMMARY OF FUNCTIONS
  2.  
  3. START:            DO [{ScriptFile} [{parameters}] [/e|/r]]
  4.  
  5. TEXT VARIABLES:   %{variable name}[({format option}{length})]
  6.  
  7. NUMERIC VARIABLES %{variable name}({format})
  8.  
  9. SPECIAL VARIABLES
  10.  
  11.     {script} Full Path name of current script
  12.     {date}   current date ("MM/DD/YY")
  13.     {time}   current time ("HH:MM:DD");
  14.     {home}   home directory.
  15.     {X}      cursor column position
  16.     {Y}      cursor row position
  17.  
  18. RESERVED VARIABLES
  19.  
  20.     EDIT external editor to be used in place of DO's built in editor
  21.     LIST external file lister other than LIST.COM
  22.  
  23. SPECIAL CHARACTERS: ~{number}
  24.  
  25. PARAMETER PASSING:  [C:> | /]{script} {script01} {script02} . . .
  26.  
  27. COMMENTS: *{Comment}
  28.  
  29. STRING FUNCTIONS
  30.  
  31.     @cpy({string},{start},{length})
  32.     @del({string},{start},{length})
  33.     @ins({string},{target},{position})
  34.     @len({string})
  35.     @pos({string},{target})
  36.     @trim({string},{target},L|R|B)
  37.  
  38. DATE AND TIME FUNCTIONS
  39.  
  40.     @date({DateString})
  41.     @time({TimeString})
  42.     @dtst({Days})
  43.     @tmst({seconds})
  44.     @day({DateString})
  45.  
  46. MISCELLANEOUS FUNCTIONS
  47.  
  48.     @math({calculation})
  49.  
  50. COMMANDS: /{command} {token1} "{token 2}"  ... {token19}
  51.  
  52.     /ASK {variable} {Default} {Prompt} {maxlength} UC
  53.     /BOX {left} {top} {right} {bottom} {fc} {hc} {heading}
  54.     /FRAME {v} {h} {Lr} {ur} {ll} {ul}
  55.     /CAL {Row} {Column}
  56.     /CANCEL [ALL|ONE]
  57.     /CD {directory}
  58.     /CHAIN {path} {command line}
  59.     /CLEAR [ALL|CURRENT|{variable}]
  60.     /CLOCK {OFF|ON|STD} [{Row} {Column}]
  61.     /CLOSE {handle}
  62.     /CLOSECOM {Drop DTR}
  63.     /CWAIT [{timeout}]
  64.     /DEBUG [ON|OFF|FULL|MEM]
  65.     /DELWAIT {{variable}|ALL}
  66.     /DIAL {string}
  67.     /DIR {pattern} {$[F|P|E]}
  68.     /DISP[LAY][ {display parameters}]
  69.     /DOCUMENT/DOCUMENT {ON|OFF}
  70.     ![{flags};]{command}
  71.     /DRAW,{V|H},{{row}|{col}},{start},{end}[,{speed}[,{character}]]
  72.     /EDIT {filename}
  73.     /ERASE {Filename} [n]
  74.     /{ScriptName}[{parameter1}...]
  75.     /ENDEXEC CLEAR
  76.     /EXIST {Filename}
  77.     /FLUSHCOM [{OUT|IN|BOTH}]
  78.     /GD {variable}
  79.     /GETC[HARACTER] {Prompt} {List} [{variable}] [LC]
  80.         No {variable} stored in CHAR.
  81.     /GOSUB {Label} {param01} {param02} . . .
  82.     /GOTO {Label} [[{Default}] ASIS]
  83.     /GOTOC {Prompt} {List}[ {variable}][ LC]
  84.         No {variable} stored in CHAR.
  85.     /HALT [{ReturnCode}]
  86.     /IF {value1} {EQ|LT|GT|NE|GE|LE|LK} {value} [[{else label}][ ASIS]]
  87.     /{INC|DEC} {variable}[ {value}]
  88.     /INITCOM {port} {baud} [{parity} {data} {stop} {string}]
  89.     /INKEY [{key}] [{label}]
  90.     /LIST {filename}
  91.     /LOOK {row} {column} {length}
  92.     /MACROS {OFF|ON {macro file}}
  93.     /MATH {Variable} {Formula}
  94.     /MD {directory} [n]
  95.     /OPEN {handle} {filename} {mode} [{extension}] [{label}]
  96.     /PAGE {{-}line number}
  97.     /PARSE[ "{parameters}"]
  98.     /PASSWORD {filename} {pattern} {seed}
  99.     /PAUSE {seconds} [{parameter1} ... {parameter18}]
  100.     /PAGEPROMPT[ {Prompt}]
  101.     /PRINT {FileName}
  102.     /RD {directory} [N]
  103.     /READ {handle} {delimiters} {variable} {variable} . . .
  104.     /RENAME {Filename} {NewName}
  105.     /REPEAT
  106.     /UNTIL {value1} [EQ/LT/GT/NE/GE/LE/LK] {value}[[{else label}]
  107.     /RETRIEVE on | off
  108.     /RETURN
  109.     /RETURNCODE [{code}]
  110.     /SEND {string}
  111.     /SETCOMDELAY {milli-seconds}
  112.     /SETWAIT {variable} {string}
  113.     /STOP [{label}]
  114.     /SUBST {variable} {string} {target} {phrase} [{start}]
  115.     /TERM {initstring} {x1} {y1} {x2} {y2}
  116.     /VERSION
  117.     /WALK {L|R} {row} {start} {line} {speed}
  118.     /WRITE {handle}[ ["]{line}[&]["]
  119.  
  120. DISPLAY CONTROL PARAMETERS: .{parameter 1} {parameter 2} .. {parameter 20}
  121.  
  122.     WI[NDOW] [{X Y X Y}|{FULL}]
  123.     SP[EED] {millisecond delay}
  124.     FAST
  125.     CLICK
  126.     QU[IET]
  127.     C {foreground} {background}
  128.         Black        =  0
  129.         Blue         =  1
  130.         Green        =  2
  131.         Cyan         =  3
  132.         Red          =  4
  133.         Magenta      =  5
  134.         Brown        =  6
  135.         LightGray    =  7 [#]
  136.         DarkGray     =  8 [gy]
  137.         LightBlue    =  9 [bl]
  138.         LightGreen   = 10 [gr]
  139.         LightCyan    = 11 [cy]
  140.         LightRed     = 12 [re]
  141.         LightMagenta = 13 [ma]
  142.         Yellow       = 14 [ye]
  143.         White        = 15 [wh]
  144.         +    blink (before color)
  145.  
  146.     CLR
  147.     BELL
  148.     PAGE (PG)
  149.     GO[TO] {column} {row}
  150.     PA[USE] {seconds}
  151.     RE[SET]
  152.     STD  is the same as C 7 0 QUIET FAST
  153.          (it resets the default DO display parameters)
  154.     BO   is the equivalent of C 7 0
  155.     UL   is the equivalent of C 1 0
  156.     #    resets the display to C 7 0 (white on black)
  157.     TYPE is the equivalent of SPEED 75 CLICK
  158.  
  159. /IF Operators and Wildcard Characters
  160.  
  161.     EQ    - {value1} equal to {value}
  162.     LT    - {value1} less than {value}
  163.     GT    - {value1} greater than {value}
  164.     NE    - {value1} not equal to {value}
  165.     GE    - {value1} greater than or equal to {value}
  166.     LE    - {value1} less than or equal to {value}
  167.     IN    - {value1} appears in {value}
  168.     LK    - {value1} matches pattern in {value}
  169.     NL    - {value1} does not match the pattern in {value}
  170.  
  171.     ?    = Any character
  172.     #   = Any integer
  173.     \   = next character is literal
  174.     *   = any string of characters
  175.     []  = Groups characters inclusive
  176.     [~]     = Groups characters exclusive
  177.     U   = Any uppercase letter
  178.     L   = any lower case letter
  179.     @   = Any alphabetic character
  180.     {|} = Groups of phrases
  181.     >   = Goto end of phrase
  182.  
  183. /MATH Operators and Functions
  184.  
  185.     +   Addition        /   Division
  186.     -   Subtraction     ^   Exponentiation
  187.     *   Multiplication  ()  Grouping
  188.  
  189.     ABS     Returns the absolute value of the argument
  190.     ATAN    Returns the arctangent of the argument
  191.     COS     Returns the cosine of the argument
  192.     EXP     Returns the exponential
  193.     LN      Returns the natural logarithm of the argument
  194.     ROUND   Rounds a real number to an integer
  195.     SIN     Returns the sine of the argument
  196.     SQRT    Returns the square root of the argument
  197.     SQR     Returns the square of the argument
  198.     TRUNC   Truncates a real to an integer
  199.  
  200. /PASSWORD Wildcard Characters
  201.  
  202.     ? = any character from the sets below
  203.     $ = any alpha character (ABCDEFGHIJKLMNOPQRSTUVWXYZ)
  204.     # = any numeric character (0123456789)
  205.     % = any special character (!#$^&*()<>?+=)
  206.  
  207.  
  208. Interactive Mode Command Line Edit Keys
  209.  
  210.     Quit and clear line ........................... <ctrl-break> <esc>
  211.     Beginning of line ............................. <home> <ctrl-q><ctrl-s>
  212.     Left one character ............................ <left arrow> <ctrl-s>
  213.     Right one character ........................... <right arrow> <ctrl-d>
  214.     End of line ................................... <end>
  215.     Toggle insert mode (insert default) ........... <ins>
  216.     Delete character under cursor ................. <del> <ctrl-g>
  217.     Left one word ................................. <ctrl-left arrow>
  218.     Right one word ................................ <ctrl-right arrow> <ctrl-f>
  219.     Delete to end of line ......................... <ctrl-end> <ctrl-q><ctrl-y>
  220.     Delete to beginning of line ................... <ctrl-home>
  221.     Delete character to left of cursor ............ <backspace> <ctrl-h>
  222.     Execute Command ............................... <enter> <ctrl-m>
  223.                                                     <ctrl-q><ctrl-d>
  224.     Enter Control Character ....................... <ctrl-p>
  225.      (next character will be entered as is)
  226.     Restore original command ...................... <ctrl-r> <ctrl-q><ctrl-l>
  227.     Delete Word ................................... <ctrl-t>
  228.     Delete command ................................ <ctrl-x> <ctrl-y>
  229.  
  230. Built-in Editor Commands
  231.  
  232.     Character left                     <Ctrl-S> or <Left Arrow>
  233.     Character right                    <Ctrl-D> or <Right Arrow>
  234.     Word left                          <Ctrl-A> or <Ctrl-Left Arrow>
  235.     Word right                         <Ctrl-F> or <Ctrl-Right Arrow>
  236.     Line up                            <Ctrl-E> or <Up Arrow>
  237.     Line down                          <Ctrl-X> or <Down Arrow>
  238.     Scroll up                          <Ctrl-W>
  239.     Scroll down                        <Ctrl-Z>
  240.     Page up                            <Ctrl-R> or <PgUp>
  241.     Page down                          <Ctrl-C> or <PgDn>
  242.     Beginning of file                  <Ctrl-Q> R or <Ctrl-PgUp>
  243.     End of file                        <Ctrl-Q> C or <Ctrl-PgDn>
  244.     Beginning of line                  <Ctrl-Q> S or <Home>
  245.     End of line                        <Ctrl-Q> D or <End>
  246.     Top of screen                      <Ctrl-Q> E or <Ctrl-Home>
  247.     Bottom of screen                   <Ctrl-Q> X or <Ctrl-End>
  248.     Top of block                       <Ctrl-Q> B
  249.     Bottom of block                    <Ctrl-Q> K
  250.     Jump to marker 0..3                <Ctrl-Q> 0..<Ctrl-Q> 3
  251.     Set market 0..3                    <Ctrl-K> 0..<Ctrl-K> 3
  252.     Previous cursor position           <Ctrl-Q> P
  253.     New line                           <Ctrl-M> or <Enter>
  254.     Insert line                        <Ctrl-N>
  255.     Insert control character           <Ctrl-P> {character}
  256.     Tab                                <Ctrl-I> or <Tab>
  257.     Delete current character           <Ctrl-G> or <Del>
  258.     Delete character left              <Ctrl-H> or <Backspace>
  259.     Delete word                        <Ctrl-T>
  260.     Delete to end of line              <Ctrl-Q> Y
  261.     Delete line                        <Ctrl-Y>
  262.     Find                               <Ctrl-Q> F
  263.     Find-and-replace                   <Ctrl-Q> A
  264.     Find next                          <Ctrl-L>
  265.     Begin block                        <Ctrl-K> B or <F7>
  266.     End block                          <Ctrl-K> K or <F8>
  267.     Copy block                         <Ctrl-K> C
  268.     Move block                         <Ctrl-K> V
  269.     Delete block                       <Ctrl-K> Y
  270.     Hide block                         <Ctrl-K> H
  271.     Mark current word as block         <Ctrl-K> T
  272.     Read block from file               <Ctrl-K> R
  273.     Write block to file                <Ctrl-K> W
  274.     Print block                        <Ctrl-K> P
  275.     Toggle insert mode                 <Ctrl-V> or <Ins>
  276.     Toggle autoindent mode             <Ctrl-O> I
  277.     Toggle fixed tabs                  <Ctrl-O> T
  278.     Restore Line                       <Ctrl-Q> L
  279.     Exit editor (save file)            <Ctrl-K> D or <Alt-X> or <F10>
  280.     Quit editor (no save)              <Ctrl-K> Q
  281.  
  282.     Enter start- & end-parameter
  283.     symbols (/E, /R only)              <F1>
  284.