From 7c202eb5fc6ff25ded28708b5b91db09ff74ce9d Mon Sep 17 00:00:00 2001 From: "Jason A. Donenfeld" <Jason@zx2c4.com> Date: Wed, 4 Jan 2017 18:20:08 +0100 Subject: [PATCH] wg: add makefile instructions Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> --- src/INSTALL | 34 ++++++++++++++++++++++++++++++++++ src/Makefile | 5 ++++- 2 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 src/INSTALL diff --git a/src/INSTALL b/src/INSTALL new file mode 100644 index 0000000..ea3be53 --- /dev/null +++ b/src/INSTALL @@ -0,0 +1,34 @@ +Installation Makefile Target +============================ + + # make install + +This command takes into account several environment variables: + + * PREFIX default: /usr + * DESTDIR default: + * BINDIR default: $(PREFIX)/bin + * LIBDIR default: $(PREFIX)/lib + * MANDIR default: $(PREFIX)/share/man + * BASHCOMPDIR default: $(PREFIX)/share/bash-completion/completions + * RUNSTATEDIR default: /var/run + * PKG_CONFIG default: pkg-config + + * WITH_BASHCOMPLETION default: yes + * WITH_WGQUICK default: yes + +The first section is rather standard. The second section is not: + + * WITH_BASHCOMPLETION decides whether or not bash completion files for the + tools are installed. This is just a nice thing for people who have bash. + If you don't have bash, or don't want this, set the environment variable + to `no'. + + * WITH_WGQUICK decides whether or not the wg-quick(8) script is installed. + This is a very quick and dirty bash script for reading a few extra + variables from wg(8)-style configuration files, and automatically + configures the interface. If you don't have bash, you probably don't want + this at all. Likewise, if you already have a working network management + tool or configuration, you probably want to integrate wg(8) or the direct + WireGuard API into your network manager, rather than using wg-quick(8). + But for folks who like simple quick&dirty scripts, this is nice. diff --git a/src/Makefile b/src/Makefile index cc11c9e..fb727d8 100644 --- a/src/Makefile +++ b/src/Makefile @@ -38,6 +38,9 @@ install: wg check: clean CFLAGS=-g scan-build --view --keep-going $(MAKE) wg -.PHONY: clean install check +help: + @cat INSTALL + +.PHONY: clean install check help -include *.d