X-Git-Url: https://git.openssl.org/gitweb/?p=openssl.git;a=blobdiff_plain;f=INSTALL;h=f1065548974888d553392f4b5826e663bf817104;hp=d394bf8a7b9eac0cc96d14069e34ba6673443211;hb=6b691a5c85ddc4e407e32781841fee5c029506cd;hpb=7dfb0b774e6592dcbfe47015168a0ac8b44e2a17 diff --git a/INSTALL b/INSTALL index d394bf8a7b..f106554897 100644 --- a/INSTALL +++ b/INSTALL @@ -1,6 +1,142 @@ -# Installation of SSLeay. -# It depends on perl for a few bits but those steps can be skipped and -# the top level makefile edited by hand + + INSTALLATION ON THE UNIX PLATFORM + --------------------------------- + + [For instructions for compiling OpenSSL on Windows systems, see INSTALL.W32]. + + To install OpenSSL, you will need: + + * Perl + * C compiler + * A supported Unix operating system + + Quick Start + ----------- + + If you want to just get on with it, do: + + $ ./config [if this fails, go to step 1b below] + $ make + $ make rehash + $ make test + $ make install + + This will build and install OpenSSL in the default location, which is (for + historical reasons) /usr/local/ssl. If you want to install it anywhere else, + do this after running `./config': + + $ perl util/ssldir.pl /new/install/path + + There are several options to ./config to customize the build: + + rsaref Build with RSADSI's RSAREF toolkit. + no-asm Build with no assembler code. + 386 Use the 80386 instruction set only (the default x86 code is + more efficient, but requires at least a 486). + + If anything goes wrong, follow the detailed instructions below. If your + operating system is not (yet) supported by OpenSSL, see the section on + porting to a new system. + + Installation in Detail + ---------------------- + + 1a. Configure OpenSSL for your operation system automatically: + + $ ./config + + This guesses at your operating system (and compiler, if necessary) and + configures OpenSSL based on this guess. Check the first line of output to + see if it guessed correctly. If it did not get it correct or you want to + use a different compiler then go to step 1b. Otherwise go to step 2. + + 1b. Configure OpenSSL for your operating system manually + + OpenSSL knows about a range of different operating system, hardware and + compiler combinations. To see the ones it knows about, run + + $ ./Configure + + Pick a suitable name from the list that matches your system. For most + operating systems there is a choice between using "cc" or "gcc". When + you have identified your system (and if necessary compiler) use this name + as the argument to ./Configure. For example, a "linux-elf" user would + run: + + $ ./Configure linux-elf + + If your system is not available, you will have to edit the Configure + program and add the correct configuration for your system. + + Configure configures various files by converting an existing .org file + into the real file. If you edit any files, remember that if a + corresponding .org file exists them the next time you run ./Configure + your changes will be lost when the file gets re-created from the .org + file. The files that are created from .org files are: + + Makefile.ssl + crypto/des/des.h + crypto/des/des_locl.h + crypto/md2/md2.h + crypto/rc4/rc4.h + crypto/rc4/rc4_enc.c + crypto/rc2/rc2.h + crypto/bf/bf_locl.h + crypto/idea/idea.h + crypto/bn/bn.h + + 2. Set the install directory + + If the install directory will be the default of /usr/local/ssl, skip to + the next stage. Otherwise, run + + $ perl util/ssldir.pl /new/install/path + + This configures the installation location into the "install" target of + the top-level Makefile, and also updates some defines in an include file + so that the default certificate directory is under the proper + installation directory. It also updates a few utility files used in the + build process. + + 3. Build OpenSSL by running: + + $ make + + This will build the OpenSSL libraries (libcrypto.a and libssl.a) and the + OpenSSL binary ("openssl"). The libraries will be built in the top-level + directory, and the binary will be in the "apps" directory. + + 4. After a successful build, the libraries should be tested. Run: + + $ make rehash + $ make test + + (The first line makes the test certificates in the "certs" directory + accessable via an hash name, which is required for some of the tests). + + 5. If everything tests ok, install OpenSSL with + + $ make install + + This will create the installation directory (if it does not exist) and + then create the following subdirectories: + + bin Contains the openssl binary and a few other + utility programs. + include Contains the header files needed if you want to + compile programs with libcrypto or libssl. + lib Contains the library files themselves and the + OpenSSL configuration file "openssl.cnf". + certs Initially empty, this is the default location + for certificate files. + private Initially empty, this is the default location + for private key files. + + +-------------------------------------------------------------------------------- +The orignal Unix build instructions from SSLeay follow. +Note: some of this may be out of date and no longer applicable +-------------------------------------------------------------------------------- # When bringing the SSLeay distribution back from the evil intel world # of Windows NT, do the following to make it nice again under unix :-) @@ -126,3 +262,8 @@ The examples for solaris and windows NT/95 are in the mt directory. have fun eric 25-Jun-1997 + +IRIX 5.x will build as a 32 bit system with mips1 assember. +IRIX 6.x will build as a 64 bit system with mips3 assember. It conforms +to n32 standards. In theory you can compile the 64 bit assember under +IRIX 5.x but you will have to have the correct system software installed.