changeset 1493:72fd994fe7bd

Update build instructions for localoptions, and tidy
author Matt Johnston <matt@ucc.asn.au>
date Wed, 14 Feb 2018 00:24:32 +0800
parents bd46cf0e245a
children da095983a60b
files INSTALL
diffstat 1 files changed, 15 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/INSTALL	Wed Feb 14 00:17:30 2018 +0800
+++ b/INSTALL	Wed Feb 14 00:24:32 2018 +0800
@@ -1,20 +1,26 @@
 Basic Dropbear build instructions:
 
-- Edit options.h to set which features you want.
-- Edit debug.h if you want any debug options (not usually required).
+- Edit localoptions.h to set which features you want. Available options
+  are described in default_options.h.in, these will be overridden by
+  anything set in localoptions.h
 
-(If using a non-tarball copy, "autoconf; autoheader")
+- If using a Mercurial or Git checkout, "autoconf; autoheader"
 
-./configure      (optionally with --disable-zlib or --disable-syslog,
+- Configure for your system:
+  ./configure     (optionally with --disable-zlib or --disable-syslog,
                   or --help for other options)
 
-Now compile:
+- Compile:
 
-make PROGRAMS="dropbear dbclient dropbearkey dropbearconvert scp"
+  make PROGRAMS="dropbear dbclient dropbearkey dropbearconvert scp"
+
+- Optionally install, or copy the binaries another way
 
-And install (/usr/local/bin is usual default):
+  make install (/usr/local/bin is usual default):
 
-make PROGRAMS="dropbear dbclient dropbearkey dropbearconvert scp" install
+  or
+
+  make PROGRAMS="dropbear dbclient dropbearkey dropbearconvert scp" install
 
 (you can leave items out of the PROGRAMS list to avoid compiling them. If you
 recompile after changing the PROGRAMS list, you *MUST* "make clean" before
@@ -25,7 +31,7 @@
 If you want to compile statically use ./configure --enable-static
 
 By default Dropbear adds various build flags that improve robustness 
-against programming bugs (good for security) - if these cause problems
+against programming bugs (good for security). If these cause problems
 they can be disabled with ./configure --disable-harden
 
 Binaries can be stripped with "make strip"