Home » Recent acquisitions » Acorn ADFS disks » adfs_AcornUser_199801_2.adf » Regulars2 » StarInfo/Fletcher/!Setup/Docs/Commands

StarInfo/Fletcher/!Setup/Docs/Commands

This website contains an archive of files for the Acorn Electron, BBC Micro, Acorn Archimedes, Commodore 16 and Commodore 64 computers, which Dominic Ford has rescued from his private collection of floppy disks and cassettes.

Some of these files were originally commercial releases in the 1980s and 1990s, but they are now widely available online. I assume that copyright over them is no longer being asserted. If you own the copyright and would like files to be removed, please contact me.

Tape/disk: Home » Recent acquisitions » Acorn ADFS disks » adfs_AcornUser_199801_2.adf » Regulars2
Filename: StarInfo/Fletcher/!Setup/Docs/Commands
Read OK:
File size: 0AA6 bytes
Load address: 0000
Exec address: 0000
File contents
---- Setup ----

Script commands
---------------

Syntax:

<> - compulsory statment
<**> - statement may contain spaces
[] - optional statement

Commands:

NAME <*Name*> - sets the name (displayed at the top). Should be the first
statement of your script.

MESSAGE <*Message*> - displays a message in a box

CHOICE <number> <choice1> ... <var num> <message> - brings a confirmation
box

END - quits the setup program

GOTO <*Label*> - goes to a given label

IF <var num> <condition> <value> <*command*> - an if statement...

GOSUB <*Label*> - same as goto, but stores the last position

RETURN - returns from a GOSUB

OPTIONS <number> <choice1> ... <var num> <message> - brings an option
box. The number is stored in binary form (if bit 1 is set, then option
1 was chosen).

RADIOS <number> <choice1> ... <var num> <message> - brings an option
box. The number is stored in binary form (if bit 1 is set, then option
1 was chosen).

GETDIR <DirName> <*message*> - obtains the directory that is to be installed
in. You may either drag the directory out, or drag an existing directory
in. INSTALL will install here, and the system variable tmp$dir is set to
point to it (so you can use COMPARE, COPY, etc). You can call this more than
once!

NEWER [OFF] - Turns the newer feature on [OFF]. When on, will ensure that
only the newest version is installed.

UPDATE <DirName> <*message*> - updates a system resource directory (eg
!System). Performs the same action as !SysMerge, but on a wider range of
system directories.

SWAPDISC <filename> <*message*> - if filename does not exist in the 'Files'
directory, then prompt for a disc change, and set the path to search to
ADFS::0.$ until it does. The user can also drag in a !Setup directory
containing the appropriate files (If, for example, it is stored in an
archive).

INSTALL <filename> [dest] - copys from Files.<filename> to [dest] or the
directory set by GETDIR.

COPY <source> <dest> - copies from <source> to <dest>

DELETE <filename> - erases filename - *** Use with extreme caution ***
DELETE IDEFS::4.$ would probably erase your harddisc!! ('cos force
and recurse are set on). It is best not to copy what you are going to delete
anyway. So... avoid the use of this command (OK, OK, I used it. So what?)

FAST [OFF] - Turns fast mode on [off] - in fast mode the program doesn't
multi-task while it's working.

CHDIR <directory> - checks if <directory> exists. If it doesn't, it is
created! (And, if required, all the sub-directories)

COMPARE <filename1> <filename2> <*message*> - compares <filename1> with
<filename2>. If <filename2> is newer (and exists!), then <message> is
displayed in an error box. If the user clicks on Cancel, then the Setup
process is terminated.
00000000  2d 2d 2d 2d 20 53 65 74  75 70 20 2d 2d 2d 2d 0a  |---- Setup ----.|
00000010  0a 53 63 72 69 70 74 20  63 6f 6d 6d 61 6e 64 73  |.Script commands|
00000020  0a 2d 2d 2d 2d 2d 2d 2d  2d 2d 2d 2d 2d 2d 2d 2d  |.---------------|
00000030  0a 0a 53 79 6e 74 61 78  3a 0a 0a 3c 3e 20 2d 20  |..Syntax:..<> - |
00000040  63 6f 6d 70 75 6c 73 6f  72 79 20 73 74 61 74 6d  |compulsory statm|
00000050  65 6e 74 0a 3c 2a 2a 3e  20 2d 20 73 74 61 74 65  |ent.<**> - state|
00000060  6d 65 6e 74 20 6d 61 79  20 63 6f 6e 74 61 69 6e  |ment may contain|
00000070  20 73 70 61 63 65 73 0a  5b 5d 20 2d 20 6f 70 74  | spaces.[] - opt|
00000080  69 6f 6e 61 6c 20 73 74  61 74 65 6d 65 6e 74 0a  |ional statement.|
00000090  0a 43 6f 6d 6d 61 6e 64  73 3a 0a 0a 4e 41 4d 45  |.Commands:..NAME|
000000a0  20 3c 2a 4e 61 6d 65 2a  3e 20 2d 20 73 65 74 73  | <*Name*> - sets|
000000b0  20 74 68 65 20 6e 61 6d  65 20 28 64 69 73 70 6c  | the name (displ|
000000c0  61 79 65 64 20 61 74 20  74 68 65 20 74 6f 70 29  |ayed at the top)|
000000d0  2e 20 53 68 6f 75 6c 64  20 62 65 20 74 68 65 20  |. Should be the |
000000e0  66 69 72 73 74 0a 73 74  61 74 65 6d 65 6e 74 20  |first.statement |
000000f0  6f 66 20 79 6f 75 72 20  73 63 72 69 70 74 2e 0a  |of your script..|
00000100  0a 4d 45 53 53 41 47 45  20 3c 2a 4d 65 73 73 61  |.MESSAGE <*Messa|
00000110  67 65 2a 3e 20 2d 20 64  69 73 70 6c 61 79 73 20  |ge*> - displays |
00000120  61 20 6d 65 73 73 61 67  65 20 69 6e 20 61 20 62  |a message in a b|
00000130  6f 78 0a 0a 43 48 4f 49  43 45 20 3c 6e 75 6d 62  |ox..CHOICE <numb|
00000140  65 72 3e 20 3c 63 68 6f  69 63 65 31 3e 20 2e 2e  |er> <choice1> ..|
00000150  2e 20 3c 76 61 72 20 6e  75 6d 3e 20 3c 6d 65 73  |. <var num> <mes|
00000160  73 61 67 65 3e 20 2d 20  62 72 69 6e 67 73 20 61  |sage> - brings a|
00000170  20 63 6f 6e 66 69 72 6d  61 74 69 6f 6e 0a 62 6f  | confirmation.bo|
00000180  78 0a 0a 45 4e 44 20 2d  20 71 75 69 74 73 20 74  |x..END - quits t|
00000190  68 65 20 73 65 74 75 70  20 70 72 6f 67 72 61 6d  |he setup program|
000001a0  0a 0a 47 4f 54 4f 20 3c  2a 4c 61 62 65 6c 2a 3e  |..GOTO <*Label*>|
000001b0  20 2d 20 67 6f 65 73 20  74 6f 20 61 20 67 69 76  | - goes to a giv|
000001c0  65 6e 20 6c 61 62 65 6c  0a 0a 49 46 20 3c 76 61  |en label..IF <va|
000001d0  72 20 6e 75 6d 3e 20 3c  63 6f 6e 64 69 74 69 6f  |r num> <conditio|
000001e0  6e 3e 20 3c 76 61 6c 75  65 3e 20 3c 2a 63 6f 6d  |n> <value> <*com|
000001f0  6d 61 6e 64 2a 3e 20 2d  20 61 6e 20 69 66 20 73  |mand*> - an if s|
00000200  74 61 74 65 6d 65 6e 74  2e 2e 2e 0a 0a 47 4f 53  |tatement.....GOS|
00000210  55 42 20 3c 2a 4c 61 62  65 6c 2a 3e 20 2d 20 73  |UB <*Label*> - s|
00000220  61 6d 65 20 61 73 20 67  6f 74 6f 2c 20 62 75 74  |ame as goto, but|
00000230  20 73 74 6f 72 65 73 20  74 68 65 20 6c 61 73 74  | stores the last|
00000240  20 70 6f 73 69 74 69 6f  6e 0a 0a 52 45 54 55 52  | position..RETUR|
00000250  4e 20 2d 20 72 65 74 75  72 6e 73 20 66 72 6f 6d  |N - returns from|
00000260  20 61 20 47 4f 53 55 42  0a 0a 4f 50 54 49 4f 4e  | a GOSUB..OPTION|
00000270  53 20 3c 6e 75 6d 62 65  72 3e 20 3c 63 68 6f 69  |S <number> <choi|
00000280  63 65 31 3e 20 2e 2e 2e  20 3c 76 61 72 20 6e 75  |ce1> ... <var nu|
00000290  6d 3e 20 3c 6d 65 73 73  61 67 65 3e 20 2d 20 62  |m> <message> - b|
000002a0  72 69 6e 67 73 20 61 6e  20 6f 70 74 69 6f 6e 0a  |rings an option.|
000002b0  62 6f 78 2e 20 54 68 65  20 6e 75 6d 62 65 72 20  |box. The number |
000002c0  69 73 20 73 74 6f 72 65  64 20 69 6e 20 62 69 6e  |is stored in bin|
000002d0  61 72 79 20 66 6f 72 6d  20 28 69 66 20 62 69 74  |ary form (if bit|
000002e0  20 31 20 69 73 20 73 65  74 2c 20 74 68 65 6e 20  | 1 is set, then |
000002f0  6f 70 74 69 6f 6e 0a 31  20 77 61 73 20 63 68 6f  |option.1 was cho|
00000300  73 65 6e 29 2e 0a 0a 52  41 44 49 4f 53 20 3c 6e  |sen)...RADIOS <n|
00000310  75 6d 62 65 72 3e 20 3c  63 68 6f 69 63 65 31 3e  |umber> <choice1>|
00000320  20 2e 2e 2e 20 3c 76 61  72 20 6e 75 6d 3e 20 3c  | ... <var num> <|
00000330  6d 65 73 73 61 67 65 3e  20 2d 20 62 72 69 6e 67  |message> - bring|
00000340  73 20 61 6e 20 6f 70 74  69 6f 6e 0a 62 6f 78 2e  |s an option.box.|
00000350  20 54 68 65 20 6e 75 6d  62 65 72 20 69 73 20 73  | The number is s|
00000360  74 6f 72 65 64 20 69 6e  20 62 69 6e 61 72 79 20  |tored in binary |
00000370  66 6f 72 6d 20 28 69 66  20 62 69 74 20 31 20 69  |form (if bit 1 i|
00000380  73 20 73 65 74 2c 20 74  68 65 6e 20 6f 70 74 69  |s set, then opti|
00000390  6f 6e 0a 31 20 77 61 73  20 63 68 6f 73 65 6e 29  |on.1 was chosen)|
000003a0  2e 0a 0a 47 45 54 44 49  52 20 3c 44 69 72 4e 61  |...GETDIR <DirNa|
000003b0  6d 65 3e 20 3c 2a 6d 65  73 73 61 67 65 2a 3e 20  |me> <*message*> |
000003c0  2d 20 6f 62 74 61 69 6e  73 20 74 68 65 20 64 69  |- obtains the di|
000003d0  72 65 63 74 6f 72 79 20  74 68 61 74 20 69 73 20  |rectory that is |
000003e0  74 6f 20 62 65 20 69 6e  73 74 61 6c 6c 65 64 0a  |to be installed.|
000003f0  69 6e 2e 20 59 6f 75 20  6d 61 79 20 65 69 74 68  |in. You may eith|
00000400  65 72 20 64 72 61 67 20  74 68 65 20 64 69 72 65  |er drag the dire|
00000410  63 74 6f 72 79 20 6f 75  74 2c 20 6f 72 20 64 72  |ctory out, or dr|
00000420  61 67 20 61 6e 20 65 78  69 73 74 69 6e 67 20 64  |ag an existing d|
00000430  69 72 65 63 74 6f 72 79  0a 69 6e 2e 20 49 4e 53  |irectory.in. INS|
00000440  54 41 4c 4c 20 77 69 6c  6c 20 69 6e 73 74 61 6c  |TALL will instal|
00000450  6c 20 68 65 72 65 2c 20  61 6e 64 20 74 68 65 20  |l here, and the |
00000460  73 79 73 74 65 6d 20 76  61 72 69 61 62 6c 65 20  |system variable |
00000470  74 6d 70 24 64 69 72 20  69 73 20 73 65 74 20 74  |tmp$dir is set t|
00000480  6f 0a 70 6f 69 6e 74 20  74 6f 20 69 74 20 28 73  |o.point to it (s|
00000490  6f 20 79 6f 75 20 63 61  6e 20 75 73 65 20 43 4f  |o you can use CO|
000004a0  4d 50 41 52 45 2c 20 43  4f 50 59 2c 20 65 74 63  |MPARE, COPY, etc|
000004b0  29 2e 20 59 6f 75 20 63  61 6e 20 63 61 6c 6c 20  |). You can call |
000004c0  74 68 69 73 20 6d 6f 72  65 20 74 68 61 6e 0a 6f  |this more than.o|
000004d0  6e 63 65 21 0a 0a 4e 45  57 45 52 20 5b 4f 46 46  |nce!..NEWER [OFF|
000004e0  5d 20 2d 20 54 75 72 6e  73 20 74 68 65 20 6e 65  |] - Turns the ne|
000004f0  77 65 72 20 66 65 61 74  75 72 65 20 6f 6e 20 5b  |wer feature on [|
00000500  4f 46 46 5d 2e 20 57 68  65 6e 20 6f 6e 2c 20 77  |OFF]. When on, w|
00000510  69 6c 6c 20 65 6e 73 75  72 65 20 74 68 61 74 0a  |ill ensure that.|
00000520  6f 6e 6c 79 20 74 68 65  20 6e 65 77 65 73 74 20  |only the newest |
00000530  76 65 72 73 69 6f 6e 20  69 73 20 69 6e 73 74 61  |version is insta|
00000540  6c 6c 65 64 2e 0a 0a 55  50 44 41 54 45 20 3c 44  |lled...UPDATE <D|
00000550  69 72 4e 61 6d 65 3e 20  3c 2a 6d 65 73 73 61 67  |irName> <*messag|
00000560  65 2a 3e 20 2d 20 75 70  64 61 74 65 73 20 61 20  |e*> - updates a |
00000570  73 79 73 74 65 6d 20 72  65 73 6f 75 72 63 65 20  |system resource |
00000580  64 69 72 65 63 74 6f 72  79 20 28 65 67 0a 21 53  |directory (eg.!S|
00000590  79 73 74 65 6d 29 2e 20  50 65 72 66 6f 72 6d 73  |ystem). Performs|
000005a0  20 74 68 65 20 73 61 6d  65 20 61 63 74 69 6f 6e  | the same action|
000005b0  20 61 73 20 21 53 79 73  4d 65 72 67 65 2c 20 62  | as !SysMerge, b|
000005c0  75 74 20 6f 6e 20 61 20  77 69 64 65 72 20 72 61  |ut on a wider ra|
000005d0  6e 67 65 20 6f 66 0a 73  79 73 74 65 6d 20 64 69  |nge of.system di|
000005e0  72 65 63 74 6f 72 69 65  73 2e 0a 0a 53 57 41 50  |rectories...SWAP|
000005f0  44 49 53 43 20 3c 66 69  6c 65 6e 61 6d 65 3e 20  |DISC <filename> |
00000600  3c 2a 6d 65 73 73 61 67  65 2a 3e 20 2d 20 69 66  |<*message*> - if|
00000610  20 66 69 6c 65 6e 61 6d  65 20 64 6f 65 73 20 6e  | filename does n|
00000620  6f 74 20 65 78 69 73 74  20 69 6e 20 74 68 65 20  |ot exist in the |
00000630  27 46 69 6c 65 73 27 0a  64 69 72 65 63 74 6f 72  |'Files'.director|
00000640  79 2c 20 74 68 65 6e 20  70 72 6f 6d 70 74 20 66  |y, then prompt f|
00000650  6f 72 20 61 20 64 69 73  63 20 63 68 61 6e 67 65  |or a disc change|
00000660  2c 20 61 6e 64 20 73 65  74 20 74 68 65 20 70 61  |, and set the pa|
00000670  74 68 20 74 6f 20 73 65  61 72 63 68 20 74 6f 0a  |th to search to.|
00000680  41 44 46 53 3a 3a 30 2e  24 20 75 6e 74 69 6c 20  |ADFS::0.$ until |
00000690  69 74 20 64 6f 65 73 2e  20 54 68 65 20 75 73 65  |it does. The use|
000006a0  72 20 63 61 6e 20 61 6c  73 6f 20 64 72 61 67 20  |r can also drag |
000006b0  69 6e 20 61 20 21 53 65  74 75 70 20 64 69 72 65  |in a !Setup dire|
000006c0  63 74 6f 72 79 0a 63 6f  6e 74 61 69 6e 69 6e 67  |ctory.containing|
000006d0  20 74 68 65 20 61 70 70  72 6f 70 72 69 61 74 65  | the appropriate|
000006e0  20 66 69 6c 65 73 20 28  49 66 2c 20 66 6f 72 20  | files (If, for |
000006f0  65 78 61 6d 70 6c 65 2c  20 69 74 20 69 73 20 73  |example, it is s|
00000700  74 6f 72 65 64 20 69 6e  20 61 6e 0a 61 72 63 68  |tored in an.arch|
00000710  69 76 65 29 2e 0a 0a 49  4e 53 54 41 4c 4c 20 3c  |ive)...INSTALL <|
00000720  66 69 6c 65 6e 61 6d 65  3e 20 5b 64 65 73 74 5d  |filename> [dest]|
00000730  20 2d 20 63 6f 70 79 73  20 66 72 6f 6d 20 46 69  | - copys from Fi|
00000740  6c 65 73 2e 3c 66 69 6c  65 6e 61 6d 65 3e 20 74  |les.<filename> t|
00000750  6f 20 5b 64 65 73 74 5d  20 6f 72 20 74 68 65 0a  |o [dest] or the.|
00000760  64 69 72 65 63 74 6f 72  79 20 73 65 74 20 62 79  |directory set by|
00000770  20 47 45 54 44 49 52 2e  0a 0a 43 4f 50 59 20 3c  | GETDIR...COPY <|
00000780  73 6f 75 72 63 65 3e 20  3c 64 65 73 74 3e 20 2d  |source> <dest> -|
00000790  20 63 6f 70 69 65 73 20  66 72 6f 6d 20 3c 73 6f  | copies from <so|
000007a0  75 72 63 65 3e 20 74 6f  20 3c 64 65 73 74 3e 0a  |urce> to <dest>.|
000007b0  0a 44 45 4c 45 54 45 20  3c 66 69 6c 65 6e 61 6d  |.DELETE <filenam|
000007c0  65 3e 20 2d 20 65 72 61  73 65 73 20 66 69 6c 65  |e> - erases file|
000007d0  6e 61 6d 65 20 2d 20 2a  2a 2a 20 55 73 65 20 77  |name - *** Use w|
000007e0  69 74 68 20 65 78 74 72  65 6d 65 20 63 61 75 74  |ith extreme caut|
000007f0  69 6f 6e 20 2a 2a 2a 0a  44 45 4c 45 54 45 20 49  |ion ***.DELETE I|
00000800  44 45 46 53 3a 3a 34 2e  24 20 77 6f 75 6c 64 20  |DEFS::4.$ would |
00000810  70 72 6f 62 61 62 6c 79  20 65 72 61 73 65 20 79  |probably erase y|
00000820  6f 75 72 20 68 61 72 64  64 69 73 63 21 21 20 28  |our harddisc!! (|
00000830  27 63 6f 73 20 66 6f 72  63 65 0a 61 6e 64 20 72  |'cos force.and r|
00000840  65 63 75 72 73 65 20 61  72 65 20 73 65 74 20 6f  |ecurse are set o|
00000850  6e 29 2e 20 49 74 20 69  73 20 62 65 73 74 20 6e  |n). It is best n|
00000860  6f 74 20 74 6f 20 63 6f  70 79 20 77 68 61 74 20  |ot to copy what |
00000870  79 6f 75 20 61 72 65 20  67 6f 69 6e 67 20 74 6f  |you are going to|
00000880  20 64 65 6c 65 74 65 0a  61 6e 79 77 61 79 2e 20  | delete.anyway. |
00000890  53 6f 2e 2e 2e 20 61 76  6f 69 64 20 74 68 65 20  |So... avoid the |
000008a0  75 73 65 20 6f 66 20 74  68 69 73 20 63 6f 6d 6d  |use of this comm|
000008b0  61 6e 64 20 28 4f 4b 2c  20 4f 4b 2c 20 49 20 75  |and (OK, OK, I u|
000008c0  73 65 64 20 69 74 2e 20  53 6f 20 77 68 61 74 3f  |sed it. So what?|
000008d0  29 0a 0a 46 41 53 54 20  5b 4f 46 46 5d 20 2d 20  |)..FAST [OFF] - |
000008e0  54 75 72 6e 73 20 66 61  73 74 20 6d 6f 64 65 20  |Turns fast mode |
000008f0  6f 6e 20 5b 6f 66 66 5d  20 2d 20 69 6e 20 66 61  |on [off] - in fa|
00000900  73 74 20 6d 6f 64 65 20  74 68 65 20 70 72 6f 67  |st mode the prog|
00000910  72 61 6d 20 64 6f 65 73  6e 27 74 0a 6d 75 6c 74  |ram doesn't.mult|
00000920  69 2d 74 61 73 6b 20 77  68 69 6c 65 20 69 74 27  |i-task while it'|
00000930  73 20 77 6f 72 6b 69 6e  67 2e 0a 0a 43 48 44 49  |s working...CHDI|
00000940  52 20 3c 64 69 72 65 63  74 6f 72 79 3e 20 2d 20  |R <directory> - |
00000950  63 68 65 63 6b 73 20 69  66 20 3c 64 69 72 65 63  |checks if <direc|
00000960  74 6f 72 79 3e 20 65 78  69 73 74 73 2e 20 49 66  |tory> exists. If|
00000970  20 69 74 20 64 6f 65 73  6e 27 74 2c 20 69 74 20  | it doesn't, it |
00000980  69 73 0a 63 72 65 61 74  65 64 21 20 28 41 6e 64  |is.created! (And|
00000990  2c 20 69 66 20 72 65 71  75 69 72 65 64 2c 20 61  |, if required, a|
000009a0  6c 6c 20 74 68 65 20 73  75 62 2d 64 69 72 65 63  |ll the sub-direc|
000009b0  74 6f 72 69 65 73 29 0a  0a 43 4f 4d 50 41 52 45  |tories)..COMPARE|
000009c0  20 3c 66 69 6c 65 6e 61  6d 65 31 3e 20 3c 66 69  | <filename1> <fi|
000009d0  6c 65 6e 61 6d 65 32 3e  20 3c 2a 6d 65 73 73 61  |lename2> <*messa|
000009e0  67 65 2a 3e 20 2d 20 63  6f 6d 70 61 72 65 73 20  |ge*> - compares |
000009f0  3c 66 69 6c 65 6e 61 6d  65 31 3e 20 77 69 74 68  |<filename1> with|
00000a00  0a 3c 66 69 6c 65 6e 61  6d 65 32 3e 2e 20 49 66  |.<filename2>. If|
00000a10  20 3c 66 69 6c 65 6e 61  6d 65 32 3e 20 69 73 20  | <filename2> is |
00000a20  6e 65 77 65 72 20 28 61  6e 64 20 65 78 69 73 74  |newer (and exist|
00000a30  73 21 29 2c 20 74 68 65  6e 20 3c 6d 65 73 73 61  |s!), then <messa|
00000a40  67 65 3e 20 69 73 0a 64  69 73 70 6c 61 79 65 64  |ge> is.displayed|
00000a50  20 69 6e 20 61 6e 20 65  72 72 6f 72 20 62 6f 78  | in an error box|
00000a60  2e 20 49 66 20 74 68 65  20 75 73 65 72 20 63 6c  |. If the user cl|
00000a70  69 63 6b 73 20 6f 6e 20  43 61 6e 63 65 6c 2c 20  |icks on Cancel, |
00000a80  74 68 65 6e 20 74 68 65  20 53 65 74 75 70 0a 70  |then the Setup.p|
00000a90  72 6f 63 65 73 73 20 69  73 20 74 65 72 6d 69 6e  |rocess is termin|
00000aa0  61 74 65 64 2e 0a                                 |ated..|
00000aa6