X-Git-Url: https://git.openssl.org/?a=blobdiff_plain;f=INSTALL;h=cc8c38aed8c236d42c1a3c748ac0724a2538dcfe;hb=e452de9d8753d1fc6ba8cd26eb035988ea2635e9;hp=57a6c808d8af8b23fd9202b747b8ef0ab070f49d;hpb=db209ec295c358b45332ae48d3041c5b1b25c929;p=openssl.git diff --git a/INSTALL b/INSTALL index 57a6c808d8..cc8c38aed8 100644 --- a/INSTALL +++ b/INSTALL @@ -2,13 +2,16 @@ INSTALLATION ON THE UNIX PLATFORM --------------------------------- - [See INSTALL.W32 for instructions for compiling OpenSSL on Windows systems, - and INSTALL.VMS for installing on OpenVMS systems.] + [Installation on Windows, OpenVMS and MacOS (before MacOS X) is described + in INSTALL.W32, INSTALL.VMS and INSTALL.MacOS.] To install OpenSSL, you will need: + * make * Perl 5 * an ANSI C compiler + * a development environment in form of development libraries and C + header files * a supported Unix operating system Quick Start @@ -33,7 +36,8 @@ Configuration Options --------------------- - There are several options to ./config to customize the build: + There are several options to ./config (or ./Configure) to customize + the build: --prefix=DIR Install in DIR/bin, DIR/lib, DIR/include/openssl. Configuration files used by OpenSSL will be in DIR/ssl @@ -42,9 +46,6 @@ --openssldir=DIR Directory for OpenSSL files. If no prefix is specified, the library files and binaries are also installed there. - rsaref Build with RSADSI's RSAREF toolkit (this assumes that - librsaref.a is in the library search path). - no-threads Don't try to build with support for multi-threaded applications. @@ -52,6 +53,21 @@ This will usually require additional system-dependent options! See "Note on multi-threading" below. + no-zlib Don't try to build with support for zlib compression and + decompression. + + zlib Build with support for zlib compression/decompression. + + zlib-dynamic Like "zlib", but has OpenSSL load the zlib library dynamically + when needed. This is only supported on systems where loading + of shared libraries is supported. + + no-shared Don't try to create shared libraries. + + shared In addition to the usual static libraries, create shared + libraries on platforms where it's supported. See "Note on + shared libraries" below. + no-asm Do not use assembler code. 386 Use the 80386 instruction set only (the default x86 code is @@ -117,9 +133,12 @@ OpenSSL binary ("openssl"). The libraries will be built in the top-level directory, and the binary will be in the "apps" directory. - If "make" fails, please report the problem to - (note that your message will be forwarded to a public mailing list). - Include the output of "make report" in your message. + If "make" fails, look at the output. There may be reasons for + the failure that aren't problems in OpenSSL itself (like missing + standard headers). If it is a problem with OpenSSL itself, please + report the problem to (note that your + message will be forwarded to a public mailing list). Include the + output of "make report" in your message. [If you encounter assembler error messages, try the "no-asm" configuration option as an immediate fix.] @@ -131,10 +150,13 @@ $ make test - If a test fails, try removing any compiler optimization flags from - the CFLAGS line in Makefile.ssl and run "make clean; make". Please - send a bug report to , including the - output of "make report". + If a test fails, look at the output. There may be reasons for + the failure that isn't a problem in OpenSSL itself (like a missing + or malfunctioning bc). If it is a problem with OpenSSL itself, + try removing any compiler optimization flags from the CFLAGS line + in Makefile.ssl and run "make clean; make". Please send a bug + report to , including the output of + "make report". 4. If everything tests ok, install OpenSSL with @@ -252,3 +274,19 @@ you can still use "no-threads" to suppress an annoying warning message from the Configure script.) + + Note on shared libraries + ------------------------ + + Shared library is currently an experimental feature. The only reason to + have them would be to conserve memory on systems where several program + are using OpenSSL. Binary backward compatibility can't be guaranteed + before OpenSSL version 1.0. + + For some systems, the OpenSSL Configure script knows what is needed to + build shared libraries for libcrypto and libssl. On these systems, + the shared libraries are currently not created by default, but giving + the option "shared" will get them created. This method supports Makefile + targets for shared library creation, like linux-shared. Those targets + can currently be used on their own just as well, but this is expected + to change in future versions of OpenSSL.