dropbear: INSTALL annotate

annotate INSTALL @ 433:c216212001fc

Fix for -pedantic -ansi compilation, change // to /**/, plus some signedness and trailing-comma-in-array issues

author	Matt Johnston <matt@ucc.asn.au>
date	Fri, 16 Feb 2007 14:42:08 +0000
parents	b24730e11c83
children	2d943453cecf

rev	line source
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1 Basic Dropbear build instructions:
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2
72 9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	3 - Edit options.h to set which features you want.
9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	4 - Edit debug.h if you want any debug options (not usually required).
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	5
72 9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	6 (If using a non-tarball copy, "autoconf; autoheader")
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	7
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	8 ./configure (optionally with --disable-zlib or --disable-syslog,
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	9 or --help for other options)
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	10
72 9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	11 Now compile:
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	12
72 9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	13 make PROGRAMS="dropbear dbclient dropbearkey dropbearconvert scp"
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	14
72 9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	15 And install (/usr/local/bin is usual default):
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	16
72 9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	17 make PROGRAMS="dropbear dbclient dropbearkey dropbearconvert scp" install
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	18
72 9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	19 (you can leave items out of the PROGRAMS list to avoid compiling them. If you
9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	20 recompile after changing the PROGRAMS list, you MUST "make clean" before
9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	21 recompiling - bad things will happen otherwise)
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	22
72 9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	23 See MULTI for instructions on making all-in-one binaries.
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	24
72 9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	25 If you want to compile statically, add "STATIC=1" to the make command-line.
9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	26
9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	27 Binaries can be strippd with "make strip"
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	28
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	29 ============================================================================
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	30
245 b24730e11c83 add note about compiling for 386 Matt Johnston <matt@ucc.asn.au> parents: 72 diff changeset	31 If you're compiling for a 386-class CPU, you will probably need to add
b24730e11c83 add note about compiling for 386 Matt Johnston <matt@ucc.asn.au> parents: 72 diff changeset	32 CFLAGS=-DLTC_NO_BSWAP so that libtomcrypt doesn't use 486+ instructions.
b24730e11c83 add note about compiling for 386 Matt Johnston <matt@ucc.asn.au> parents: 72 diff changeset	33
b24730e11c83 add note about compiling for 386 Matt Johnston <matt@ucc.asn.au> parents: 72 diff changeset	34 ============================================================================
b24730e11c83 add note about compiling for 386 Matt Johnston <matt@ucc.asn.au> parents: 72 diff changeset	35
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	36 Compiling with uClibc:
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	37
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	38 Firstly, make sure you have at least uclibc 0.9.17, as getusershell() in prior
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	39 versions is broken. Also note that you may get strange issues if your uClibc
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	40 headers don't match the library you are running with, ie the headers might
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	41 say that shadow password support exists, but the libraries don't have it.
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	42
72 9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	43 Compiling for uClibc should be the same as normal, just set CC to the magic
9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	44 uClibc toolchain compiler (ie export CC=i386-uclibc-gcc or whatever).
9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	45 You can use "make STATIC=1" to make statically linked binaries, and it is
9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	46 advisable to strip the binaries too. If you're looking to make a small binary,
9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	47 you should remove unneeded ciphers and MD5, by editing options.h
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	48
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	49 It is possible to compile zlib in, by copying zlib.h and zconf.h into a
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	50 subdirectory (ie zlibincludes), and
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	51
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	52 export CFLAGS="-Izlibincludes -I../zlibincludes"
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	53 export LDFLAGS=/usr/lib/libz.a
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	54
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	55 before ./configure and make.
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	56
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	57 If you disable zlib, you must explicitly disable compression for the client -
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	58 OpenSSH is possibly buggy in this regard, it seems you need to disable it
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	59 globally in ~/.ssh/config, not just in the host entry in that file.
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	60
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	61 You may want to manually disable lastlog recording when using uClibc, configure
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	62 with --disable-lastlog.
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	63
69 59d16db56e9f Simple text changes Matt Johnston <matt@ucc.asn.au> parents: 4 diff changeset	64 One common problem is pty allocation. There are a number of types of pty
59d16db56e9f Simple text changes Matt Johnston <matt@ucc.asn.au> parents: 4 diff changeset	65 allocation which can be used -- if they work properly, the end result is the
59d16db56e9f Simple text changes Matt Johnston <matt@ucc.asn.au> parents: 4 diff changeset	66 same for each type. Running configure should detect the best type to use
59d16db56e9f Simple text changes Matt Johnston <matt@ucc.asn.au> parents: 4 diff changeset	67 automatically, however for some systems, this may be incorrect. Some
59d16db56e9f Simple text changes Matt Johnston <matt@ucc.asn.au> parents: 4 diff changeset	68 things to note:
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	69
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	70 If your system expects /dev/pts to be mounted (this is a uClibc option),
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	71 make sure that it is.
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	72
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	73 Make sure that your libc headers match the library version you are using.
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	74
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	75 If openpty() is being used (HAVE_OPENPTY defined in config.h) and it fails,
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	76 you can try compiling with --disable-openpty. You will probably then need
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	77 to create all the /dev/pty?? and /dev/tty?? devices, which can be
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	78 problematic for devfs. In general, openpty() is the best way to allocate
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	79 PTYs, so it's best to try and get it working.

Mercurial > dropbear

annotate INSTALL @ 433:c216212001fc