1# @(#) $Id: INSTALLING,v 1.8 2005/06/30 17:51:42 alex Exp $
2
3The program should compile on any reasonably modern Unix or Linux
4system, but has been tested only on FreeBSD and RedHat Linux. No
5extra libraries are required.  If you compile on other systems,
6please let me know.  I have deliberately attempted to avoid the
7need for massive "autoconfuse" scripts, but time will tell.
8
9For FreeBSD and Linux, it should be sufficient to just type 'make'
10unless you wish to change defaults for CFLAGS (see below). On
11some systems you may need 'gmake' (or edit the PREFIX line to
12something your make will accept).
13
14If your system does not have a system include file "endian.h"
15which defines BYTE_ORDER (or __BYTE_ORDER) as LITTLE-something or
16BIG-something, you may need to fix the file "makebyteorder.sh",
17or manually create a file "byteorder.h" in the distribution
18directory.  If your machine's native byte order is big-endian,
19add the single line:
20
21#define NATIVE_BYTEORDER_BIGENDIAN
22
23The sources assume little-endian unless told otherwise,
24so an empty "byteorder.h" is sufficient in that case.
25
26Check CFLAGS:
27    If your system includes provide the type 'uint32_t' in types.h
28    but not 'u_int32_t' (Solaris), uncomment the line which defines
29    uint32_t (or add the definition to CFLAGS). BSD and Linux define
30    u_int32_t in sys/types.h, which is where this code expects it.
31
32    If you do NOT want support for ANSI color sequences to emphasize
33    certain sections of the output, remove
34        -DCOLOR
35    Alternatively, if you want color but find my selections bilious,
36    you can change a few defines in defs.h.  The colors currently
37    used are intended to be used with a light background; I don't
38    recommend them with 'reverse-video' or otherwise dark backgrounds.
39
40    If you want color compiled in, but don't want it by default (the
41    '-c' flag toggles color if support is compiled in) edit defs.h to
42    remove the PRINT_COLOR bit from PRINT_DEFAULTS.
43
44Check PREFIX, BINDIR and MANDIR: set to the directories where the executable
45    and manual page should be copied.  Normally, you will only need to set
46    PREFIX.
47
48Then do
49    (optional) make depend (requires the executable 'makedepend')
50    make
51
52and when you're ready
53    make install
54
55The files in the 'aux" directory must be compiled and/or installed
56manually.  There is a simple Makefile for the C programs.  You may
57want to modify the scripts for your own purposes.
58
59Duane Hesser
60dhh@virtual-cafe.com
61http://virtual-cafe.com/~dhh/tools.d/software.html
62