contrib/amd/README

   1 This is the official version of am-utils.
   2
   3 See the file NEWS for news on this and previous releases.
   4
   5 *** General Notes to alpha/beta testers:
   6
   7 [A] as alpha/beta testers, I expect you to be able to find certain things on
   8 your own (especially look at the sources to figure out how things work).
   9
  10 [B] if you intend to modify any files, first find out if the file you want
  11 to modify gets autogenerated from some other place.  If so, modify it at the
  12 source.
  13
  14 You can adjust some of the configuration of am-utils after it has been
  15 auto-configured by putting whatever definitions you wish in a file called
  16 localconfig.h, located in the top build directory (the same one where
  17 config.h is created for you).
  18
  19 [C] there are several ways you can build am-utils:
  20
  21 (1) run the buildall script as follows:
  22
  23         ./buildall
  24
  25 This would build all the applications inside a special directory relative to
  26 the root of the source tree, called A.<cpu-company-system>, where the <>
  27 part is filled in by GNU's config.guess script.  This is the preferred
  28 method, for it will separate the build from the sources, and allow you to
  29 run buildall for multiple architectures concurrently.
  30
  31 You can run "buildall -h" to see what options it takes.
  32
  33 (2) run the configure script such as:
  34
  35         ./configure
  36
  37 and then run
  38
  39         make
  40
  41 This would configure amd in the directory you've run the configure script
  42 in, and the built it there.  Run "make install" to install all the necessary
  43 files.
  44
  45 Note that this is good for building only one version of amd on one
  46 architecture!  Don't try this for multiple architectures.  If you must, then
  47 after doing one such build, run "make distclean" and then reconfigure for
  48 another architecture.
  49
  50 (3) run the configure script for build in a different location.  Let's say
  51 that /src/am-utils-6.0 is where you unpacked the sources.  So you could
  52
  53         mkdir /src/build/sunos5
  54         cd /src/build/sunos5
  55         /src/am-utils-6.0/configure --srcdir=/src/am-utils-6.0
  56         make
  57
  58 This is a manual method that will let you build in any directory outside the
  59 am-utils source tree.  It requires that your "make" program understand
  60 VPATH.  This can be used multiple times to build am-utils concurrently in
  61 multiple (but different) directories.  In fact, the buildall script
  62 described above does precisely that, using the A.* subdirectories.
  63
  64 (4) If you need to configure am-utils with extra libraries and/or headers,
  65 for example to add hesiod support, do so as follows:
  66
  67         configure --enable-libs="-lhesiod -lresolv" \
  68                 --enable-ldflags="-L/usr/local/hesiod/lib" \
  69                 --enable-cppflags="-I/usr/local/hesiod/include"
  70
  71 [D] If you modify any of the *.[chyl] sources in the directories amd, amq,
  72 hlfsd, lib, etc, all you need to do to get a new version of am-utils is run
  73 make.
  74
  75 If you modify any of the files in the m4/ or conf/ directories, or any *.in
  76 or *.am file, then you must rebuild the configure script, Makefile.in files,
  77 aclocal.m4, etc.  The best way to do so is to run
  78
  79         ./bootstrap
  80 or
  81         ./buildall -K
  82
  83 To be a developer and be able to run "bootstrap", you must have
  84 autoconf-2.50, automake-1.5, and libtool 1.4 installed on your system (or
  85 later versions thereof).  You no longer need to get my special version of
  86 automake.  Contact me if you'd like to be a maintainer and get access to the
  87 CVS server.
  88
  89 After you've remade the basic configuration files you must rerun the
  90 buildall script to rerun configure and then remake the binaries.
  91
  92 Modifying M4 macros may not be very intuitive to anyone that has not done so
  93 before.  Let me know if you are having any problems with them.  I fully
  94 expect, at least initially, to have to be the sole developers of the M4
  95 macros and let others concentrate on C sources.
  96
  97 [E] Report all bugs to am-utils@am-utils.org.  Avoid reporting to my
  98 personal email address.  It is important to involve the whole list in bug
  99 fixes etc.
 100
 101 Good luck.
 102
 103 Erez Zadok,
 104 Maintainer, am-utils.