dmake/doc/public/install.txt

   1                 DMAKE UNPACKING AND INSTALLATION INSTRUCTIONS
   2
   3
   4 We attempt to keep the information presented here accurate.  However, the
   5 defacto location of the most up to date information is the dmake WWW site
   6 found at:
   7
   8    http://dmake.wticorp.com/
   9
  10 DMAKE is available in several formats:  a compressed tar src archive,
  11 a pkzip src archive, a variety of executable archives.  Refer to the
  12 appropriate section below for unpacking instructions.
  13
  14
  15 1. UNPACKING THE DISTRIBUTION FILES
  16
  17    OPTION 'A' (compressed tar src archive):
  18    --------------------------------------
  19    Assumption:  The current directory contains the latest version of dmake in
  20                 the file 'dm41src.tgz'.
  21
  22    This file is a standard GNU zip compressed tar archive.  To unpack the file
  23    issue the following command.  gunzip is available for most UNIX platforms
  24    as well as DOS.
  25
  26            gunzip -c dm41src.tgz | tar xf -
  27
  28
  29    OPTION 'B' (src zip archive):
  30    -----------------------------
  31    Assumption:  The current directory contains the latest version of DMAKE in
  32                 the file dm41src.zip.
  33
  34    To unpack the full zip distribution simply use pkunzip with the
  35    following command:
  36
  37            pkunzip dm41src.zip
  38    or
  39            unzip dm41src.zip
  40
  41
  42    Instructions for unpacking executable only versions are given on the
  43    dmake WWW site.
  44
  45
  46 2. BUILDING THE EXECUTABLE
  47
  48    Skip this step if you have purchased a prebuilt binary distribution.
  49
  50    The only supported method for building a new executable from a fresh or
  51    patched distribution is to use the self building scripts rather than DMAKE
  52    itself.  This is necessary in order to allow for the use of new DMAKE
  53    features and functionality in the DMAKE 'makefile' itself.  Once built
  54    the DMAKE executable can be used to rebuild DMAKE.
  55
  56    To determine the set of supported environments issue the following
  57    commands:
  58
  59         cd src
  60         make
  61
  62    The output of this command will be a set of arguments representing the
  63    supported environments that DMAKE can be compiled in.  Choose the one
  64    that most closely represents your environment and issue the command:
  65
  66         make environ_tag
  67
  68    where 'environ_tag' is from the previous list, for example on a Solaris
  69    System the option is Solaris, so you would issue the command 'make Solaris'.
  70
  71    The script runs the appropriate set of commands; upon completion the file
  72    'dmake' or 'dmake.exe' is found in the current directory.
  73    This is the binary executable.
  74
  75    Note: before issuing the build command please read Section 3 and decide
  76    if you need or want to modify the pre-compiled value of MAKESTARTUP.
  77
  78    During the build it is safe to ignore any warnings that may
  79    be generated by your build.  If you get errors from the build then
  80    it is probably the case that you have chosen a build target that is
  81    not compatible with your environment.
  82
  83
  84 3. INSTALLING AND CONFIGURING THE EXECUTABLE
  85
  86    To install the dmake executable place the executable into the
  87    location where your system normally finds executables.  That is
  88    place dmake into a subdirectory that is or will be in your
  89    executable search PATH.
  90
  91    You can now issue the command 'dmake -V'; the output will be
  92    similar to:
  93
  94       dmake - Copyright (c) 1990,...,1996 by Dennis Vadura, Version 4.10, PL 0
  95
  96       Default Configuration:
  97          MAXPROCESSLIMIT := 10
  98          MAXLINELENGTH := 8190
  99          .IMPORT .IGNORE: ROOTDIR
 100          .MAKEFILES : makefile.mk Makefile makefile
 101          .SOURCE    : .NULL
 102          MAKESTARTUP := $(ROOTDIR)/usr/local/lib/dmake/startup/startup.mk
 103
 104       Please read the file readme/release for the latest release notes.
 105
 106
 107    Take note of the line defining the value of MAKESTARTUP; to configure
 108    the executable you must perform two steps:
 109
 110         1. Copy the <dmake-distdir>/startup subtree to a suitable location,
 111         2. Tell dmake where you put it,
 112
 113
 114    Step 1:
 115    -------
 116    The above example build of dmake assumes that the directory path (assuming
 117    ROOTDIR is NULL)
 118
 119         /usr/local/lib/dmake/
 120
 121    is a directory which contains a copy of the "<dmake-distdir>/startup"
 122    subtree.  Thus to properly configure dmake so that the precompiled
 123    defaults would be used you would have to perform the following:
 124
 125         cd <dmake-distdir>
 126         mkdir /usr/local/lib/dmake
 127         cp -r startup /usr/local/lib/dmake
 128
 129    or if you are in the MSDOS or Windows-95/NT world:
 130
 131         cd <dmake-distdir>
 132         md \usr\local\lib\dmake
 133         xcopy startup \usr\local\lib\dmake
 134
 135    and you are done Step 1.
 136
 137
 138    Step 2:
 139    -------
 140    You must tell dmake where it is that you placed the "startup" subtree.  If
 141    the location is the directory that is pre-compiled into dmake then you
 142    are done.  If the directory where you copied the dmake subtree is not the
 143    precompiled value you must either set the global environment variable
 144    MAKESTARTUP to point at the new location of "startup/startup.mk" or you
 145    must rebuild dmake with a new precompiled value of MAKESTARTUP.  To do the
 146    latter create the file:
 147
 148         src/startup.h
 149
 150    and make sure that it contains an entry similar to the following:
 151
 152      /* This file contains the default value of the MAKESTARTUP variable.
 153       * You must set the quoted string below to the default path to the startup
 154       * variable, so that it gets compiled in.  LEAVE ROOTDIR at the front of
 155       * the path.  This allows the user to customize his environment for dmake
 156       * by setting up a new ROOTDIR environment variable. */
 157
 158      "MAKESTARTUP := $(ROOTDIR)/usr/local/lib/dmake/startup/startup.mk",
 159
 160    (See src/msdos/startup.h for an example).  Once set properly rerun your
 161    previous build.  In the rare instance that your compiler has broken
 162    #include search rules, the shipped "startup.h" files are located in
 163    architecture specific subdirectories as described in the file
 164    "readme/srcorg".
 165
 166
 167 4. DMAKE SPECIFIC ENVIRONMENT VARIABLES
 168
 169    Once you have built dmake, the dmake startup directory contains the file
 170    "config.mk".  This file contains definitions corresponding to your installed
 171    target environment for the variables:
 172
 173         OS            - Specifies the flavour of operating system.
 174         OSRELEASE     - Specifies the particular version of the operating
 175                         system.
 176         OSENVIRONMENT - An optional configuration parameter for the operating
 177                         system release.
 178
 179    Appropriate values for these variables are found in the
 180
 181         <install-dir>/startup/templates/<OS>/<OSRELEASE>/<OSENVIRONMENT>/template.mk
 182
 183    file.  Select the OS, OSRELEASE, and OSENVIRONMENT that best suits your
 184    setup (check readme.1st) for hints on selecting the most appropriate
 185    settings.
 186
 187    These three variables are used to determine the correct dmake configuration
 188    when dmake starts up, and loads its builtin definitions from the startup
 189    subtree hierarchy.  The only time you should have a need to change these
 190    values or the contents of the startup subtree is when you wish to supply
 191    your own customized default environment or you are building dmake for a
 192    new as yet unsupported target environment.
 193
 194
 195 5. LOCALE SPECIFIC CONFIGURATION
 196
 197    Locale specific macro definitions that are not part of the predefined macro
 198    set should be placed into the file "startup/local.mk".  This ensures that
 199    future dmake releases will not overwrite your prior definitions.  We
 200    guarantee that the file "startup/local.mk" will never be part of any future
 201    dmake distribution.
 202
 203