---
name: "bgcode"
section: "1"
platform: "linux"
package: "bgcode"
version: "0.0~git20250220.5041c09-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/bgcode"
---

# bgcode(1)

compress/decompress byte streams using LZSS

## NAME

bgcode - compress/decompress byte streams using LZSS

## SYNOPSIS

**bgcode** \[*IN\_FILE*\] OPTIONS

## DESCRIPTION

**bgcode** converts textual gcode files into binary gcode, as used by Prusa 3D printers.

## OPTIONS

- **--checksum**=*CHECKSUM*

  Checksum algorithm to use. Valid values for *CHECKSUM* are `0` for no checksum and `1` for CRC32 (default).

- **--file\_metadata\_compression**=*COMPRESSION*

  Compression algorithm to use 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*

  Compression algorithm to use 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*

  Compression algorithm to use 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*

  Compression algorithm to use 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*

  Compression algorithm to use 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*

  Encoding format to use for G-code. Valid values for *GCODE\_ENCODING* are `0` for None (default), `1` for MeatPack, and `2` for MeatPackComments.

- **--metadata\_encoding**=*METADATA\_ENCODING*

  Encoding format to use for metadata. The only available value for this is `0` for INI (default).

## BUGS

The upstream BTS can be found at https://github.com/prusa3d/libbgcode/issues.

## AUTHOR

- Chow Loong Jin

  ⟨hyperair@debian.org⟩\\c Wrote this manpage for the Debian system.

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