README.md
1# libarchive-qt
2A Qt based archiving solution with libarchive backend
3
4This is a simple archiving library for Qt mainly based on libarchive.
5Currently it supports the following archive/compression formats
6
7 - Gzip
8 - BZip2
9 - LZMA2
10 - LZip (needs lzlib or lzip binary)
11 - LZ4
12 - Cpio
13 - AR
14 - ISO9660
15 - PAX
16 - Shar
17 - Zip
18 - 7Zip
19 - Tar
20
21Following formats have read (extraction) support have limited support using extrnal binary
22 - LZip
23 - LZop
24 - LrZip
25
26Please open an `Issue` in `github` if you find bugs. If you know the fix, please contribute.
27
28Several other filters such as compress, grzip, rpm, zstd are supported by the libarchive, but not by this library. Also, several archive formats
29like XAR, LHA, CAB, RAR and a few more at not yet supported by this library, though the backend exists in libarchive. If and when I find time
30and knowledge to add those filters, I shall do so.
31
32Those who know to add these and other filters to this library, are welcome to do so. :)
33
34## Dependencies (Version in my system: Debian Sid)
35 - Qt5 (Qt5 5.12.5)
36 - libarchive (3.4.0)
37 - liblzma (5.2.4)
38 - libbz2 (1.0.8)
39 - zlib (1.2.11)
40 - lzlib (liblz1) (1.11)
41 - lzop (binary) (1.04)
42 - lzip (binary) (1.21)
43 - lrzip (binary) (0.631)
44
45An minimal illustration of how to use this library can be found in example.cpp.
46It compiles to a tiny stand-alone archiver capable of creating, extracting and listing archives.
47
48A simple implementation of this library in a GUI project can be found [here](https://gitlab.com/cubocore/corearchiver)
49