home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 3 / goldfish_volume_3.bin / files / dev / misc / data2object / d2o.doc < prev    next >
Encoding:
Text File  |  1994-02-20  |  3.8 KB  |  155 lines
  1. NAME
  2.  
  3.     d2o (Short for Data2Object) $VER: 1.3 (18.2.94)
  4.  
  5.  
  6. SYNOPSIS
  7.  
  8.     This program makes an object file out of a text file. It's a 2.04 and
  9.     up only program.
  10.  
  11.  
  12. FUNCTION
  13.  
  14.     Sometimes you want to have a large text file into your code. For
  15.     example a built-in helpfile. d2o gives an easy way to do just that.
  16.     It takes the textfile as an argument an produces a standard object
  17.     file.
  18.  
  19.     An example for in a makefile:
  20.  
  21.     -----------------------------------------------
  22.         OBJ = aMain.o aTextHelp.o
  23.  
  24.         Prog: $(OBJ)
  25.             slink WITH prog.lnk
  26.  
  27.         aTextHelp.o: Prog.Help
  28.             d2o Prog.Help SYMBOL TextHelp OBJECT aTextHelp.o
  29.  
  30.         c.o.:
  31.             sc $*
  32.     -----------------------------------------------
  33.  
  34.     So when you change the helpfile Prog.Help, the object file will be
  35.     automaticly created. The helpfile is accessible through the symbols
  36.     pTextHelp and lTextHelpLen. pTextHelp is a text array (TEXT) off the
  37.     helpfile. lTextHelpLen is a LONG and gives the length of the helpfile.
  38.  
  39.     Don't forget to take the following two lines into your program:
  40.  
  41.         extern LONG lTextHelpLen;
  42.         extern TEXT pTextHelp[];
  43.  
  44.  
  45.    Of course, the name of the variables depends on the name you give to
  46.    them with the SYMBOL option.
  47.  
  48.  
  49. INPUTS
  50.  
  51.     d2o FILE/A,CHIP/S,FAST/S,SYMBOL/K,OBJECT/K
  52.  
  53.  
  54.     CHIP
  55.  
  56.     With the CHIP switch the data will be loaded into chip ram. This is
  57.     nescesary for graphics and sound data.
  58.  
  59.  
  60.     FAST
  61.  
  62.     With the FAST switch the data will be loaded into fast ram. Be
  63.     carefull when you use this option, because not all computers have fast
  64.     ram.
  65.  
  66.  
  67.     SYMBOL
  68.  
  69.     The symbol name is the base name of the generated symbols pText and
  70.     pTextLen. The default basename is 'Text' and gives the two symbol
  71.     names 'pText' and 'lTextLen', but it can also be 'Help'. This gives
  72.     the two symbol names pHelp and lHelpLen.
  73.  
  74.  
  75.     OBJECT
  76.  
  77.     If no object name is given, it wil get the default object name
  78.     'Text.o'. If you specify a name there will be no '.o' appended to it.
  79.  
  80.  
  81.  
  82. RESULTS
  83.  
  84.     An object file with the following symbols:
  85.  
  86.         TEXT   pText[];     /* Pointer to the text    */
  87.         LONG   lTextLen;    /* Length of the textfile */
  88.  
  89.     d2o returns 0 when succesfull and 10 in case of an error.
  90.  
  91.  
  92.  
  93. NOTES
  94.  
  95.     When the CHIP and the FAST option both are specified the memory type
  96.     is the default MEMF_ANY.
  97.  
  98.     It is only tested with slink from SAS, but it should work with other
  99.     linkers to.
  100.  
  101.     d2o takes any file as an input file and stores it in one large chunk
  102.     of code. So you could also use it for graphic data or any other file.
  103.     However, this is not tested so be warned if it doesn't work.
  104.  
  105.  
  106.  
  107. ADDRESS
  108.  
  109.                 Matthijs Luger
  110.  
  111.     Internet:   mluger@bio.vu.nl
  112.  
  113.     Fidonet:    2:280/509.4
  114.                 2:280/303.4
  115.  
  116.  
  117. RELEASE
  118.  
  119.     v1.0 (29.9.93) 9096 bytes
  120.     -------------------------
  121.  
  122.         o Initial release.
  123.  
  124.  
  125.     v1.1 (1.11.93) 9208 bytes
  126.     -------------------------
  127.  
  128.         o Added -c option so data will be loaded into CHIP_RAM.
  129.         o Updated the manual and changed the reference off STRPTR to TEXT.
  130.  
  131.  
  132.     v1.2 (23.22.93) 9208 bytes
  133.     --------------------------
  134.  
  135.         o There were some typo's in the manual.
  136.  
  137.  
  138.     v1.3 (18.2.94) 2076 bytes
  139.     -------------------------
  140.  
  141.         o Added ReadArgs() for argument parsing. From now on d2o is a
  142.           2.04+ only program.
  143.  
  144.         o Added FAST switch.
  145.  
  146.         o Added return codes when something goes wrong. d2o returns 10 in
  147.           case of any error. (file not found, wrong arguments, not enough 
  148.           memory or no arguments)
  149.  
  150.         o Optimized some routines, removed sprintf() function, removed
  151.           startup module and recompiled with other switches. The
  152.           executable is now four times smaller then v1.2.
  153.           
  154.         o Added examples in assembler and C.
  155.