heatshrink - compress/decompress byte streams using LZSS
Contents
Bugs
The upstream BTS can be found at https://github.com/atomicobject/heatshrink/issues
Copyright
Copyright © 2023 Chow Loong Jin
This manual page was written for the Debian system (and may be used by others).
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General
Public License, Version 2 or (at your option) any later version published by the Free Software Founda‐
tion.
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-
licenses/GPL.
“December 5 2023” heatshrink(1)
Description
heatshrink compresses or decompresses byte streams using LZSS and is designed especially for embedded,
low-memory, and/or hard real-time systems.
Name
heatshrink - compress/decompress byte streams using LZSS
Options
-h Print help
-e Encode (compress, default)
-d Decode (decompress)
-v Verbose (print input & output sizes, compression ratio, etc.)
-wSIZE
Base-2 log of LZSS sliding window size A larger value allows searches a larger history of the data
for repeated patterns, potentially compressing more effectively, but will use more memory and pro‐
cessing time. Recommended default: -w8 (embedded systems), -w10 (elsewhere)
-lBITS
Number of bits used for back-reference lengths. A larger value allows longer substitutions, but
since all back-references must use -w + -l bits, larger -w or -l can be counterproductive if most
patterns are small and/or local. Recommended default: -l4
If IN_FILE or OUT_FILE are unspecified, they will default to - for standard input and standard output,
respectively.
Synopsis
heatshrink [-h]
heatshrink [-e | -d] [-v] [-wSIZE] [-lBITS] [IN_FILE] [OUT_FILE]
