home *** CD-ROM | disk | FTP | other *** search
/ Hall of Fame / HallofFameCDROM.cdr / util1 / smstr32c.lzh / SM07.DOC < prev    next >
Text File  |  1991-01-21  |  10KB  |  301 lines
  1.  
  2.      -------------------------------------------------------------------------
  3.      SECTION 7   Batch Command Reference
  4.      -------------------------------------------------------------------------
  5.  
  6.      7.1    Batch Primer
  7.  
  8.             A detailed description of DOS or its function would be a
  9.             long and lengthy undertaking. So, in order to make this
  10.             text as brief and meaningful as possible, each individual
  11.             Batch command will be touched upon as it pertains to the
  12.             SYSTEM MASTER command Processor.  (See the DOS Manual for
  13.             your particular version of DOS for detailed descriptions
  14.             of each of the following commands).
  15.  
  16.  
  17.             Batch Commands (Listing)(DOS ver 3.3 specific)
  18.  
  19.  
  20.                             :label
  21.                             @
  22.                             %#
  23.                             %string%
  24.                             CALL
  25.                             ECHO
  26.                             FOR
  27.                             GOTO
  28.                             IF ERRORLEVEL
  29.                             IF EXIST
  30.                             IF s1==s2
  31.                             PAUSE
  32.                             REM
  33.                             SHIFT
  34.  
  35.  
  36.  
  37.             All Batch commands may be executed with the SYSTEM MASTER
  38.             shell using batch conventions.
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.      Release Date: 21 January, 1991
  59.      -------------------------------------------------------------------------
  60.      System Master 3.2                                              Page  7- 1
  61.  
  62.      -------------------------------------------------------------------------
  63.      SECTION 7   Batch Command Reference
  64.      -------------------------------------------------------------------------
  65.  
  66.      7.2    Batch Command Descriptions
  67.  
  68.             7.2.1   :label
  69.  
  70.                     The :label command is not a true command, but is
  71.                     instead a tag to which GOTO instructions are
  72.                     routed within a batch file. A 'label' can be any
  73.                     valid label tag as described within your DOS manual.
  74.  
  75.                     Format:  :label
  76.  
  77.                     Exampl:  if NOT EXIST bogusfil.txt GOTO exitbatch
  78.                              del bogusfil.txt
  79.                              :exitbatch
  80.                              cls
  81.  
  82.                              This example first checks for the existance of
  83.                              a disk file called 'bogusfil.txt'.  If the file
  84.                              exists, it is deleted.  if it does not exist,
  85.                              processing jumps to the 'exitbatch' label and,
  86.                              and the batch file clears the CRT and terminates
  87.                              normally.
  88.  
  89.             7.2.2   @
  90.  
  91.                     The @ command is not a true command, but it is instead
  92.                     a filter which allows batch commands to be executed
  93.                     without displaying the batch commands on the CRT.
  94.                     This command is available starting with version 3.3
  95.                     DOS.  Using this command with earlier versions of DOS
  96.                     will cause SYSTEM MASTER to operate incorrectly.
  97.  
  98.                     Format:  @command
  99.  
  100.             7.2.3   %n
  101.  
  102.                     The %n command is not a true command but is instead a
  103.                     means by which DOS passes input parameters to command
  104.                     files which use them.  'n' can be any positive integer
  105.                     value in the range 1..9 (SYSTEM MASTER requirement).
  106.  
  107.                     Other normal DOS Input parameter passing requirements
  108.                     remain in effect.
  109.  
  110.             7.2.4   %string%
  111.  
  112.                     The %string% command is not a true command but is instead
  113.                     a means by which program variables are passed to and from
  114.                     the DOS environment.  'string' represents any valid
  115.                     DOS Environmental variable assigned using the 'SET'
  116.                     command.
  117.  
  118.      Release Date: 21 January, 1991
  119.      -------------------------------------------------------------------------
  120.      System Master 3.2                                              Page  7- 2
  121.  
  122.      -------------------------------------------------------------------------
  123.      SECTION 7   Batch Command Reference
  124.      -------------------------------------------------------------------------
  125.  
  126.             7.2.5   CALL
  127.  
  128.                     The CALL command allows a batch file to be executed from
  129.                     within another batch file without terminating the first
  130.                     batch file.  This command allows batch files to be
  131.                     processed as commands within other batch files.
  132.  
  133.                     Format:  CALL another.bat
  134.  
  135.                     This command is available starting with version 3.3
  136.                     DOS.  Using this command with earlier versions of DOS
  137.                     will cause SYSTEM MASTER to operate incorrectly.
  138.  
  139.             7.2.6   ECHO
  140.  
  141.                     The ECHO command has 3 functions:
  142.                        1)  to turn echoing of screen commands ON.
  143.                        2)  to turn echoing of screen commands OFF.
  144.                        3)  to display a text string on the CRT.
  145.  
  146.                     Format:  ECHO ON
  147.  
  148.                     Format:  ECHO OFF
  149.  
  150.                     Format:  ECHO This String Will be Displayed!
  151.  
  152.             7.2.7   FOR
  153.  
  154.                     The FOR command allows repetitive execution (Looping) of
  155.                     DOS commands.
  156.  
  157.                     Format:  FOR %%variable IN (set) DO command
  158.  
  159.             7.2.8   GOTO
  160.  
  161.                     The GOTO command allows branching within a batch file.
  162.                     when a GOTO command is encountered in a batch file
  163.                     processing continues at the 'label' specified.
  164.  
  165.                     Format:  GOTO label
  166.  
  167.                     Exampl:  if NOT EXIST bogusfil.txt GOTO exitbatch
  168.                              del bogusfil.txt
  169.                              :exitbatch
  170.                              cls
  171.  
  172.                              This example first checks for the existance of
  173.                              a disk file called 'bogusfil.txt'.  If the file
  174.                              exists, it is deleted.  if it does not exist,
  175.                              processing jumps to the 'exitbatch' label and,
  176.                              and the batch file clears the CRT and terminates
  177.                              normally.
  178.      Release Date: 21 January, 1991
  179.      -------------------------------------------------------------------------
  180.      System Master 3.2                                              Page  7- 3
  181.  
  182.      -------------------------------------------------------------------------
  183.      SECTION 7   Batch Command Reference
  184.      -------------------------------------------------------------------------
  185.  
  186.             7.2.9   IF [NOT] ERRORLEVEL
  187.  
  188.                     The IF ERRORLEVEL command checks for errorcodes returned
  189.                     from some DOS commands and provides those codes to the
  190.                     batch processor.
  191.  
  192.                     Exampl:  replace bogusfil.txt a:\
  193.                              IF ERRORLEVEL 2 then goto :exitbatch
  194.                              :exitbatch
  195.                              echo File Not Found
  196.  
  197.                              This example first attempts to replace a disk
  198.                              file called 'bogusfil.txt'.  If ERRORLEVEL is 2,
  199.                              processing jumps to the 'exitbatch' label, and
  200.                              the batch file displays an error message and
  201.                              terminates normally.
  202.  
  203.             7.2.10  IF [NOT] EXIST
  204.  
  205.                     The IF EXIST command checks for the existance or non-
  206.                     existance of a disk file.
  207.  
  208.                     Exampl:  if NOT EXIST bogusfil.txt GOTO exitbatch
  209.                              del bogusfil.txt
  210.                              :exitbatch
  211.                              cls
  212.  
  213.                              This example first checks for the existance of
  214.                              a disk file called 'bogusfil.txt'.  If the file
  215.                              exists, it is deleted.  if it does not exist,
  216.                              processing jumps to the 'exitbatch' label and,
  217.                              and the batch file clears the CRT and terminates
  218.                              normally.
  219.  
  220.             7.2.11  IF [NOT] s1==s2
  221.  
  222.                     The IF s1==s2 command compares 2 strings for equality.
  223.  
  224.                     Exampl:  if %1==STEVE ECHO STEVE IS USING THIS SYSTEM
  225.  
  226.             7.2.12  PAUSE
  227.  
  228.                     The PAUSE command suspends processing of the batch
  229.                     file until the user presses a key.  A Remark can be
  230.                     tagged to the PAUSE command for command clarity.
  231.  
  232.                     Exampl:  PAUSE Insert a New Diskette in Drive A
  233.  
  234.             7.2.13  REM
  235.  
  236.                     The REM command displays remarks from within a batch
  237.  
  238.      Release Date: 21 January, 1991
  239.      -------------------------------------------------------------------------
  240.      System Master 3.2                                              Page  7- 4
  241.  
  242.      -------------------------------------------------------------------------
  243.      SECTION 7   Batch Command Reference
  244.      -------------------------------------------------------------------------
  245.  
  246.                     file.  If ECHO is 'OFF' the remarks are NOT displayed.
  247.  
  248.                     Exampl:  REM If ECHO is ON this remark will be displayed
  249.  
  250.             7.2.14  SHIFT
  251.  
  252.                     The SHIFT command allows input parameters to exceed the
  253.                     DOS limit of 10 (0..9).
  254.  
  255.                     When the SHIFT command is used, %2 param becomes %1 ...
  256.                     and the last defined parameter becomes nul.
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.      Release Date: 21 January, 1991
  299.      -------------------------------------------------------------------------
  300.      System Master 3.2                                              Page  7- 5
  301.