bgcode(1)

✨ NAME ✨

okay so welcome to bgcode(1), bestie 💖 — this is the manual page for bgcode, and what it does is compress/decompress byte streams using LZSS. no cap, that's the whole vibe.

---

🌸 SYNOPSIS 🌸

bgcode [IN_FILE] OPTIONS

putting the file first, options after. IN_FILE is optional, options are not optional-optional but you'll want them, iykyk 💅

---

🦋 DESCRIPTION 🦋

so like. bgcode converts textual gcode files into binary gcode, as used by Prusa 3D printers 👑✨ that's it, that's the main character energy.

---

💅 OPTIONS 💅

okay this is the part where we read the whole menu, no skipping, we are NOT summarising, periodt 💜

• --checksum=CHECKSUM — which checksum algorithm you want. valid values for CHECKSUM are 0 for no checksum and 1 for CRC32 (that one's the default, so if you don't say anything it's already slaying that way 🎀).
• --file_metadata_compression=COMPRESSION — the compression algorithm used for file metadata. valid values for COMPRESSION are: 0 for None (default ✨), 1 for Deflate, 2 for Heatshrink_11_4, and 3 for Heatshrink_12_4.
• --print_metadata_compression=COMPRESSION — the compression algorithm used for print metadata. valid values for COMPRESSION are: 0 for None (default ✨), 1 for Deflate, 2 for Heatshrink_11_4, and 3 for Heatshrink_12_4.
• --printer_metadata_compression=COMPRESSION — the compression algorithm used for printer metadata. valid values for COMPRESSION are: 0 for None (default ✨), 1 for Deflate, 2 for Heatshrink_11_4, and 3 for Heatshrink_12_4.
• --slicer_metadata_compression=COMPRESSION — the compression algorithm used for slicer metadata. valid values for COMPRESSION are: 0 for None (default ✨), 1 for Deflate, 2 for Heatshrink_11_4, and 3 for Heatshrink_12_4.
• --gcode_compression=COMPRESSION — the compression algorithm used for G-code. valid values for COMPRESSION are: 0 for None (default ✨), 1 for Deflate, 2 for Heatshrink_11_4, and 3 for Heatshrink_12_4.
• --gcode_encoding=GCODE_ENCODING — the encoding format used for G-code. valid values for GCODE_ENCODING are 0 for None (default ✨), 1 for MeatPack, and 2 for MeatPackComments.
• --metadata_encoding=METADATA_ENCODING — the encoding format used for metadata. the only available value here is 0 for INI (default ✨). like, that's the only one, that's the whole list, it's giving exclusive 🎀

---

💀 BUGS 💀

the upstream BTS can be found at

https://github.com/prusa3d/libbgcode/issues

go there if something's acting up, not me tho, I'm just the messenger 🙈

---

🫶 AUTHOR 🫶

Chow Loong Jin ⟨hyperair@debian.org⟩ Wrote this manpage for the Debian system. iconic behavior honestly 👑

---

💜 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 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, bestie 🦋 this was dated “December 23 2023” and it's the bgcode(1) page — go compress something, you're gonna eat 💅✨