home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d5xx / d579 / bintohunk.lha / BinToHunk / BinToHunk.doc < prev    next >
Text File  |  1991-12-22  |  2KB  |  72 lines
  1.  
  2. === BinToHunk - Version 1.0 ===
  3.  
  4. BinToHunk is a utility to convert a raw data file (text, bitmapped
  5. image, etc.) into an Amiga Hunk format object file.
  6.  
  7. Usage:
  8.  
  9.   BinToHunk [<options>] <infile> [<outfile> [<data-ident> [ <length-ident>]]]
  10.  
  11.   <infile>     is the name of the input file.
  12.  
  13.   <outfile>     is the name of the output file.  The default <outfile> is
  14.          the <infile> with a `.o' suffix.
  15.  
  16.   <data-ident>     is the name of the symbol for the array that contains the
  17.          data.  It should start with an underscore if it is to be
  18.          used from C code.  The default <data-ident> is <infile>
  19.          without a suffix and a `_' prepended.
  20.  
  21.   <length-ident> is the name of the symbol that gives the number of
  22.          elements in the <data-ident> array.  It should start with
  23.          an underscore if it is to be used from C code.  The default
  24.          <length-ident> is <data-ident> with a `_length' appended.
  25.  
  26.   <options>:
  27.  
  28.     -c         Make hunk load into Chip RAM.
  29.  
  30.     -f         Make hunk load into Fast RAM.
  31.  
  32.     -l         Don't generate a length symbol.
  33.  
  34.     -t[<term>]     Add a terminator <term> to the end of the array.  The
  35.          default <term> is zero.
  36.  
  37.     -s<size>     Specify the size of the elements in the array to be <size>
  38.          bytes.  If -s is not used, the default <size> is 1.
  39.  
  40.     -a         Make length symbol an absolute definition.  This could be
  41.          useful for assembly programmers.
  42.  
  43. If necessary, the data will be padded with zeros to make an even number of
  44. elements in the array.
  45.  
  46.  
  47. === Examples ===
  48.  _______________________________________________________________________
  49. /                                    \
  50.  Command line:
  51.  
  52.    BinToHunk -l -t help.txt
  53.  
  54.  External declaration in C source code:
  55.  
  56.    extern char help[];        /* Zero terminated character string. */
  57. \_______________________________________________________________________/
  58. /                                    \
  59.  Command line:
  60.  
  61.    BinToHunk -s4 image.data  
  62.  
  63.  External declaration in C source code:
  64.  
  65.    extern ULONG image[];    /* Array of 32-bit words. */
  66.    extern ULONG image_length;    /* 32-bit word. */
  67. \_______________________________________________________________________/
  68.  
  69.  
  70. Ray Burr - December 1, 1991
  71. hoggle!ryb@peora.sdc.ccur.com
  72.