home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / jsage / zsus / z3help / m.lbr / MYLOAD.HZP / MYLOAD.HLP
Encoding:
Text File  |  1991-11-18  |  6.5 KB  |  129 lines
  1. ;
  2.                                  MYLOAD.COM                                   
  3.  
  4.              Size (recs) CRC   Version    Author/Latest Issue      Disk
  5.                4k (32)   9BCF  1.1        Hal Bower 3/91           Z3COM13
  6.  
  7.   1- Syntax  2- Usage  3- Configuration  4- Error Messages  5- Notes          
  8.  
  9.  
  10.    MYLOAD is an Intel HEX file loader/overlayer.   It is written as a Z-System
  11. Tool, and relies heavily on Version 4 of  The Libraries for  proper operation.
  12. As a Z-System tool,  it accepts DU: or DIR: specifications for re-direction of
  13. file input.   It  also contains  an extensive  parser to  alleviate  excessive
  14. typing.   File Types may  be  specified or default,  but  the  file  format is
  15. somewhat restricted by the basic function of overlaying/loading Intel-standard
  16. HEX files to produce a standard COM file.
  17.  
  18.    While MYLOAD is primarily intended to apply HEX overlays onto COM files, it
  19. also functions like the old CP/M LOAD.COM.  Vs 1.0 (2/17/90) by Hal Bower.
  20. :1
  21.  Syntax   MYLOAD [dir][comfil[.com][=][dir][oldcom[.hex]][,fil1[.hex]][,...]
  22.  
  23.    If no destination file is specified,  the name  of the  first input file is
  24. taken for the output file.  If the first specified file is of type HEX, then a
  25. simple HEX load is assumed, followed by optional HEX overlays.   Addresses are
  26. validated to insure that no HEX overlay  specifies an  address  less than 100H
  27. (if overlaying COM) or the first HEX load address if loading a HEX file.
  28. :2
  29.  Usage - 1/4 
  30.  
  31.    Myload will load FILE.HEX from and  write FILE.COM to the current Drive and
  32. User areas.  If operating in  the Verbose mode (See Configuration),  a message
  33. will be displayed that FILE.COM cannot be located (assuming none exists),  and
  34. that the program is switching to FILE.HEX.   If FILE.COM already exists in the
  35. current user area,  it will be loaded,  then FILE.HEX loaded over it.   Before
  36. writing the new file to  disk,  a check is made for the presence of the output
  37. file,  and you have the option of replacing the existing file, or aborting the
  38. write.   To load  FILE.HEX to  a  COM file in another User area, or on another
  39. drive, use the syntax:
  40.  
  41.     MYLOAD DU:=file   or   MYLOAD DIR:=file   (on a Z-System)
  42.  Usage - 2/4 
  43.  
  44.    Multiple HEX files may also be loaded  and combined into  a single COM file
  45. by simply listing their names separated by spaces,  commas or other recognized
  46. delimiters as:
  47.  
  48.         MYLOAD file1,file2, file3,...
  49.  
  50.    As in the simple load case,  this example  will  produce  FILE1.COM  from a
  51. successive load  of FILE1.HEX  (assuming FILE1.COM does not exist), FILE2.HEX,
  52. FILE3.HEX, etc.   If FILE1.COM already  exists,  it  will  be overlayed by the
  53. following HEX files.  Explicit DU: or DIR: specifications are accepted for all
  54. file entries.  An example of multiple file overlaying is:
  55.  
  56.     MYLOAD A15:newfile=b3:oldfile work:ovrlay1 newpatch.hx
  57.  
  58.    In this example, the file NEWFILE.COM would be written to Drive A, User 15.
  59. It would be  comprised  of OLDFILE.COM  (or OLDFILE.HEX if  no COM found) from 
  60. User Area  3  on  Drive B,  overlayed  with  OVRLAY1.HEX in  the  WORK:  Named 
  61. Directory and NEWPATCH.HX (which  must be  a standard HEX file) in the current
  62. Drive and User area.
  63.  Usage - 3/4  
  64.  
  65.    Likewise, Named Directories will be printed in a  Z-System where a Name has
  66. been defined for a Drive/User.   If no Name is located, then status lines will
  67. use the DU: form.  When operating in  a "vanilla" CP/M system, the DU: form is
  68. always used for input and output.
  69.  
  70.    MYLOAD also senses specified  File  Types,  and will not override any which
  71. are so entered with the default COM or HEX.   It is therefore possible to make
  72. an OBJ or other user-specified type for output,  or overlay an input file with
  73. types other than HEX.  The contents of the overlay files will,  however,  have
  74. to follow the  required  Intel-standard  Hex  file  formats.   There  are  two
  75. constraints imposed  by  this.   The first is that no  writes are permitted to
  76. page 0, or any address less than 100H;  and the  second is that the first file
  77. in the argument string,  if no  assignment of an output name is made (no equal
  78. sign), or the first name after the equal sign MUST be EITHER .COM or .HEX.
  79.  Usage - 4/4 
  80.  
  81.    The contents of the  overlay  files  will,  however,  have  to  follow  the
  82. required Intel-standard Hex file formats.   There are two  constraints imposed
  83. by this.   The first is that no writes are permitted to page 0, or any address
  84. less than 100H;  and the second is that the first file in the argument string,
  85. if no assignment of an output name is made (no equal sign),  or the first name
  86. after the equal sign MUST be EITHER .COM or .HEX.
  87. :3
  88.  Configuration 
  89.  
  90.    Two options may be specified by  configuration  bytes in the MYLOAD header.
  91. The first of these  bytes,  located at  115H,  causes  Verbose output with all
  92. status messages to be  displayed.   Setting  this  byte to  a binary Zero will
  93. reduce output to the terminal to only essential  messages,  and errors.   On a
  94. system operating under ZCPR 3.x, this local flag is combined with the Z-System
  95. Quiet flag, so a  "Quiet"  mode will only be  selected when both the local and
  96. ZCPR flag bytes are Zero.
  97.  
  98.    The second byte controls whether a  BELL  character is sent to the terminal
  99. when errors are detected.   If this beeping creates  an annoyance,  it  may be
  100. disabled by setting the configuration byte  at 116H to  a  binary Zero.   
  101.  
  102.    Both configuration bytes may be changed by overlaying with a HEX file using
  103. MYLOAD, or with  Al Hawley's  excellent  ZCNFG tool  via  the  MYLOAD.CFG file
  104. contained in the release package.
  105. :4
  106.  Error Messages 
  107.  
  108.    The following decimal values are stored in the ZCPR3  Program Error Flag by
  109. MYLOAD.   The Program Error Flag is  unaffected by  executing  MYLOAD  for its
  110. built-in syntax help screen only.
  111.  
  112.    0    No error detected, normal MYLOAD run
  113.    1    DOS File Open error
  114.    2    DOS File Read error or unexpected EOF
  115.    3    DOS File Write or Close error
  116.    4    DOS insufficient directory space error
  117.    5    No file contents to save to disk
  118.    6    Memory overflow error
  119.    7    HEXfile lower bound exceeded error
  120.    8    HEXfile checksum error
  121.    9    One or more requested files not found
  122. :5
  123.  MYLOAD Notes 
  124.  
  125.    a. Version 1.1 updates (3/21/91, Bruce Morgen): 
  126.       - Fixed bugs under non-Z
  127.       - Added TINIT/DINIT calls,  Program Error Flag support,  more precise Z3
  128.         parsing, use actual program name in syntax help screen.
  129.