bup-bloom(1)

📦
version 0.34 · 10 versions
, in fedora 44, nixpkgs unstable

💖 bup-bloom — the bloom filter glow-up station 💖

okay so bestie, welcome to bup-bloom, the manual page for the bup bloom command, living in the General Commands Manual section. she generates bloom filters, regenerates bloom filters, and updates bloom filters, and honestly? she's serving range. ✨

✨ NAME ✨

bup-bloom — generates, regenerates, updates bloom filters. that's it, that's the whole job, and she does it flawlessly fr fr 🦋

🎀 SYNOPSIS 🎀

bup bloom [-d dir] [-o outfile] [-k hashes] [-c idxfile] [-f] [--ruin]

look at her. compact. iconic. no notes. 💅

🌸 DESCRIPTION 🌸

so bup bloom builds a bloom filter file for a bup repository, and if one already exists? she's not just gonna ignore it — she checks the filter and then updates or regenerates it as needed. basically she does a vibe check on your existing bloom and then decides whether to refresh it or start over. main character energy, truly. 👑

💅 OPTIONS 💅

  • --ruin — okay so this one destroys bloom filters by setting the whole bitmask to zeros. and like... you really want to know what you're doing if you run this, bestie 😭 and you want to delete the resulting bloom when you are done with it. do not leave that thing lying around like a cursed artifact from a bad dream. 💀
  • -f, --force — don't update the existing bloom file, just generate a whole new one from scratch. no editing era, only fresh-start era. 🎀
  • -d, --dir=directory — the directory to process, the one containing the .idx files. defaults to $BUP_DIR/objects/pack. she knows where the files live iykyk 🗂️
  • -o, --outfile=outfile — the file to write the bloom filter to. defaults to $dir/bup.bloom. 💾
  • -k, --hashes=hashes — number of hash functions to use. only 4 and 5 are valid, so don't get creative. defaults to 5 for repositories < 2 TiB, or 4 otherwise. See comments in git.py for more on this value. see, she's even pointing you at the lore. 🧚
  • -c, --check=idxfile — checks the bloom file (which is counterintuitively the outfile) against the specified .idx file. first it checks that the bloom filter is claiming to contain the .idx, then it checks that it does actually contain all of the objects in the .idx. Does not write anything and ignores the -k option. yes, -k gets ghosted here. sorry to that flag. 👻

🌈 BUP 🌈

Part of the bup(1) suite. she's got a whole family, and they're all kinda iconic. 🫶

👑 AUTHORS 👑

Brandon Low lostlogic@lostlogicx.com — thank you for your service, king. ⭐

real talk tho: --ruin is a destroy-the-blob move, not a cute little toggle. it zeroes the entire bitmask. know what you're doing, and clean up after yourself when you're done with it. 🙈

and that's the page bestie!! written for Bup 0.34, dated 2026-09-01. go forth, build your blooms, and slay 💖🌸✨

📦 where this page comes from