path: root/INSTALL
diff options
authorJason A. Donenfeld <Jason@zx2c4.com>2019-01-24 18:07:53 +0100
committerJason A. Donenfeld <Jason@zx2c4.com>2019-01-24 18:47:02 +0100
commit4b5406d71c9a0ad2b65b376ed732967b6ad2a789 (patch)
tree23a5b4cafde5dc88ed2c4addf8ff17ece13543b7 /INSTALL
Initialize project with scafolding and embeddable-wg-library
Diffstat (limited to 'INSTALL')
1 files changed, 30 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..3a9468e
--- /dev/null
@@ -0,0 +1,30 @@
+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: [auto-detect]
+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'. If you'd like to force its use, even if bash-completion isn't
+ detected in DESTDIR, then set it to `yes'.
+If you're a simple `make && make install` kind of user, you can get away with
+not setting these variables and relying on the auto-detection. However, if
+you're writing a package for a distro, you'll want to explicitly set these,
+depending on what you want.