Add config.sub update to %configure macro
[platform/upstream/rpm.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 96ddbdb..0536727 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -9,17 +9,34 @@ The libmagic (aka file) library for file type detection (used by rpmbuild).
 The source for the file utility + library is available from
     ftp://ftp.astron.com/pub/file/
 
-The NSS library for encryption, and NSPR library which NSS uses. 
-Both NSPR and NSS libraries and headers need to be installed during RPM
-compilation. As NSPR and NSS typically install their headers outside
-the regular include search path, you need to tell configure about this,
-eg something like:
+You will need a cryptographic library to support digests and signatures.
+This library may be Mozilla NSS, OpenSSL or beecrypt. Which library to use
+must be specified with the --with-crypto=[beecrypt|nss|openssl] argument
+to configure.
+
+If using the Mozilla NSS library for encyption (and NSPR library which
+NSS uses) it must be version 3.12 or later. Both NSPR and NSS libraries and
+headers need to be installed during RPM compilation. As NSPR and NSS
+typically install their headers outside the regular include search path,
+you need to tell configure about this, eg something like:
     ./configure <......> CPPFLAGS="-I/usr/include/nspr -I/usr/include/nss"
 
 The NSPR and NSS libraries are available from 
     http://www.mozilla.org/projects/security/pki/nss/
     http://www.mozilla.org/projects/nspr/
 
+If using the OpenSSL library for encryption, it must be version 1.0.2 or
+later. Note: when compiling against OpenSSL, there is a possible license
+incompatibility. For more details on this, see
+https://people.gnome.org/~markmc/openssl-and-the-gpl.html
+Some Linux distributions have different legal interpretations of this
+possible incompatibility. It is recommended to consult with a lawyer before
+building RPM against OpenSSL.
+Fedora: https://fedoraproject.org/wiki/Licensing:FAQ#What.27s_the_deal_with_the_OpenSSL_license.3F
+Debian: https://lists.debian.org/debian-legal/2002/10/msg00113.html
+
+The OpenSSL crypto library is available from https://www.openssl.org/
+
 The Berkeley DB >= 4.3.x (4.5.x or newer recommended) is required for the
 default database backend. BDB can be downloaded from
 http://www.oracle.com/technology/software/products/berkeley-db/index.html
@@ -77,7 +94,7 @@ is available from
 It may be desired to install bzip2, gzip, and xz/lzma so that RPM can use these
 formats.  Gzip is necessary to build packages that contain compressed
 tar balls, these are quite common on the Internet.
-These are availible from
+These are available from
     http://www.gzip.org
     http://www.bzip.org
     http://tukaani.org/xz/
@@ -162,9 +179,9 @@ and then install with:
     make install
 
 Rpm comes with an automated self-test suite. The test-suite relies heavily
-on fakechroot (https://github.com/fakechroot/) and cannot be executed
+on fakechroot (https://github.com/dex4er/fakechroot/) and cannot be executed
 without it. Provided that fakechroot was found during configure,
-it can be executed after a succesful build with:
+it can be executed after a successful build with:
 
     make check
 
@@ -186,7 +203,7 @@ with two rpms which can be found in RPMS and SRPMS.
 If you are going to install rpm on machines with OS package managers
 other then rpm, you may choose to install the base rpm package via a
 cpio instead of a tar file.  Instead of running "make tar" during the
-build process, as discribed above, use the base rpm packages to create
+build process, as described above, use the base rpm packages to create
 a cpio.  After the rpms have been created run rpm2cpio on the base rpm
 package, this will give you a cpio package which can then use to
 install rpm on a new system.
@@ -208,13 +225,13 @@ an issue.
 RPM will need to be informed of all the dependencies which were
 satisfied before RPM was installed.  Typically this only refers to
 libraries that are installed by the OS, but may include other
-libraries and packages which are availible at the time RPM is
+libraries and packages which are available at the time RPM is
 installed and will not under RPM control.  Another common example of
 libraries which may need dependency provisions are precompiled
 libraries which are installed by the OS package manager during system
 build time.  The list of dependencies you will wish to load into RPM
 will depend on exactly how you bootstrap RPM onto your system and what
-parts of the sytem you put into packages as well as on the specific OS
+parts of the system you put into packages as well as on the specific OS
 you are using.
 
 The script vpkg-provides.sh can be used to generate a package which
@@ -231,7 +248,7 @@ can use the option:
 
 By default the generated rpm will include a %verifyscript to verify
 checksum of all files traversed has not changed.  This additional
-check can be surpressed with:
+check can be suppressed with:
 
     --no_verify