From 32851d20419001f0304a83ddb147f39357c2545e Mon Sep 17 00:00:00 2001 From: yrutschle Date: Fri, 15 Nov 2019 22:20:31 +0100 Subject: [PATCH] minor doc clarification for dependencies --- doc/INSTALL.md | 34 ++++++++++++++++++++++++---------- 1 file changed, 24 insertions(+), 10 deletions(-) diff --git a/doc/INSTALL.md b/doc/INSTALL.md index 40f01b5..92f122c 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -4,11 +4,31 @@ Compile and install Dependencies ------------ -`sslh` uses [libconfig](http://www.hyperrealm.com/libconfig/) -and [libwrap](http://packages.debian.org/source/unstable/tcp-wrappers). +`sslh` uses: + +* [libconfig](http://www.hyperrealm.com/libconfig/). For + Debian this is contained in package `libconfig8-dev`. You +can compile with or without it using USELIBCONFIG in the +Makefile. + +* [libwrap](http://packages.debian.org/source/unstable/tcp-wrappers). + For Debian, this is contained in packages +`libwrap0-dev`. You +can compile with or without it using USELIBWRAP in the +Makefile. + +* [libsystemd](http://packages.debian.org/source/unstable/libsystemd-dev), in package `libsystemd-dev`. You +can compile with or without it using USESYSTEMD in the +Makefile. + +* [libcap](http://packages.debian.org/source/unstable/libcap-dev), in package `libcap-dev`. You can compile with or without it using USELIBCAP in the Makefile + +* libbsd, to enable to change the process name (as shown in + `ps`, so each forked process shows what protocol and what + connection it is serving), +which requires `libbsd` at runtime, and `libbsd-dev` at +compile-time. -For Debian, these are contained in packages `libwrap0-dev` and -`libconfig8-dev`. For OpenSUSE, these are contained in packages libconfig9 and libconfig-dev in repository @@ -19,17 +39,11 @@ For Fedora, you'll need packages `libconfig` and yum install libconfig libconfig-devel -If you can't find `libconfig`, or just don't want a -configuration file, set `USELIBCONFIG=` in the Makefile. - If you want to rebuild `sslh-conf.c` (after a `make distclean` for example), you will also need to add [conf2struct](https://www.rutschle.net/tech/conf2struct/README.html) (v1.0) to your path. -There is optional support to change the process name (as shown in `ps`), -which requires `libbsd` at runtime, and `libbsd-dev` at compile-time. - Compilation -----------