Build the 'openssl rehash' command on VMS version 8.3 and up
[openssl.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 4283e9d19913eeb6c0aa8eaf13d86b7212316bf9..ff134f2cb1b9208cf8021a1fabd5eade8c50747d 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -2,16 +2,15 @@
  OPENSSL INSTALLATION
  --------------------
 
  OPENSSL INSTALLATION
  --------------------
 
- [This document describes installation on the main supported operating
-  systems, currently the Linux/Unix family, OpenVMS and Windows.
-  Installation on DOS (with djgpp), MacOS (before MacOS X)
-  is described in INSTALL.DJGPP or INSTALL.MacOS, respectively.]
+ [This document describes installation on all supported operating
+  systems (currently mainly the Linux/Unix family, OpenVMS and
+  Windows)]
 
  To install OpenSSL, you will need:
 
 
  To install OpenSSL, you will need:
 
-  * make
-  * Perl 5 with core modules (please read README.PERL)
-  * The perl module Text::Template (please read README.PERL)
+  * A make implementation
+  * Perl 5 with core modules (please read NOTES.PERL)
+  * The perl module Text::Template (please read NOTES.PERL)
   * an ANSI C compiler
   * a development environment in the form of development libraries and C
     header files
   * an ANSI C compiler
   * a development environment in the form of development libraries and C
     header files
@@ -21,7 +20,8 @@
  please read one of these:
 
   * NOTES.VMS (OpenVMS)
  please read one of these:
 
   * NOTES.VMS (OpenVMS)
-  * NOTES.WIN (any Windows except for Windows CE)
+  * NOTES.WIN (any supported Windows)
+  * NOTES.DJGPP (DOS platform with DJGPP)
 
  Quick Start
  -----------
 
  Quick Start
  -----------
   enable-crypto-mdebug-backtrace
                    As for crypto-mdebug, but additionally provide backtrace
                    information for allocated memory.
   enable-crypto-mdebug-backtrace
                    As for crypto-mdebug, but additionally provide backtrace
                    information for allocated memory.
+                   TO BE USED WITH CARE: this uses GNU C functionality, and
+                   is therefore not usable for non-GNU config targets.  If
+                   your build complains about the use of '-rdynamic' or the
+                   lack of header file execinfo.h, this option is not for you.
+                   ALSO NOTE that even though execinfo.h is available on your
+                   system (through Gnulib), the functions might just be stubs
+                   that do nothing.
 
   no-ct
                    Don't build support for Certificate Transparency.
 
   no-ct
                    Don't build support for Certificate Transparency.
        $ mms test                                       ! OpenVMS
        $ nmake test                                     # Windows
 
        $ mms test                                       ! OpenVMS
        $ nmake test                                     # Windows
 
+     NOTE: you MUST run the tests from an unprivileged account (or
+     disable your privileges temporarly if your platform allows it).
+
      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
      malfunction with Perl).  You may want increased verbosity, that
      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
      malfunction with Perl).  You may want increased verbosity, that