summaryrefslogtreecommitdiffstats
path: root/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL65
1 files changed, 65 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..c05e8a8
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,65 @@
+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 compliant compiler.
+Gcc is available at http://gcc.gnu.org.
+Lzlib is available at http://www.nongnu.org/lzip/lzlib.html.
+
+
+Procedure
+---------
+1. Unpack the archive if you have not done so already:
+
+ tar -xf tarlz[version].tar.lz
+or
+ lzip -cd tarlz[version].tar.lz | tar -xf -
+
+This creates the directory ./tarlz[version] containing the source from
+the main archive.
+
+2. Change to tarlz directory and run configure.
+ (Try 'configure --help' for usage instructions).
+
+ cd tarlz[version]
+ ./configure
+
+3. Run make.
+
+ make
+
+4. Optionally, type 'make check' to run the tests that come with tarlz.
+
+5. Type 'make install' to install the program and any data files and
+ 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).
+
+ 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.
+
+
+Another way
+-----------
+You can also compile tarlz 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
+object files and executables to go and run the 'configure' script.
+'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
+look for the sources. Usually 'configure' can determine that directory
+automatically.
+
+After running 'configure', you can run 'make' and 'make install' as
+explained above.
+
+
+Copyright (C) 2013-2018 Antonio Diaz Diaz.
+
+This file is free documentation: you have unlimited permission to copy,
+distribute and modify it.