Commit graph

157 commits

Author SHA1 Message Date
Richard Levitte
4fa3f08fee Add some notes on shared library names on different platforms
This is overdue since the addition of the unified build system

Reviewed-by: Rich Salz <rsalz@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/1767)
2016-10-25 20:33:21 +02:00
FdaSilvaYY
e2562bbbe1 Update INSTALL about no-md5 removal
no-rsa is no longer an option since 7ec8de1

Fix a typo about poly1305

Reviewed-by: Andy Polyakov <appro@openssl.org>
Reviewed-by: Rich Salz <rsalz@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/1582)
2016-09-19 20:12:58 +02:00
Andy Polyakov
758baa3dc2 Configure: impose ^X on whole build procedure.
Traditionally Configure passed $ENV{PERL} to Makefile. But this
resulted in ambiguilty as Configure script could be executed by
interpreter different from one executing remaining scripts. Since
we separate compile- and run-time interpreters with HASHBANGPERL
variable, there is no reason to segment the build procedure.

Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-09-13 13:22:28 +02:00
Richard Levitte
b3e718e286 Document the enhanced tests specification
Reviewed-by: Emilia Käsper <emilia@openssl.org>
2016-09-01 20:58:41 +02:00
Richard Levitte
967e831e88 Revert "INSTALL: add information on option no-fuzz-test"
This reverts commit 7f9ae88817.

Reviewed-by: Emilia Käsper <emilia@openssl.org>
2016-09-01 20:58:40 +02:00
Richard Levitte
7f9ae88817 INSTALL: add information on option no-fuzz-test
Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-08-31 21:19:19 +02:00
Richard Levitte
ed43fe73ea INSTALL: add information on the environment variable BUILDFILE
Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-08-31 21:19:19 +02:00
Richard Levitte
bf98d9dab5 INSTALL: clarify OPENSSL_LOCAL_CONFIG_DIR
Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-08-31 21:19:19 +02:00
Richard Levitte
e8fd2a4cb4 Add a note about a perl issue on VMS and how to work around it
I bug in perl's File::Spec->canonpath() was uncovered.  There's
nothing we can do about it (except re-implementing canonpath()),
except working around the problem (a directory rename) and reporting
the issue to the perl module developers.

Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-08-06 16:00:13 +02:00
Richard Levitte
ea24fe2996 INSTALL: Make the use of [, ], { and } consistent and explain it
The diverse notations used in INSTALL are not as self explanatory as
we might imagine, so let's attempt a consistent notation for mandatory
and optional pieces of a command line, and to explain the meaning of
each notation.

This does away with the bash notation used in one spot, as it isn't
universally understood and will only confuse the unknowing more.

Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-08-03 15:46:52 +02:00
Richard Levitte
d178ddb3b6 INSTALL: Add missing details on VMS installation results
Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-08-03 15:46:52 +02:00
Matt Caswell
255af26c5d Some minor tweaks to the fuzzing docs
Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-08-01 22:07:04 +01:00
Andy Polyakov
85afea67f5 INSTALL: clarify --cross-compile-prefix.
Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-07-16 20:35:54 +02:00
Richard Levitte
d513369bfa perl: Separate compile-time environment from runtime environment
Make it possible to have a separate and different perl command string
for installable scripts than we use when building, with the
environment variable HASHBANGPERL.  Its value default to the same as
the environment PERL if it's defined, otherwise '/usr/bin/env perl'.

Note: this is only relevant for Unix-like environments.

Reviewed-by: Rich Salz <rsalz@openssl.org>
Reviewed-by: Andy Polyakov <appro@openssl.org>
Reviewed-by: Kurt Roeckx <kurt@openssl.org>
2016-07-04 15:40:31 +02:00
FdaSilvaYY
f430ba31ac Spelling... and more spelling
Reviewed-by: Kurt Roeckx <kurt@openssl.org>
Reviewed-by: Rich Salz <rsalz@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/1245)
2016-06-22 00:26:10 +02:00
Matt Caswell
fa28bfd66f Update INSTALL instructions
Fill out the INSTALL instructions with more information on Configure
arguments, environment variables and Makefile targets.

Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-06-03 17:24:50 +01:00
Richard Levitte
6616429d4c Build the 'openssl rehash' command on VMS version 8.3 and up
Include a note in INSTALL that tests must be run from an unprivileged
process.

Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-06-02 21:11:07 +02:00
Richard Levitte
8d054a5530 Add a warning about using enable-crypto-mdebug-backtrace
Reviewed-by: Matt Caswell <matt@openssl.org>
2016-06-02 13:00:31 +02:00
Richard Levitte
07930a75a1 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 <rsalz@openssl.org>
2016-05-23 16:02:53 +02:00
Rich Salz
20ab55f494 Remove INSTALL.WCE and refs to it.
Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-23 09:55:24 -04:00
Richard Levitte
e817315702 VMS: support VERBOSE and V in descrip.mms
With Unixly Makefiles as well as with nmake, make variables are
transferred to the shell running the commands as envinronment
variables.  This principle doesn't apply with MMS, so we must
explicitely define VERBOSE as commands when it's needed.

Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-05-09 16:11:36 +02:00
Dr. Stephen Henson
be6bdab6f8 Recognise VERBOSE and V as well as HARNESS_VERBOSE
PR#4462

Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-05-09 14:08:25 +01:00
Benjamin Kaduk
42a9f38613 Remove the never-functional no-sct
It was added as part of 2df84dd329
but has never actually been used for anything; presumably it was
a typo for one of SCTP or CT.

This removes the last '??' entry from INSTALL.

Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-04-26 08:32:10 -04:00
Richard Levitte
84f4f0bdd4 NOTES files will contain more requirements, make that explicit
Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-04-18 14:20:41 +02:00
Matt Caswell
ce942199db Make "shared" builds the default
In most cases we expect that people will be using shared libraries not
static ones, therefore we make that the default.

Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-04-14 22:23:12 +01:00
Matt Caswell
0532881513 Update INSTALL file based on feedback
Update the config options documentation based on feedback.

Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-04-13 21:28:17 +01:00
Matt Caswell
ecabf05e5b Update the INSTALL instructions with lots of options
There were a lot of options missing from INSTALL. This adds descriptions
for them.

Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-04-13 21:25:24 +01:00
Richard Levitte
667c6bfe18 Adjust some default installation directories
- on VMS, SYS$COMMON:[SSL] is already used as installation directory
  by HP SSL, so we make our default for --openssldir
  SYS$COMMON:[OPENSSL-COMMON] instead.
- Updated notes on default installation dirs fir Unix and Windows

Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-03-24 00:36:03 +01:00
Rich Salz
1fbab1dc6f Remove Netware and OS/2
Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-03-17 17:06:57 -04:00
Richard Levitte
8c16829ebd Add install targets for Windows
On Windows, we set INSTALLTOP to default as follows:

  VC-WIN32:

    PREFIX:     %ProgramFiles(x86)%\OpenSSL
    OPENSSLDIR: %CommonProgramFiles(x86)%\SSL

  VC-WIN64*:

    PREFIX:     %ProgramW6432%\OpenSSL
    OPENSSLDIR: %CommonProgramW6432%\SSL

Should those environment variables be missing, the following is used
as fallback:

    PREFIX:     %ProgramFiles%\OpenSSL
    OPENSSLDIR: %CommonProgramFiles%\SSL

Reviewed-by: Andy Polyakov <appro@openssl.org>
2016-03-17 21:06:14 +01:00
Matt Caswell
d5957691f2 More tweaks to the installation instructions
A few things were out of date and a few things were missing. Also some
formatting updates.

Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-03-11 10:00:39 +00:00
Richard Levitte
b32b896166 Adapt INSTALL and related notes for Windows
Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-03-09 11:22:07 +01:00
Richard Levitte
5bb9e2b48b Tweak some more information in INSTALL
The summary on how to add configs and how Makefile et al wasn't quite
correct any more.

Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-03-08 15:42:41 +01:00
Richard Levitte
2acd8ec7a9 Change the INSTALL documentation for unified builds
Because of the unified scheme, building on different platforms is very
similar.  We currently have Unix and OpenVMS on the unified scheme,
which means that a separate INSTALL.VMS is no longer needed.

Reviewed-by: Matt Caswell <matt@openssl.org>
2016-03-08 10:48:25 +01:00
Richard Levitte
3c65577f1a Rename INSTALL_PREFIX to DESTDIR, remove option --install_prefix
INSTALL_PREFIX is a confusing name, as there's also --prefix.
Instead, tag along with the rest of the open source world and adopt
the Makefile variable DESTDIR to designate the desired staging
directory.

The Configure option --install_prefix is removed, the only way to
designate a staging directory is with the Makefile variable (this is
also implemented for VMS' descrip.mms et al).

Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-02-12 21:54:07 +01:00
Richard Levitte
d40b0622fa Document the changes in "make test" behavior
Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-02-12 20:56:46 +01:00
Matt Caswell
35d8fa563c Updates for auto init/deinit review comments
Fixes for the auto-init/deinit code based on review comments

Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-02-09 15:12:02 +00:00
Matt Caswell
8b75603cc0 Provide documentation for auto-init/auto-deinit
Provide some man pages for auto-init/deinit. Also update the INSTALL
documentation for information on the new Configure options implemented as
part of this.

Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-02-09 15:11:38 +00:00
Richard Levitte
d36ab9ce9a Refactor file writing - information on our use of Perl and Perl modules
This includes a start on how to install missing modules.

Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-01-22 23:12:22 +01:00
Matt Caswell
7a77bd9de7 Update Windows installation instructions
The windows installation instructions were very out of date. Substantial
update to the text. Remove a lot of historical stuff that isn't relevant
any more, and merge the win64 and win32 instructions into one file.

Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-01-15 11:01:00 +00:00
Rich Salz
d10dac1187 Move Makefiles to Makefile.in
Create Makefile's from Makefile.in
Rename Makefile.org to Makefile.in
Rename Makefiles to Makefile.in
Address review feedback from Viktor and Richard

Reviewed-by: Viktor Dukhovni <viktor@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-01-12 16:26:56 -05:00
Rich Salz
41977c53cd RT4202: Update rt URL's.
Reviewed-by: Matt Caswell <matt@openssl.org>
2015-12-28 16:40:40 -05:00
Richard Levitte
2e996acf2f Extend the notes on how to do testing
These notes include the use of HARNESS_VERBOSE (see the manual for
Test::Harness) and the method to enumerate specific tests to run.

Reviewed-by: Emilia Käsper <emilia@openssl.org>
2015-09-15 15:26:32 +02:00
Richard Levitte
187bad4c24 Add a few notes on perl
Reviewed-by: Emilia Käsper <emilia@openssl.org>
2015-09-15 13:14:49 +02:00
Veres Lajos
478b50cf67 misspellings fixes by https://github.com/vlajos/misspell_fixer 2013-09-05 21:39:42 +01:00
Lutz Jänicke
b4be380889 Fix URI of OpenSSL Request Tracker information
PR: 1661
2008-04-07 06:37:05 +00:00
Ulf Möller
d9907c972b wording (can't really call shared libs experimental after several years in the major Linux distributions) 2006-11-21 20:51:25 +00:00
Ulf Möller
60cdb821db manual pages as HTML
Submitted by: Oliver Tappe <zooey@hirschkaefer.de>
2006-04-11 21:09:57 +00:00
Ulf Möller
c58d983e3b *** empty log message *** 2006-03-17 19:29:35 +00:00
Ulf Möller
a84c9d1ed9 Clarification for CPU specific config options. 2006-03-17 19:22:35 +00:00
Andy Polyakov
216ddfaf6b Mention no-sse2 option in INSTALL note. 2005-02-06 13:10:23 +00:00
Richard Levitte
4d8743f490 Netware-specific changes,
PR: 780
Submitted by: Verdon Walker <VWalker@novell.com>
Reviewed by: Richard Levitte
2003-11-28 13:10:58 +00:00
Richard Levitte
4e59cd3bb6 Add verbosity 2003-01-15 17:23:16 +00:00
Richard Levitte
c0ac323360 CFLAG, not CFLAGS 2003-01-10 11:30:44 +00:00
Richard Levitte
a0cd3ca62b It's recommended to do 'make clean' after having prepared a new build tree.
PR: 437
2003-01-10 11:00:50 +00:00
Richard Levitte
4a9476dd8d When preparing a separate build tree, don't make softlinks to softlinks.
Add instructions in INSTALL, for easy access.
PR: 437
2003-01-10 10:56:14 +00:00
Lutz Jänicke
123e5dfc3a Fix wrong URI.
Submitted by: assar@kth.se
Reviewed by:
PR: 390
2002-12-09 08:49:58 +00:00
Lutz Jänicke
96c930dd2f More information to the important issue of seeding the PRNG
Submitted by:
Reviewed by:
PR: 285
2002-11-11 08:33:10 +00:00
Lutz Jänicke
7650934f21 README and INSTALL should contain information about the request tracker
(noted by Jonathan Louie <jlouie@recourse.com>).
2002-06-30 19:40:18 +00:00
Richard Levitte
d5492d9b47 Add support for DJGPP. 2002-06-13 20:44:49 +00:00
Richard Levitte
f1ca5f5b89 Clarify that zlib-dynamic is the default choice. 2001-07-12 09:19:34 +00:00
Richard Levitte
e452de9d87 Add the possibility to specify the use of zlib compression and
decompression.  It can be set up to link at link time or to load the
zlib library at run-time.
2001-07-12 09:11:14 +00:00
Richard Levitte
c1c971654b Make an extra note about shared libraries and backward compatibility. 2001-07-03 01:43:11 +00:00
Richard Levitte
d57d85ff35 Add a few more details on what one might need. make and a development
environment were a part of a Unix operating systems, but these days
you see an increasing number of installations that do not necessarely
have these crucial parts by default, so it's needs mentioning.
2001-05-17 04:16:19 +00:00
Richard Levitte
9020b86250 Documentation language corrections, contributed by Chris Pepper <pepper@mail.reppep.com> 2001-01-25 14:46:00 +00:00
Richard Levitte
ccb9643f02 Remove references to RSAref. The glue library is but a memory to fade
away now...
2000-11-08 17:51:37 +00:00
Richard Levitte
a652ffc4b5 Clarify how one should behave when make fails. The fault is not
necessarely ours.
2000-09-08 22:19:27 +00:00
Richard Levitte
fcc6a1c4ec Added and corrected documentation for the 'shared' option 2000-08-02 04:19:50 +00:00
Bodo Möller
2d99cee790 Explain configuration options more completely. 2000-03-25 01:49:07 +00:00
Ulf Möller
47722fe636 Keep the references to other INSTALL files short. These are the Unix
instructions.
2000-03-01 00:40:26 +00:00
Bodo Möller
2c51f2d909 Point to INSTALL.MacOS for MacOS pre X. 2000-02-29 19:07:39 +00:00
Ulf Möller
db209ec295 minor clarification 2000-02-26 22:06:02 +00:00
Ulf Möller
4d524e10b4 nicer manpages 2000-02-24 11:55:57 +00:00
Bodo Möller
435b72dd4f mention manual pages 2000-01-21 09:35:56 +00:00
Ulf Möller
2fdf5d7c23 Remove obsolete SSLeay instructions. 2000-01-07 02:08:20 +00:00
Bodo Möller
78bf1920a2 Point out that openssl-bugs is public. 1999-12-18 01:13:30 +00:00
Bodo Möller
f4e723f3e7 typo 1999-09-21 14:03:20 +00:00
Ulf Möller
b82ccbb7a0 Check the as version on Solaris x86. People don't read INSTALL anyway. :) 1999-09-07 16:45:04 +00:00
Ulf Möller
91174a91b9 Hint about unresolved symbols when mixing compilers. 1999-06-04 21:31:15 +00:00
Bodo Möller
436a376bb0 Some assembler-related clean-ups. 1999-05-28 23:18:51 +00:00
Ulf Möller
33d50ef662 Small corrections. 1999-05-19 18:39:23 +00:00
Ulf Möller
92afda6ccc Mention "make depend". 1999-05-17 20:42:59 +00:00
Ulf Möller
7d7d2cbcb0 VMS support.
Submitted by: Richard Levitte <richard@levitte.org>
1999-05-13 11:37:32 +00:00
Ulf Möller
d5a2ea4b73 Move openssl.cnf out of lib/. 1999-05-10 23:59:28 +00:00
Ulf Möller
d872c55c20 c_rehash doesn't work at that point of the installation, so don't even
try.
1999-05-04 15:41:01 +00:00
Bodo Möller
69bb35ed72 Point out the "rehashing skipped" is not a problem.
Submitted by:
Reviewed by:
PR:
1999-05-01 00:28:56 +00:00
Ulf Möller
b1fe6b43f4 More information about installing. 1999-04-30 18:22:59 +00:00
Ulf Möller
7e05db957f Typo. 1999-04-29 22:07:40 +00:00
Bodo Möller
e5f3045fbf Support INSTALL_PREFIX for packagers.
Submitted by:
Reviewed by:
PR:
1999-04-29 21:52:08 +00:00
Bodo Möller
5f8d5c967f New Configure options "threads" and "no-threads".
For Solaris and Linux, "threads" (with proper compiler options)
is the default.
Submitted by:
Reviewed by:
PR:
1999-04-29 16:10:09 +00:00
Ulf Möller
73bfb9ad6a Do make rehash automatically at make test. 1999-04-28 16:14:39 +00:00
Ulf Möller
462ba4f6b6 New Configure option --openssldir to replace util/ssldir.pl. 1999-04-24 22:59:36 +00:00
Bodo Möller
4fd53220b6 Some instructions for how to handle the <foo.h> => <openssl/foo.h>
transition.

Submitted by:
Reviewed by:
PR:
1999-04-24 17:41:45 +00:00
Ulf Möller
806115771c *.org files are gone for good. 1999-04-23 21:31:54 +00:00
Ulf Möller
abb3e53f9b Be more specify about system requirements. 1999-04-22 17:37:07 +00:00
Ulf Möller
5fbe91d86b New Configure option "rsaref". 1999-04-13 00:58:49 +00:00
Ulf Möller
2613c1fa2f New option to generate 80386 code. 1999-03-31 12:38:27 +00:00
Ralf S. Engelschall
4109b97c4b Bring style of INSTALL* documents in sync with README file
and fix some inconsistencies.
1999-03-22 15:36:37 +00:00
Ralf S. Engelschall
afb2306346 Some more source tree cleanups (removed obsolete files crypto/bf/asm/bf586.pl,
test/test.txt and crypto/sha/asm/f.s; changed permission on "config" script to
be executable) and a fix for the INSTALL document.

Submitted by: Ulf Moeller <ulf@fitug.de>
Reviewed by: Ralf S. Engelschall
1999-03-20 13:04:12 +00:00
Ben Laurie
dd56626ecc Don't make links in INSTALL doc - also, work first time! 1999-03-07 15:22:59 +00:00