PINOT-INDEX(1)

📦
version 1.24 · 5 versions
, in ubuntu stonking

💖 PINOT-INDEX(1) — like, the user commands era 💖

okay bestie, welcome to the pinot-index glow-up guide 💅 this is a User Commands manual page, and yes, we're about to make terminal indexing cute and functional. no cap.

✨ NAME ✨

pinot-index — index documents from the command-line 🦋

🌸 SYNOPSIS 🌸

pinot-index [OPTIONS] --db DATABASE URLS

that's the whole vibe. flags, a database, some URLs, let's go 🎀

💜 DESCRIPTION 💜

okay so first things first, the page literally opens with this line:

ModuleFactory::loadModules: xapian is supported by libxapianbackend.so

✨ foreshadowing, honestly ✨ — xapian is the moment.

and then, for the record, the one-line summary:

pinot-index - Index documents from the command-line

that's it, that's the whole job. you point it at stuff, it puts stuff in an index. iconic behavior, truly 👑

🔥 OPTIONS 🔥

one bullet per flag, no skipping, we eat every single one 🍓

  • -b, --backend — name of back-end to use (default xapian)
  • -c, --check — check whether the given URL is in the index 👀
  • -d, --db — path to, or name of, index to use (mandatory, so like, don't forget it bestie, it's not optional and it will not be chill about it) 💀
  • -h, --help — display this help and exit 🫶
  • -i, --index — index the given URL ✅
  • -o, --override — MIME type detection override, as TYPE:EXT
  • -s, --showinfo — show information about the document 🔍
  • -v, --version — output version information and exit ⭐

and for the backend girlies, the receipts:

Supported back-ends are: 'xapian'

that's the list. one entry. xapian ate and left no crumbs 🙈

🌈 EXAMPLES 🌈

here's where it gets real. copy these exactly, they're the blueprint:

check + showinfo + explicit backend + explicit db:

pinot-index --check --showinfo --backend xapian --db ~/.pinot/daemon ../Bozo.txt

index a URL into the Docs db:

pinot-index --index --db Docs https://github.com/FabriceColin/pinot

index a file and force the MIME type with --override:

pinot-index --index --db Docs --override text/x-rst:rst /usr/share/doc/python-kitchen-1.1.1/docs/index.rst
⚠️ also pls note, for real: indexing documents to My Web Pages or My Documents with pinot-index is not recommended. the manpage said it, i'm just relaying it, don't shoot the messenger 💀

💌 REPORTING BUGS 💌

found a bug? first of all, relatable. report it to:

fabrice.colin@gmail.com

and then the legal bit, which we are keeping in full because it matters:

This is free software. You may redistribute copies of it under the terms of the GNU General Public License <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>. There is NO WARRANTY, to the extent permitted by law.

NO WARRANTY, bestie. none. zero. the software is out here with no safety net and we respect its honesty 😭

👑 SIGN-OFF 👑

this whole page is pinot 1.24, dated May 2026, and it goes by PINOT-INDEX(1). go index something cute, and remember: --db is mandatory, so don't be the person who forgets it 💖✨🎀

📦 where this page comes from