home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 053.lha / manual < prev    next >
Text File  |  1986-11-20  |  43KB  |  1,051 lines
  1.                   * Copyright 1987 by 4th Works, Inc. *
  2.                * written by Steve Ahlstrom and Dan Moore *
  3.     * Support for this program to be found on CompuServe's AmigaForum *
  4.     
  5. -----------------------------------------------------------------------------
  6.  
  7.     This program is not public domain.  It is a freely distributable
  8.     copyrighted program with the following conditions:
  9.  
  10.     1)  The program and data files must be distributed in the exact
  11.         form and content as they were found on the original source of
  12.         distribution (AmigaForum on CompuServe).
  13.  
  14.     2)  A seperate file, meant to be incorporated into the manual file,
  15.         may be included in the distribution ARC file.
  16.         
  17.     3)  Any form of commercial sales of this program is specifically 
  18.         denied with the exception of those user groups or entities
  19.         selling "Public Domain Program Disks".  If this program is
  20.         included in such a collection, the disk containing this 
  21.         program may not sell for more than $8.00 (US currency).
  22.         
  23. ------------------------------------------------------------------------------
  24. #arc
  25. Arc ---- Archive utility, Version 0.23
  26. Syntax:  
  27.     ARC {amufdxerplvtc}[bswn][g<password>] <archive> [<filename> . . .]
  28.     
  29. Switches:   
  30.     a   = add files to archive
  31.     m   = move files to archive
  32.     u   = update files in archive
  33.     f   = freshen files in archive
  34.     d   = delete files from archive
  35.     x,e = extract files from archive
  36.     p   = copy files from archive to standard output
  37.     l   = list files in archive
  38.     v   = verbose listing of files in archive
  39.     t   = test archive integrity
  40.     c   = convert entry to new packing method
  41.     b   = retain backup copy of archive
  42.     s   = suppress compression (store only)
  43.     w   = suppress warning messages
  44.     n   = suppress notes and comments
  45.     g   = Encrypt/decrypt archive entry
  46. #Help
  47. Help -- An online help facility
  48. Syntax:
  49.     Help command_name
  50. Inputs:
  51.     command_name   Name of the command or function for which you are
  52.                    seeking help.  Example:  HELP ARC.  
  53.                    Since AmigaDOS is case insensitive, Help is also
  54.                    case insensitive.
  55.                    
  56.                           Copyright 1987 by 4th Works, Inc.
  57.          This program is not public domain.  It is a freely distributable
  58.          program with the following conditions:
  59.          
  60.          1)  The program and data files must be distributed in the exact
  61.              form and content as they were found on the original source of
  62.              distribution (AmigaForum on CompuServe).
  63.              
  64.          2)  A seperate file, meant to be incorporated into the manual file,
  65.              may be included in the distribution ARC file.  
  66.              
  67.  Support for this program to be found exclusively on AmigaForum on CompuServe
  68. #Assign
  69. Assign - assign a logical device name to a filing system directory.
  70. Syntax:
  71.     ASSIGN [[<name>]<dir>] [LIST]
  72.     
  73. Specification:
  74.     ASSIGN  with no  parameter s or with  the LIST  switch ("ASSIGN LIST")
  75.     displays all current assignments.  To remove the assignment, just give 
  76.     <name> by itself.
  77.  
  78. Example:
  79.     ASSIGN sources: ram:work/game  --
  80.          a "CD sources:" will put you in the ram:work/game directory.
  81.     ASSIGN sources:  -- 
  82.          this will remove the assignment of "sources:" to "ram:work/game"
  83. #Break
  84. Break - set the break flag
  85. Syntax:
  86.     BREAK <task> [ALL] [C] [D] [E] [F]
  87.     
  88. Specification:
  89.     BREAK sets  the specified  attention flags  in the process.  C sets the
  90.     CTRL-C flag, D  sets the  CTRL-D flag,  etc.  AmigaDOS  only  sets  the
  91.     CRTL-C flag.  If the program is not written to look for these attention
  92.     flags, the process will continue to run until normal termination.
  93.  
  94. Example:
  95.     BREAK 7 sets the CTRL-C attention flag of process 7.
  96.     BREAK 5 D sets the CTRL-D attention flag of process 5.
  97.     BREAK 3 D E sets both CTRL-D and CTRL-E in process 3.
  98.     BREAK 4 ALL sets all frags in process 4.
  99. #CD
  100. CD - changes the current default directory or drive.
  101. Syntax:
  102.     CD [<dir>]
  103.  
  104. Specification:
  105.     CD  with  no  parameters  displays  the name  of  the current directory.
  106.     "CD TEST"  will change the current directory to TEST if test exists as a
  107.     subdirectory in the current directory.  
  108.     If you are in a subdirectory, "CD /" will move you up one level, "CD //" 
  109.     will move you up 2 levels, etc.
  110.     "CD :" will move you to the root directory of the logged drive.
  111.     "CD dfn:"  sets the current drive to dfn:  and the  current directory to 
  112.     the root directory of dfn:
  113.     
  114. Example:
  115.     "CD df1:work" sets the current directory to 'work' on disk 'df1:' and 
  116.     sets current drive to df1:.
  117. #Copy
  118. Copy - copy a file or directory from one place to another
  119. Syntax:
  120.     COPY [[FROM] <name>] [TO] <name>] [ALL] [QUIET]
  121.  
  122. Specification:
  123.     Copy places a copy of the file or directory specified as TO.  
  124.  
  125.     If you specify a directory name as FROM,  COPY copies all the files in 
  126.     the FROM directory to the TO directory.   The TO directory must exist.
  127.  
  128.     If you specify ALL,  COPY also copies the files in any subdirectories.
  129.     It automatically creates subdirectories in the TO directory as needed. 
  130.  
  131. Example:
  132.     COPY FROM file1 TO :work/file2          COPY file1 TO :work/file2
  133.     COPY file1 :work/file2                  COPY :wrk :work ALL
  134. #Addbuffers
  135. ADDBUFFERS - adds cache buffers to disk to reduce access time
  136. Syntax:
  137.     ADDBUFFERS <drive> <##>
  138.  
  139. Specification:
  140.     DOS 1.2  uses disk sector caching in memory to speed up disk accesses. 
  141.     This  command  allows the  user to  significantly  increase the access
  142.     times.  The amount of available RAM will be decreased by approximately
  143.     500 bytes for each buffer added.
  144.  
  145.     NOTE: Adding more than 25-30 buffers will not enhance speed greatly.
  146.  
  147. Example:
  148.     ADDBUFFERS DF0: 12  --
  149.          This will add 12 disk cache buffers drive DF0:
  150. #Date
  151. DATE -- display or set the system date.
  152. Syntax:
  153.     DATE [<date>] [<time>] [TO|VER <name>]
  154.  
  155. Specification:
  156.     DATE with no parameters displays the currently set system date and time.
  157.     Time is displayed using a 24-hour clock.  The earliest date which can be 
  158.     set is 01-JAN-78.  
  159.  
  160.     <date>    is of the form DD-MMM-YY, with MMM being the first three 
  161.               letters of the month.  
  162.     <time>    is of the form HH:MM (i.e. HOURS:MINUTES).  Use leading zeros.
  163.  
  164. Example:
  165.     DATE --                  displays the current date and time.
  166.     DATE 16:30 14-Feb-87 --  set date to Wednesday, Feb. 14, 1987 at 4:30 PM.
  167.     DATE 16:30 --            set time only to 4:30 PM.
  168.     DATE 14-Feb-87 --        set date only to Feb. 14, 1987
  169. #Delete
  170. DELETE - deletes specified files or directories.
  171. Syntax:
  172.     DELETE <name> [<name> ...] [ALL] [QUIET]
  173.  
  174. Specification:
  175.     <name>  Any file or directory name.  Patterns may also be used to 
  176.             specify the filename or directory levels, and/or files.
  177.  
  178.     ALL     If  ALL  is specified with  a directory name,  DELETE  will
  179.             delete all files in that directory and it's subdirectories.
  180.             Otherwise, a directory must be empty to be deleted.
  181.  
  182.     QUIET   Do not display names of files being deleted.
  183.  
  184. Example:
  185.     DELETE work/file1 work/file2 work --
  186.          deletes "file1" and "file2" from the directory "work" and then
  187.          deletes the directory "work".
  188.     DELETE DF1:#?.txt ALL -- deletes all files on DF1: ending in ".txt".
  189. #Dir
  190. DIR - display a sorted directory listing.
  191. Syntax:
  192.     DIR [<name>] [OPT A | I | A I | D | K]
  193.  
  194. Specification:
  195.     Provides a list of the files in a directory in sorted order.  
  196.  
  197.     <name>  Must be a directory name.  If omitted, the files in the current
  198.             directory will be displayed.  
  199.             
  200.     OPT is a keyword that passes options to DIR.
  201.          A - option  is  used  to  include  any  subdirectories  below  the
  202.              specified one in the list.  Each sublist of files is indented.
  203.          D - when this option is used, only directory names will be listed.
  204.  
  205. Example:
  206.     DIR --            lists the files in the default directory.
  207.     DIR DF1: OPT A -- 
  208.               lists all directories, subdirectories, and files on "DF1:"
  209.     DIR RAM: OPT D -- lists all directory names on "RAM:".
  210. #Echo
  211. ECHO - displays the text string given.
  212. Syntax:
  213.     ECHO <string>
  214.  
  215. Specification:
  216.     Echo writes  the single string  argument to  the current output stream, 
  217.     which can be a  file or a device.   Normally this is only useful within
  218.     a command sequence or as part of a RUN command.  If the string is given
  219.     incorrectly, an error is displayed.  The string must be enclosed in 
  220.     quotes (""). 
  221.  
  222. Example:
  223.     ECHO "" -- this will display a blank line to the screen.
  224.     ECHO "Please insert the test disk in the internal drive..." --
  225.          is a typical prompt for user action from within a command sequence.
  226. #BindDrivers
  227. BINDDRIVERS - allows user to bind device drivers for new hardware to DOS
  228. Syntax:
  229.     BINDDRIVERS
  230.  
  231. Specification:
  232.     (usually used as a batch command in the  "s/startup-sequence" boot file)
  233.     This command is used to connect new hardware to AmigaDOS.  The way this
  234.     is done is to bind the device driver software provided with the hardware
  235.     into Workbench.   Then when the user selects the device's icon, DOS will
  236.     use the driver to access the device.  BINDDRIVERS will cause DOS to bind
  237.     in ANY new drivers that it finds in the directory "SYS:Expansion".
  238.  
  239. Example:
  240.     Copy the device driver to the "SYS:Expansion" directory.
  241.     Add the BINDDRIVERS command to the file "s/startup-sequence", which
  242.     will be automatically executed whenever you boot DOS.
  243. #Diskcopy
  244. DISKCOPY - copies the contents of one 3.5" diskette to another.
  245. Syntax:
  246.     DISKCOPY [FROM] <disk> TO <disk> [NAME <disk>]
  247.  
  248. Specification:
  249.     DISKCOPY copies  the entire contents of the disk you specified as FROM,
  250.     overwriting the previous contents  of the  entire disk specified as TO.
  251.     If you specify NAME,  the new disk is renamed.   If needed, the TO disk
  252.     will be formatted as it is copied.  If the TO disk contains data before
  253.     the DISKCOPY,  it will be lost.   Once the command is entered,  you are
  254.     prompted  to  insert the source  and destination  disks.  If you do not 
  255.     specify a  <NAME>  for the destination disk, the new disk will have the
  256.     same name.
  257.  
  258. Example:
  259.     DISKCOPY DF0: TO DF0: NAME "Data" --
  260.          copies the disk in drive DF0: using only one drive with new name 
  261.          "Data".
  262. #DiskChange
  263. DISKCHANGE - indicates that the disk in a 5-1/4" drive has been changed
  264. Syntax:
  265.     DISKCHANGE <drive>
  266.  
  267. Specification:
  268.      Unlike the Amiga's 3-1/2" drives, which keep checking to see if a disk
  269.      has been changed in the drive,  the Amiga 5-1/4" drive just sits there.
  270.      It  doesn' t let DOS  know whether  you've swapped  disks or not.  This 
  271.      command should be used whenever you change the disk in the drive.
  272.  
  273. Example:
  274.     DISKCHANGE DF3: --
  275.          tells DOS that you just swapped the disk in drive DF3: for another
  276.          one.
  277. #Ed
  278. ED - a full-screen ASCII text editor (mouse not supported).
  279. Syntax:
  280.     ED [FROM] <name> [SIZE <n>]
  281.  
  282. Specification:
  283.     A very simple full-screen editor used to create/modify ASCII text files.
  284.  
  285.     <name>  Specifies the file you wish to edit.  If the FROM filename does 
  286.             not exist,  AmigaDOS creates a  new file.  The  keyword FROM is 
  287.             optional.
  288.  
  289.     SIZE    The complete file you are editing is held in memory.  The default
  290.             workspace  size  i s 40,000  bytes.   To  alter  the workspace, a
  291.             suitable value (in bytes) is specified after the SIZE keyword.
  292.  
  293. Examples:
  294.     ED df1:practice/test --
  295.          edits the file "DF1:practice/test". 
  296.     ED "My File" SIZE 60000 -- 
  297.          edits a large file named "My File" in the current directory,
  298.          using a memory workspace of 60,000 bytes (or characters).
  299. #Edit
  300. EDIT - a line-oriented ASCII text editor.
  301. Syntax:
  302.     EDIT [FROM] <name> [TO <name>] [WITH <name>] [VER <name>] [OPT <option>]
  303.  
  304. Specification:
  305.     A line-at-a-time editor used to modify ASCII text files.
  306.     FROM   Specifies an existing file you wish to edit. 
  307.     TO     TO  is the  output  filename,  if different  from the  input  FROM
  308.            filename. If a TO filename is given, the FROM file is not changed.
  309.     WITH   specifies a file containing  EDIT commands to be used in this EDIT
  310.            session.   If WITH is omitted,  EDIT will read  commands from  the
  311.            the terminal.
  312.     VER    editor messages  are  output  to  the file  specified.  If the
  313.            VER name is omitted, the output is sent to the terminal.
  314.     OPT    specifies editor options.  P# sets the max # of previous lines
  315.            (default=40).  W# sets the max line width (default=120).
  316.               
  317. Example:
  318.     EDIT Practice/Test TO Practice/Newtest --
  319.          edits the file "Practice/Test" the edited  result being saved to
  320.          "Practice/Newtest".  "Practice/Test" remains unchanged.
  321. #ChangeTaskPri
  322. ChangeTaskPri - changes the time-slice priority of the current CLI
  323. Syntax:
  324.     ChangeTaskPri <##>
  325.  
  326. Specification:
  327.     This command changes  the  CPU  time allocation priority  with which DOS
  328.     treats the current CLI window task.  Normal task priority is 0. Priority
  329.     should be changed to a positive number to increase it  and to a negative
  330.     number to decrease it.  The maximum priority values are  +127  to  -127,
  331.     but you should keep user tasks between  +5 and -5  to  avoid interfering
  332.     with DOS tasks; e.g. Intuition runs at priority 10.
  333.  
  334.     Tasks which are run from the changed CLI will also operate at the higher,
  335.     or lower, priority.
  336.  
  337. Example:
  338.      ChangeTaskPri 2 --
  339.          this will give the CLI task where the command is given, as well
  340.          as all successive programs running under it,  a slightly higher
  341.          priority than regular tasks.  This means that DOS will allocate
  342.          more CPU time to tasks running under this CLI than others.
  343. #DiskDoctor
  344. DISKDOCTOR - fixes corrupted disks with soft errors (not defects!)
  345. Syntax:
  346.     DISKDOCTOR <drive>
  347.  
  348. Specification:
  349.     Whenever a  diskette is inserted in a  3-1/2" drive,  DOS attempts to
  350.     verify whether the disk is valid.  If DOS fails to validate the disk,
  351.     it will let you know.  So that you don't lose all your information on
  352.     the disk, you should try to restore the  disk using this command.  If
  353.     DISKDOCTOR fails, the error is likely a physical defect!
  354.  
  355. Example:
  356.     DISKDOCTOR DF1: -- 
  357.          This will temporarily restore  MOST of the file  structure  on 
  358.          DF1:.   Your next step will be to format a blank disk and copy
  359.          all the files from the old disk to the new one using the  COPY
  360.          command.   You should  reformat the  old, restored  disk after
  361.          COPYing off your files.
  362. #EndCLI
  363. ENDCLI - ends an interactive CLI process.
  364. Syntax:
  365.     ENDCLI
  366.  
  367. Specification:
  368.      ENDCLI  can only be used  within a n active CLI window.   It closes the
  369.      CLI window and deletes the process from the list of currently executing
  370.      tasks. If the CLI was started from Workbench (using the CLI icon),  you
  371.      will be  returned to the Workbench.   If you used  NEWCLI to  open  the
  372.      current  CLI  from a previous one,  then you  will be  returned to that 
  373.      previous CLI.   Note that if you  do not have  Workbench  loaded,  then
  374.      ending the  startup CLI with no  other CLI open gives  you no way doing
  375.      anything else other than rebooting using CTRL-AMIGA-AMIGA.
  376. #Run
  377. RUN - executes a command as a background process.
  378. Syntax:
  379.     RUN <command>
  380.  
  381. Specification:
  382.      RUN creates a non-interactive Command Line Interface (CLI) process.
  383.      The background CLI executes  the commands then deletes itself.  The
  384.      new CLI has  the same command stack size as  the CLI from which you
  385.      executed RUN.
  386.      The background CLI commands will be executed simultaneously with 
  387.      commands given in the foreground CLI window. 
  388.      A plus sign <+>,  followed by a <RETURN>,  i s used  to  separate 
  389.      multiple commands.  However, a better method would be to create a
  390.      command sequence file (see the EXECUTE command), then RUN EXECUTE
  391.      the sequence.
  392.  
  393. Examples:
  394.     RUN "Sample" --
  395.          will execute the user application program "Sample" as a
  396.          background task. 
  397. #SetMap
  398. SETMAP - changes the keyboard definition map being used
  399. Syntax:
  400.     SETMAP <file>
  401.  
  402. Specification:
  403.      This command let's the user choose a different keyboard setup.
  404.  
  405. Example:
  406.      SETMAP :devs/keymaps/gb --
  407.          sets the keyboard to the keymap for Great Britain.
  408.      SETMAP usa --
  409.          resets to the default USA keymap (resident in DOS, not on disk).
  410. #Relabel
  411. RELABEL - changes the volume name of a diskette.
  412. Syntax:
  413.     RELABEL [DRIVE] <drive> [NAME] <name>
  414.  
  415. Specification:
  416.      RELABEL changes the volume name of a disk to the name you specify.
  417.      Volume names are set when you initialize a disk using Workbench or
  418.      FORMAT,  and may also be changed with Rename [Workbench menu]. The
  419.      max length is 30.
  420.  
  421. Example:
  422.      RELABEL df1: "Data Disk Backup" --
  423.          gives the name "Data Disk Backup" to the disk currently in drive
  424.          "DF1:"
  425. #Version
  426. VERSION - shows the current version numbers for KickStart and for WorkBench
  427. Syntax:
  428.     VERSION
  429.  
  430. Specification:
  431.     VERSION will display the current version numbers for the KickStart and
  432.     WorkBench code loaded. For example, KickStart 1.0 has a version number
  433.     of 29, while the version number for KickStart 1.1 is 31 and if you are
  434.     using DOS 1.2, the version number for KickStart 1.2 is 33.
  435. #Why
  436. WHY - explains why the previous command failed (if it did).
  437. Syntax:
  438.     WHY
  439.  
  440. Specification:
  441.      When a command fails,  a brief message  that something  went wrong is 
  442.      usually displayed  on the screen,  or else the screen  is  flashed by 
  443.      AmigaDOS.  If you enter  WHY immediately after the failure, a message
  444.      describing in somewhat more detail what sent wrong will be displayed.
  445.  
  446. Example:
  447.      you've entered:   TYPE DF1:
  448.      Amiga responds:   cannot open DF1:
  449.      you enter:        WHY
  450.      Amiga responds:   Last command failed because object not of
  451.                        required type.
  452. #Join
  453. JOIN - concatenates up to 15 files to form a new file.
  454. Syntax:
  455.     JOIN <name> <name> [<name>...] AS <name>
  456.  
  457. Specification:
  458.     Each of the specified files is appended to the last in the order
  459.     listed on the command line and output into the AS file.
  460.  
  461. Example:
  462.     JOIN part1 part2 part3 part4 AS book --
  463.          joins the  four files together  in the order listed,  with the
  464.          combined file being placed in "book".  The four original files
  465.          remain unchanged.
  466. #Fault
  467. FAULT - display a message about the fault codes supplied.
  468. Syntax:
  469.     FAULT [<n>...]
  470.  
  471. Specification:
  472.     AmigaDOS looks up the fault codes and displays the corresponding
  473.     messages.   Up to ten messages may be displayed.   Codes must be
  474.     separated by spaces. 
  475.  
  476. Example:
  477.     FAULT 103 221 218 --
  478.          displays the messages for fault conditions 103, 221, and 218.
  479. #Format
  480. FORMAT - formats and initializes a new 3.5 inch disk.
  481. Syntax:
  482.     FORMAT DRIVE <drivename> NAME <diskname> [NOICONS]
  483.  
  484. Specification:
  485.     FORMAT prepares a disk for use by AmigaDOS.
  486.     DOS 1.2 Addition:  NOICONS will prevent a Trashcan icon from being added.
  487.  
  488.     DRIVE   Under DOS 1.2, any existing drive or partition is valid.
  489.  
  490.     NAME    can be any string; if it includes spaces, the whole string must
  491.             be enclosed in quotes <"">.
  492.  
  493. Example:
  494.     FORMAT DRIVE df1: NAME "1986 Taxes" --
  495.          formats and initializes the disk in drive DF0: with the name 
  496.          "1986 Taxes".  
  497.     FORMAT DRIVE df2: NAME Data001 NOICONS --
  498.          formats the 5-1/4" floppy disk drive DF2: with name "Data001"
  499.          with no Trashcan icon.
  500. #Alink
  501. ALINK - Links together sections of code into an executable file.
  502. Syntax:
  503.     ALINK  [FROM|ROOT]  <filename>  [{, <filename> ...} | {+ <filename> ...}]
  504.            [TO <name>]  [WITH <name>] [LIBRARY|LIB <name>]  [MAP <map>]
  505.            [XREF <name>] [WIDTH <n>]
  506.  
  507. Specification:
  508.     Links sections of  compiled or assembled  AmigaDOS  object code together
  509.     into  executable program  files.   Handles automatic  library references
  510.     and builds overlay files.  The output from ALINK is a file in the proper
  511.     form to be loaded by the loader and, if necessary, run under the overlay
  512.     supervisor.
  513.  
  514. Example:
  515.  ALINK FROM libs/Lstartup.o+myobj TO myprog LIB libs/mylib --
  516.      links the files "libs/Lstartup" and "myobj", and produces the output
  517.      file "myprog".  External references will be searched for in "libs/mylib".
  518.  
  519.  ALINK myprog.o TO myprog WITH link-parms --
  520.      creates the executable program "myprog" from the object file "myprog.o",
  521.      using additional parameters supplied by the file "link-parms".
  522. #Assem
  523. ASSEM - Assemble a program written in MC68000 assembly language.
  524. Syntax:
  525.     ASSEM  [PROG|FROM] <source filename> [-O|TO <object filename>]
  526.            [-V <message file>] [-L <list file>] [-H <header file>]
  527.            [-I <include list>] [-C|OPT <option>] [-E]
  528.  
  529. Specification:
  530.     To use this command, you first must purchase the MC68000 assembler.
  531.     The MC68000 assembler is not provided with the Workbench disk.
  532.  
  533.     This command produces a linkable object file from a text source
  534.     code file written in MC68000 assembly language.  
  535.  
  536.     For information on parameters and flags, see ASSEM_FLAGS.
  537.  
  538. Example:
  539.  ASSEM myprog TO myobj -L mylist -V mybugs -H myhdr -I includes/myincl1.i+ 
  540.        includes/myincl2.i+intuition/myincl3.i+dos/myincl4.i OPT -S -D -X  --
  541.      will assemble "myprog", including header code in "myhdr", into object
  542.      file "myobj", with listing in "mylist"  including a cross-referenced
  543.      global symbol table, and with error messages in "mybugs".
  544. #ASSEM_FLAGS
  545. ASSEM_FLAGS - description of flags and parameters used by ASSEM.
  546.  
  547. Parameters which may be set are:
  548.  
  549. -O or TO <object file>  the assembler will not produce any binary object
  550.                         code unless this parameter is provided.
  551.     -L <list file>      produces a list file containing both source  and
  552.                         the  corresponding  object code.
  553.     -V <message file>   save warnings and error messages to a file
  554.     -H <header file>    use to include a source code header file
  555.     -I <include list>   a list of paths to files listed as INCLUDE files
  556.                         within  the  source  file. 
  557.     -E <equates file>   generates  a  header  file  containing  the  EQU
  558.                         directive assignments in the source file 
  559.     -C <options>        one or more option "switches" may  be  specified
  560.  or OPT <options>       to the assembler, as follows:
  561.        -S  produce a complete list of symbols during assembly.
  562.        -D  restrict the -S switch output to Global symbols only.
  563.        -C  ignores the case of labels 
  564.        -W <width>  sets the size of the assembler workspace.
  565.        -X  produces a cross-referenced symbol table listing.
  566. #Execute
  567. EXECUTE - executes a file of commands (similar to batch files).
  568. Syntax:
  569.     EXECUTE <sequence> [<argument>...]
  570.  
  571. Specification:
  572.      EXECUTE allows  you to perform a complex , pre-programmed  sequence of
  573.      AmigaDOS commands.  (For those already familiar with MS-DOS or PC-DOS,
  574.      it is the same as a .BAT batch file.)  A command sequence is a list of
  575.      DOS commands which will be executed  sequentially.   There are several
  576.      AmigaDOS  commands which are  intended  specifically  for use  in such
  577.      sequences.   
  578.  
  579.      Many commands will require parameters (arguments, switches, etc.) that
  580.      are unknown ahead of time.   EXECUTE allows you to include variable
  581.      parameters which are filled in when the sequence is executed.
  582.  
  583.      Many AmigaDOS commands are specific to EXECUTE command files, they
  584.      include:  IF  ELSE  ENDIF  FAILAT  QUIT  SKIP  LAB  WAIT  ECHO
  585.  
  586. Example:
  587.     EXECUTE install -- executes a script program named "install".
  588. #Syntax:
  589.     FAILAT <n>
  590.  
  591. Specification:
  592.     When a command fails,  a non-zero  return  code  is  set.  A  return code 
  593.     greater  than  or  equal  to the fail limit terminates a sequence of non-
  594.     interactive commands. The return code indicates how serious the error was
  595.     and is usually:  5 (warning), 10 (error), or 20 (fatal).
  596.  
  597.     The FAILAT command is used to alter the default value fail level of 10.  
  598.     The argument should be  a positive integer.  Upon exit from the command 
  599.     sequence, the fail level is reset to the default value of 10.
  600.     
  601.     If the return code value is increased,  it indicates that certain classes
  602.     of error should not be regarded as fatal and that execution of subsequent
  603.     commands may proceed after an error.
  604.  
  605.     The FAILAT command should be used BEFORE the commands that will be tested
  606.     for failure. If you use FAILAT without an argument,  the current value of
  607.     the current fail limit will be displayed.
  608. #FileNote
  609. FILENOTE - attaches a comment or a note to a file.
  610. Syntax:
  611.     FILENOTE [FILE] <file> [COMMENT] <string>
  612.  
  613. Specification:
  614.     COMMENT adds an optional comment of up to 80 characters.  If the comment
  615.     contains embedded spaces, it must be enclosed in quotes <"">.
  616.  
  617.     When a new file is created, it does not have a comment. If you overwrite
  618.     an existing file that has a comment, the comment is retained,
  619.  
  620.     If a file with a comment is copied with the command COPY,  the new file
  621.     will not have the comment from the original.
  622.  
  623. Example:
  624.     FILENOTE program1 "Version 2.1   July 4, 1987" --
  625.          attaches the comment "Version 2.1   July 4, 1987" to the file
  626.          "program1".  If the LIST command "LIST program1" is used, the
  627.          result will be a two-line listing of the file as follows:
  628.               program1         1341 rwed  Today        12:36:51
  629.               :Version 2.1   July 4, 1987
  630. #If
  631. IF - allows conditionals within a command sequence.
  632. Syntax:
  633.     IF [NOT] [WARN | ERROR | FAIL | {<string> EQ <string>} | {EXISTS <name>}]
  634.  
  635. Specification:
  636.   NOT   processing should occur only if the test following fails.
  637.  
  638.   The command MUST be followed by one of the following tests:
  639.   WARN    TRUE if the immediately prior command returned a code >= 5.
  640.   ERROR   TRUE if the immediately prior command returned a code >= 10.
  641.   FAIL    TRUE if the immediately prior command returned a code >= 20.
  642.   <string> EQ <string> ... tests the exact equality of two strings. <string>
  643.   EXISTS <name> .......... TRUE  if  the file <name> exists in the specified
  644.                            directory (may be part of <name>).
  645.   ERROR is meaningful only if you set FAILAT to greater than the default 10.
  646.   FAIL is only meaningful if FAILAT is set to greater than 20.
  647.   Nested IF's are terminated by the nearest enclosing ENDIF in the sequence.
  648.   The optional ELSE may provide an  alternative if the  specified conditions
  649.   are not met.  The conditions and commands in IF and  ELSE  statements  can
  650.   span several command lines before their corresponding ENDIFs.  Indentation
  651.   is permitted.
  652. #Info
  653. INFO - displays a report on mounted disk devices.
  654. Syntax:
  655.     INFO
  656.  
  657. Specification:
  658.     Information about each mounted disk device is given as follows: 
  659.  
  660.        Unit.... the disk device name
  661.        Size.... total space on the disk (in Kbytes, typically 880K)
  662.        USED.... disk space allocated to files & subdir's (in 512-byte Blocks)
  663.        Free.... available free space on the disk (in Blocks)
  664.        Full.... the % space now used (i.e. USED/Size)
  665.        Errs.... number of soft disk errors detected
  666.        Status.. Read/Write or Read Only
  667.        Name.... the disk volume name
  668. #Install
  669. INSTALL - makes a formatted disk bootable.
  670. Syntax:
  671.     INSTALL [DRIVE] <drive>
  672.  
  673. Specification:
  674.     <drive>    the drive containing the formatted diskette to be installed.
  675.  
  676.     An INSTALLed  disk can be  inserted at  the  Workbench  prompt  (after
  677.     KICKSTARTing the Amiga) to  "boot" the system. The only possible drive
  678.     names are DF0:, DF1:, DF2:, and DF3:.
  679.  
  680.     No files are copied to the disk during installation.  If you want to be
  681.     able to execute AmigaDOS commands after booting, you must copy  the "c"
  682.     subdirectory from your Workbench disk onto the disk you have INSTALLED.
  683.     You will probably also need the other workbench directories as well.
  684.  
  685.  Example:
  686.     INSTALL DF1: --
  687.          makes the disk in drive "df1:" a bootable disk.  To add all the
  688.          Workbench files to the disk, you would use the COPY command.
  689. #List
  690. LIST - list specified information about a directory or file.
  691. Syntax:
  692.     LIST [DIR] <dir> [P|PAT=<pattern>] [KEYS] [DATES] [NODATES]
  693.          [TO <name>] [S <string>] [SINCE <date>] [UPTO <date>] [QUICK]
  694.  
  695. Specification:
  696.  LIST with no options will display:
  697.            filename           size  protection  date  time
  698.            :comment
  699.  There are three options for the <dir> argument to the DIR keyword:
  700.  (1) if a filename is specified, information for that file will be displayed;
  701.  (2) if a directory name is given, the file information for all files and
  702.      subdirectories within that directory will be displayed;
  703.  (3) if the <dir> argument is omitted, information about files and
  704.      subdirectories within the current directory will displayed.
  705.  
  706.  Other LIST options available:
  707.  P <pattern>   searches for files whose name matches the specified pattern.
  708.  KEYS          displays the block number of each file header or directory.
  709.  SINCE <date>  displays only the files last update  ON OR AFTER <date>.
  710.  UPTO <date>   displays only files last updated ON OR BEFORE <date>.  
  711. #MakeDir
  712. MAKEDIR - creates a new subdirectory.
  713. Syntax:
  714.     MAKEDIR <dir>
  715.  
  716. Specification:
  717.    MAKEDIR creates a directory with the name you specify.  Only one directory
  718.    can be created at a time, so if you wish to create a subdirectory within a
  719.    directory, that parent directory must exist or be created first.
  720.  
  721.    The directory will not be created if a directory or  file  with  the  same
  722.    name  already exists in the directory above it in the heirarchy.  You can,
  723.    however, have two with the same name within two different directories. 
  724.  
  725. Example:
  726.      MAKEDIR :map -- 
  727.          creates a directory named "map" in the default root directory.
  728.      MAKEDIR DF1:sheets --
  729.          creates a directory "sheets" in on drive DF1:.
  730.      MAKEDIR "DF1:budget/work sheets" --
  731.          creates a subdirectory "work sheets" the parent directory "budget"
  732.          on drive DF1:.  The directory "budget" must already exist.
  733. #Mount
  734. MOUNT - install a new hardware device name into DOS (not WorkBench)
  735. Syntax:
  736.     MOUNT <devicename>
  737.  
  738. Specification:
  739.     This command installs a new hardware device into DOS's device tables.
  740.     In most cases,  the hardware  will be supplied  with a  mounting disk 
  741.     containing  a  "mountlist"  file which  must be  added  to  the  file 
  742.     "SYS:devs/Mountlist".   The default  Mountlist  file on your DOS disk
  743.     contains an example device  specification for  a 5.25" disk drive and
  744.     for a serial device (the handler is NOT supplied for the example).
  745.  
  746.     You will probably include MOUNT commands in your "s/startup-sequence"
  747.     boot file. This will install the devices at power-up.
  748.  
  749. Example:
  750.   (1) Copy the device handler to the "l:" directory.
  751.   (2) Add the device's mountlist to the "SYS:devs/Mountlist" file.  
  752.   (3) Add the command "MOUNT <device-name>" to the file "s/startup-sequence".
  753. #Prompt
  754. PROMPT - changes the prompt in the current CLI.
  755. Syntax:
  756.     PROMPT [<prompt>]
  757.  
  758. Specification:
  759.     The  prompt is set  to  the  string  you  supply.  The special character 
  760.     combination <%N> in the prompt string is displayed as the CLI's  process 
  761.     number. If a parameter is not given, the prompt is reset to the standard 
  762.     string "%N> ". Note the space included after the > symbol!
  763.  
  764. Example:
  765.     PROMPT --  resets the current prompt to "%N> ".
  766.     PROMPT "Current Process is #%N.  Command? " --
  767.          resets  the CLI prompt to "Current Process is #n.  Command? " where
  768.          n is the current process number.  If the CLI's process were #4, the 
  769.          resulting prompt would appear as:
  770.          
  771.                        Current Process is #4. Command? _
  772.                        
  773.     The underscore character above is  positioned where the cursor would be.
  774. #Read
  775. READ - download development files over serial or parallel port.
  776. Syntax:
  777.     READ [TO] <name> [SERIAL]
  778.  
  779. Specification:
  780.     This command allows the user to download specially formatted files over
  781.     the serial or parallel port.  If SERIAL is specified, then data is read
  782.     at the current Preferences data speed.  Otherwise data is read from the
  783.     parallel port.
  784.  
  785.    The file  to be downloaded  must be converted  into the format of a
  786.    two-digit hex  code for each  byte  in the file BEFORE it  is  read. 
  787.    Use the CONVERT command supplied with your cross-development system.
  788.  
  789. Example:
  790.     On the IBM-PC:  CONVERT <PROGRAM >PROGRAM.OUT
  791.     then transfer it to the Amiga at 9600 bps. 
  792.     On the Amiga, you enter:
  793.     READ DF1:PROGRAM SERIAL, then start output from the IBM-PC.
  794. #Rename
  795. RENAME - changes the name of a file or directory.
  796. Syntax:
  797.     RENAME [FROM] <name> [TO|AS] <name>
  798.  
  799. Specification:
  800.     RENAME changes the name of the FROM file or directory to the specified 
  801.     TO name.  If you already have a file with exactly the same name as the
  802.     TO file, RENAME won't work.
  803.  
  804.     RENAME can also be used to MOVE a file into another directory.
  805.  
  806.    RENAME cannot be used to change the case of the letters in a file name;
  807.   (i.e. "RENAME jones TO Jones" will not work).
  808.  
  809. Example:
  810.     RENAME Demo1 Demonstration --
  811.          changes the name of the file "Demo1" to "Demonstration". 
  812.          The contents of the file remain the same.
  813. #Quit
  814. QUIT - exit from a command sequence with a given error code.
  815. Syntax:
  816.     QUIT [<returncode>]
  817.  
  818. Specification:
  819.     QUIT  exits  the  current  command sequence with a error return code.
  820.     The default return code is zero.
  821.  
  822. Example: 
  823.     IF WARN 
  824.        QUIT 20
  825.     ENDIF
  826.  
  827.  If the last command was in error (code >=5), this terminates the
  828.  command sequence with return code 20.
  829. #Protect
  830. PROTECT - sets a file's protection status.
  831. Syntax:
  832.     PROTECT [FILE] <filename> [[FLAGS] <status>]
  833.  
  834. Specification:
  835.     The keyword FLAGS has four options:  <rwed>, where...
  836.                      r = read            e = execute
  837.                      w = write           d = delete
  838.  
  839.  If a flag is set,  that option is NOT protected.  If it is  omitted,  then
  840.  protection is set.  The keyword FLAGS itself is optional; omitting it does
  841.  not  change  the  effect  of the command.  To check the current protection
  842.  status of a file, use the LIST command.  
  843.  
  844. Example: 
  845.     PROTECT report1 r 
  846.        sets the protection status of "report1" as read only.
  847.     PROTECT report2
  848.        resets all the protection flags of the file "report2" to unprotected.
  849. #Skip
  850. SKIP - perform a jump in a command sequence.
  851. Syntax:
  852.     SKIP <label>
  853.  
  854. Specification:
  855.   SKIP is used in conjunction with LAB.  SKIP will read through the command
  856.   file  looking  for a  label you  defined with LAB,  without executing any
  857.   commands.  SKIP will only jump forward in the command sequence.
  858.  
  859.  SKIP can be used with or without a label.  Without one,  it finds the next
  860.  unnamed  LAB  command.  With  one,  it  will  look  for a LAB defining the
  861.  specified label.  LAB must be the first item on a line  of  the  file.  If
  862.  SKIP  does  not find the label you specified,  the sequence terminates and
  863.  the following message is displayed:  "label "<label>" not found by Skip."
  864.  
  865. Example: 
  866.      SKIP  
  867.         used alone jumps to the next LAB command that does not have
  868.         a name following it.
  869. #NewCLI
  870. NEWCLI - opens a new interactive CLI process and creates a console
  871.          window for input and output.
  872. Syntax:
  873.     NEWCLI [<window>] [FROM <startup-file>]
  874.  
  875. Specification:
  876.    A new CLI window is created, which becomes the currently selected process.
  877.    Each CLI window is independent,  allowing separate  &  nearly simultaneous
  878.    input, output, and program execution.
  879.  
  880. Example:
  881.     NEWCLI --  creates a new CLI process in a window of default size & 
  882.                location.
  883.     NEWCLI "CON:20/30/300/100/Tom's Custom CLI" --
  884.        The quotes  <"">  around the window argument allows the title to
  885.       contain spaces.  
  886.     NEWCLI FROM ExecFile        [ DOS 1.2 ONLY! ]  --
  887.       this will open a default CLI window, and will begin EXECUTEing 
  888.       "ExecFile".
  889. #SetDate
  890. SETDATE - updates the date and time assigned to a file or directory
  891. Syntax:
  892.     SETDATE <file> <date> [<time>]
  893.  
  894. Specification:
  895.     This command let's the user set the date and time of a file.
  896.        <file>    the filename to receive a date change.
  897.        <date>    a date specified in the standard Amiga format: ##-LLL-##,
  898.        where:  
  899.                  the first two digits are the month; (1-9) must be 01-09;
  900.                  the second three letters are the month code;
  901.                  the last two digits are the year;
  902.        <time>    this is the time in 24-hour format: ##:##, representing
  903.                  hours and minutes.
  904.  
  905. Example:
  906.     SETDATE  TempFile 01-Jan-88 13:07 --
  907.       this sets the date and time on file "TempFile" in the current
  908.       directory.
  909. #Path
  910. PATH - specifies which directories to search in for CLI commands
  911. Syntax:
  912.     PATH  [SHOW] | [ADD <dir>,<dir>,...] | [RESET <dir>,...]
  913.  
  914. Specification:     
  915.   When a DOS command is given in the CLI, the current directory is searched
  916.   for the command.  If the command isn't found,  the next directory  in the
  917.   path will be searched.  Ultimately,  the  "c:" directory is searched.  
  918.   <dir>   this is a directory name, including drive or disk name if needed.
  919.   SHOW    this option will display the current path.
  920.   ADD     this mutually exclusive option lets you add the specified directory
  921.           or directories to the current path.  
  922.   RESET   this option, also mutually exclusive, lets you remove the specified
  923.           directories from the current path. If no directory is supplied, the
  924.           path is reset to the default DOS path: Current Directory, C:
  925.  
  926. Example:
  927.     PATH ADD DataFiles,Utilities --
  928.     adds the directories "DataFiles" and "Utilities" to the current command
  929.     search path.
  930. #Search
  931. SEARCH - looks for a text string in all the files in a directory.
  932. Syntax:
  933.     SEARCH [FROM] <name>|<pattern> [SEARCH] <string> [ALL]
  934.  
  935. Specification:
  936.     <name>     a filename, including directories;
  937.     <pattern>  a  generalized  form of filename specification
  938.  
  939.  SEARCH looks through the FROM file (or,  if only a directory is specified,
  940.  all files in that directory) for occurences of the SEARCH string.  If  ALL
  941.  is added, then all the subdirectories contained in the specified directory
  942.  are searched.  When the SEARCH string is found, the line where it occurred
  943.  is displayed. As each file is being searched, its name is displayed to the
  944.  screen.  The search is non-case sensitive.
  945.  
  946. Example:
  947.     SEARCH SEARCH "Test #86" --
  948.          searches the default directory for file containing the string
  949.          "Test #86".
  950. #Sort
  951. SORT - alphabetically sorts a specified file.
  952. Syntax:
  953.     SORT [FROM] <name> [TO] <name> [COLSTART <n>]
  954.  
  955. Specification:
  956.     WARNING:   If the file is longer than about  150  records (lines) , you
  957.     should increase Stack size.  Estimate an additional 1000 bytes of Stack
  958.     for each additional 50 records (lines) in the file.
  959.     Does a simple, ascending-order, alphabetic sort of the FROM file into
  960.     the TO file,  without distinguishing  between  upper and  lower cases.
  961.     Each record in the  file to be sorted must end with a carriage return.
  962.     COLSTART  this keyword can be used to specify the first column where the
  963.            comparison will take place.
  964.  
  965. Example:
  966.     SORT Pre-Registered TO "Class Roster" COLSTART 16 --
  967.     "Pre-Registered" is a list of students with first names in columns
  968.     1-15 and last names beginning in column 16.  In this example, the names
  969.     would be sorted in order of last names,  with each group of identical
  970.     last names being subsorted by the first name.  
  971. #Stack
  972. STACK - sets the stack size for commands.
  973. Syntax:
  974.     STACK [<size>]
  975.  
  976. Specification:
  977.     When a program is run,  it uses a certain amount of stack space.  The
  978.     normal stack size is  4000 bytes,  which is sufficient in most cases. 
  979.     When using some programs, you may need to increase  the stack size to
  980.     prevent a crash.   To do this, type  STACK  followed by the new stack
  981.     size in bytes.  A value from 8000 to 10000 is usually adequate.
  982.  
  983.     STACK alone displays the currently set stack size.
  984.  
  985.     WARNING:  The only indication that you have run out of stack is that
  986.     the Amiga crashes. It is better to overestimate if you are not sure.
  987.  
  988. Example:
  989.     STACK --  displays the current stack size.
  990.     STACK 16000 --
  991.          sets the stack size to 16000 bytes.
  992. #Status
  993. STATUS - displays information about existing CLI processes.
  994. Syntax:
  995.     STATUS [<process>] [FULL] [TCB] [SEGS] [CLI|ALL]
  996.  
  997. Specification:
  998.     STATUS without any parameters lists the numbers of the CLI processes
  999.     and the program tasks running in each.
  1000.     <process>  specifies a process number and only gives information about
  1001.             that  process.  Otherwise, information  is displayed about all
  1002.             processes.
  1003.    FULL      = SEGS + TCB + CLI flags 
  1004.    SEGS      displays the names of the sections on the segment list of each
  1005.              process.
  1006.    TCB       displays information about the priority, stacksize, and global
  1007.              vector size of each process.
  1008. CLI or ALL   identifies  Command  Line Interface processes and displays the
  1009.              section name(s) of the currently loaded command.
  1010.  
  1011. Example:
  1012.     STATUS 4 FULL --
  1013.          displays full information about task #4 in the current CLI window.
  1014. #Type
  1015. TYPE - type a text file, or type a file out as hexadecimal numbers.
  1016. Syntax:
  1017.     TYPE [FROM] <name> [[TO] <name>] [OPT N|H]
  1018.  
  1019. Specification:
  1020.     TO <name>  with this optional keyword, you can send the output of the
  1021.                TYPE  command to a  specified file.   If an output file is
  1022.                not specified the output is usually sent to current window.
  1023.     OPT        this keyword lets you specify one of two available options:
  1024.           N ...  line numbers will be included in the output.
  1025.           H ...  each byte will be output as a hex number, as well as ASCII.  If
  1026.  
  1027. Example:
  1028.     TYPE sales/report1 --
  1029.          displays the text file "report1" in the subdirectory "sales"
  1030.     TYPE program1 program1hex OPT H  --
  1031.          writes out the code stored in "program1" in hexadecimal and ASCII
  1032.          and  stores it in the file "program1hex".
  1033. #Wait
  1034. WAIT - wait for a specified amount of time.
  1035. Syntax:
  1036.     WAIT <n> [SEC|SECS] [<m> MIN|MINS] [UNTIL <time>]
  1037.  
  1038. Specification:
  1039.     WAIT can be used in command  sequences or after  RUN  to wait  for a
  1040.     certain period, or to wait until a certain time of day.  The waiting
  1041.     time is one second unless you specify otherwise.
  1042.     The keywords SECS and MINS may follow or precede the amounts.
  1043.     Use the keyword UNTIL to wait until a specific time of day,  given in 
  1044.     the format HH:MM.
  1045.  
  1046. Example:
  1047.     WAIT -- waits one second.
  1048.     WAIT 15 -- waits for 15 seconds.
  1049.     WAIT 30 MINS -- waits for 30 minutes.
  1050.     WAIT UNTIL 14:30 -- waits until 2:30 p.m.
  1051. #