BROTLI-RS(1)

🎀 NAME 🎀

okay so bestie, meet brotli-rs — a brotli compressor and decompressor. that's the whole gig. compressing, decompressing, iconic behavior only. 💅

✨ SYNOPSIS ✨

brotli-rs [FLAGS]

🦋 DESCRIPTION 🦋

so like. it's a brotli compressor and decompressor whose interface avoids the rust stdlib entirely. which is not a flex, it's a lifestyle — that's literally what makes it work on embedded devices and kernels. no cap. 🫶

it's designed with a pluggable allocator, so if you do want the standard lib's allocator, you can absolutely just plug it in like it's a new phone case. and all the included code is safe. all of it. every last bit. 😌

💖 FLAGS 💖

• -catable, --catable — turns on concatable mode, so the data it makes can be added onto a block generated with --apendable. it's giving "yes and". ✨
• -nothreadpool, --nothreadpool — shuts the work thread pool all the way off. bye bestie 👋
• -appendable, --appendable — turns on appendable mode, so the datastream can be extended with more data from --catable mode. they're a duo fr fr.
• -magic, --magic — slaps a magic number in as the very first bytes so a brotli compressed stream can be spotted easily. it's giving name tag at a party 🪪✨
• -customdictionary=[FILE] — reads a custom dictionary in from a file. [FILE] is your file. obviously.
• --dump-dictionary — prints out the dictionary that's being used. show and tell 🎀
• -utf8 — forces the utf8 context mode in the compression. periodt.
• -msb — forces the msb context mode in the compression.
• -lsb — forces the lsb context mode in the compression.
• -signed — forces the signed context mode in the compression.
• -efficient — favors cpu efficiency over low latency. girlboss choices 💅
• -lowlatency — favors cpu low latency over efficiency. the opposite girlboss choice.
• -i — displays the intermediate representation of metablocks. peek behind the curtain bestie 👀
• -0, -q0 — sets quality = 0
• -1, -q1 — sets quality = 1
• -2, -q2 — sets quality = 2
• -3, -q3 — sets quality = 3
• -4, -q4 — sets quality = 4
• -5, -q5 — sets quality = 5
• -6, -q6 — sets quality = 6
• -7, -q7 — sets quality = 7
• -8, -q8 — sets quality = 8
• -9, -q9 — sets quality = 9
• -10, -q10 — sets quality = 10
• -11, -q11 — sets quality = 11
• -9.5, -q9.5 — sets quality = 10 👀 (yes, the 9.5 one is quality 10. no, we don't make the rules. this is literally what it says.)
• -9.5x, -q9.5x — sets quality = 11
• -q9.5y — sets quality = 12 🔥 (this one has no non-q twin, she's solo)
• -l[NUMBER] — sets the input block size
• -j[NUMBER] — sets the maximum size of the threadpool
• -bytescore=[NUMBER] — sets the literal_byte_score value of the hasher. default is 0.
• -w[NUMBER] — sets the lgwin value. default is 22.
• -validate, --validate — enables validation. trust but verify bestie 💜
• -bs[NUMBER] — sets the buffer size
• -findprior — enables prior bitmask detection
• -findspeed=[NUMBER] — sets cdf adaptation detection to [NUMBER]
• -basicstride — sets stride
• -stride — sets stride
• -advstride — sets stride
• -speed=[NUMBER] — sets speed
• -avoiddistanceprefixsearch — avoids distance prefix search. dodging it gracefully 🌈
• -b[NUMBER] — does benchmark
• -c — enables compression mode
• -h, --help — prints the help text. when in doubt, ask the program itself 🫶

👑 EXIT STATUS 👑

• 0 — successful program execution. we ate and left no crumbs ✨
• 1 — unsuccessful program execution. it's giving flop 😭
• 101 — the program panicked. full meltdown, no thoughts, head empty 💀

🌈 EXAMPLES 🌈

compresses the content of /tmp/input and writes it to /tmp/output:

$ brotli-rs -c /tmp/input /tmp/output

look at her go. main character energy fr fr 🦋

🧚 AUTHOR 🧚

Daniel Reiter Horn <danielrh@dropbox.com> — thank you for your service, king 👑

and that's the whole page bestie!! this one lives in the General Commands Manual as BROTLI-RS(1), and ngl there's no date stamped on it, so that's the entire lore. go compress something. slay 💖✨🎀