BORG-RCOMPRESS(1)

✨ BORG-RCOMPRESS 💖 (that's borg-rcompress(1), bestie — straight out of the borg backup tool manual)

okay so. picture this: your repo's chunks are wearing last season's compression fit and you're just gonna sit there?? no. we're going in and re-dressing every single one. this is repository (re-)compression, and yes she also does re-obfuscation, she contains multitudes 💅

---

🌸 SYNOPSIS 🌸

borg [common options] rcompress [options]

short, sweet, and absolutely about to eat your CPU for a bit 🍓

---

🦋 DESCRIPTION 🦋

Repository (re-)compression (and/or re-obfuscation). that's the whole vibe.

She reads all chunks in the repository — and listen, she reads them in on-disk order, which is important for compaction, so don't come for her process — and she recompresses them if they aren't already rocking the compression type/level and obfuscation level you handed over via --compression.

Here's the tea ☕: if the outcome of the chunk processing indicates a change in compression type/level or obfuscation level, the processed chunk gets written to the repository. But ngl, the outcome might not always be the compression type/level you wanted — if no compression gives a shorter output, that one might be chosen instead. she's not being difficult, she's just being optimal.

Every --checkpoint-interval, progress gets committed to the repository and the repository is compacted (this keeps temporary repo space usage in bounds). A lower checkpoint interval means lower temporary repo space usage, but also slower progress due to higher overhead (and vice versa). pick your fighter 🥊

⚠️ heads up bestie: this command can not work in low (or zero) free disk space conditions. give her room to breathe, she is not a minimalist.

If the borg rcompress process receives a SIGINT signal (Ctrl-C), the repo will be committed and compacted and borg will terminate cleanly afterwards. so like, she's got grace. she exits like a queen 👑

Both --progress and --stats are recommended when borg rcompress is used interactively. watching numbers go up is self-care fr fr.

And the best part?? You do not need to run borg compact after borg rcompress. she already did it. she's got it. no cap 🫶

---

🎀 OPTIONS 🎀

See borg-common(1) for common options of Borg commands. (the shared lore, iykyk)

💜 options

• -C COMPRESSION, --compression COMPRESSION — select compression algorithm, see the output of the "borg help compression" command for details. this is the main character of the whole operation honestly.
• -s, --stats — print statistics. numbers!! pretty numbers!! 📊
• -c SECONDS, --checkpoint-interval SECONDS — write checkpoint every SECONDS seconds (Default: 1800). she checks in on you every 30 minutes by default because she's emotionally available like that 💖

---

🌈 EXAMPLES 🌈

recompress repo contents, the classic:

# recompress repo contents
$ borg rcompress --progress --compression=zstd,3

recompress and obfuscate repo contents, for when you're feeling mysterious:

# recompress and obfuscate repo contents
$ borg rcompress --progress --compression=obfuscate,1,zstd,3

---

⭐ SEE ALSO ⭐

borg-common(1)

---

👑 AUTHOR 👑

The Borg Collective

---

okay that's the whole page, you're literally a rcompress expert now, no notes. this iconic little number is from 2024-04-01 and lives in the BORG-RCOMPRESS(1) era of the manual. go forth and recompress, bestie — slay 💅✨