PUBLIC-INBOX-COMPACT(1)

📦
version 2.0.0~20230714git590023f · 6 versions
, in fedora 43, fedora 44

💅 public-inbox-compact — the public-inbox user manual, bestie edition

okay so. you wanna know about public-inbox-compact(1)? say less, i got you 🫶 it's a little tool that compacts your Xapian DBs inside an inbox. very demure, very mindful, very niche. let's go ✨

🌸 NAME 🌸

public-inbox-compact — compact Xapian DBs in an inbox 🎀

🦋 SYNOPSIS 🦋

public-inbox-compact INBOX_DIR

public-inbox-compact --all

like. that's it. that's the whole vibe check. one inbox, or all of them. choose your fighter 💖

✨ DESCRIPTION ✨

okay so public-inbox-compact is literally a wrapper around xapian-compact(1) — like it's wearing a lil trench coat and doing the job, but with ✨security✨. the way it works is it locks the inbox so other processes — besties like public-inbox-watch(1) or public-inbox-mda(1) — cannot write while it's doing its thing. no stepping on each other's toes, no chaos, periodt 💅

it also enforces the --no-renumber option of xapian-compact(1), which is fr fr required to work with the rest of the public-inbox search code. not optional, not negotiable, it's the law 🫡

ngl though — this command is rarely needed for active inboxes. like, if your inbox is out here living its best life and constantly getting mail? you probably don't need this.

instead, the recommended move is using the --compact option of public-inbox-index(1), and only when you're doing a --reindex. that's the main character behavior 👑

💖 OPTIONS 💖

  • --all — compact all the inboxes configured in ~/.public-inbox/config. it's the alternative to naming individual inbox directories on the command line. one flag, every inbox, slay 🌈
  • --blocksize
  • --no-full
  • --fuller

these three are passed directly to xapian-compact(1). no middleman, no filter, straight through. iconic behavior honestly 🦋

🧚 ENVIRONMENT 🧚

  • PI_CONFIG — the default config file, normally "~/.public-inbox/config". go read public-inbox-config(5) for the deets, iykyk 💜
  • XAPIAN_FLUSH_THRESHOLD — the number of documents to update before committing changes to disk. this one is handled directly by Xapian, so if you want the full lore, refer to the Xapian API documentation for more details. Default: 10000 🍓

🎀 CONTACT 🎀

feedback is welcome via plain-text mail to <mailto:meta@public-inbox.org> — slide into the inbox, bestie 💌

the mail archives are hosted at <https://public-inbox.org/meta/> and <http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/> ✨

Copyright 2018-2021 all contributors <mailto:meta@public-inbox.org> 💖

License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>

🔥 SEE ALSO 🔥

xapian-compact(1), public-inbox-index(1)

and that's the whole page, babes 🫶 this lil gem is from public-inbox.git, dated 1993-10-02 — yes the date is older than the internet probably, don't ask, it's just the vibe 💅 mwah, go compact something responsibly ✨🌸

📦 where this page comes from