XADUMP(1)

📦 version 1.43.16, in debian bookworm, debian trixie, fedora 43, nixos 26.05, nixpkgs unstable, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ XADUMP ✨

okay bestie, gather round, because we're about to get deep into a Xapian index 💅 this is xadump, from the General Commands Manual section, and she is not like other girls — she goes straight to the bones of a Recoll index.

🎀 NAME 🎀

xadump — low level access to a Recoll Xapian index.

like, low level low level. we are in the basement. we are reading the raw vibes. 🦋

🌸 SYNOPSIS 🌸

xadump [ -d <dbdir> ] [ -e <outputencoding> ] -i <docid> -D
xadump [ -d <dbdir> ] [ -e <outputencoding> ] -i <docid> -X
xadump [ -d <dbdir> ] [ -e <outputencoding> ] -i <docid> [ -x ] -T
xadump [ -d <dbdir> ] [ -e <outputencoding> ] -i <docid> [ -x ] -r

xadump [ -d <dbdir> ] [ -e <outputencoding> ] -t <term> -E
xadump [ -d <dbdir> ] [ -e <outputencoding> ] -t <term> -F
xadump [ -d <dbdir> ] [ -e <outputencoding> ] -t <term> -P

xadump -T [ -f ] [ -n ] [ -l ]

xadump -q term [term ...]

four whole moods, bestie. pick your fighter. ✨

💖 DESCRIPTION 💖

so the way that xadump works is: she's a low-level access and diagnostic tool for a Xapian index — specifically one as organized by the Recoll indexer. which index dir are we poking at? that's what option -d is for, babes. 💅

🫶 the -i <docid> girlies: -D, -X, -T, -r

options -D, -X, -T and -r all take a single docid argument, and you hand her that with option -i. here's the tea on each:

  • -D — displays the document data record. like, the whole record. iconic.
  • -X — deletes all index data for the document. 💀 no cap, this one is destructive, she is not asking twice.
  • -T — prints the term list for the document. and if you don't give her a docid argument? she'll list the whole index term list instead. main character energy, honestly.
    • -f — can be set to precede each term with its occurrence count. ⚠️ only if no docid is specified, bestie. only then.
    • -n — can be set to omit the enclosing brackets. clean, minimal, obsessed. ✨
    • -l — can be set to skip prefixed terms. we're filtering, we're curating. 🎀
  • -r — prints the document text as reconstructed from index data. it's giving "the index remembers everything." 🦋

🌈 the -x moment

when option -x is set, terms are printed with each character separated by a space. lowkey chaotic to look at, highkey useful — she's great for checking some encoding issues. 👑

💜 the -t <term> girlies: -E, -F, -P

options -E, -F and -P all need a term argument, and you specify it with -t <term>. periodt.

  • -E — performs a term existence test. does it exist? vibe check complete. 🔥
  • -F — retrieves the term frequency for the given term. how often, bestie? she'll tell you.
  • -P — displays the postings for the given term. the whole posting list, served fresh. 🍓

🧚 the -q era

with option -q, xadump performs a simple AND query on the index, using the given term arguments. simple! AND! query! she's efficient, she's focused, she ate. ⭐

⚠️ real talk bestie: -X deletes all index data for the document. that's not a metaphor. that's not a vibe. that's gone. 💀 double-check your -d before you type that one, fr fr.

and that's the whole page, gorgeous 💖 xadump from the General Commands Manual, dated 18 November 2017. thanks for coming to my TED talk, now go read your index like the icon you are. 💅✨🫶🌸

📦 where this page comes from