From 49371f8654a82e3300caa898f4a211716681735f Mon Sep 17 00:00:00 2001 From: PS Date: Sun, 1 Feb 2026 12:07:40 +0100 Subject: version 0.2.0.0 --- INSTALL | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 INSTALL (limited to 'INSTALL') diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..19c0276 --- /dev/null +++ b/INSTALL @@ -0,0 +1,83 @@ +Build Instructions +------------------ + +* Requirements + ------------ + + - A POSIX-compliant set of utils + - A set of OS specific utils + - s6 https://skarnet.org/software/s6/ + - s6-rc https://skarnet.org/software/s6-rc/ + - execline https://skarnet.org/software/execline/ + + This software will run on any operating system that implements +POSIX.1-2008, available at: + https://pubs.opengroup.org/onlinepubs/9699919799/ + + +* Standard usage + -------------- + + ./configure && make && sudo make install + + will work for most users. + + +* Customization + ------------- + + You can customize paths via flags given to configure. + See ./configure --help for a list of all available configure options. + +* Make variables + -------------- + + You can invoke make with a few variables for more configuration. + + INSTALL can be overridden on the make command line. This is +an even bigger hammer than running ./configure with environment +variables, so it is advised to only do this when it is the only way of +obtaining the behaviour you want. + + DESTDIR can be given on the "make install" command line in order to +install to a staging directory. + +* The slashpackage convention + --------------------------- + + The slashpackage convention (http://cr.yp.to/slashpackage.html) +is a package installation scheme that provides a few guarantees +over other conventions such as the FHS, for instance fixed +absolute pathnames. skarnet.org packages support it: use the +--enable-slashpackage option to configure, or +--enable-slashpackage=DIR for a prefixed DIR/package tree. +This option will activate slashpackage support during the build +and set slashpackage-compatible installation directories. +If $package_home is the home of the package, defined as +DIR/package/$category/$package-$version with the variables +read from the package/info file, then: + + --bindir is set to $package_home/command + --sbindir is also set to $package_home/command (slashpackage +differentiates root-only binaries by their Unix rights, not their +location in the filesystem) + --libdir is set to $package_home/ + + --prefix is pretty much ignored when you use --enable-slashpackage. +You should probably not use both --enable-slashpackage and --prefix. + + When using slashpackage, two additional Makefile targets are +available after "make install": + - "make update" changes the default version of the software to the +freshly installed one. (This is useful when you have several installed +versions of the same software, which slashpackage supports.) + - "make global-links" adds links from /command and /library.so to the +default version of the binaries and shared libraries. + + +* Out-of-tree builds + ------------------ + + This package does not support out-of-tree builds. It +is small, so it does not cost much to duplicate the entire +source tree if parallel builds are needed. -- cgit v1.2.3