summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README42
1 files changed, 42 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..4a5a621
--- /dev/null
+++ b/README
@@ -0,0 +1,42 @@
+Description
+
+Lunzip is a decompressor for lzip files. It is written in C and its
+small size makes it well suited for embedded devices or software
+installers that need to decompress files but do not need compression
+capabilities.
+
+Lunzip replaces every file given in the command line with a decompressed
+version of itself. Each decompressed file has the same modification
+date, permissions, and, when possible, ownership as the corresponding
+compressed file. Lunzip is able to read from some types of non regular
+files if the "--stdout" option is specified.
+
+Lunzip attempts to guess the name for the decompressed file from that of
+the compressed file as follows:
+
+filename.lz becomes filename
+filename.tlz becomes filename.tar
+anyothername becomes anyothername.out
+
+If no file names are specified, lunzip decompresses from standard input
+to standard output. In this case, lunzip will decline to read compressed
+input from a terminal.
+
+Lunzip will correctly decompress a file which is the concatenation of
+two or more compressed files. The result is the concatenation of the
+corresponding uncompressed files. Integrity testing of concatenated
+compressed files is also supported.
+
+The amount of memory required by lunzip to decompress a file is only a
+few tens of KiB larger than the dictionary size used to compress that
+file.
+
+
+Copyright (C) 2010 Antonio Diaz Diaz.
+
+This file is free documentation: you have unlimited permission to copy,
+distribute and modify it.
+
+The file Makefile.in is a data file used by configure to produce the
+Makefile. It has the same copyright owner and permissions that configure
+itself.