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