In the past I have built this tree on NetBSD (i386,sparc), FreeBSD, SunOS, Solaris (sparc,x86). I have also built much of it (many years ago) on Linux, HP-UX, IRIX and Ultrix.
More recently it has been tested on NetBSD, FreeBSD, Darwin [1] and SunOS.
[1] | with the exception of stn3270. |
Feedback and patches are always welcome.
The build instructions have been greatly simplified by using the sandbox model. A sandbox is just a tree which has a file .sandbox-env at the top, which serves to both mark the top of the tree and provide a means of conditioning the environment.
A simple wrapper script is provided, which finds .sandbox-env reads it and .sandboxrc if it exists, and then invokes make. Actually it invokes:
exec ${REAL_MAKE:-${MAKE:-make}} "$@"
Unless you are running a recent NetBSD, you must build bmake which is a portable version of NetBSD's make and tracks it closely (I am one of the maintainers of NetBSD make).
This tree is designed to be built with bmake and with support for multiple architectures. GNU autoconf is used to generate a config.h which handles most system dependencies, but the Makefiles rely on bmake. Fortunately bmake uses autoconf :-)
You simply need to install my macros and tell make where to find them:
cd /tmp tar zxf /tmp/mk.tar.gz ./mk/install-mk $SB/src/mk
Building bmake is trivial:
$ tar zxf ~/bmake.tar.gz $ tar zxf ~/mk.tar.gz $ ./bmake/boot-strap
is all I use, and it will print out the commands needed to install bmake and the mk macros.
Note: I have the following in ~/.bmake-boot-strap.rc which keeps the above simple:
: echo "Building for $HOST_TARGET" case "$HOST_TARGET" in netbsd*) sys_share_mk=:/usr/share/mk;; *) sys_share_mk=;; esac objdir=./$HOST_TARGET case "$prefix" in */$HOST_TARGET) CONFIGURE_ARGS="$CONFIGURE_ARGS --with-default-sys-path=$prefix/share/mk:`dirname $prefix`/share/mk$sys_share_mk" ;; esac
The Makefiles want to know where the top level directory is. The easy way to do this is with the mk wrapper mentioned above.
These Makefiles use my own macro files which were originally derrived from the NetBSD (1.0?) bsd.*.mk macros. You can put them where ever you like and set the location in $MAKESYSPATH in $SB/.sandbox-env. The default location is $SB/mk
We default the macro NOMAN=no to supress formatting of man pages. You can override this if you have the BSD mandoc macros for [nt]roff.
A couple of my macro files differ from the bsd.* originals (apart from being more portable), man.mk handles installing unformatted nroff, as well as formatted pages with the normal extension rather than BSD's .0
Unless SUBDIR_MUST_EXIST is defined, subdir.mk will skip missing subdirs (after telling you...) rather than die. This is important, since you very likely have a subset of the full src tree.
This is included by prog.mk and lib.mk and tries to include *.libnames.mk of which:
does not exist unless you creat it. It is a handy way for you to customize without touching the distributed files. For example, on a test machine I needed to build openssl but could not install it so put the following in local.libnames.mk:
.if ${host_os} == "sunos" LIBCRYPTO = ${OBJTOP}/openssl/lib/crypto/libcrypto${DLIBEXT} LIBSSL = ${OBJTOP}/openssl/lib/ssl/libssl${DLIBEXT} INCLUDES_libcrypto = -I${OBJ_libcrypto} .endif
The makefile created an openssl dir in ${OBJ_libcrypto} to gather all the headers. dpadd.mk did the rest.
Each file above gets an opportunity to define things like:
LIBSSLFD ?= ${OBJTOP}/ssl/lib/sslfd/libsslfd${DLIBEXT} INCLUDES_libsslfd = -I${SRC_libsslfd}/h -I${OBJ_libslfd}
these are used by dpadd.mk and will be explained below.
This file looks like line noise, and is best considered read-only. However it provides some very useful functionality, which simplifies the build.
Makefiles can use the LIB* macros defined via libnames.mk or anywhere else in various ways:
# indicate that we need to include headers from LIBCRYPTO # this would result in ${INCLUDES_libcrypto} being added to CFLAGS. SRC_LIBS += ${LIBCRYPTO} # indicate that libsslfd must be built already. # it also has the same effect as SRC_LIBS DPADD += ${LIBSSLFD} # indicate that not only must libsslfd be built, # but that we need to link with it. # this is exactly equivalent to # DPADD += ${LIBSSLFD} # LDADD += -L${LIBSSLFD:H} -lsslfd # and mostly serves to ensure that DPADD and LDADD are in sync. DPLIBS += ${LIBSSLFD}
Any library (referenced by its full path) in any of the above, is added to DPMAGIC_LIBS with the following results, for each lib foo.
In various directories, you may find symlinks named src pointing off to no where. These should point to the directories holding the appropriate distribution. For instance:
$ ls -l ssl/bin/rdist/src lrwxrwxr-x 1 sjg wheel 17 Jun 20 1996 ssl/bin/rdist/src@ -> ../../../../rdist-6.1.3 $
Obviously you will need these links correct before you can expect to build things like SSLrdist. See other distributions for details on where to get the other distrbutions you might need.
Now just:
$ PATH=$PATH:$SB/scripts $ cd $SB $ mk # mk install
The distributed $SB/.sandbox-env sets MAKECONF=$SB/Makefile.inc so that will always be read by prog and lib makefiles.
You can put customized settings in $SB/Makefile.local.inc which will be read by $SB/Makefile.inc. For example:
# gcc, but an old version USE_AUTODEP_MK=no USE_DMALLOC?=no USE_DBUG?=no USE_DPADD_MK=yes WARNINGS_SET?=MIN
If you run mk depend, the macros will use ${MKDEP} (default is /usr/bin/mkdep or mkdeps.sh) If you don't have either skip the mk depend step. Also see autodep.mk
If you have a recent gcc, you can set USE_AUTODEP_MK=yes and autodep.mk will automagically update dependencies as and when files are compiled.
Note that I always use object dirs to keep the build tree neat and facilitate build/editing within emacs while shareing the src via NFS.
The .sandbox-env file included in the distribution turns this on automatically:
SB_SRC=$SB SB_NAME=`basename $SB` SRCTOP=$SB OBJTOP=${MAKEOBJDIRPREFIX:-/var/obj/$SB_NAME} MAKEOBJDIR='${.CURDIR:S,${SRCTOP},${OBJTOP},}' MKOBJDIRS=auto MAKECONF=$SB/Makefile.inc MAKESYSPATH=$SB/mk if [ -s /netbsd ]; then BMAKE=${BMAKE:-make} fi REAL_MAKE=${BMAKE:-bmake} # we only need these if using the full mk version. SB_PROJECT=sjg SB_PATH=${PATH:-/usr/bin:/bin:/usr/sbin:/sbin:/usr/pkg/bin:/usr/local/bin} # on many "modern" systems /bin/sh is not posix compliant # so we avoid export VAR=value unset MAKEOBJDIRPREFIX export SB_SRC SB_NAME export SRCTOP OBJTOP export MAKESYSPATH MAKECONF MAKEOBJDIR export MKOBJDIRS export REAL_MAKE
The above allows you to override OBJTOP by simply setting MAKEOBJDIRPREFIX. You will need that if you do not have permissions to creat dirs in /var
Warning
If you disable auto objdirs and skip making of obj dirs, don't be surprised when the build fails in subtle ways.
The ssl tree here now expects OpenSSL to be already installed, it will try to guess where but you may need to set INCLUDES_libcrypto in local.libnames.mk
An example usually helps. The following assumes that OpenSSL has been built and installed.
First unpack all the packages in a single tree such as ~/work/sjg (this will be $SB):
$ mkdir -p ~/work/sjg $ cd ~/work/sjg $ gzcat /tmp/bmake.tar.gz | tar xvf - $ gzcat /tmp/mk.tar.gz | tar xvf - $ gzcat /tmp/SSLrsh.tar.gz | tar xvf - .. ..
Note: if you have already installed bmake you do not need to unpack it in $SB.
Also note that if you want to support sharing read-only src via NFS ensure that .sandbox-env sets OBJTOP=/var/obj/$SB_NAME or similar.
You will likely need to be root to install anything as the install macros use chown which is usually restricted to root:
# mk install
If you want to force installing without chown etc:
$ mk install BINOWN= LIBOWN=
It is highly likely that your source tree is a small subset of ours. We have taken setps to try and ensure that the build will work for you despite this, but we may have missed something.
It is also possible (likely) that newer OS versions can introduce new hiccups - especially since much of the code in telnet for example is pretty old.
In general it is safest to start with a clean tree. If you have unpacked previous versions of SSLrsh.tar you may have Makefiles or headers present that are not in the current release and will cause you problems.
Author: | sjg@crufty.net |
---|---|
Revision: | $Id: install.txt,v 1.7 2009/12/19 07:08:08 sjg Exp $ |
Copyright: | Crufty.NET |