From: Richard Levitte Date: Mon, 23 May 2016 13:11:04 +0000 (+0200) Subject: Slight cleanup of the collection of READMEs, INSTALLs and NOTES X-Git-Tag: OpenSSL_1_1_0-pre6~727 X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=07930a75a1f82fd359d0af7849f01990b73659dd;p=oweals%2Fopenssl.git Slight cleanup of the collection of READMEs, INSTALLs and NOTES README is a fairly independent document, and so is INSTALL. NOTES are merely addendums to INSTALL. Therefore , INSTALL.DJGPP and README.PERL get renamed to NOTES.DJGPP and NOTES.PERL. Reviewed-by: Rich Salz --- diff --git a/INSTALL b/INSTALL index bdf67a6d7b..ab35353bdd 100644 --- a/INSTALL +++ b/INSTALL @@ -2,15 +2,15 @@ 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) is described in INSTALL.DJGPP.] + [This document describes installation on all supported operating + systems (currently mainly the Linux/Unix family, OpenVMS and + Windows)] 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 @@ -21,6 +21,7 @@ * NOTES.VMS (OpenVMS) * NOTES.WIN (any supported Windows) + * NOTES.DJGPP (DOS platform with DJGPP) Quick Start ----------- diff --git a/INSTALL.DJGPP b/INSTALL.DJGPP deleted file mode 100644 index 4fd94e44db..0000000000 --- a/INSTALL.DJGPP +++ /dev/null @@ -1,48 +0,0 @@ - - - INSTALLATION ON THE DOS PLATFORM WITH DJGPP - ------------------------------------------- - - OpenSSL has been ported to DJGPP, a Unix look-alike 32-bit run-time - environment for 16-bit DOS, but only with long filename support. - If you wish to compile on native DOS with 8+3 filenames, you will - have to tweak the installation yourself, including renaming files - with illegal or duplicate names. - - You should have a full DJGPP environment installed, including the - latest versions of DJGPP, GCC, BINUTILS, BASH, etc. This package - requires that PERL and the PERL module Text::Template also be - installed. - - All of these can be obtained from the usual DJGPP mirror sites or - directly at "http://www.delorie.com/pub/djgpp". For help on which - files to download, see the DJGPP "ZIP PICKER" page at - "http://www.delorie.com/djgpp/zip-picker.html". You also need to have - the WATT-32 networking package installed before you try to compile - OpenSSL. This can be obtained from "http://www.watt-32.net/". - The Makefile assumes that the WATT-32 code is in the directory - specified by the environment variable WATT_ROOT. If you have watt-32 - in directory "watt32" under your main DJGPP directory, specify - WATT_ROOT="/dev/env/DJDIR/watt32". - - To compile OpenSSL, start your BASH shell, then configure for DJGPP by - running "./Configure" with appropriate arguments: - - ./Configure no-threads --prefix=/dev/env/DJDIR DJGPP - - And finally fire up "make". You may run out of DPMI selectors when - running in a DOS box under Windows. If so, just close the BASH - shell, go back to Windows, and restart BASH. Then run "make" again. - - RUN-TIME CAVEAT LECTOR - -------------- - - Quoting FAQ: - - "Cryptographic software needs a source of unpredictable data to work - correctly. Many open source operating systems provide a "randomness - device" (/dev/urandom or /dev/random) that serves this purpose." - - As of version 0.9.7f DJGPP port checks upon /dev/urandom$ for a 3rd - party "randomness" DOS driver. One such driver, NOISE.SYS, can be - obtained from "http://www.rahul.net/dkaufman/index.html". diff --git a/NOTES.DJGPP b/NOTES.DJGPP new file mode 100644 index 0000000000..bbe63dc154 --- /dev/null +++ b/NOTES.DJGPP @@ -0,0 +1,48 @@ + + + INSTALLATION ON THE DOS PLATFORM WITH DJGPP + ------------------------------------------- + + OpenSSL has been ported to DJGPP, a Unix look-alike 32-bit run-time + environment for 16-bit DOS, but only with long filename support. + If you wish to compile on native DOS with 8+3 filenames, you will + have to tweak the installation yourself, including renaming files + with illegal or duplicate names. + + You should have a full DJGPP environment installed, including the + latest versions of DJGPP, GCC, BINUTILS, BASH, etc. This package + requires that PERL and the PERL module Text::Template also be + installed (see NOTES.PERL). + + All of these can be obtained from the usual DJGPP mirror sites or + directly at "http://www.delorie.com/pub/djgpp". For help on which + files to download, see the DJGPP "ZIP PICKER" page at + "http://www.delorie.com/djgpp/zip-picker.html". You also need to have + the WATT-32 networking package installed before you try to compile + OpenSSL. This can be obtained from "http://www.watt-32.net/". + The Makefile assumes that the WATT-32 code is in the directory + specified by the environment variable WATT_ROOT. If you have watt-32 + in directory "watt32" under your main DJGPP directory, specify + WATT_ROOT="/dev/env/DJDIR/watt32". + + To compile OpenSSL, start your BASH shell, then configure for DJGPP by + running "./Configure" with appropriate arguments: + + ./Configure no-threads --prefix=/dev/env/DJDIR DJGPP + + And finally fire up "make". You may run out of DPMI selectors when + running in a DOS box under Windows. If so, just close the BASH + shell, go back to Windows, and restart BASH. Then run "make" again. + + RUN-TIME CAVEAT LECTOR + -------------- + + Quoting FAQ: + + "Cryptographic software needs a source of unpredictable data to work + correctly. Many open source operating systems provide a "randomness + device" (/dev/urandom or /dev/random) that serves this purpose." + + As of version 0.9.7f DJGPP port checks upon /dev/urandom$ for a 3rd + party "randomness" DOS driver. One such driver, NOISE.SYS, can be + obtained from "http://www.rahul.net/dkaufman/index.html". diff --git a/NOTES.PERL b/NOTES.PERL new file mode 100644 index 0000000000..eda812dc8e --- /dev/null +++ b/NOTES.PERL @@ -0,0 +1,118 @@ + TOC + === + + - Notes on Perl + - Notes on Perl on Windows + - Notes on Perl modules we use + - Notes on installing a perl module + + Notes on Perl + ------------- + + For our scripts, we rely quite a bit on Perl, and increasingly on + some core Perl modules. These Perl modules are part of the Perl + source, so if you build Perl on your own, you should be set. + + However, if you install Perl as binary packages, the outcome might + differ, and you may have to check that you do get the core modules + installed properly. We do not claim to know them all, but experience + has told us the following: + + - on Linux distributions based on Debian, the package 'perl' will + install the core Perl modules as well, so you will be fine. + - on Linux distributions based on RPMs, you will need to install + 'perl-core' rather than just 'perl'. + + You MUST have at least Perl version 5.10.0 installed. This minimum + requirement is due to our use of regexp backslash sequence \R among + other features that didn't exist in core Perl before that version. + + Notes on Perl on Windows + ------------------------ + + There are a number of build targets that can be viewed as "Windows". + Indeed, there are VC-* configs targeting VisualStudio C, as well as + MinGW and Cygwin. The key recommendation is to use "matching" Perl, + one that matches build environment. For example, if you will build + on Cygwin be sure to use the Cygwin package manager to install Perl. + For VC-* builds we recommend ActiveState Perl, available from + http://www.activestate.com/ActivePerl. + + Notes on Perl on VMS + -------------------- + + You will need to install Perl separately. One way to do so is to + download the source from http://perl.org/, unpacking it, reading + README.vms and follow instructions. Another way is to download a + .PCSI file from http://www.vmsperl.com/ and install it using the + POLYCENTER install tool. + + Notes on Perl modules we use + ---------------------------- + + We make increasing use of Perl modules, and do our best to limit + ourselves to core Perl modules to keep the requirements down. There + are just a few exceptions: + + Test::More We require the minimum version to be 0.96, which + appeared in Perl 5.13.4, because that version was + the first to have all the features we're using. + This module is required for testing only! If you + don't plan on running the tests, you don't need to + bother with this one. + + Text::Template This module is not part of the core Perl modules. + As a matter of fact, the core Perl modules do not + include any templating module to date. + This module is absolutely needed, configuration + depends on it. + + To avoid unnecessary initial hurdles, we have bundled a copy of the + following modules in our source. They will work as fallbacks if + these modules aren't already installed on the system. + + Text::Template + + Notes on installing a perl module + --------------------------------- + + There are a number of ways to install a perl module. In all + descriptions below, Text::Template will server as an example. + + 1. for Linux users, the easiest is to install with the use of your + favorite package manager. Usually, all you need to do is search + for the module name and to install the package that comes up. + + On Debian based Linux distributions, it would go like this: + + $ apt-cache search Text::Template + ... + libtext-template-perl - perl module to process text templates + $ sudo apt-get install libtext-template-perl + + Perl modules in Debian based distributions use package names like + the name of the module in question, with "lib" prepended and + "-perl" appended. + + 2. Install using CPAN. This is very easy, but usually requires root + access: + + $ cpan -i Text::Template + + Note that this runs all the tests that the module to be install + comes with. This is usually a smooth operation, but there are + platforms where a failure is indicate even though the actual tests + were successful. Should that happen, you can force an + installation regardless (that should be safe since you've already + seen the tests succeed!): + + $ cpan -f -i Text::Template + + Note: on VMS, you must quote any argument that contains upper case + characters, so the lines above would be: + + $ cpan -i "Text::Template" + + and: + + $ cpan -f -i "Text::Template" diff --git a/NOTES.WIN b/NOTES.WIN index bed5037410..a2e91201ab 100644 --- a/NOTES.WIN +++ b/NOTES.WIN @@ -5,10 +5,13 @@ Requirement details for native (Visual C++) builds -------------------------------------------------- + In addition to the requirements and instructions listed in INSTALL, + this are required as well: + - You need Perl. We recommend ActiveState Perl, available from http://www.activestate.com/ActivePerl. You also need the perl module Text::Template, available on CPAN. - Please read README.PERL for more information. + Please read NOTES.PERL for more information. - You need a C compiler. OpenSSL has been tested to build with these: diff --git a/README b/README index e32844ed1a..1672580225 100644 --- a/README +++ b/README @@ -48,8 +48,8 @@ ------------ See the appropriate file: - INSTALL Linux, Unix, Windows, OpenVMS - INSTALL.DJGPP DOS platform with DJGPP + INSTALL Linux, Unix, Windows, OpenVMS, ... + NOTES.* INSTALL addendums for different platforms SUPPORT ------- diff --git a/README.PERL b/README.PERL deleted file mode 100644 index eda812dc8e..0000000000 --- a/README.PERL +++ /dev/null @@ -1,118 +0,0 @@ - TOC - === - - - Notes on Perl - - Notes on Perl on Windows - - Notes on Perl modules we use - - Notes on installing a perl module - - Notes on Perl - ------------- - - For our scripts, we rely quite a bit on Perl, and increasingly on - some core Perl modules. These Perl modules are part of the Perl - source, so if you build Perl on your own, you should be set. - - However, if you install Perl as binary packages, the outcome might - differ, and you may have to check that you do get the core modules - installed properly. We do not claim to know them all, but experience - has told us the following: - - - on Linux distributions based on Debian, the package 'perl' will - install the core Perl modules as well, so you will be fine. - - on Linux distributions based on RPMs, you will need to install - 'perl-core' rather than just 'perl'. - - You MUST have at least Perl version 5.10.0 installed. This minimum - requirement is due to our use of regexp backslash sequence \R among - other features that didn't exist in core Perl before that version. - - Notes on Perl on Windows - ------------------------ - - There are a number of build targets that can be viewed as "Windows". - Indeed, there are VC-* configs targeting VisualStudio C, as well as - MinGW and Cygwin. The key recommendation is to use "matching" Perl, - one that matches build environment. For example, if you will build - on Cygwin be sure to use the Cygwin package manager to install Perl. - For VC-* builds we recommend ActiveState Perl, available from - http://www.activestate.com/ActivePerl. - - Notes on Perl on VMS - -------------------- - - You will need to install Perl separately. One way to do so is to - download the source from http://perl.org/, unpacking it, reading - README.vms and follow instructions. Another way is to download a - .PCSI file from http://www.vmsperl.com/ and install it using the - POLYCENTER install tool. - - Notes on Perl modules we use - ---------------------------- - - We make increasing use of Perl modules, and do our best to limit - ourselves to core Perl modules to keep the requirements down. There - are just a few exceptions: - - Test::More We require the minimum version to be 0.96, which - appeared in Perl 5.13.4, because that version was - the first to have all the features we're using. - This module is required for testing only! If you - don't plan on running the tests, you don't need to - bother with this one. - - Text::Template This module is not part of the core Perl modules. - As a matter of fact, the core Perl modules do not - include any templating module to date. - This module is absolutely needed, configuration - depends on it. - - To avoid unnecessary initial hurdles, we have bundled a copy of the - following modules in our source. They will work as fallbacks if - these modules aren't already installed on the system. - - Text::Template - - Notes on installing a perl module - --------------------------------- - - There are a number of ways to install a perl module. In all - descriptions below, Text::Template will server as an example. - - 1. for Linux users, the easiest is to install with the use of your - favorite package manager. Usually, all you need to do is search - for the module name and to install the package that comes up. - - On Debian based Linux distributions, it would go like this: - - $ apt-cache search Text::Template - ... - libtext-template-perl - perl module to process text templates - $ sudo apt-get install libtext-template-perl - - Perl modules in Debian based distributions use package names like - the name of the module in question, with "lib" prepended and - "-perl" appended. - - 2. Install using CPAN. This is very easy, but usually requires root - access: - - $ cpan -i Text::Template - - Note that this runs all the tests that the module to be install - comes with. This is usually a smooth operation, but there are - platforms where a failure is indicate even though the actual tests - were successful. Should that happen, you can force an - installation regardless (that should be safe since you've already - seen the tests succeed!): - - $ cpan -f -i Text::Template - - Note: on VMS, you must quote any argument that contains upper case - characters, so the lines above would be: - - $ cpan -i "Text::Template" - - and: - - $ cpan -f -i "Text::Template"