]> git.rkrishnan.org Git - tahoe-lafs/zfec.git/blobdiff - zfec/README.txt
doc: TGPPLv1+, not TGGPLv1
[tahoe-lafs/zfec.git] / zfec / README.txt
index e34eee285a52fb61ec89b52f58a3cecafe929115..49fac551c7cc82319e212fbff5b373bc35dfabaf 100644 (file)
@@ -4,13 +4,14 @@ This package implements an "erasure code", or "forward error correction code".
 
 You may use this package under the GNU General Public License, version 2 or, at
 your option, any later version.  You may use this package under the Transitive
-Grace Period Public Licence, version 1.0.  (You may choose to use this package
-under the terms of either licence, at your option.)  See the file COPYING.GPL
-for the terms of the GNU General Public License, version 2.  See the file
-COPYING.TGPPL.html for the terms of the Transitive Grace Period Public Licence,
-version 1.0.  In addition, Allmydata, Inc. offers other licensing terms.  If you
-would like to inquire about a commercial relationship with Allmydata, Inc.,
-please contact partnerships@allmydata.com and visit http://allmydata.com .
+Grace Period Public Licence, version 1.0 or, at your option, any later version.
+(You may choose to use this package under the terms of either licence, at your
+option.)  See the file COPYING.GPL for the terms of the GNU General Public
+License, version 2.  See the file COPYING.TGPPL.html for the terms of the
+Transitive Grace Period Public Licence, version 1.0.  In addition, Allmydata,
+Inc. offers other licensing terms.  If you would like to inquire about a
+commercial relationship with Allmydata, Inc., please contact
+partnerships@allmydata.com and visit http://allmydata.com .
 
 The most widely known example of an erasure code is the RAID-5 algorithm which
 makes it so that in the event of the loss of any one hard drive, the stored data
@@ -54,7 +55,7 @@ takes a reference to an FFI function.
 
 The source is currently available via darcs on the web with the command:
 
-darcs get http://allmydata.org/source/zfec
+darcs get http://allmydata.org/source/zfec/trunk
 
 More information on darcs is available at http://darcs.net
 
@@ -105,15 +106,16 @@ input to the encoding step.
 The bin/ directory contains two Unix-style, command-line tools "zfec" and
 "zunfec".  Execute "zfec --help" or "zunfec --help" for usage instructions.
 
-Note: a Unix-style tool like "zfec" does only one thing -- in this case
-erasure coding -- and leaves other tasks to other tools.  Other Unix-style
-tools that go well with zfec include "GNU tar" for archiving multiple files
-and directories into one file, "rzip" or "lrzip" for compression, and "GNU
-Privacy Guard" for encryption or "sha256sum" for integrity.  It is important
-to do things in order: first archive, then compress, then either encrypt or
-sha256sum, then erasure code.  Note that if GNU Privacy Guard is used for
-privacy, then it will also ensure integrity, so the use of sha256sum is
-unnecessary in that case.
+Note: a Unix-style tool like "zfec" does only one thing -- in this case erasure
+coding -- and leaves other tasks to other tools.  Other Unix-style tools that go
+well with zfec include "GNU tar" or "7z" a.k.a. "p7zip" for archiving multiple
+files and directories into one file, "7z" or "rzip" for compression, and "GNU Privacy
+Guard" for encryption or "sha256sum" for integrity.  It is important to do
+things in order: first archive, then compress, then either encrypt or sha256sum,
+then erasure code.  Note that if GNU Privacy Guard is used for privacy, then it
+will also ensure integrity, so the use of sha256sum is unnecessary in that case.
+Note that if 7z is used for archiving then it also does compression, so you
+don't need a separate compressor in that case.
 
 
  * Performance Measurements