Home » Personal collection » Acorn ADFS disks » Electron » PRES_E00_backup.ADF » Help/Utils

Help/Utils

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 » Personal collection » Acorn ADFS disks » Electron » PRES_E00_backup.ADF
Filename: Help/Utils
Read OK:
File size: 057F bytes
Load address: 0000
Exec address: 0000
File contents
             ** UTILS **

UTILS  is a  menu  program  designed to
provide easy access to the utilities in
the library directory on a disc.
 It also  provides access to help files
about these utilities.

The menu entries have the form:

Key *FileName  or
Key  FileName

where  the '*',  if present,  signifies
that the utility is written in  machine
code, rather  than  being an EXECutable
command file.

To run a utility, press the key  beside
it. Choosing an EXECutable command file
utility  will  result in  that  utility
being  directly  executed. Selecting  a
machine code  utility will  result in a
prompt  for any command-line arguments,
after which the utility wil be called.


Note that, outside of the menu program,
all  utilities  may  be  called  with a
command line of the form:

*UtilName

To  exit from  the Utility menu, simply
press ESCAPE.


Adding utilities
----------------

To add a utility  in such a way that it
will be recognised by the menu program,
you need to do two things:

1. Add the utility to $.Library
2. Add help information to $.Help


The utility may either be machine code,
or  be a textual  (EXECutable)  command
file. Command  files are  recognised by
having an execute address of &FFFFFFFF,
and  may be created  using *Build; they
will typically contain the two lines:

*BASIC
CH."$.Library.BASIC.UtilName"


Help information should be formatted to
be read in mode 6.
00000000  20 20 20 20 20 20 20 20  20 20 20 20 20 2a 2a 20  |             ** |
00000010  55 54 49 4c 53 20 2a 2a  0d 0d 55 54 49 4c 53 20  |UTILS **..UTILS |
00000020  20 69 73 20 61 20 20 6d  65 6e 75 20 20 70 72 6f  | is a  menu  pro|
00000030  67 72 61 6d 20 20 64 65  73 69 67 6e 65 64 20 74  |gram  designed t|
00000040  6f 0d 70 72 6f 76 69 64  65 20 65 61 73 79 20 61  |o.provide easy a|
00000050  63 63 65 73 73 20 74 6f  20 74 68 65 20 75 74 69  |ccess to the uti|
00000060  6c 69 74 69 65 73 20 69  6e 0d 74 68 65 20 6c 69  |lities in.the li|
00000070  62 72 61 72 79 20 64 69  72 65 63 74 6f 72 79 20  |brary directory |
00000080  6f 6e 20 61 20 64 69 73  63 2e 0d 20 49 74 20 61  |on a disc.. It a|
00000090  6c 73 6f 20 20 70 72 6f  76 69 64 65 73 20 61 63  |lso  provides ac|
000000a0  63 65 73 73 20 74 6f 20  68 65 6c 70 20 66 69 6c  |cess to help fil|
000000b0  65 73 0d 61 62 6f 75 74  20 74 68 65 73 65 20 75  |es.about these u|
000000c0  74 69 6c 69 74 69 65 73  2e 0d 0d 54 68 65 20 6d  |tilities...The m|
000000d0  65 6e 75 20 65 6e 74 72  69 65 73 20 68 61 76 65  |enu entries have|
000000e0  20 74 68 65 20 66 6f 72  6d 3a 0d 0d 4b 65 79 20  | the form:..Key |
000000f0  2a 46 69 6c 65 4e 61 6d  65 20 20 6f 72 0d 4b 65  |*FileName  or.Ke|
00000100  79 20 20 46 69 6c 65 4e  61 6d 65 0d 0d 77 68 65  |y  FileName..whe|
00000110  72 65 20 20 74 68 65 20  27 2a 27 2c 20 20 69 66  |re  the '*',  if|
00000120  20 70 72 65 73 65 6e 74  2c 20 20 73 69 67 6e 69  | present,  signi|
00000130  66 69 65 73 0d 74 68 61  74 20 74 68 65 20 75 74  |fies.that the ut|
00000140  69 6c 69 74 79 20 69 73  20 77 72 69 74 74 65 6e  |ility is written|
00000150  20 69 6e 20 20 6d 61 63  68 69 6e 65 0d 63 6f 64  | in  machine.cod|
00000160  65 2c 20 72 61 74 68 65  72 20 20 74 68 61 6e 20  |e, rather  than |
00000170  20 62 65 69 6e 67 20 61  6e 20 45 58 45 43 75 74  | being an EXECut|
00000180  61 62 6c 65 0d 63 6f 6d  6d 61 6e 64 20 66 69 6c  |able.command fil|
00000190  65 2e 0d 0d 54 6f 20 72  75 6e 20 61 20 75 74 69  |e...To run a uti|
000001a0  6c 69 74 79 2c 20 70 72  65 73 73 20 74 68 65 20  |lity, press the |
000001b0  6b 65 79 20 20 62 65 73  69 64 65 0d 69 74 2e 20  |key  beside.it. |
000001c0  43 68 6f 6f 73 69 6e 67  20 61 6e 20 45 58 45 43  |Choosing an EXEC|
000001d0  75 74 61 62 6c 65 20 63  6f 6d 6d 61 6e 64 20 66  |utable command f|
000001e0  69 6c 65 0d 75 74 69 6c  69 74 79 20 20 77 69 6c  |ile.utility  wil|
000001f0  6c 20 20 72 65 73 75 6c  74 20 69 6e 20 20 74 68  |l  result in  th|
00000200  61 74 20 20 75 74 69 6c  69 74 79 0d 62 65 69 6e  |at  utility.bein|
00000210  67 20 20 64 69 72 65 63  74 6c 79 20 20 65 78 65  |g  directly  exe|
00000220  63 75 74 65 64 2e 20 53  65 6c 65 63 74 69 6e 67  |cuted. Selecting|
00000230  20 20 61 0d 6d 61 63 68  69 6e 65 20 63 6f 64 65  |  a.machine code|
00000240  20 20 75 74 69 6c 69 74  79 20 77 69 6c 6c 20 20  |  utility will  |
00000250  72 65 73 75 6c 74 20 69  6e 20 61 0d 70 72 6f 6d  |result in a.prom|
00000260  70 74 20 20 66 6f 72 20  61 6e 79 20 63 6f 6d 6d  |pt  for any comm|
00000270  61 6e 64 2d 6c 69 6e 65  20 61 72 67 75 6d 65 6e  |and-line argumen|
00000280  74 73 2c 0d 61 66 74 65  72 20 77 68 69 63 68 20  |ts,.after which |
00000290  74 68 65 20 75 74 69 6c  69 74 79 20 77 69 6c 20  |the utility wil |
000002a0  62 65 20 63 61 6c 6c 65  64 2e 0d 0d 0d 4e 6f 74  |be called....Not|
000002b0  65 20 74 68 61 74 2c 20  6f 75 74 73 69 64 65 20  |e that, outside |
000002c0  6f 66 20 74 68 65 20 6d  65 6e 75 20 70 72 6f 67  |of the menu prog|
000002d0  72 61 6d 2c 0d 61 6c 6c  20 20 75 74 69 6c 69 74  |ram,.all  utilit|
000002e0  69 65 73 20 20 6d 61 79  20 20 62 65 20 20 63 61  |ies  may  be  ca|
000002f0  6c 6c 65 64 20 20 77 69  74 68 20 61 0d 63 6f 6d  |lled  with a.com|
00000300  6d 61 6e 64 20 6c 69 6e  65 20 6f 66 20 74 68 65  |mand line of the|
00000310  20 66 6f 72 6d 3a 0d 0d  2a 55 74 69 6c 4e 61 6d  | form:..*UtilNam|
00000320  65 0d 0d 54 6f 20 20 65  78 69 74 20 66 72 6f 6d  |e..To  exit from|
00000330  20 20 74 68 65 20 55 74  69 6c 69 74 79 20 6d 65  |  the Utility me|
00000340  6e 75 2c 20 73 69 6d 70  6c 79 0d 70 72 65 73 73  |nu, simply.press|
00000350  20 45 53 43 41 50 45 2e  0d 0d 0d 41 64 64 69 6e  | ESCAPE....Addin|
00000360  67 20 75 74 69 6c 69 74  69 65 73 0d 2d 2d 2d 2d  |g utilities.----|
00000370  2d 2d 2d 2d 2d 2d 2d 2d  2d 2d 2d 2d 0d 0d 54 6f  |------------..To|
00000380  20 61 64 64 20 61 20 75  74 69 6c 69 74 79 20 20  | add a utility  |
00000390  69 6e 20 73 75 63 68 20  61 20 77 61 79 20 74 68  |in such a way th|
000003a0  61 74 20 69 74 0d 77 69  6c 6c 20 62 65 20 72 65  |at it.will be re|
000003b0  63 6f 67 6e 69 73 65 64  20 62 79 20 74 68 65 20  |cognised by the |
000003c0  6d 65 6e 75 20 70 72 6f  67 72 61 6d 2c 0d 79 6f  |menu program,.yo|
000003d0  75 20 6e 65 65 64 20 74  6f 20 64 6f 20 74 77 6f  |u need to do two|
000003e0  20 74 68 69 6e 67 73 3a  0d 0d 31 2e 20 41 64 64  | things:..1. Add|
000003f0  20 74 68 65 20 75 74 69  6c 69 74 79 20 74 6f 20  | the utility to |
00000400  24 2e 4c 69 62 72 61 72  79 0d 32 2e 20 41 64 64  |$.Library.2. Add|
00000410  20 68 65 6c 70 20 69 6e  66 6f 72 6d 61 74 69 6f  | help informatio|
00000420  6e 20 74 6f 20 24 2e 48  65 6c 70 0d 0d 0d 54 68  |n to $.Help...Th|
00000430  65 20 75 74 69 6c 69 74  79 20 6d 61 79 20 65 69  |e utility may ei|
00000440  74 68 65 72 20 62 65 20  6d 61 63 68 69 6e 65 20  |ther be machine |
00000450  63 6f 64 65 2c 0d 6f 72  20 20 62 65 20 61 20 74  |code,.or  be a t|
00000460  65 78 74 75 61 6c 20 20  28 45 58 45 43 75 74 61  |extual  (EXECuta|
00000470  62 6c 65 29 20 20 63 6f  6d 6d 61 6e 64 0d 66 69  |ble)  command.fi|
00000480  6c 65 2e 20 43 6f 6d 6d  61 6e 64 20 20 66 69 6c  |le. Command  fil|
00000490  65 73 20 61 72 65 20 20  72 65 63 6f 67 6e 69 73  |es are  recognis|
000004a0  65 64 20 62 79 0d 68 61  76 69 6e 67 20 61 6e 20  |ed by.having an |
000004b0  65 78 65 63 75 74 65 20  61 64 64 72 65 73 73 20  |execute address |
000004c0  6f 66 20 26 46 46 46 46  46 46 46 46 2c 0d 61 6e  |of &FFFFFFFF,.an|
000004d0  64 20 20 6d 61 79 20 62  65 20 63 72 65 61 74 65  |d  may be create|
000004e0  64 20 20 75 73 69 6e 67  20 2a 42 75 69 6c 64 3b  |d  using *Build;|
000004f0  20 74 68 65 79 0d 77 69  6c 6c 20 74 79 70 69 63  | they.will typic|
00000500  61 6c 6c 79 20 63 6f 6e  74 61 69 6e 20 74 68 65  |ally contain the|
00000510  20 74 77 6f 20 6c 69 6e  65 73 3a 0d 0d 2a 42 41  | two lines:..*BA|
00000520  53 49 43 0d 43 48 2e 22  24 2e 4c 69 62 72 61 72  |SIC.CH."$.Librar|
00000530  79 2e 42 41 53 49 43 2e  55 74 69 6c 4e 61 6d 65  |y.BASIC.UtilName|
00000540  22 0d 0d 0d 48 65 6c 70  20 69 6e 66 6f 72 6d 61  |"...Help informa|
00000550  74 69 6f 6e 20 73 68 6f  75 6c 64 20 62 65 20 66  |tion should be f|
00000560  6f 72 6d 61 74 74 65 64  20 74 6f 0d 62 65 20 72  |ormatted to.be r|
00000570  65 61 64 20 69 6e 20 6d  6f 64 65 20 36 2e 0d     |ead in mode 6..|
0000057f
Help/Utils.m0
Help/Utils.m1
Help/Utils.m2
Help/Utils.m4
Help/Utils.m5