CBFS-COM...SION-TOOL(8)

πŸ“¦
version 25.09 Β· 3 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ NAME ✨

cbfs-compression-tool β€” Benchmark compression tool (coreboot tools)

ok so bestie, this is a lil utility from the System Administration Utilities family (that's the manual section it lives in πŸ’…), and it does exactly two vibes: it either benchmarks compression algorithms, or it compresses a file for you with whichever algorithm you pick. that's it. that's the whole girl. πŸŽ€


🌸 SYNOPSIS 🌸

cbfs-compression-tool benchmark
cbfs-compression-tool compress <infile> <outfile> <algo>
cbfs-compression-tool rawcompress <infile> <outfile> <algo>

three little entry points, no cap. pick your fighter. πŸ¦‹


πŸ’– DESCRIPTION πŸ’–

so the whole point of this thing, in one breath: benchmark compression algorithms, or compress an input file into an output file with a given algorithm. that's the mission statement, periodt. ✨

now let's break down each mode because they are NOT the same and u need to know which one u want:

πŸ”₯ cbfs-compression-tool benchmark

runs benchmarks for all implemented algorithms. not one, not two β€” all of them. it's giving science fair but make it compression. πŸ§ͺ

πŸ’… cbfs-compression-tool compress inFile outFile algo

compresses inFile with algo and stores it in outFile.

and the file it writes? it has a lil header, bestie. it's structured like this:

4 bytes little endian: algorithm ID (as used in CBFS)
4 bytes little endian: uncompressed size
...: compressed data stream

so that's the algorithm ID (same one CBFS uses, iykyk), then the uncompressed size, then the actual compressed data stream riding in after. ✨

🫢 cbfs-compression-tool rawcompress inFile outFile algo

compresses inFile with algo and stores it in outFile β€” without the header.

the file format for this one is just:

...: compressed data stream

no algorithm ID, no uncompressed size, no nothing. just the raw compressed data stream and vibes. the way that it's literally just the stream and nothing else?? iconic. 🌈

⚠️ lowkey important: compress and rawcompress produce different file layouts. compress has the header, rawcompress does not. don't mix them up or ur gonna have a bad time. πŸ’€

πŸ‘‘ AUTHORS πŸ‘‘

  • coresystems GmbH.
  • Man page written by Ahmad Khalifa.

and that's the whole page bestie!! πŸŽ€ this was the CBFS-COM...SION-TOOL(8) page from the System Administration Utilities manual, dated November 2024. go compress something cute. mwah. πŸ’–βœ¨πŸ¦‹

πŸ“¦ where this page comes from