frameworks/karchive/README.md

0001 # KArchive
0002
0003 Reading, creating, and manipulating file archives
0004
0005 ## Introduction
0006
0007 KArchive provides classes for easy reading, creation and manipulation of
0008 "archive" formats like ZIP and TAR.
0009
0010 It also provides transparent compression and decompression of data, like the
0011 GZip format, via a subclass of QIODevice.
0012
0013 ## Usage
0014
0015 If you want to read and write compressed data, just create an instance of
0016 KCompressionDevice and write to or read from that.
0017
0018 If you want to read and write archive formats, create an instance of the
0019 appropriate subclass of KArchive (eg: K7Zip for 7-Zip files).  You may need to
0020 combine this with usage of KCompressionDevice (see the API documentation for the
0021 relevant KArchive subclass for details).
0022