heatshrink(1)

📦
version 0.4.1 · 2 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

💖 heatshrink(1) — the LZSS glow-up 💖

okay bestie, real talk: this is heatshrink, a little command-line icon that takes byte streams and squeezes them down with LZSS (or un-squeezes them, depending on the vibe). It's built especially for embedded systems, low-memory setups, and/or hard real-time systems. so like, tiny footprint, no drama, just compression. periodt. 🎀

✨ SYNOPSIS ✨

heatshrink [-h]

heatshrink [-e | -d] [-v] [-w SIZE] [-l BITS] [IN_FILE] [OUT_FILE]

yes the second form is the whole personality. we love a flexible queen. 💅

🌸 DESCRIPTION 🌸

heatshrink compresses or decompresses byte streams using LZSS, and it was designed especially for embedded, low-memory, and/or hard real-time systems. no cap. it's the kind of tool that shows up to the party in a very small dress and still out-performs everyone. 🦋

👑 OPTIONS 👑

  • -h — print help. that's it, that's the whole job. asks nothing of you. 🫶
  • -e — encode (aka compress). this is the default bestie, it's already on unless you say otherwise.
  • -d — decode (aka decompress). reversing the glow-up.
  • -v — verbose mode. prints input & output sizes, compression ratio, etc. it's giving receipts, and honestly we're obsessed. 😌
  • -w SIZE — base-2 log of the LZSS sliding window size. a larger value lets it search a larger history of the data for repeated patterns, which potentially compresses more effectively 🔥 — but heads up, it'll use more memory and processing time. recommended default: -w 8 for embedded systems, -w 10 everywhere else.
  • -l BITS — 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. like, sometimes less is more, iykyk 😭. recommended default: -l 4.
psst — if IN_FILE or OUT_FILE are unspecified, they default to - for standard input and standard output, respectively. so you can just yeet data through it in a pipe. 💜

💀 BUGS 💀

the upstream BTS (bug tracker system, bestie, not the band 🙈) lives here:

https://github.com/atomicobject/heatshrink/issues

go be a main character and file that report. ⭐

✨ AUTHOR ✨

Chow Loong Jin ⟨hyperair@debian.org⟩ wrote this manpage for the Debian system. icon behaviour, honestly. 💖

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 Foundation.

on Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.

and that's the whole page babes 💅 this was heatshrink(1) from User Commands, dated December 5 2023 — mwah, go compress something slay. 🎀✨🦋

📦 where this page comes from