summaryrefslogtreecommitdiffstats
path: root/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL37
1 files changed, 22 insertions, 15 deletions
diff --git a/INSTALL b/INSTALL
index fb86f55..aa2858a 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,11 +1,15 @@
Requirements
------------
-You will need a C++ compiler and the lzlib compression library installed.
-I use gcc 5.3.0 and 4.1.2, but the code should compile with any standards
+You will need a C++11 compiler and the compression library lzlib installed.
+(gcc 3.3.6 or newer is recommended).
+I use gcc 6.1.0 and 4.1.2, but the code should compile with any standards
compliant compiler.
-Lzlib must be version 1.0 or newer, but the fast encoder is only available
-in lzlib 1.7 or newer, and the HD = 3 detection of corrupt headers on
-non-seekable multimember files is only available in lzlib 1.10 or newer.
+
+Lzlib must be version 1.0 or newer, but the fast encoder requires lzlib 1.7
+or newer, the Hamming distance (HD) = 3 detection of corrupt headers in
+non-seekable multimember files requires lzlib 1.10 or newer, and the 'no
+copy' optimization for testing requires lzlib 1.12 or newer.
+
Gcc is available at http://gcc.gnu.org.
Lzlib is available at http://www.nongnu.org/lzip/lzlib.html.
@@ -33,7 +37,10 @@ the main archive.
To link against a lzlib not installed in a standard place, use:
- ./configure CPPFLAGS='-I<dir_of_lzlib.h>' LDFLAGS='-L<dir_of_liblz.a>'
+ ./configure CPPFLAGS='-I <includedir>' LDFLAGS='-L <libdir>'
+
+ (Replace <includedir> with the directory containing the file lzlib.h,
+ and <libdir> with the directory containing the file liblz.a).
If you are compiling on MinGW, use --with-mingw (note that the Windows
I/O functions used with MinGW are not guaranteed to be thread safe):
@@ -50,11 +57,11 @@ the main archive.
documentation.
Or type 'make install-compress', which additionally compresses the
- info manual and the man page after installation. (Installing
- compressed docs may become the default in the future).
+ info manual and the man page after installation.
+ (Installing compressed docs may become the default in the future).
- You can install only the program, the info manual or the man page by
- typing 'make install-bin', 'make install-info' or 'make install-man'
+ You can install only the program, the info manual, or the man page by
+ typing 'make install-bin', 'make install-info', or 'make install-man'
respectively.
Instead of 'make install', you can type 'make install-as-lzip' to
@@ -65,10 +72,10 @@ the main archive.
Another way
-----------
You can also compile plzip into a separate directory.
-To do this, you must use a version of 'make' that supports the 'VPATH'
-variable, such as GNU 'make'. 'cd' to the directory where you want the
+To do this, you must use a version of 'make' that supports the variable
+'VPATH', such as GNU 'make'. 'cd' to the directory where you want the
object files and executables to go and run the 'configure' script.
-'configure' automatically checks for the source code in '.', in '..' and
+'configure' automatically checks for the source code in '.', in '..', and
in the directory that 'configure' is in.
'configure' recognizes the option '--srcdir=DIR' to control where to
@@ -79,7 +86,7 @@ After running 'configure', you can run 'make' and 'make install' as
explained above.
-Copyright (C) 2009-2019 Antonio Diaz Diaz.
+Copyright (C) 2009-2021 Antonio Diaz Diaz.
This file is free documentation: you have unlimited permission to copy,
-distribute and modify it.
+distribute, and modify it.