Add install targets for Windows
[openssl.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index eed3e22..2377449 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,13 +1,13 @@
 
- INSTALLATION ON THE UNIX PLATFORM
- ---------------------------------
+ OPENSSL INSTALLATION
+ --------------------
 
- [Installation on DOS (with djgpp), Windows, MacOS (before MacOS X)
-  and NetWare is described in INSTALL.DJGPP, INSTALL.WIN, INSTALL.MacOS
+ [Installation on DOS (with djgpp), MacOS (before MacOS X)
+  and NetWare is described in INSTALL.DJGPP, INSTALL.MacOS
   and INSTALL.NW.
   
   This document describes installation on the main supported operating
-  systems, currently the Unix family and OpenVMS.]
+  systems, currently the Linux/Unix family, OpenVMS and Windows.]
 
  To install OpenSSL, you will need:
 
   * Perl 5 with core modules (please read README.PERL)
   * The perl module Text::Template (please read README.PERL)
   * an ANSI C compiler
-  * a development environment in form of development libraries and C
+  * a development environment in the form of development libraries and C
     header files
   * a supported operating system
 
  For more details regarding specific platforms, there are these notes
  available:
 
-  * NOTES.VMS
+  * NOTES.VMS (OpenVMS)
+  * NOTES.WIN (any Windows except for Windows CE)
 
  Quick Start
  -----------
     $ mms test
     $ mms install
 
+  on Windows (only pick one of the targets for configuration):
+
+    $ perl Configure { VC-WIN32 | VC-WIN64A | VC-WIN64I | VC-CE }
+    $ nmake
+    $ nmake test
+    $ nmake install
+
  [If any of these steps fails, see section Installation in Detail below.]
 
  This will build and install OpenSSL in the default location, which is:
@@ -50,6 +58,7 @@
   Unix:    normal installation directories under /usr/local
   OpenVMS: SYS$COMMON:[OPENSSL-'version'...], where 'version' is the
            OpenSSL version number ('major'_'minor').
+  Windows: currently don't have an install function     <TBA>
 
  If you want to install it anywhere else, run config like this:
 
  ---------------------
 
  There are several options to ./config (or ./Configure) to customize
- the build:
+ the build (note that for Windows, the defaults for --prefix and
+ --openssldir depend in what configuration is used and what Windows
+ implementation OpenSSL is built on.  More notes on this in NOTES.WIN):
 
-  --prefix=DIR  The top of the installation directory tree.  Defaults are:
+  --prefix=DIR     The top of the installation directory tree.  Defaults are:
 
-                Unix:           /usr/local
-                OpenVMS:        SYS$COMMON:[OPENSSL-'version']
+                   Unix:           /usr/local
+                   Windows:        C:\Program Files\OpenSSL
+                                or C:\Program Files (x86)\OpenSSL
+                   OpenVMS:        SYS$COMMON:[OPENSSL-'version']
 
   --openssldir=DIR Directory for OpenSSL configuration files, and also the
-                default certificate and key store.  Defaults are:
-
-                Unix:           PREFIX/ssl (PREFIX is given by --prefix)
-                OpenVMS:        SYS$COMMON:[SSL]
-
-  no-autoalginit Don't automatically load all supported ciphers and digests.
-                Typically OpenSSL will make available all of its supported
-                ciphers and digests. For a statically linked application this
-                may be undesirable if small executable size is an objective.
-                This only affects libcrypto. Ciphers and digests will have to be
-                loaded manually using EVP_add_cipher() and EVP_add_digest() if
-                this option is used.
-
-  no-autoerrinit Don't automatically load all libcrypto/libssl error strings.
-                Typically OpenSSL will automatically load human readable error
-                strings. For a statically linked application this may be
-                undesirable if small executable size is an objective.
-
-  no-threads    Don't try to build with support for multi-threaded
-                applications.
-
-  threads       Build with support for multi-threaded applications.
-                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.  This is the default choice.
-
-  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           On Intel hardware, use the 80386 instruction set only
-                (the default x86 code is more efficient, but requires at
-                least a 486). Note: Use compiler flags for any other CPU
-                specific configuration, e.g. "-m32" to build x86 code on
-                an x64 system.
-
-  no-sse2      Exclude SSE2 code pathes. Normally SSE2 extension is
-               detected at run-time, but the decision whether or not the
-               machine code will be executed is taken solely on CPU
-               capability vector. This means that if you happen to run OS
-               kernel which does not support SSE2 extension on Intel P4
-               processor, then your application might be exposed to
-               "illegal instruction" exception. There might be a way
-               to enable support in kernel, e.g. FreeBSD kernel can be
-               compiled with CPU_ENABLE_SSE, and there is a way to
-               disengage SSE2 code pathes upon application start-up,
-               but if you aim for wider "audience" running such kernel,
-               consider no-sse2. Both 386 and no-asm options above imply
-               no-sse2.
-
-  no-<cipher>   Build without the specified cipher (bf, cast, des, dh, dsa,
-                hmac, md2, md5, mdc2, rc2, rc4, rc5, rsa, sha).
-                The crypto/<cipher> directory can be removed after running
-                "make depend".
-
-  -Dxxx, -lxxx, -Lxxx, -fxxx, -mXXX, -Kxxx These system specific options will
-                be passed through to the compiler to allow you to
-                define preprocessor symbols, specify additional libraries,
-                library directories or other compiler options.
+                   default certificate and key store.  Defaults are:
+
+                   Unix:           PREFIX/ssl (PREFIX is given by --prefix)
+                   Windows:        C:\Program Files\Common Files\SSL
+                                or C:\Program Files (x86)\Common Files\SSL
+                   OpenVMS:        SYS$COMMON:[SSL]
+
+  --api=x.y.z      Don't build with support for deprecated APIs below the
+                   specified version number. For example "--api=1.1.0" will
+                   remove support for all APIS that were deprecated in OpenSSL
+                   version 1.1.0 or below.
+
+  no-deprecated    Don't build with support for any deprecated APIs. This is the
+                   same as using "--api" and supplying the latest version
+                   number.
+
+  no-autoalginit   Don't automatically load all supported ciphers and digests.
+                   Typically OpenSSL will make available all of its supported
+                   ciphers and digests. For a statically linked application this
+                   may be undesirable if small executable size is an objective.
+                   This only affects libcrypto. Ciphers and digests will have to
+                   be loaded manually using EVP_add_cipher() and
+                   EVP_add_digest() if this option is used.
+
+  no-autoerrinit   Don't automatically load all libcrypto/libssl error strings.
+                   Typically OpenSSL will automatically load human readable
+                   error strings. For a statically linked application this may
+                   be undesirable if small executable size is an objective.
+
+  no-threads       Don't try to build with support for multi-threaded
+                   applications.
+
+  threads          Build with support for multi-threaded applications.
+                   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.  This is the
+                   default choice.
+
+  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              On Intel hardware, use the 80386 instruction set only
+                   (the default x86 code is more efficient, but requires at
+                   least a 486). Note: Use compiler flags for any other CPU
+                   specific configuration, e.g. "-m32" to build x86 code on
+                   an x64 system.
+
+  no-sse2          Exclude SSE2 code pathes. Normally SSE2 extension is
+                   detected at run-time, but the decision whether or not the
+                   machine code will be executed is taken solely on CPU
+                   capability vector. This means that if you happen to run OS
+                   kernel which does not support SSE2 extension on Intel P4
+                   processor, then your application might be exposed to
+                   "illegal instruction" exception. There might be a way
+                   to enable support in kernel, e.g. FreeBSD kernel can be
+                   compiled with CPU_ENABLE_SSE, and there is a way to
+                   disengage SSE2 code pathes upon application start-up,
+                   but if you aim for wider "audience" running such kernel,
+                   consider no-sse2. Both 386 and no-asm options above imply
+                   no-sse2.
+
+  no-<alg>         Build without the specified algorithm (bf, cast, des, dh,
+                   dsa, hmac, md2, md5, mdc2, rc2, rc4, rc5, rsa, sha).
+
+  -Dxxx, -lxxx,    These system specific options will be passed through to the
+  -Lxxx, -fxxx,    compiler to allow you to define preprocessor symbols, specify
+  -mXXX, -Kxxx     additional libraries, library directories or other compiler
+                   options.
 
 
  Installation in Detail
 
  1a. Configure OpenSSL for your operation system automatically:
 
+     NOTE: This is not available on Windows.
+
        $ ./config [options]                             # Unix
 
        or
 
        $ ./Configure linux-elf [options]
 
-     If your system is not available, you will have to edit the Configure
-     program and add the correct configuration for your system. The
-     generic configurations "cc" or "gcc" should usually work on 32 bit
-     systems.
+     If your system isn't listed, you will have to create a configuration
+     file named Configurations/{something}.conf and add the correct
+     configuration for your system. See the available configs as examples
+     and read Configurations/README and Configurations/README.design for
+     more information.
+
+     The generic configurations "cc" or "gcc" should usually work on 32 bit
+     Unix-like systems.
 
-     Configure creates the file Makefile.ssl from Makefile.in and
+     Configure creates a build file ("Makefile" on Unix and "descrip.mms"
+     on OpenVMS) from a suitable template in Configurations, and
      defines various macros in crypto/opensslconf.h (generated from
      crypto/opensslconf.h.in).
 
 
        $ @[PATH.TO.OPENSSL.SOURCE]Configure {target} {options}
 
+     Windows example:
+
+       $ C:
+       $ mkdir \temp-openssl
+       $ cd \temp-openssl
+       $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure {target} {options}
+
      Paths can be relative just as well as absolute.  Configure will
      do its best to translate them to relative paths whenever possible.
 
 
        $ make                                           # Unix
        $ mms                                            ! (or mmk) OpenVMS
+       $ nmake                                          # Windows
 
      This will build the OpenSSL libraries (libcrypto.a and libssl.a on
      Unix, corresponding on other platforms) and the OpenSSL binary
      report the problem to <rt@openssl.org> (note that your message
      will be recorded in the request tracker publicly readable at
      https://www.openssl.org/community/index.html#bugs and will be
-     forwarded to a public mailing list). Include the output of "make
-     report" in your message.  Please check out the request tracker. Maybe
-     the bug was already reported or has already been fixed.
+     forwarded to a public mailing list). Please check out the request
+     tracker. Maybe the bug was already reported or has already been
+     fixed.
 
      [If you encounter assembler error messages, try the "no-asm"
      configuration option as an immediate fix.]
 
        $ make test                                      # Unix
        $ mms test                                       ! OpenVMS
+       $ nmake test                                     # Windows
 
      If some tests fail, look at the output.  There may be reasons for
      the failure that isn't a problem in OpenSSL itself (like a
        $ DEFINE HARNESS_VERBOSE YES
        $ mms test                                       ! OpenVMS
 
+       $ set HARNESS_VERBOSE=yes
+       $ nmake test                                     # Windows
+
      If you want to run just one or a few specific tests, you can use
      the make variable TESTS to specify them, like this:
 
        $ make TESTS='test_rsa test_dsa' test            # Unix
        $ mms/macro="TESTS=test_rsa test_dsa" test       ! OpenVMS
+       $ nmake TESTS='test_rsa test_dsa' test           # Windows
 
      And of course, you can combine (Unix example shown):
        
      You can find the list of available tests like this:
 
        $ make list-tests                                # Unix
-       $ make list-tests                                ! OpenVMS
+       $ mms list-tests                                 ! OpenVMS
+       $ nmake list-tests                               # Windows
 
      Have a look at the manual for the perl module Test::Harness to
      see what other HARNESS_* variables there are.
      compiler optimization flags from the CFLAGS line in Makefile and
      run "make clean; make" or corresponding.
 
-     Please send a bug report to <openssl-bugs@openssl.org>, and when
-     you do, please run the following and include the output in your
-     report:
-
-       $ make report
+     Please send a bug reports to <rt@openssl.org>.
 
   4. If everything tests ok, install OpenSSL with
 
          lib/engines    Contains the OpenSSL dynamically loadable engines.
          share/man/{man1,man3,man5,man7}
                         Contains the OpenSSL man-pages.
-         share/doc/openssl/html{man1,man3,man5,man7}
+         share/doc/openssl/html/{man1,man3,man5,man7}
                         Contains the HTML rendition of the man-pages.
 
        OpenVMS ('arch' is replaced with the architecture name, "Alpha"
  use them would be to conserve memory on systems where several programs
  are using OpenSSL.
 
- For some systems, the OpenSSL Configure script knows what is needed to
+ For most 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.
+ the option "shared" will get them created.
 
  Note on random number generation
  --------------------------------