greg/pcompress
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update Licensing notes and build notes.

Browse source 
More whitespace fixes.
This commit is contained in:
Moinak Ghosh 2014-07-26 15:28:40 +05:30
parent c1411a6af6
commit d5ceda559e
20 changed files with 55 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
INSTALL
View file

@ -110,6 +110,14 @@ is not the usual GNU Autoconf script.
support is used. So a local static libarchive build with support is used. So a local static libarchive build with
most features disabled can be used with this option. most features disabled can be used with this option.
--with-external-libbsc=<path to libbsc source tree>
Enable building with exernal libbsc sources. In the LGPL licensed
sources a fork of the previous LGPL licensed libbsc source tree is
already included in the Pcompress repo. The same is not true for the
MPLv2 licensed sources. So libbsc has to be downloaded separately
from: http://libbsc.com/ and linked into Pcompress using this option.
The current libbsc sources are licensed with ASLv2.
--no-sse-detect Do not try to detect the CPU's SSE capability. This --no-sse-detect Do not try to detect the CPU's SSE capability. This
mode will simply use SSE2 as the fallback default. mode will simply use SSE2 as the fallback default.
Using SSE4 and later improves performance significantly. Using SSE4 and later improves performance significantly.

18
README.md
View file

@ -33,6 +33,16 @@ Pcompress also supports encryption via AES, Salsa20 and uses Scrypt from
Tarsnap for Password Based Key generation. A unique key is generated per Tarsnap for Password Based Key generation. A unique key is generated per
session even if the same password is used and HMAC is used to do authentication. session even if the same password is used and HMAC is used to do authentication.
LICENSING
=========
Pcompress is dual licensed with LGPLv3 and MPLv2 sources. The main git
repository is LGPL licensed. A separate tarball of the sources with
MPLv2 license is made available as a download. This is updated
periodically. Since Pcompress also integrates a bunch of third-party
software a few features may be missing in the MPLv2 licensed version
because of the upstream software being LGPL licensed originally.
Links of Interest Links of Interest
================= =================
@ -198,6 +208,12 @@ Compression Algorithms
However in a few cases this can produce slightly lesser compression However in a few cases this can produce slightly lesser compression
gain. gain.
libbsc - This is a new block-sorting compressor having much better effectiveness
and performance over a variety of data types as compared to Bzip2.
NOTE: In the LGPL licensed version libbsc is an integral part of Pcompress.
When building MPLv2 licensed sources, the libbsc sources must be
downloaded separately and linked in. This is described in the INSTALL file.
PPMD - Slow. Extreme compression for Text, average compression for binary. PPMD - Slow. Extreme compression for Text, average compression for binary.
In addition PPMD decompression time is also high for large chunks. In addition PPMD decompression time is also high for large chunks.
This requires lots of RAM similar to LZMA. PPMd requires This requires lots of RAM similar to LZMA. PPMd requires
@ -232,6 +248,8 @@ Enabled features based on Compression Level
10 - 14 - Global Dedup block size 2KB, Adaptive Delta Encoding with extra rounds, Dispack, 10 - 14 - Global Dedup block size 2KB, Adaptive Delta Encoding with extra rounds, Dispack,
LZP Preprocessing, PackJPG filter for Jpegs. LZP Preprocessing, PackJPG filter for Jpegs.
NOTE: - LZP Preprocessing and PackJPG are not available in the MPLv2 licensed version.
Encryption Encryption
========== ==========
Pcompress supports encryption and authentication in both archive and single-file Pcompress supports encryption and authentication in both archive and single-file