COMPILING

   1 General Information
   2 ~~~~~~~~~~~~~~~~~~~
   3 To compile this you need a couple things
   4   - A working POSIX system with working POSIX gcc, g++, make (GNU),
   5     ar, sh, awk and sed in the path
   6   - GNU Make 3.74 or so, -- normal UNIX make will NOT work
   7     * Note 3.77 is broken.
   8   - A working ANSI C++ compiler, this is not g++ 2.7.*
   9     g++ 2.8 works OK and newer egcs work well also. Nobody has tried it
  10     on other compilers :< You will need a properly working STL as well.
  11   - A C library with the usual POSIX functions and a BSD socket layer.
  12     If you OS conforms to the Single User Spec then you are fine:
  13       http://www.opengroup.org/onlinepubs/7908799/index.html
  14
  15 Guidelines
  16 ~~~~~~~~~~
  17 I am not interested in making 'ultra portable code'. I will accept patches
  18 to make the code that already exists conform more to SUS or POSIX, but
  19 I don't really care if your not-SUS OS doesn't work. It is simply too
  20 much work to maintain patches for dysfunctional OSs. I highly suggest you
  21 contact your vendor and express intrest in a conforming C library.
  22
  23 That said, there are lots of finniky problems that must be delt with even
  24 between the supported OS's. Primarily the path I choose to take is to put
  25 a shim header file in build/include that transparently adds the required
  26 functionality. Patches to make autoconf detect these cases and generate the
  27 required shims are OK.
  28
  29 Current shims:
  30   * C9x integer types 'inttypes.h'
  31   * sys/statvfs.h to convert from BSD/Linux statfs to SUS statvfs
  32   * rfc2553 hostname resolution (methods/rfc*), shims to normal gethostbyname.
  33     The more adventerous could steal the KAME IPv6 enabled resolvers for those
  34     OS's with IPv6 support but no rfc2553 (why?)
  35   * define _XOPEN_EXTENDES_SOURCE to bring in h_errno on HP-UX
  36   * socklen_t shim in netdb.h if the OS does not have socklen_t
  37
  38 The only completely non-shimed OS is Linux with glibc2.1, glibc2.0 requires
  39 the first three shims.
  40
  41 Platform Notes
  42 ~~~~~~~~~~~~~~
  43 Debian GNU Linux 2.1 'slink'
  44 Debian GNU Linux 'potato'
  45   * All Archs
  46   - Works flawlessly
  47   - You will want to have debiandoc-sgml and yodl installed to get
  48     best results.
  49   - No IPv6 Support in glibc's < 2.1.
  50
  51 Sun Solaris
  52   SunOS cab101 5.7 Generic_106541-04 sun4u sparc
  53   - Works fine
  54   - Note, no IPv6 Support, OS lacks RFC 2553 hostname resolution
  55
  56 OpenBSD
  57   OpenBSD gsb086 2.5 CMPUT#0 i386 unknown
  58   - Works fine
  59   - OS needs 'ranlib' to generate the symbol table after 'ar'.. (not using
  60     GNU ar with the gnu tool chain :<)
  61   - Note, no IPv6 Support, OS lacks RFC 2553 hostname resolution
  62
  63 HP-UX
  64   HP-UX nyquist B.10.20 C 9000/780 2016574337 32-user license
  65   - Evil OS, does not conform very well to SUS
  66      1) snprintf exists but is not prototyped, ignore spurios warnings
  67      2) No socklen_t
  68      3) Requires -D_XOPEN_SOURCE_EXTENDED for h_errno
  69     configure should fix the last two (see above)
  70   - Note, no IPv6 Support, OS lacks RFC 2553 hostname resolution
  71