home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / DMAKE38A.ZIP / _INSTALL next >
Text File  |  1992-01-23  |  9KB  |  202 lines
  1. INSTALLATION INSTRUCTIONS
  2.  
  3. This file contains the instructions required to install and create the
  4. appropriate version of dmake.
  5.  
  6. NOTE:  If you use dmake to bootstrap a NEW DISTRIBUTED version or to remake
  7.        it after applying a PATCH, it may be NECESSARY to use the batch
  8.        script instead of dmake as a patch may incorporate changes to the
  9.        makefile.mk file and associated config.mk files that cannot be
  10.        handled by earlier versions of dmake.  The use of the batch files
  11.        is the ONLY supported method of making a new release or update
  12.        version.
  13.  
  14. MAKING THE PROPER VERSION
  15.  
  16. The list of available versions of dmake has grown quite large.  The best
  17. method to determine what versions are available for your configuration is to
  18. simply issue the command 'make' in the source root directory.  Below is a
  19. partial list of the available versions to give an idea of what is supported.
  20. Note that this copy of the list is not maintained up to date.
  21.  
  22.     bsd43       - Generic BSD 4.3 (eg, true BSD, apollo, Sun OS4, SGI etc)
  23.     bsd43uw       - Generic BSD 4.3 at U of Waterloo
  24.     bsd43vf       - Generic BSD with no vfprintf in its library  (use this
  25.              target if you are missing the vfprintf function in your
  26.              C library)
  27.     sysvr3       - Generic SysV R3 UNIX
  28.     sysvr1       - Generic SysV R1 UNIX
  29.     386ix      - 386/ix (SysV R3), not tested
  30.     dynix      - Sequent Symmetry dynix
  31.     ultrix       - Ultrix 3.0 system
  32.     mips       - Any MIPS box
  33.         os2msc60   - OS/2 with MSC 6.0
  34.     tos        - Atari-ST using GCC as compiler
  35.         tcc        - DOS with tcc 2.0
  36.         tccswp     - swapping DOS version with tcc 2.0
  37.         msc60      - DOS with MSC 6.0
  38.         msc60swp   - swapping DOS version with MSC 6.0
  39.  
  40. The file 'makefile' understands these targets and runs the appropriate script
  41. to create the correct version.
  42.  
  43. The source code is organized as follows:
  44.  
  45.             dmake         [source for all common functions]
  46.               |
  47.               |
  48.         ----------------------------
  49.         |       |          |          |
  50.        unix   tos      os2       msdos  [source for OS specific functions]
  51.         |                |          |
  52.   --------------------    mscdos    -------------------
  53.   |         |        |              |       |         |
  54. 386ix     bsd43  sysvr[134]      tccdos   bccdos   mscdos  [source for OSRELEASE
  55.         |                                      specific functions] 
  56.     --------
  57.     |      |
  58.        uw      vf   [source for OSENVIRONMENT specific functions]
  59.  
  60.  
  61. Each of the directories (eg. bsd43, mscdos, tccdos, and sysvr3) contain source
  62. that is specific to that release of the OS (and possibly C-library)
  63. To make the appropriate versions of dmake, simply type the command
  64.  
  65.     'make system'
  66.  
  67. where system is one of the supplied possibilities.  Note that if you are using
  68. an earlier version of dmake to make a new version from scratch then you must
  69. use the command:
  70.  
  71.     'dmake -f makefile system'
  72.  
  73. as dmake by default first reads makefile.mk and would thus use the wrong
  74. makefile for bootstrapping purposes.
  75.  
  76. The bootstrapping of dmake is accomplished by running a shell script with the
  77. appropriate compile commands hard coded.
  78.  
  79. (NOTE:  If you are using MSDOS then, you will actually be using the make.bat
  80.     scriptfile to make the correct version of dmake for MSDOS.  If you
  81.     are running a SHELL other than command.com, you may have to perform
  82.     some extra work to invoke the batch file.
  83.     
  84.     Make sure you read the readme/msdos file before attempting to make the
  85.     MSDOS version, as it contains important configuration and limitation
  86.     information.)
  87.  
  88. The making of dmake, echoes the commands being executed, and should proceed
  89. relatively error free.  Ignore ANY warnings produced by the compile
  90. They have all be verified and are spurious noise.
  91.  
  92. UNIX SYSV R3 AND GETCWD
  93.  
  94. Some versions of UNIX SysV R3 and Xenix use the popen call to capture the
  95. output of pwd when invoking the C library function getcwd().  These versions
  96. of the function cause dmake to terminate with the "lost a child" message
  97. due to the fact that the parent dmake process may catch the pwd and not
  98. recognize it as a child.  For systems that have this problem use the version
  99. of dmake that supplies its own getcwd function.  The settings are:
  100.  
  101.    OS = unix
  102.    OSRELEASE = sysvr3
  103.    OSENVIRONMENT = pwd
  104.  
  105. It is directly available through the 'makefile' by typing one of:
  106.  
  107.    make sysvr3pwd
  108.    make xenixpwd
  109.  
  110. both include the getcwd code but the xenixpwd target compiles for a Xenix
  111. system.
  112.  
  113.  
  114. UNIX and "limits.h"
  115.  
  116. Some compilers do not yet provide the "limits.h" file, if yours is one of
  117. these then simply copy the file "namemax.h" in the source root directory to
  118. "limits.h".  Make sure the length of a file name is correctly set in
  119. "limits.h" as it is processed prior to "namemax.h".
  120.  
  121.  
  122. STARTUP FILE
  123.  
  124. dmake requires the loading of a startup file when it is invoked.  The
  125. path for the startup file is set in the file 'startup.h' found in the
  126. appropriate system sub-directories.  You may override the value of the
  127. path variable compiled-in by creating a file at the root source directory
  128. called startup.h and inserting into that file a definition that is like
  129. the definition found in the supplied startup.h files.  Alternatively you
  130. can modify the MAKESTARTUP environment variable to point at the location
  131. of your startup.mk file.
  132.  
  133.  
  134. INSTALLATION
  135.  
  136. To install dmake you must copy the executable to where your system
  137. locates executables, and you must place a copy of startup.mk (found in the
  138. root source directory after the build is successfuly completed) into a location
  139. corresponding to the value of the MAKESTARTUP macro or environment variable.
  140. You are free to customize the contents of startup.mk.
  141.  
  142. To make dmake again, (using itself), you will have to set three environment
  143. variables.  See the files in readme/options for their names and their legal
  144. values.  Once set you can invoke dmake to make itself.
  145.  
  146.  
  147. DOCUMENTATION
  148.  
  149. All documentation for dmake appears under the man directory.
  150. The file dmake.tf included in this distribution contains the troff
  151. source for the man page.  You must typeset it using the -man macros.
  152. If you cannot typeset it, the file dmake.p is a version that has been
  153. typeset for a normal dumb terminal.  The file dmake.p contains control
  154. characters.  The file dmake.nc is a version of the man page that has
  155. all of the control characters stripped.
  156.  
  157.  
  158. CREATING A NEW VERSION
  159.  
  160. To create yet another version of dmake you should follow the following steps.
  161.  
  162. The sysvr3 version as sent is the base version, all dmake versions must provide
  163. the equivalent of the functions defined in the sysvr3 directory, and MUST
  164. provide the same semantics (MSDOS archive lib searches are an exception since
  165. we cannot search libraries for timestamps in MSDOS, Actually the MKS version
  166. of dmake does this, I don't have the inclination to add this code though).
  167.  
  168. 1. Create a new directory for the version you will be making at the level
  169.    that is appropriate.  If it is a new OS then add the dir at the top level,
  170.    if it is a new version of UNIX then add it below the unix directory.
  171.  
  172. 2. Copy the files from the unix and unix/sysvr3 directories to the new dir.
  173.    (Or from any other directory sub-tree that is more appropriate)
  174.  
  175. 3. Not all OS/OSRELEASE combinations are compatible so in order to make
  176.    dmake on each, the particular directory may contain C-source for functions
  177.    present in the SVID SysV R3 distribution which are used by dmake but are
  178.    not supplied by the C-library in the target system.  For example the bsd43
  179.    directory contains source for tempnam.c since it is not provided with
  180.    the BSD C-library.  Before writing a new version of the source file
  181.    check the other directories to see if one already exists.
  182.  
  183. 4. Under some systems the standard include files may be missing or incorrect.
  184.    eg. under BSD stdarg.h and string.h.  If this is the case
  185.    you should create the proper .h file in the proper directory.
  186.    This works as expected as the compile line includes the flag -Idir
  187.    where dir is the configuration dir, (bsd43 for example) and any
  188.    standard include files will be searched for in dir before the compiler
  189.    looks in the normal places (if you have a sane compiler :-).
  190.  
  191. 5. Modify dmake.sh to contain the appropriate C compiler flags and link command
  192.    and to include any specific C files that you have had to add for this
  193.    version of dmake, and run the result through the shell.
  194.    (make the same changes to config.mk so that once you have a working copy of
  195.    dmake you can use it to bring itself up to date)
  196.  
  197. 6. Send me the changes :-) so that I can incorporate them into future
  198.    distributions.
  199.  
  200. 7. This should be all that you require to create a new version of dmake.
  201.    If you have any questions send e-mail to dvadura@plg.uwaterloo.ca
  202.