home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / dmake40.zip / readme / install < prev    next >
Text File  |  1994-10-23  |  7KB  |  171 lines
  1.             DMAKE UNPACKING AND INSTALLATION INSTRUCTIONS
  2.  
  3. DMAKE is available in several formats:  a compressed tar src archive,
  4. a compressed shar src archive, a pkzip src archive, or a pkzip MSDOS-executable
  5. archive.  Refer to the appropriate section below for unpacking instructions.
  6. In each instance the archive creates a new directory named 'dmake' and
  7. extracts all relevant files to that sub-directory.
  8.  
  9.  
  10. 1. UNPACKING THE DISTRIBUTION FILES
  11.  
  12.    OPTION 'A' (compressed tar src archive):
  13.    --------------------------------------
  14.    Assumption:  The current directory contains the latest version of dmake in
  15.         the file 'dmake.tar.gz' or the file 'dmake.tar.Z'. 
  16.  
  17.    This file is a standard GNU zip compressed tar archive.  To unpack the file
  18.    issue the following command.  gunzip is available for most UNIX platforms
  19.    as well as DOS.
  20.  
  21.        gunzip -c dmake.tar.gz | tar xf -
  22.    or
  23.        zcat dmake.tar.Z | tar xf -
  24.  
  25.  
  26.    OPTION 'B' (compressed shar src archive):
  27.    -----------------------------------------
  28.    Assumption:  The current directory contains the latest version of dmake in
  29.         the files 'dmake.shar.XX.gz'.  Where XX are the sequence numbers
  30.         for the shar files.
  31.  
  32.    To unpack the shar files you must uncompress them first, and then run the
  33.    output through /bin/sh, or some other popular shar archive extraction tool.  
  34.    The following csh script should do the trick:
  35.  
  36.        foreach i (dmake.shar.*)
  37.           gunzip $i
  38.           sh < `basename $i .gz`
  39.        end
  40.  
  41.  
  42.    OPTION 'C' (src zip archive):
  43.    -----------------------------
  44.    Assumption:  The current directory contains the latest version of DMAKE in
  45.         the file dmake.zip.
  46.  
  47.    To unpack the full zip distribution simply use pkunzip with the
  48.    following command:
  49.  
  50.        pkunzip dmake.zip
  51.    or
  52.        unzip dmake.zip
  53.  
  54.  
  55.    OPTION 'D' (MSDOS-executable zip archive):
  56.    ------------------------------------------
  57.    Assumption:  The current directory contains the latest version of the DMAKE
  58.         MSDOS executable files in the file dmexe.zoo.
  59.  
  60.    To unpack the source-less MSDOS executable distribution use pkunzip
  61.    with the following command:
  62.  
  63.        pkunzip dmexe.zip
  64.    or
  65.        unzip dmexe.zip
  66.  
  67.    Please skip section (2) below and go directly to Section 3 (Configuring the
  68.    executable) for further installation instructions.
  69.  
  70.  
  71. 2. BUILDING THE EXECUTABLE
  72.  
  73.    The only supported method for building a new executable from a fresh or
  74.    patched distribution is to use the self building scripts rather than DMAKE
  75.    itself.  This is necessary in order to allow for the use of new DMAKE
  76.    features and functionality in the DMAKE 'makefile' itself.  Once built
  77.    the DMAKE executable can be used to build new versions of DMAKE by setting
  78.    the environment variables defined in Section 4 below.
  79.  
  80.    To determine the set of supported environments issue the following
  81.    commands:
  82.  
  83.     cd src
  84.     make
  85.  
  86.    The output of this command will be a set of arguments representing the
  87.    supported environments that DMAKE can be compiled in.  Choose the one
  88.    that most closely represents your environment and issue the command:
  89.  
  90.     make environ_tag
  91.  
  92.    where 'environ_tag' is from the previous list, for example on a Solaris
  93.    System the option is Solaris, so you would issue the command 'make Solaris'.
  94.  
  95.    The script runs the appropriate set of commands; upon completion the file
  96.    'dmake' is found in the current directory as is the file startup.mk.
  97.    The first is the binary executable and the second is the initial DMAKE
  98.    startup file.  The startup file is read by DMAKE each time it is invoked to
  99.    process a user makefile.
  100.  
  101.    Before issuing the build command read Section 3 and decide if you need
  102.    or want to modify the precompiled value of MAKESTARTUP as described
  103.    below.
  104.  
  105.    During the build it is safe to ignore any warnings that may
  106.    get generated by the build.
  107.  
  108.  
  109. 3. CONFIGURING THE EXECUTABLE
  110.  
  111.    Once built you must place the executable into the location where your
  112.    system finds executables.  DMAKE looks for the file 'startup.mk' before
  113.    processing any user makefiles.  To discover where DMAKE searches for this
  114.    file issue the command:
  115.  
  116.     dmake -V
  117.  
  118.    one of the lines printed will be of the form:
  119.  
  120.     MAKESTARTUP=$(ROOTDIR)/.../startup.mk
  121.  
  122.    This is the path where DMAKE will look for the file 'startup.mk'.  The
  123.    value of ROOTDIR is imported from the environment and is assumed to be NULL
  124.    if not set.
  125.  
  126.    You have three options:
  127.  
  128.     1. Place the startup.mk file found in the 'src' directory into the
  129.        path specified by the path given in the MAKESTARTUP definition.
  130.  
  131.     2. Define the environment variable MAKESTARTUP to point to the path
  132.        where 'startup.mk' may be found.  For example if you place
  133.        'startup.mk' into the directory '/u/joe/lib' then you may define
  134.        MAKESTARTUP in your environment to have the value:
  135.  
  136.           "/u/joe/lib/startup.mk"
  137.  
  138.     3. Recompile DMAKE with the proper value of startup.mk hard-coded into
  139.        the binary.  In order to perform this follow these steps:
  140.  
  141.           a) copy the file src/unix/startup.h to the src directory
  142.           b) edit the file and change the string definition (follow
  143.              instructions in the file)
  144.           c) Rebuild the executable.  
  145.           d) NOTE:  If your compiler searches for include files in a
  146.          non-sensible way this may not work and you may have to edit
  147.          the file in-place.  If you are building a DOS executable the
  148.          startup.h file is found in the msdos, instead of the unix,
  149.          subdirectory.  The same is true for other non-unix operating
  150.          system combinations.  In the event that step c) does not work
  151.          refer to the appropriate directory.
  152.  
  153.  
  154. 4. DMAKE SPECIFIC ENVIRONMENT VARIABLES 
  155.  
  156.    In order to use DMAKE to recompile itself you must define the following
  157.    three environment variables in addition to MAKESTARTUP.
  158.  
  159.     OS            - Specifies the flavour of operating system.
  160.     OSRELEASE     - Specifies the particular version of the operating
  161.                 system.
  162.     OSENVIRONMENT - An optional configuration parameter for the operating
  163.             system release.
  164.  
  165.    Specific values for these variables can be found in each of the operating
  166.    system specific files named in the 'readme.1st' file.  You should have
  167.    to deal with this only if you are modifying DMAKE and making frequent
  168.    changes to the source.  In these circumstances you will want to recompile
  169.    only the effected files rather than the entire source and you must set
  170.    the value of the environment variables to reflect your environment.
  171.