omnizip 0.4.7-arm-linux

data/docs/guides/archive-formats/rpm-format.adoc

@@ -0,0 +1,108 @@
+---
+title: RPM Format
+nav_order: 9
+parent: Archive Formats
+grand_parent: Guides
+---
+
+[[rpm-format]]
+== Purpose
+
+RPM is the package format of Red Hat-based Linux distributions. An
+RPM file is a lead, signature, metadata header and a payload — a
+CPIO archive compressed with gzip/bzip2/xz/zstd.
+
+== Basic Usage
+
+=== Open a Package
+
+[source,ruby]
+----
+Omnizip::Formats::Rpm.open('package.rpm') do |rpm|
+  puts rpm.files.size
+end
+
+rpm = Omnizip::Formats::Rpm.open('package.rpm')
+rpm.close
+----
+
+=== Package Metadata
+
+[source,ruby]
+----
+info = Omnizip::Formats::Rpm.info('package.rpm')
+puts info[:name]        # => "app"
+puts info[:version]
+puts info[:release]
+puts info[:arch]
+puts info[:summary]
+puts info[:license]
+puts info[:vendor]
+puts info[:build_time]
+puts info[:file_count]
+
+# Same details on the reader
+Omnizip::Formats::Rpm.open('package.rpm') do |rpm|
+  puts rpm.name
+  puts rpm.version
+  puts rpm.license
+end
+----
+
+=== List and Extract Files
+
+[source,ruby]
+----
+# File paths inside the payload
+Omnizip::Formats::Rpm.list('package.rpm')
+
+# Extract the payload (CPIO contents)
+Omnizip::Formats::Rpm.extract('package.rpm', '/output/directory/')
+
+# Or per-reader
+Omnizip::Formats::Rpm.open('package.rpm') do |rpm|
+  rpm.extract('/output/directory/')
+end
+----
+
+== RPM Structure
+
+. **Lead** - 96 bytes identifying the package
+. **Signature** - cryptographic signatures
+. **Header** - metadata (name, version, dependencies)
+. **Payload** - CPIO archive
+
+[source,ruby]
+----
+rpm = Omnizip::Formats::Rpm.open('package.rpm')
+puts rpm.lead.inspect
+puts rpm.signature.inspect
+puts rpm.header.inspect
+----
+
+== Payload
+
+[source,ruby]
+----
+Omnizip::Formats::Rpm.open('package.rpm') do |rpm|
+  puts "Compression: #{rpm.payload_compressor}"
+
+  # Compressed CPIO bytes; decompress with the matching format
+  payload = rpm.payload
+end
+----
+
+== Dependencies
+
+[source,ruby]
+----
+Omnizip::Formats::Rpm.open('package.rpm') do |rpm|
+  rpm.requires.each { |name, op, version| puts "#{name} #{op} #{version}" }
+  rpm.provides.each { |name, op, version| puts "#{name} #{op} #{version}" }
+  rpm.conflicts.each { |name, op, version| puts "#{name} #{op} #{version}" }
+end
+----
+
+== See Also
+
+* link:gzip-format.html[GZIP Format] - Common payload compression

data/docs/guides/archive-formats/seven-zip-format.adoc

@@ -0,0 +1,35 @@
+---
+title: 7z Format
+nav_order: 1
+parent: Archive Formats
+grand_parent: Guides
+---
+
+== 7z Format
+
+=== General
+
+The 7z format is a compressed archive format created by 7-Zip.
+
+=== Features
+
+* High compression ratio (LZMA2)
+* Solid archives
+* Multi-volume support
+* AES-256 encryption
+
+=== Usage
+
+[source,bash]
+----
+# Create 7z archive
+omnizip archive create backup.7z documents/
+
+# Extract 7z archive
+omnizip archive extract backup.7z output/
+----
+
+=== See Also
+
+* link:../compression-algorithms/lzma2.html[LZMA2 Algorithm]
+

data/docs/guides/archive-formats/tar-format.adoc

@@ -0,0 +1,106 @@
+---
+title: TAR Format
+nav_order: 4
+parent: Archive Formats
+grand_parent: Guides
+---
+
+== Purpose
+
+TAR (Tape Archive) is the standard archive format on Unix/Linux systems. It combines multiple files into a single archive without compression, typically paired with external compression tools.
+
+== Key Characteristics
+
+[cols="1,3"]
+|===
+|Property |Value
+
+|Compression
+|External (GZIP, BZip2, XZ)
+
+|Encryption
+|None
+
+|POSIX Support
+|Full POSIX.1-1988 and POSIX.1-2001
+
+|Large Files
+|Yes (with extensions)
+
+|Best For
+|Unix backups, software packaging, source distribution
+|===
+
+== Common TAR Variants
+
+[cols="1,2,2"]
+|===
+|Extension |Compression |Typical Use
+
+|`.tar`
+|None
+|Intermediate archives
+
+|`.tar.gz` / `.tgz`
+|GZIP (Deflate)
+|Source distributions
+
+|`.tar.bz2` / `.tbz2`
+|BZip2
+|Better compression
+
+|`.tar.xz` / `.txz`
+|XZ (LZMA2)
+|Maximum compression
+|===
+
+== Basic Usage
+
+=== Create TAR Archive
+
+[source,ruby]
+----
+# Create uncompressed TAR
+Omnizip::Archive.create('backup.tar', format: :tar) do |archive|
+  archive.add_directory('project/')
+end
+
+# Create TAR.GZ
+Omnizip.compress_directory('project/', 'backup.tar.gz',
+  format: :tar_gzip,
+  level: 6
+)
+
+# Create TAR.XZ
+Omnizip.compress_directory('project/', 'backup.tar.xz',
+  format: :tar_xz,
+  level: 6
+)
+----
+
+=== Extract TAR Archive
+
+[source,ruby]
+----
+# Extract TAR.GZ
+Omnizip.extract_archive('backup.tar.gz', 'output/')
+
+# Extract TAR.XZ
+Omnizip.extract_archive('backup.tar.xz', 'output/')
+----
+
+== POSIX Features
+
+Omnizip supports extended POSIX features:
+
+* **Long filenames** (beyond 100 characters)
+* **Symbolic links**
+* **File permissions**
+* **Ownership information**
+* **Sparse files**
+
+== See Also
+
+* link:gzip-format.html[GZIP Format] - Common TAR compression
+* link:xz-format.html[XZ Format] - Maximum compression for TAR
+* link:../../compatibility.html[Compatibility] - TAR support across tools

data/docs/guides/archive-formats/xz-format.adoc

@@ -0,0 +1,118 @@
+---
+title: XZ Format
+nav_order: 6
+parent: Archive Formats
+grand_parent: Guides
+---
+
+== Purpose
+
+XZ is a modern compression format based on LZMA2 that provides excellent compression ratios. It's commonly used for Linux package distribution and software archives.
+
+== Key Characteristics
+
+[cols="1,3"]
+|===
+|Property |Value
+
+|Compression
+|LZMA2 (with LZMA, BCJ filters)
+
+|Encryption
+|None
+
+|Archive Support
+|Single file only (use with TAR for multiple files)
+
+|Large Files
+|Yes (up to 4 EB)
+
+|Best For
+|Software packages, maximum compression, Unix systems
+|===
+
+== Basic Usage
+
+=== Compress a File
+
+[source,ruby]
+----
+# Compress single file with XZ
+Omnizip.compress_file('data.bin', 'data.bin.xz',
+  level: 6  # Default level
+)
+
+# Maximum compression
+Omnizip.compress_file('data.bin', 'data.bin.xz',
+  level: 9,
+  extreme: true  # Use more CPU for slightly better ratio
+)
+----
+
+=== Decompress a File
+
+[source,ruby]
+----
+# Decompress XZ file
+Omnizip.decompress_file('data.bin.xz', 'data.bin')
+----
+
+== XZ Utils Compatibility
+
+Omnizip is compatible with files created by XZ Utils:
+
+[source,bash]
+----
+# Create with XZ Utils
+$ xz -k data.bin
+
+# Extract with Omnizip
+Omnizip.decompress_file('data.bin.xz', 'data.bin')
+
+# Create with Omnizip
+Omnizip.compress_file('data.bin', 'data.bin.xz')
+
+# Extract with XZ Utils
+$ xz -d data.bin.xz
+----
+
+== Compression Levels
+
+[cols="1,2,2,2"]
+|===
+|Level |Memory (Compress) |Memory (Decompress) |Typical Use
+
+|1-3
+|4-24 MB
+|1-3 MB
+|Fast compression
+
+|4-6
+|32-96 MB
+|4-9 MB
+|**Default** - balanced
+
+|7-9
+|192-674 MB
+|16-64 MB
+|Maximum compression
+|===
+
+== TAR.XZ Archives
+
+XZ is commonly combined with TAR:
+
+[source,ruby]
+----
+# Create TAR.XZ archive
+Omnizip.compress_directory('project/', 'project.tar.xz',
+  format: :tar_xz,
+  level: 6
+)
+----
+
+== See Also
+
+* link:../compression-algorithms/lzma2.html[LZMA2 Algorithm] - Compression details
+* link:tar-format.html[TAR Format] - Multi-file archives with XZ
+* link:gzip-format.html[GZIP Format] - Faster alternative

data/docs/guides/archive-formats/zip-format.adoc

@@ -0,0 +1,35 @@
+---
+title: ZIP Format
+nav_order: 2
+parent: Archive Formats
+grand_parent: Guides
+---
+
+== ZIP Format
+
+=== General
+
+The ZIP format is a widely used archive format.
+
+=== Features
+
+* Cross-platform compatibility
+* ZIP64 support for large files
+* Deflate compression
+* WinZip AES encryption
+
+=== Usage
+
+[source,bash]
+----
+# Create ZIP archive
+omnizip archive create backup.zip documents/ --format zip
+
+# Extract ZIP archive
+omnizip archive extract backup.zip output/
+----
+
+=== See Also
+
+* link:../compression-algorithms/deflate.html[Deflate Algorithm]
+

data/docs/guides/compression-algorithms/bzip2.adoc

@@ -0,0 +1,114 @@
+---
+title: BZip2
+nav_order: 4
+parent: Compression Algorithms
+grand_parent: Guides
+---
+
+== Purpose
+
+BZip2 is a compression algorithm based on the Burrows-Wheeler Transform (BWT) that provides excellent compression ratios for text files and source code. It's particularly effective for files with repetitive patterns.
+
+== Key Characteristics
+
+[cols="1,3"]
+|===
+|Property |Value
+
+|Compression Ratio
+|Very Good (better than Deflate)
+
+|Compression Speed
+|Medium
+
+|Decompression Speed
+|Medium
+
+|Memory Usage
+|Medium (dependent on block size)
+
+|Best For
+|Text files, source code, structured data
+|===
+
+== When to Use BZip2
+
+**Choose BZip2 when**:
+
+* Compressing text files or source code
+* Need better compression than Deflate
+* Working with structured data (XML, JSON, CSV)
+* Compatibility with Unix/Linux systems is needed
+
+**Consider alternatives when**:
+
+* Speed is critical (use Zstandard)
+* Maximum compression needed (use LZMA2)
+* Binary data (use LZMA2)
+
+== Basic Usage
+
+=== Compress with BZip2
+
+[source,ruby]
+----
+# Create BZip2-compressed file
+Omnizip.compress_file('data.txt', 'data.txt.bz2',
+  algorithm: :bzip2,
+  level: 9
+)
+
+# Create archive with BZip2 compression
+Omnizip::Archive.create('backup.7z', format: :seven_zip,
+                        algorithm: :bzip2) do |archive|
+  archive.add_directory('project/')
+end
+----
+
+=== Decompress BZip2
+
+[source,ruby]
+----
+# Decompress BZip2 file
+Omnizip.decompress_file('data.txt.bz2', 'data.txt')
+
+# Extract BZip2 archive
+Omnizip.extract_archive('backup.tar.bz2', 'output/')
+----
+
+== Compression Levels
+
+BZip2 supports levels 1-9:
+
+[cols="1,2,2,2"]
+|===
+|Level |Speed |Ratio |Best For
+
+|1
+|Fast
+|Good
+|Quick compression
+
+|5
+|Medium
+|Very Good
+|**Default** - balanced
+
+|9
+|Slow
+|Best
+|Maximum compression
+|===
+
+== Technical Details
+
+* **Algorithm**: Burrows-Wheeler Transform + Move-to-Front + Huffman coding
+* **Block Size**: 100KB to 900KB (level dependent)
+* **File Extension**: `.bz2`
+* **Container**: Can be used within TAR archives (`.tar.bz2` or `.tbz2`)
+
+== See Also
+
+* link:lzma.html[LZMA] - Better compression for general data
+* link:deflate.html[Deflate] - Faster alternative
+* link:../../compatibility.html[Compatibility] - BZip2 support across tools