finalized Makefile, worded COMPILING diff

Author: silv3rr

COMPILING.md

@@ -1,32 +1,46 @@
-# Yet Another Traffic Bouncer
+# Yet Another Traffic Bouncer COMPILING
 
-## COMPILING
+## Make
 
-If you've installed OpenSSL as package just runnning `make linux` should work
+Always `make clean` first.
 
-If you compiled OpenSSL from source into '/usr/local', use the oneliners for your OS below
+If you've installed OpenSSL as package just runnning `make linux` should work.
 
-In case you used some other method to install OpenSSL, set environment variables accordingly
+If you compiled OpenSSL from source into '/usr/local', use the oneliners for your OS below.
+
+In case you're on a different OS and/or used some other method to install OpenSSL you have set environment variables accordingly.
 
 * `PREFIX` base directory used in variables 
 * `OPENSSL_BIN` path to 'openssl' binary
 * `LDFLAGS` linker libraries
 * `LD_LIBRARY_PATH` needed to run openssl binary
 * `CPPFLAGS` C preprocessor includes
 
-### Debian 
+Make will first run `openssl dhparam -noout -C 2048 >>include/tls_dh.h`
+
+We want to be sure 'make' can find the openssl binary and dependent shared libraries. This is why OPENSSL_BIN and LD_LIBRARY_PATH need to be set.
+
+To run yatb LD_LIBRARY_PATH also needs to be set. You can print the libs required by runing `ldd yatb`.
+
+### Debian
+
+First compile:
 
-* Make: `PREFIX="/usr/local" LDFLAGS="-L${PREFIX}/lib" LD_LIBRARY_PATH="${PREFIX}/lib" OPENSSL_BIN="${PREFIX}/bin/openssl" make linux`
-* Run: `LD_LIBRARY_PATH=/usr/local/lib ./yatb yatb.conf`
+`PREFIX="/usr/local" LDFLAGS="-L${PREFIX}/lib" LD_LIBRARY_PATH="${PREFIX}/lib" OPENSSL_BIN="${PREFIX}/bin/openssl" make linux`
+
+Then start yatb:
+
+`LD_LIBRARY_PATH=/usr/local/lib ./yatb yatb.conf`
 
 ### CentOS
 
-* Make: `PREFIX="/usr/local" LDFLAGS="-L${PREFIX}/lib64" LD_LIBRARY_PATH="${PREFIX}/lib64" OPENSSL_BIN="${PREFIX}/bin/openssl" make linux`
-* Run: `LD_LIBRARY_PATH=/usr/local/lib64 ./yatb yatb.conf`
+`PREFIX="/usr/local" LDFLAGS="-L${PREFIX}/lib64" LD_LIBRARY_PATH="${PREFIX}/lib64" OPENSSL_BIN="${PREFIX}/bin/openssl" make linux`
+
+`LD_LIBRARY_PATH=/usr/local/lib64 ./yatb yatb.conf`
 
 ### Wrapper
 
-Or, create a little 'yatb.sh' wrapper script:
+For starting you could also create a small 'yatb.sh' wrapper script:
 
 ``` bash
 #!/bin/sh
@@ -39,4 +53,3 @@ if [ -x "yatb" ]; then
   LD_LIBRARY_PATH="/usr/local/lib" ./yatb "$@"
 fi
 ```
-

Makefile

@@ -3,33 +3,36 @@
 CXX = g++
 CXXFLAGS += -W -Wall
 CPPFLAGS += -Iinclude
-
+LDFLAGS += -lssl -lcrypto
 OBJ = src/fpwhitelist.o src/whitelist.o src/iplist.o src/yatb.o src/forward.o src/controlthread.o src/datathread.o src/tls.o src/stringlist.o
 OBJ_TOOLS = src/config.o src/lock.o src/counter.o src/tools.o
-LIBS = -lssl -lcrypto
+
+TARGETS = linux linux-debug linux-static linux-debug-static \
+  bsd bsd-debug bsd-static bsd-debug-static \
+  cygwin cygwin-debug cygwin-static cygwin-debug-static \
+  solaris solaris-debug solaris-static solaris-debug-static
 
 ifneq ("$(findstring static,"$(MAKECMDGOALS)")","")
-  LDFLAGS += -static
-  SUFFIX := $(SUFFIX)-static
+  LDFLAGS := -static $(LDFLAGS) -ldl -lz
+  POSTFIX := $(POSTFIX)-static
 endif
-ifneq ("$(findstring debug, "$(MAKECMDGOALS)")","")
-  LIBS += -ldl -lz
+ifneq ("$(findstring debug,"$(MAKECMDGOALS)")","")
   CXXFLAGS += -g
-  SUFFIX := $(SUFFIX)-debug
+  POSTFIX := $(POSTFIX)-debug
 else
   CXXLAGS += -O2
 endif
-
-ifneq ("$(findstring cygwin, "$(MAKECMDGOALS)")","")
-  SUFFIX := $(SUFFIX).exe
+ifneq ("$(findstring cygwin,"$(MAKECMDGOALS)")","")
+  POSTFIX := $(POSTFIX).exe
 else
-  LIBS += -lpthread
+  LDFLAGS += -lpthread
 endif
-
 OPENSSL_BIN ?= openssl
 
+.PHONY: all yatb clean
+
 .cc.o   :
-	 g++ -c $(CPPFLAGS) $< -o $@
+	$(CXX) -c $(CPPFLAGS) $< -o $@
 
 all:
 	@echo "To compile yatb type"
@@ -42,34 +45,17 @@ all:
 include/tls_dh.h :
 	$(OPENSSL_BIN) dhparam -noout -C 2048 >>include/tls_dh.h
 
-default: include/tls_dh.h $(OBJ) $(OBJ_TOOLS) src/blowcrypt.o src/bnccheck.o src/getfp.o
-	$(CXX) $(LDFLAGS) $(OBJ) $(OBJ_TOOLS) $(LIBS) -o bin/yatb$(SUFFIX)
-	$(CXX) $(CXXFLAGS) $(CPPFLAGS) $(LDFLAGS) src/blowcrypt.o $(OBJ_TOOLS) -o bin/blowcrypt$(SUFFIX) $(LIBS)
-	$(CXX) $(CXXFLAGS) $(CPPFLAGS) $(LDFLAGS) src/bnccheck.o $(OBJ_TOOLS) -o bin/bnccheck$(SUFFIX) $(LIBS)
-	$(CXX) $(CXXFLAGS) $(CPPFLAGS) $(LDFLAGS) src/getfp.o $(OBJ_TOOLS) -o bin/getfp$(SUFFIX) $(LIBS)
+yatb: include/tls_dh.h $(OBJ) $(OBJ_TOOLS) src/blowcrypt.o src/bnccheck.o src/getfp.o
+	$(CXX) $(OBJ) $(OBJ_TOOLS) -o bin/yatb$(POSTFIX) $(LDFLAGS)
+	$(CXX) $(CXXFLAGS) $(CPPFLAGS) src/blowcrypt.o $(OBJ_TOOLS) -o bin/blowcrypt$(POSTFIX) $(LDFLAGS)
+	$(CXX) $(CXXFLAGS) $(CPPFLAGS) src/bnccheck.o $(OBJ_TOOLS) -o bin/bnccheck$(POSTFIX) $(LDFLAGS) 
+	$(CXX) $(CXXFLAGS) $(CPPFLAGS) src/getfp.o $(OBJ_TOOLS) -o bin/getfp$(POSTFIX) $(LDFLAGS) 
 ifneq ($(findstring debug, "$@"),"")
-	strip bin/yatb$(SUFFIX) bin/blowcrypt$(SUFFIX) bin/bnccheck$(SUFFIX) bin/getfp$(SUFFIX)
+	strip bin/yatb$(POSTFIX) bin/blowcrypt$(POSTFIX) bin/bnccheck$(POSTFIX) bin/getfp$(POSTFIX)
 endif
 
-linux: default
-linux-debug: default
-linux-static: default
-linux-debug-static: default
-
-bsd: default
-bsd-debug: default
-bsd-static: default
-bsd-debug-static: default
-
-cygwin: default
-cygwin-debug: default
-cygwin-static: default
-cygwin-debug-static: default
-
-solaris: default
-solaris-debug: default
-solaris-static: default
-solaris-debug-static: default
+.PHONY: $(TARGETS)
+$(TARGETS): yatb
 
 clean:
 	@(rm -f bin/yatb bin/blowcrypt bin/yatb-static bin/blowcrypt-static bin/yatb-debug bin/blowcrypt-debug bin/yatb-static-debug bin/blowcrypt-static-debug bin/bnccheck bin/bnccheck-static bin/bnccheck-debug bin/bnccheck-static-debug bin/*.exe src/*.o bin/getfp* include/tls_dh.h)