home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 337.lha / SuperMenu_v1.51 / AmigaDOS.HELP < prev    next >
Encoding:
Text File  |  1990-01-28  |  31.3 KB  |  1,095 lines
  1. *:ADDBUFFERS
  2. Format:     ADDBUFFERS <drive>: <nn>
  3.  
  4. Template:   ADDBUFFERS "DRIVE/A,BUFFERS/A"
  5.  
  6. Purpose:    To command the file system to add cache buffers.
  7.  
  8. Path:       C:ADDBUFFERS
  9.  
  10. Specification:
  11.  
  12. ADDBUFFERS adds <nn> buffers to the list of sector caches for <drive>. When
  13. using the standard file system, additional buffers can make disk access
  14. significantly faster. However, each additional buffer reduces memory by
  15. approximately 500 bytes. As a general rule, only add 25-30 buffers. Disk
  16. access time does not really increase by adding more than 25 or 30; you would
  17. also be using up valuable memory.
  18.  
  19. When using the FastFileSystem with a hard drive, adding additional buffers
  20. always speeds up disk access. The recommended number of additional buffers
  21. varies depending on how much extra memory is available.
  22.  
  23. Example:
  24.  
  25. 1> ADDBUFFERS df1: 25
  26.  
  27. Adds 24 buffers to the sector caches for disk drive df1:.
  28. *:ASK
  29. Format:     ASK <prompt>
  30.  
  31. Template:   ASK "PROMPT/A"
  32.  
  33. Purpose:    To obtain user input when executing a script file.
  34.  
  35. Path:       C:ASK
  36.  
  37. Specification:
  38.  
  39. ASK writes the <prompt> string to the current output stream, then waits for
  40. the user's keyboard input. Valid responses are Y (yes), N (no), and RETURN
  41. (same as no). ASK then sets the condition flag to 5 (= WARN) is a YES
  42. response was typed, and 0 if a NO response was typed. This command is
  43. normally only useful in script files.
  44.  
  45. See also:   IF, EXECUTE
  46. *:ASSIGN
  47. Format:     ASSIGN [[<name>:] <dir>] [LIST][EXISTS][REMOVE]
  48.  
  49. Template:   ASSIGN "NAME,DIR,LIST/S,EXISTS/S,REMOVE/S"
  50.  
  51. Purpose:    To assign a logical device name to a file system directory.
  52.  
  53. Path:       C:ASSIGN
  54.  
  55. Specification:
  56.  
  57. With Version 1.3, ASSIGN will now print device names with more than 3 letters
  58. properly. If the LIST keyword is given along with a logical device name,
  59. ASSIGN will search the ASSIGN list for that name and remove it from the list.
  60.  
  61. If the EXISTS keyword is given along with a logical device name, ASSIGN will
  62. search the ASSIGN list for that name, and display the device and the
  63. directory assigned to the device. If the device is not found, the condition
  64. flag is set to WARN.
  65.  
  66. The REMOVE option disconnects a volume or device from the list of mounted
  67. devices. It does not free up resources; it merely removes the name from the
  68. list. THIS OPTION IS PRIMARILY USED DURING SOFTWARE DEVELOPMENT. CARELESS
  69. USE OF THIS OPTION MAY CAUSE A GURU FAILURE.
  70.  
  71. Examples:
  72.  
  73. 1> ASSIGN fonts: EXISTS
  74. FONTS: Workbench 1.3:fonts
  75.  
  76. 1> ASSIGN fonts: LIST
  77. Volumes:
  78. RAM Disk [Mounted]
  79.  
  80. Directories:
  81. CLIPS:      RAM DISK:clipboards
  82. ENV:        RAM DISK:env
  83. T:          RAM DISK:t
  84. S:          Workbench 1.3:s
  85. L:          Workbench 1.3:l
  86. C:          Workbench 1.3:c
  87. DEVS:       Workbench 1.3:devs
  88. LIBS:       Workbench 1.3:libs
  89. SYS:        Workbench 1.3:sys
  90.  
  91. Devices:
  92. SPEAK NEWCON DF2 DF0 PRT
  93. PAR SER RAW CON RAM
  94.  
  95. Note that the assignment "FONTS:Workbench 1.3:fonts" has been removed from
  96. the ASSIGN list.
  97. *:AVAIL
  98. Format:     AVAIL [CHIP|FAST|TOTAL]
  99.  
  100. Template:   AVAIL "CHIP/S,FAST/S,TOTAL/S"
  101.  
  102. Purpose:    To report the amount of available CHIP and FAST memory.
  103.  
  104. Path:       C:AVAIL
  105.  
  106. Specification:
  107.  
  108. The AVAIL command gives a summary of the system RAM memory, both CHIP and
  109. FAST. For each memory type, AVAIL reports the total amount, how much is
  110. available, how much is currently in use, and the largest contiguous memory
  111. block not yet allocated.
  112.  
  113. By using the CHIP, FAST, and/or TOTAL options, AVAIL will display only the
  114. number of free bytes of CHIP, FAST or TOTAL RAM available, instead of the
  115. complete summary. This value can be used for comparisons in scripts.
  116.  
  117. Examples:
  118.  
  119. 1> AVAIL
  120. Type     Available   In-Use   Maximum  Largest
  121. chip     233592      282272    515864    76792
  122. fast     341384      182896    524280   197360
  123. total    574976      465168   1040144   197360
  124.  
  125. 1> AVAIL CHIP
  126. 233592
  127.  
  128. See Also: EXECUTE, IF
  129. *:BINDDRIVERS
  130. Format:     BINDDRIVERS
  131.  
  132. Template:   BINDDRIVERS
  133.  
  134. Purpose:    To bind device drivers to hardware.
  135.  
  136. Path:       C:BINDDRIVERS
  137.  
  138. Specifications:
  139.  
  140. BINDDRIVERS is normally part of a startup sequence. It is used to bind device
  141. drivers found in the SYS:Expansion directory to add-on hardware that has been
  142. automatically configured by the expansion library. What this means, is that
  143. if drivers for expansion hardware are in the Expansion drawer, the hardware
  144. will be configured automatically when the system is booted.
  145. *:BREAK
  146. Format:     BREAK <process> [ALL|C|D|E|F]
  147.  
  148. Template:   BREAK "PROCESS/A,ALL/S,C/S,D/S,E/S,F/S"
  149.  
  150. Purpose:    To set attention flags in the specified process.
  151.  
  152. Path:       C:BREAK
  153. *:CD
  154. Format:     CD <directory>
  155.  
  156. Template:   CD "DIR"
  157.  
  158. Purpose:    To set, change, or list the current directory.
  159.  
  160. Path:       C:CD
  161. *:CHANGETASKPRI
  162. Format:     CHANGETASKPRI <priority>[<process>]
  163.  
  164. Template:   CHANGETASKPRI "PRIORITY/A,PROCESS/K"
  165.  
  166. Purpose:    To change the priority of processes started from the CLI.
  167.  
  168. Path:       C:CHANGETASKPRI
  169.  
  170. Specification:
  171.  
  172. Since the Amiga is a multitasking machine, it uses priority numbers to
  173. determine which tasks it should attend to and in which order. Normally, most
  174. tasks have a priority of 0, and the time and instruction cycles of the CPU
  175. are divided among them. CHANGETASKPRI changes the priority of the specified
  176. CLI process. (If no process is specified, the current CLI process is
  177. assumed.) Any tasks started from <process> inherit its priority.
  178.  
  179. The range of acceptable values for <priority> is -128 to 127. However, you
  180. should not enter values above +5 to avoid disrupting important system tasks.
  181.  
  182. Process numbers of CLIs can be determined by using the STATUS command.
  183.  
  184. Example:
  185.  
  186. 1> CHANGETASKPRI 5
  187.  
  188. The priority of the current CLI task is changed to 5. Any tasks started from
  189. this CLI will also have a priority of 5. They will have priority over any
  190. other user tasks created without using CHANGETASKPRI (those tasks will have
  191. a priority of 0).
  192.  
  193. See also:   STATUS
  194. *:COPY
  195. Format:     COPY [[FROM] <name>] [TO] <name> [ALL][QUIET][BUF|BUFFER=<nn>]
  196.                [CLONE][DATE][COM][NOPRO]
  197.  
  198. Template:   COPY "FROM,TO/A,ALL/S,QUIET/S,BUF=BUFFER/K,CLONE/S,DATE/S,COM/S,
  199.                NOPRO/S"
  200.  
  201. Purpose:    To copy a file or directory.
  202.  
  203. Path:       C:COPY
  204.  
  205. Specification:
  206.  
  207. You can use COPY to copy multiple files to a device. Either use the ALL
  208. option to copy an entire directory, or use pattern matching to copy files
  209. that share a common set of characters or symbols.
  210.  
  211. For instance, you can use pattern matching to copy all the files of a
  212. directory by specifying the directory name as the pattern. (For a full
  213. explanation of patterns see The AmigaDOS Manual. Note: The 31 character
  214. restriction on the use of wildcards has been removed.)
  215.  
  216. The BUF= option is used to set the number of 512 byte buffers used during
  217. the copy. (Default is 100K or 200 buffers). It is often useful to limit the
  218. number of buffers when copying to the RAM: disk.
  219.  
  220. The CLONE option tells COPY to copy the date, comments, and protection bits
  221. of the original to the destination file. The DATE and COM options direct COPY
  222. to copy the creation date and the comments of the original file. By default,
  223. COPY retains the protection bits of the original file when it makes a copy.
  224. This may be overridden by using the NOPRO option.
  225.  
  226. Formerly, if a directory specified as the destination did not exist, COPY did
  227. not create one. With Version 1.3, COPY will now create a new destination
  228. directory. You can also use a pair of quotes ("") to refer to the current
  229. directory when specifying a destination.
  230. *:DATE
  231. Format:     DATE [<date>][<time>][TO=VER<filename>]
  232.  
  233. Template:   DATE "DATE,TIME,TO=VER/K"
  234.  
  235. Purpose:    To display or set the system date and/or time.
  236.  
  237. Path:       C:DATE
  238.  
  239. Specification:
  240.  
  241. DATE now allows either a leading zero or a single digit in the date
  242. specification. Formerly you had to supply the leading zero.
  243. *:DELETE
  244. Format:     DELETE <name>* [ALL][Q][QUIET]
  245.  
  246. Template:   DELETE "NAME(S),ALL/S,Q=QUIET/S"
  247.  
  248. Purpose:    To delete up to 10 files or directories.
  249.  
  250. Path:       C:DELETE
  251.  
  252. Specification:
  253.  
  254. You can use pattern matching to delete files. If you are using pattern
  255. matching, the 31 character restriction on the use of wildcards has been
  256. removed. (For a full explanation of patterns, see The AmigaDOS Manual.)
  257. *:DIR
  258. Format:     DIR [<name>] [OPT A|I|AI|D][ALL][DIRS][INTER][FILES]
  259.  
  260. Template:   DIR "NAME,OPT/K,ALL/S,DIR/S,INTER/S,FILES/S"
  261.  
  262. Purpose:    To display a sorted list of the files in a directory.
  263.  
  264. Path:       C:DIR
  265.  
  266. Specification:
  267.  
  268. ALL, DIRS, and INTER are now synonyms for the A, D, and I options,
  269. respectively. In addition, there is a COMMAND= option in interactive mode
  270. (invoked through OPT I or INTER) which allows almost any AmigaDOS command
  271. to be executed during the interactive directory list.
  272.  
  273. When you want to issue a general command in interactive mode, type C (or COM)
  274. at the question mark prompt. DIR will ask you for the command. Type the
  275. desired command, then hit RETURN. The command will be executed and DIR will
  276. continue. You can also combine the C and the command on one line, by putting
  277. the command in quotes following the C. For instance, C "type prefs.info hex".
  278.  
  279. The FILES option displays only the files in a directory; subdirectories are
  280. not displayed.
  281. *:DISKCHANGE
  282. Format:     DISKCHANGE <drive>:
  283.  
  284. Template:   DISKCHANGE "DRIVE/A"
  285.  
  286. Purpose:    To inform the Amiga that you have changed a disk in the 5 1/4"
  287.             disk drive.
  288.  
  289. Path:       C:DISKCHANGE
  290.  
  291. Specification:
  292.  
  293. You must use the DISKCHANGE command when you are using 5 1/4" floppy disk
  294. drives with your Amiga system. Whenever you change the disks in the 5 1/4"
  295. drive, you must use DISKCHANGE to inform the system of the switch.
  296.  
  297. This command is also useful to inform Workbench of any name changes made to
  298. diskettes with the RELABEL command.
  299.  
  300. Example:
  301.  
  302. If a requester appears and asks you to insert a new disk into your 5 1/4"
  303. drive, known as df2:, you must insert the disk, then type:
  304.  
  305. 1> DISKCHANGE df2:
  306.  
  307. AmigaDOS will then recognize the new disk, and you can proceed.
  308. *:DISKDOCTOR
  309. Format:     DISKDOCTOR <drive>:
  310.  
  311. Template:   DISKDOCTOR "DRIVE/A"
  312.  
  313. Purpose:    To attempt to repair a corrupt disk.
  314.  
  315. Path:       C:DISKDOCTOR
  316.  
  317. Specification:
  318.  
  319. DISKDOCTOR attempts to repair a corrupt floppy disk enough to allow you to
  320. retrieve files from it and copy them onto a good disk. If AmigaDOS detects a
  321. corrupt disk, it displays a requester stating that the disk could not be
  322. validated. By using DISKDOCTOR, you can try to restore the disk's file
  323. structure. After running DISKDOCTOR, you should copy the restored files to
  324. another disk, then reformat the corrupt disk.
  325.  
  326. You can use DISKDOCTOR on both the standard file system and the FastFile
  327. System. However, to use DISKDOCTOR with the FastFileSystem, YOU MUST MAKE
  328. SURE THAT THE DOSTYPE KEYWORD IN THE MOUNTLIST IS SET TO 0X444F5301. Do NOT
  329. use DISKDOCTOR on the FastFileSystem partition if the DosType Keyword is not
  330. set correctly.
  331.  
  332. With Version 1.3, DISKDOCTOR checks for enough memory before starting
  333. operations and changes the boot block to type DOS.
  334.  
  335. Example:
  336.  
  337. If you receive a message stating that "Volume Workbench is not validated" or
  338. "Error validating disk/Disk is unreadable", you can use DISKDOCTOR to
  339. retrieve the disk's files. For instance, if the corrupt disk is in df1, type:
  340.  
  341. 1> DISKDOCTOR df1:
  342.  
  343. AmigaDOS will ask you to insert the disk to be corrected and press RETURN.
  344. DISKDOCTOR then reads each cylinder of the disk. If it finds an error, it
  345. displays "Hard error Track xx, Surface xx". As each file and directory is
  346. replaced, the filename is displayed on the screen. When DISKDOCTOR is
  347. finished, it says "Now copy files required to a new disk and reformat this
  348. disk."
  349. *:ECHO
  350. Format:     ECHO <string> [NOLINE][FIRST <nn>][LEN <nn>]
  351.  
  352. Template:   ECHO "STRING,NOLINES/S,FIRST/S,LEN/S"
  353.  
  354. Purpose:    To print a string.
  355.  
  356. Path:       C:ECHO
  357.  
  358. Specification:
  359.  
  360. Version 1.3 has introduced the NOLINE option. When the NOLINE option is
  361. specified, ECHO does not automatically output a new line after printing the
  362. string.
  363.  
  364. The FIRST and LEN options allow the echoing of a substring. FIRST <nn>
  365. indicates the character position to begin the echo; LEN <nn> indicates the
  366. number of characters of the substring to echo, beginning with the first
  367. character.
  368.  
  369. If the FIRST option is omitted and only the LEN keyword is given, the
  370. substring printed will consist of the rightmost <nn> characters of the main
  371. string. For instance, if your string is 20 characters long and you specify
  372. LEN <4>, the 17th, 18th, 19th, and 20th characters of the string will be
  373. echoed.
  374. *:ED
  375. Format:     ED [FROM] <filename> [SIZE <n>]
  376.  
  377. Template:   ED "FROM/A,SIZE"
  378.  
  379. Purpose:    To edit text files (a screen editor).
  380.  
  381. Path:       C:ED
  382. *:EDIT
  383. Format:     EDIT [FROM] <filename> [[TO] <filename>] [WITH <filename>]
  384.                  [VER <filename>] [OPT <option>]
  385.  
  386. Template:   EDIT "FROM/A,TO,WITH/K,VER/K,OPT/K"
  387.  
  388. Purpose:    To edit text files by processing the source file sequentially
  389.             (a line editor).
  390.  
  391. Path:       C:EDIT
  392.  
  393. Specification:
  394.  
  395. Worthless - get rid of it.
  396. *:ELSE
  397. Format:     ELSE
  398.  
  399. Template:   ELSE
  400.  
  401. Purpose:    To have an alternative in a conditional in a script file.
  402.  
  403. Path:       C:ELSE
  404. *:ENDCLI
  405. Format:     ENDCLI
  406.  
  407. Template:   ENDCLI
  408.  
  409. Purpose:    To end an interactive CLI process or a SHELL process.
  410.  
  411. Path:       C:ENDCLI
  412.  
  413. Specification:
  414.  
  415. ENDCLI can be used to end either a CLI process or a SHELL process.
  416. *:ENDIF
  417. Format:     ENDIF
  418.  
  419. Template:   ENDIF
  420.  
  421. Purpose:    To terminate an IF block in a script file.
  422.  
  423. Path:       C:ENDIF
  424. *:ENDSKIP
  425. Format:     ENDSKIP
  426.  
  427. Template:   ENDSKIP
  428.  
  429. Purpose:    To terminate a SKIP block in a script file
  430.  
  431. Path:       C:ENDSKIP
  432.  
  433. Specification:
  434.  
  435. When an ENDSKIP is encountered during a SKIP, execution of the script file
  436. resumes at the line following the ENDSKIP. (The condition flag is set to
  437. WARN.)
  438. *:EVAL
  439. Format:     EVAL <value1> <operation> <value2> [TO <file>][LFORMAT=<string>]
  440.  
  441. Template:   EVAL "VALUE1,OPERATION,VALUE2,TO/K,LFORMAT/K"
  442.  
  443. Purpose:    To provide a means of evaluating simple expressions.
  444.  
  445. Path:       C:EVAL
  446.  
  447. Specification:
  448.  
  449. The EVAL command is used to evaluate, and to print the answer of, simple (1
  450. and 2 argument) integer expressions. <value1> and <value2> may be in decimal,
  451. hexedecimal, or octal numbers. Decimal numbers are the default. Hexadecimal
  452. numbers are indicated by either a leading 0X or #X. Octal numbers are
  453. indicated by either a leading 0 or a leading # (followed by other digits).
  454. Alphabetical characters are indicated by a leading single quote (').
  455.  
  456. The supported operations and their corresponding symbols are as follows:
  457.  
  458. addition          +           not                  ~
  459. subtraction       -           left shift           <<
  460. multiplication    *           right shift          >>
  461. division          /           negation             -
  462. mod               mod         exclusive or         xor
  463. and               &           bitwise equivalence  eqv
  464. or                |
  465.  
  466. The output format defaults to decimal; however, through use of the LFORMAT
  467. keyword, you may select another format. The LFORMAT keyword specifies the
  468. formatting string used to print the answer. You may use %X (hexadecimal), %O
  469. (octal), %N (decimal), or %C (character). Note that the %X and %O options
  470. require a "number of digits" specification, (ie. %X8 gives 8 digits of hex
  471. output.)
  472.  
  473. When using the LFORMAT keyword, you can specify that a new line should be
  474. printed by including a *N in your string.
  475.  
  476. EVAL can be used in scripts to act as a counter for loops. In that case, the
  477. TO option, which sends the output of EVAL to a file, is very useful.
  478.  
  479. Examples:
  480.  
  481. 1> EVAL 4 * -5
  482. -20
  483.  
  484. 1> EVAL 0x4f / 010 LFORMAT = "The answer is %X4*N"
  485. The answer is 9
  486.  
  487. Example in a script:
  488.  
  489. .key loop/a
  490. ;demo a loop using eval and skip
  491. .bra {
  492. .ket }
  493. echo >env:loop {loop}
  494. lab start
  495. echo "Loop #" noline
  496. type env:loop
  497. eval <env:loop >NIL: to=t:qwe{$$} value2=1 op=-?
  498. type >env:loop t:qwe{$$}
  499. IF val $loop GT 0
  500. skip start back
  501. endif
  502. echo "done"
  503. *:EXECUTE
  504. Format:     EXECUTE <command file> <arguments>
  505.  
  506. Template:   EXECUTE "COMMANDFILE,ARGUMENTS"
  507.  
  508. Purpose:    To execute a command file with argument substitution.
  509.  
  510. Path:       C:EXECUTE
  511.  
  512. Specification:
  513.  
  514. EXECUTE now uses the logical name T: if it is ASSIGNed; otherwise it uses the
  515. :T directory.
  516.  
  517. Since script files call on the EXECUTE command, it is an excellent candidate
  518. for being made resident when using the SHELL.
  519.  
  520. The current CLI number can be referenced by the characters <$$>. This is
  521. useful in creating unique temporary files, logical assignments, and PIPE
  522. names.
  523.  
  524. See Also:   ASSIGN
  525. *:FAILAT
  526. Format:     FAILAT <n>
  527.  
  528. Template:   FAILAT "RCLIM"
  529.  
  530. Purpose:    To set the failure condition of a script file.
  531.  
  532. Path:       C:FAILAT
  533. *:FAULT
  534. Format:     FAULT <error number>
  535.  
  536. Template:   FAULT ",,,,,,,,,,"
  537.  
  538. Purpose:    To print the specified error message(s).
  539.  
  540. Path:       C:FAULT
  541. *:FF
  542. Format:     FF [-0][-N]
  543.  
  544. Template:   FF "-0/S,-N/S"
  545.  
  546. Purpose:    To speed up text on the Amiga.
  547.  
  548. Path:       C:FF
  549.  
  550. Specification:
  551.  
  552. FF (FastFonts) is a program written by Charlie Heath, of Microsmiths, Inc.
  553. FF speeds up the display of text on the Amiga. To turn on the FastText
  554. routines, use the -0 option. To turn off the FastText routines, use the -N
  555. option. FF can also be used to replace the default system font with a plain
  556. 8x8 pixel font. Use the command: FF <fontname>.
  557.  
  558. FF is used by permission of Microsmiths, Inc.
  559. *:FILENOTE
  560. Format:     FILENOTE [FILE] <filename> COMMENT <comment>
  561.  
  562. Template:   FILENOTE "FILE/A,COMMENT/K"
  563.  
  564. Purpose:    To attach a comment to a file.
  565.  
  566. Path:       C:FILENOTE
  567.  
  568. Specification:
  569.  
  570. The length of <comment> is limited to 79 characters.
  571. *:GETENV
  572. Format:     GETENV <name>
  573.  
  574. Template:   GETENV "NAME/A"
  575.  
  576. Purpose:    To get the value of an environment variable.
  577.  
  578. Path:       C:GETENV
  579.  
  580. Specification:
  581.  
  582. GETENV is used to get the value of an environment variable. Environment
  583. variables are stored in the ENV: handler. (Currently, this is simulated by
  584. using the RAM: disk.)
  585.  
  586. You can use many AmigaDOS commands with the ENV: handler, such as DIR, LIST,
  587. ASSIGN, etc. This gives users great flexibility in working with environment
  588. variables.
  589.  
  590. See also:   SETENV
  591. *:ICONX
  592. Format:     ICONX
  593.  
  594. Template:   ICONX
  595.  
  596. Purpose:    To execute an AmigaDOS script file from Workbench.
  597.  
  598. Path:       C:ICONX
  599.  
  600. Specification:
  601.  
  602. ICONS allows you to execute a script file of AmigaDOS commands from the
  603. Workbench. ICONX changes the current directory to the directory containing
  604. the project icon before executing the script. An input/output window for the
  605. script file is opened on the Workbench screen. You can use the icon's TOOL
  606. TYPES to specify the size of the window (WINDOW=). The DELAY= TOOL TYPES will
  607. add a short delay after the execution of the file is complete to allow time
  608. for reading the output. If a 0 is specified for DELAY=, ICONX waits for a
  609. control-C before exiting.
  610.  
  611. To use ICONX, create a script file (an ASCII file containing AmigaDOS
  612. commands), and attach a project icon to it. (Notepad can be used for this
  613. purpose, as long as you do not use styles and multiple fonts in your
  614. document). Using the Workbench INFO menu item, change the default tool of the
  615. icon to c:ICONX. Add the WINDOW= and DELAY= TOOL TYPES specifications if you
  616. choose. Then save the changed info. To execute the script, double-click on
  617. the icon.
  618.  
  619. You can work through Workbench and use extended selection to pass Workbench
  620. files to the script. These files appear to the script as keywords. To use
  621. this facility, the .key keyword must be at the start of the script. In this
  622. case, the AmigaDOS EXECUTE command is used to execute the script file. Adding
  623. a .key "" or .<space> allows the use of commands that require input in an
  624. ICONX script. (See the AmigaDOS Manual for more information on executing
  625. script files).
  626.  
  627. See Also:   EXECUTE
  628. *:IF
  629. Format:     IF [NOT][WARN][ERROR][FAIL][<string> EQ|GT|GE <string>][VAL]
  630.                [EXISTS <file>]
  631.  
  632. Template:   IF "NOT/S,WARN/S,ERROR/S,FAIL/S,,EQ/K,GT/K,GE/K,VAL/S,EXISTS/K"
  633.  
  634. Purpose:    To handle conditional operations in the script files.
  635.  
  636. Path:       C:IF
  637.  
  638. Specification:
  639.  
  640. In an EXECUTE script file, IF carries out all subsequent commands until an
  641. ENDIF or ELSE command is found.
  642.  
  643. IF now supports the GT (greater than) and GE (greater than or equal to)
  644. comparisons. Normally, the comparisons are performed as string comparisons.
  645. However, if the VAL option is specified, the comparison is a numeric
  646. comparison.
  647.  
  648. The IF command can evaluate environment variables. To specift an environment
  649. variable, the variable's name is prefaced with a $ character.
  650.  
  651. NOTE: You can use NOT GE for LT and NOT GT for LE.
  652.  
  653. For more information on the IF command, see The AmigaDOS Manual.
  654. *:INFO
  655. Format:     INFO [<device>]
  656.  
  657. Template:   INFO "DEVICE"
  658.  
  659. Purpose:    To give information about the file system(s).
  660.  
  661. Path:       C:INFO
  662.  
  663. Specification:
  664.  
  665. INFO's output now adjusts to allow longer volume names. INFO reads reserved
  666. blocks from the environment vector of the specified device.
  667.  
  668. The DEVICE option allows INFO to provide information on just one device or
  669. volume.
  670. *:INSTALL
  671. Format:     INSTALL DRIVE <DF0/A,NOBOOT/S,CHECK/S"
  672.  
  673. Template:   INSTALL "DRIVE/A,NOBOOT/S,CHECK/S"
  674.  
  675. Purpose:    To handle the boot block of a formatted disk.
  676.  
  677. Path:       C:INSTALL
  678.  
  679. Specification:
  680.  
  681. INSTALL now clears memory used to build the boot block. The NOBOOT option
  682. makes the a disk a DOS disk, but not bootable. The CHECK option checks
  683. against valid boot code. INSTALL reports if a disk is bootable, or not, and
  684. whether standard Commodore-Amiga boot code is present on the disk. The
  685. condition flag is set to 0 if the boot code is standard (or the disk isn't
  686. bootable), 5 (=WARN) otherwise.
  687.  
  688. NOTE: INSTALL's NOBOOT option will write the boot block on a non-DOS disk.
  689. *:JOIN
  690. Format:     JOIN <name> <name> * AS|TO <name>
  691.  
  692. Template:   JOIN "NAME(S),TO=AS/K"
  693.  
  694. Purpose:    To concatenate up to 15 files to make a new file.
  695.  
  696. Path:       C:JOIN
  697.  
  698. Specification:
  699.  
  700. TO is now a synonym for AS.
  701. *:LAB
  702. Format:     LAB <string>
  703.  
  704. Template:   LAB "STRING"
  705.  
  706. Purpose:    To specify a label in a script file.
  707.  
  708. Path:       C:LAB
  709. *:LIST
  710. Format:     LIST [<dir|pattern>] [P|PAT <pattern>] [KEYS][DATES][NODATES]
  711.                  [TO <name>][SUB <substring>][SINCE <date>][UPTO <date>]
  712.                  [QUICK][BLOCK][NOHEAD][FILES][DIRS][LFORMAT <string>]
  713.  
  714. Template:   LIST "DIR,P=PAT/K,KEYS/S,DATES/S,NODATES/S,TO/K,SUB/K,SINCE/K
  715.                  UPTO/K,QUICK/S,BLOCK/S,NOHEAD/S,FILES/S,DIRS/S,LFORMAT/K"
  716.  
  717. Purpose:    To list specified information about directories and files.
  718.  
  719. Path:       C:LIST
  720.  
  721. Specification:
  722.  
  723. LIST now displays the new protection bits: s (script), p (pure - used with
  724. the RESIDENT command), and a (archive).
  725.  
  726. When searching for a pattern, you can specify a search string within a
  727. directory. For example, to search for a pattern within the C: directory,
  728. you could type LIST:C:l#?. This would result in a display of all the files
  729. in the C: directory that start with the letter l.
  730.  
  731. The LIST options are as follows:
  732.  
  733.    QUICK    extra spaces are not output after each filename
  734.  
  735.    BLOCK    LIST displays file sizes in blocks, rather than bytes
  736.  
  737.    NOHEAD   supresses the printing of the header information
  738.  
  739.    FILES    limits LIST to displaying files only (no directories)
  740.  
  741.    DIRS     limits LIST to displaying directories only (no files)
  742.  
  743. LFORMAT modifies the output of LIST and can be used as a quick method of
  744. generating script files. When LFORMAT is specified, the QUICK and NOHEAD
  745. options are automatically selected. When using LFORMAT you must specify an
  746. "output format specification" string; this string is incorporated into the
  747. script file. Also, if you want the output to be saved, you must redirect it
  748. to a file by using the > command.
  749.  
  750. The format for the output format specification string (hereafter referred to
  751. as "string") is LFORMAT="string". TO include the output of LIST in this
  752. string, you can specify a %S substitution. The path and filename can also be
  753. part of this string. The number of occurrences of the %S determines the type
  754. of output to be included in the string, as follows.
  755.  
  756.       Number of %S      Output
  757.             1           filename only
  758.             2           path, filename
  759.             3           path, filename, path
  760.             4           path, filename, path, filename
  761.  
  762. Example:
  763.  
  764. 1> LIST >RAM:qwe #? LFORMAT="protect %S -d"
  765.  
  766. A new script file "qwe" is created in RAM:. The contents will include a list
  767. of all the files in the current directory. When "qwe" is executed, it will
  768. remove the delete protection from each file. For instance, the contents may
  769. look like this:
  770.  
  771.    protect Expansion.info -d
  772.    protect Trashcan.info -d
  773.    protect .info -d
  774.    protect c -d
  775.    protect Clock.info -d
  776.    protect Prefs -d
  777.      etc...
  778. *:LOADWB
  779. Format:     LOADWB [DELAY][-DEBUG]
  780.  
  781. Template:   LOADWB "DELAY/S,-DEBUG/S"
  782.  
  783. Purpose:    To start Workbench.
  784.  
  785. Path:       C:LOADWB
  786.  
  787. Specification:
  788.  
  789. The LOADWB command is used to start the Workbench. Normally, this is only
  790. done when booting, by placing the LOADWB command in the startup-sequence
  791. file.
  792.  
  793. Workbench snapshots the current paths in effect when the LOADWB command is
  794. executed. It uses these paths for each CLI (or SHELL) started from the
  795. Workbench.
  796.  
  797. If the DELAY option is specified, LOADWB waits three seconds before exiting.
  798. This allows disk activity to stop before execution continues.
  799.  
  800. The -DEBUG option tells Workbench to bring up a hidden Workbench menu --
  801. DEBUG. This menu contains the menu items Debug and FlushLibs. The Debug item
  802. breaks you into ROMWACK, the Amiga's ROM-resident debugger, so you must have
  803. a 9600 baud serial terminal attached if you intend to use this command!
  804. FlushLibs causes Workbench to attempt to allocate as much memory as possible,
  805. so that any libraries, devices, fonts, etc., resident in memory, but not
  806. currently in use will be expunged. (Assuming that the particular library or
  807. device allows itself to be expunged.)
  808.  
  809. Both the DELAY and -DEBUG options cannot be used at the same time. You can
  810. only choose one or the other.
  811. *:LOCK
  812. Format:     LOCK <drive>: [ON|OFF][<passkey>]
  813.  
  814. Template:   LOCK "DRIVE/A,ON/S,OFF/S,PASSKEY"
  815.  
  816. Purpose:    To set the write protect status of a hard disk using the
  817.             FastFileSystem.
  818.  
  819. Path:       C:LOCK
  820.  
  821. Specification:
  822.  
  823. the LOCK command sets or unsets the write protect status of a hard disk drive
  824. or partition mounted using the FastFileSystem. The LOCK remains on until the
  825. system is rebooted or until the LOCK is turned off with the LOCK OFF command.
  826. An optional 4 character passkey may be specified. If the passkey is used to
  827. lock a hard disk partition, the same passkey must be specified to unlock the
  828. partition.
  829. *:MAKEDIR
  830. Format:     MAKEDIR <dir>
  831.  
  832. Template:   MAKEDIR "DIR/A"
  833.  
  834. Purpose:    To create a new directory.
  835.  
  836. Path:       C:MAKEDIR
  837. *:MOUNT
  838. Format:     MOUNT <device> [FROM <file>]
  839.  
  840. Template:   MOUNT "DEVICE/A,FROM/K"
  841.  
  842. Purpose:    To create an AmigaDOS device node.
  843.  
  844. Path:       C:MOUNT
  845.  
  846. Specification:
  847.  
  848. MOUNT is used to create an AmigaDOS node. In other words, MOUNT informs the
  849. Amiga that an additional device has been added to the system. When the MOUNT
  850. command is issed, MOUNT looks in the DEVS:Mountlist file (or the optional
  851. FROM file) for the parameters of the device that is being mounted.
  852. *:NEWCLI
  853. Format:     NEWCLI [<window specification>][FROM <filename>]
  854.  
  855. Template:   NEWCLI "WINDOW,FROM/K"
  856.  
  857. Purpose:    To start a new interactive CLI with a new window.
  858.  
  859. Path:       C:NEWCLI
  860.  
  861. Specification:
  862. *:NEWSHELL
  863. Format:     NEWSHELL [<window specification>][FROM <filename>]
  864.  
  865. Template:   NEWSHELL "WINDOW,FROM/K"
  866.  
  867. Purpose:    To start a new interactive SHELL with a NEWCON window.
  868.  
  869. Path:       C:NEWSHELL
  870.  
  871. Specification:
  872. *:PATH
  873. Format:     PATH [SHOW][ADD <directory>*][RESET][QUIET]
  874.  
  875. Template:   PATH "SHOW/S,ADD,RESET/S,QUIET/S"
  876.  
  877. Purpose:    To control the PATH list that the CLI uses to search for
  878.             commands.
  879.  
  880. Path:       C:PATH
  881.  
  882. Specification:
  883. *:PROMPT
  884. Format:     PROMPT <prompt>
  885.  
  886. Template:   PROMPT "PROMPT"
  887.  
  888. Purpose:    To change the prompt string of the current CLI.
  889.  
  890. Path:       C:PROMPT
  891.  
  892. Specification:
  893. *:PROTECT
  894. Format:     PROTECT [FILE] <filenmame> [FLAGS] <+-status bits> [ADD][SUB]
  895.  
  896. Template:   PROTECT "FILE/A,FLAGS,ADD/S,SUB/S"
  897.  
  898. Purpose:    To change the protection bits of a file.
  899.  
  900. Path:       C:PROTECT
  901.  
  902. Specification:
  903. *:QUIT
  904. Format:     QUIT <return code>
  905.  
  906. Template:   QUIT "RC"
  907.  
  908. Purpose:    To exit from a script file with a specified error code.
  909.  
  910. Path:       C:QUIT
  911. *:RELABEL
  912. Format:     RELABEL DRIVE <drive>: NAME <name>
  913.  
  914. Template:   RELABEL "DRIVE/A,NAME/A"
  915.  
  916. Purpose:    To change the volume name of a disk.
  917.  
  918. Path:       C:RELABEL
  919. *:REMRAD
  920. Format:     REMRAD
  921.  
  922. Template:   REMRAD
  923.  
  924. Purpose:    To remove the recoverable ramdrive.device.
  925.  
  926. Path:       C:REMRAD
  927.  
  928. Specification:
  929. *:RENAME
  930. Format:     RENAME [FROM] <name> [TO|AS] <name>
  931.  
  932. Template:   RENAME "FROM/A,TO=AS/A"
  933.  
  934. Purpose:    To change the name of a file or directory.
  935.  
  936. Path:       C:RENAME
  937. *:RESIDENT
  938. Format:     RESIDENT <Resident Name> <File> [REMOVE][ADD][REPLACE][PURE]
  939.                      [SYSTEM]
  940.  
  941. Template:   RESIDENT "NAME,FILE,REMOVE/S,ADD/S,REPLACE/S,PURE/S,SYSTEM/S"
  942.  
  943. Purpose:    To load and add commands to the resident list.
  944.  
  945. Path:       C:RESIDENT
  946.  
  947. Specification:
  948. *:RUN
  949. Format:     RUN <command> [+<comment>]
  950.  
  951. Template:   RUN "COMMAND"
  952.  
  953. Purpose:    To execute commands as background processes.
  954.  
  955. Path:       C:RUN
  956.  
  957. Specification:
  958. *:SEARCH
  959. Format:     SEARCH FROM <name> <pattern> [SEARCH]<string>[ALL][NONUM][QUIET]
  960.                    [QUICK][FILE]
  961.  
  962. Template:   SEARCH "FROM,SEARCH/A,ALL/S,NONUM/S,QUIET/QUICK/S,FILE/S"
  963.  
  964. Purpose:    To look for the specified text string in the specified files.
  965.  
  966. Path:       C:SEARCH
  967.  
  968. Specification:
  969. *:SETCLOCK
  970. Format:     SETCLOCK LOAD|SAVE|RESET
  971.  
  972. Template:   SETCLOCK "LOAD/S,SAVE/S,RESET/S"
  973.  
  974. Purpose:    To set or read the real time clock.
  975.  
  976. Path:       C:SETCLOCK
  977.  
  978. Specification:
  979. *:SETDATE
  980. Format:     SETDATE <file> <date> <time>
  981.  
  982. Template:   SETDATE "FILE/A,DATE,TIME"
  983.  
  984. Purpose:    To change the date and time of a file or directory.
  985.  
  986. Path:       C:SETDATE
  987.  
  988. Specification:
  989. *:SETENV
  990. Format:     SETENV <variable name> <variable string>
  991.  
  992. Template:   SETENV "NAME/A,STRING"
  993.  
  994. Purpose:    To set an environment variable.
  995.  
  996. Path:       C:SETENV
  997.  
  998. Specification:
  999. *:SETPATCH
  1000. Format:     SETPATCH [R]
  1001.  
  1002. Template:   SETPATCH "R/S"
  1003.  
  1004. Purpose:    To make ROM patches in Version 1.2 and Version 1.3 Kickstarts.
  1005.  
  1006. Path:       C:SETPATCH
  1007.  
  1008. Specification:
  1009. *:SKIP
  1010. Format:     SKIP <label> [BACK]
  1011.  
  1012. Template:   SKIP "LABEL,BACK/S"
  1013.  
  1014. Purpose:    To skip ahead when executing command files.
  1015.  
  1016. Path:       C:SKIP
  1017.  
  1018. Specification:
  1019. *:SORT
  1020. Format:     SORT [FROM] <filename> [TO] <filename> [COLSTART <n>]
  1021.  
  1022. Template:   SORT "FROM/A,TO/A,COLSTART/K"
  1023.  
  1024. Purpose:    To alphabetically sort each line of a small file.
  1025.  
  1026. Path:       C:SORT
  1027. *:STACK
  1028. Format:     STACK [<n>]
  1029.  
  1030. Template:   STACK "SIZE"
  1031.  
  1032. Purpose:    To display or set the stack size of the current CLI.
  1033.  
  1034. Path:       C:STACK
  1035. *:STATUS
  1036. Format:     STATUS <process> [FULL][TCB][CLI|ALL][COMMAND]
  1037.  
  1038. Template:   STATUS "PROCESS,FULL/S,TCB/S,CLI=ALL/S,COMMAND/K"
  1039.  
  1040. Purpose:    To list information about the CLI/SHELL process.
  1041.  
  1042. Path:       C:STATUS
  1043.  
  1044. Specification:
  1045. *:TYPE
  1046. Format:     TYPE <from> [TO <name>] [OPT H=HEX][N=NUMBER]
  1047.  
  1048. Template:   TYPE "FROM/A,TO/S,OPT/K,HEX/S,NUMBER/S"
  1049.  
  1050. Purpose:    To type a text file.
  1051.  
  1052. Path:       C:TYPE
  1053.  
  1054. Specification:
  1055. *:VERSION
  1056. Format:     VERSION <library name|device name> [<version #>][<revision #>]
  1057.                     [<unit #>]
  1058.  
  1059. Template:   VERSION "NAME,VERSION,REVISION,UNIT"
  1060.  
  1061. Purpose:    To find the version and revision numbers of a Workbench disk.
  1062.  
  1063. Path:       C:VERSION
  1064.  
  1065. Specification:
  1066. *:WAIT
  1067. Format:     WAIT <n> [SEC|SECS][MIN|MINS][UNTIL <time>]
  1068.  
  1069. Template:   WAIT ",SEC=SECS/S,MIN=MINS/S,UNTIL/K"
  1070.  
  1071. Purpose:    To wait for the specified time.
  1072.  
  1073. Path:       C:WAIT
  1074.  
  1075. Specification:
  1076. *:WHICH
  1077. Format:     WHICH <filename> [NORES][RES]
  1078.  
  1079. Template:   WHICH "FILE/A,NORES/S,RES/S"
  1080.  
  1081. Purpose:    To search the command path for a particular command.
  1082.  
  1083. Path:       C:WHICH
  1084.  
  1085. Specification:
  1086. *:WHY
  1087. Format:     WHY
  1088.  
  1089. Template:   WHY
  1090.  
  1091. Purpose:    To print an error message to explain why the previous command
  1092.             failed.
  1093.  
  1094. Path:       C:WHY
  1095.