summaryrefslogtreecommitdiffstats
path: root/rbutil/rbutilqt/zip/README
diff options
context:
space:
mode:
authorDominik Riebeling <Dominik.Riebeling@gmail.com>2007-07-25 20:21:06 +0000
committerDominik Riebeling <Dominik.Riebeling@gmail.com>2007-07-25 20:21:06 +0000
commit680408f4ac8b04d716fd8921c01b73d30a3c66c7 (patch)
tree08908a7d5e3b95daa9a1d3ed0703e64cff712022 /rbutil/rbutilqt/zip/README
parentaa643db434e230643e18e454032fb708e0f1848d (diff)
downloadrockbox-680408f4ac8b04d716fd8921c01b73d30a3c66c7.tar.gz
rockbox-680408f4ac8b04d716fd8921c01b73d30a3c66c7.zip
First stab at porting rbutil to Qt4. Currently only installing a current or archived build is working. To build, run qmake && make in the source folder. Beware that the syntax of rbutil.ini has slightly changed. Caching of the downloaded files is also still missing.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@13989 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'rbutil/rbutilqt/zip/README')
-rw-r--r--rbutil/rbutilqt/zip/README68
1 files changed, 68 insertions, 0 deletions
diff --git a/rbutil/rbutilqt/zip/README b/rbutil/rbutilqt/zip/README
new file mode 100644
index 0000000000..81891e8516
--- /dev/null
+++ b/rbutil/rbutilqt/zip/README
@@ -0,0 +1,68 @@
+The *.cpp and *.h files in this archive are
+Copyright (C) 2007 Angius Fabrizio (blue_death@users.sourceforge.net)
+
+You may use, distribute and copy the files under the terms of
+GNU General Public License version 2 (see the file LICENSE.GPL for details)
+
+-------------------------------------------------------------------------
+
+Website: http://osdab.sourceforge.net/
+SourceForge.net project page: https://sourceforge.net/projects/osdab/
+
+**************** ******* ******************************************************
+
+detailed description
+--------------------
+Meet a couple of pure-Qt/C++ classes capable of handling PKZIP 2.0 compatible zip archives.
+
+This is not a "port" of some other existing implementation, everything has been written from scratch (althought some code was actually inspired by existing public domain projects) and it's all pure C++/Qt. Please note that this is not a complete stand-alone library, it's just a bunch of classes. You will have to add them to your project and modify them to best fit your needs.
+
+It supports basic features like file extraction and compression (with optional password encryption) and archive comments. There are methods to extract single files or the whole archive and methods to compress the contents of a whole directory. Nevertheless, it should be quite trivial to add other features. The public API only has a few methods because this is what I was looking for. This does not mean you can't write a few more lines of code (it really shouldn't take more than a few lines!) to add more features.
+
+The classes are great if you only need to use the PKZIP format for loading/saving your application's data. Just remember that you will need to customize a few parts of the code, i.e. to add your own password retrieval method.
+
+zlib is used for actual compression and decompression.
+
+Please refer to the example application's main.cpp file or to the class comments in the source files for details and more usage examples.
+
+history
+-------
+2007-02-01 - New IgnorePaths compression option and two more "addDirectoryContents()" convenience methods to use this option.
+2007-01-28 - Major changes:
+ - Bug fix: there was a big problem with directory names.
+ - API changes: the Zip::addDirectory() method is now easier to use.
+ The password can now be set using a setPassword() method and a new flag allows to preserve absolute paths.
+ - Added an "encrypted" flag to the Unzip::ZipEntry struct.
+ - Removed QObject inheritance. Internationalization is now achieved through QCoreApplication::translate().
+2006-11-30 - A good part of the UnZip class has been rewritten. Zip entries with a Data Descriptor (like OpenOffice files) are now correctly parsed; some minor API changes and bug fixes; new features: comments, zip entry list, skip paths unzip option
+2006-11-24 - Bug fix. An additional directory was being created for some files in the root directory
+2006-10-23 - Minor API changes; QIODevice support added; better binary compatibility; "long long" issue with older compilers solved
+2006-06-09 - Minor API changes
+2005-10-03 - First public release
+
+features
+--------
+Pure C++/Qt based, clean & oo implementation.
+Retrieve archive contents information before extracting any file.
+Fast (but less robust with corrupt archives) parsing of the ZIP file format.
+Traditional PKWARE password encryption (strong encryption as introduced by PKZip versions 5.0 and later is NOT available).
+Support for archive comments.
+
+missing features and restrictions
+---------------------------------
+Needs to be modified to fit into an existing project (i.e.: you might need to add your own password handling routine).
+Weak support of corrupted archives (althought some files could be extracted even if the archive is corrupted).
+No support for filesystem specific features like unix symbolic links.
+No support for spanned archives.
+No support for strong encryption or features introduced after PKZIP version 2.0 (see the PKWARE specs for details).
+
+requirements
+------------
+Qt version 4.0.x or later
+zlib library
+
+
+**************** ******* ******************************************************
+BEFORE SENDING ANY EMAIL, CHECK OUT THE OSDAB WEBSITE HOSTED AT SOURCEFORGE.NET
+**************** ******* ******************************************************
+