OMINDEX(1)

OMINDEX(1) — Index static website data via the filesystem 💅✨

okay bestie, welcome to the OMINDEX(1) manual page from the User Commands section. This is the whole vibe: static website data gets indexed via the filesystem. No cap. Let’s get into it. 🫶

NAME 💖

omindex — Index static website data via the filesystem. literally the main character of this page. 👑

SYNOPSIS ✨

omindex [OPTIONS] --db DATABASE [BASEDIR] DIRECTORY

DESCRIPTION 🦋

omindex indexes static website data via the filesystem. That’s the mission, and it ate. 💅

DIRECTORY is the directory to start indexing from. Yes, that one. Start there. 🌸

BASEDIR is the directory corresponding to URL (default: DIRECTORY). So if you don’t pass it, it lowkey assumes DIRECTORY. Cute.

OPTIONS ✨🎀

• -d, --duplicates=ARG — set duplicate handling: ARG can be 'ignore' or 'replace' (default: replace). dupes handled, periodt. 💖
• -p, --no-delete — skip the deletion of documents corresponding to deleted files. no cleanup era, we’re keeping them. 🙈
• -e, --empty-docs=ARG — how to handle documents we extract no text from: ARG can be index, warn (issue a diagnostic and index), or skip. (default: warn). so yes, warn literally throws a diagnostic and still indexes. iconic. 🎀
• -D, --db=DATABASE — path to database to use. your database, your rules. 🗂️
• -U, --url=URL — base url BASEDIR corresponds to (default: /). yes, that base url. 💫
• -M, --mime-type=EXT:TYPE — assume any file with extension EXT has MIME Content-Type TYPE, instead of using libmagic (empty TYPE removes any existing mapping for EXT; other special TYPE values: 'ignore' and 'skip'). big MIME energy. 🔥
• -G, --mime-type-match=GLOB:TYPE — assume any file with leaf name matching shell wildcard pattern GLOB has MIME Content-Type TYPE (special TYPE values: 'ignore' and 'skip'). glob girlies rise. 🌈
• -F, --filter=M[,[T][,C]]:CMD — process files with MIME Content-Type M using command CMD, which produces output (on stdout or in a temporary file) with format T (Content-Type or file extension; currently txt (default), html or svg) in character encoding C (default: UTF-8). E.g. -Fapplication/octet-stream:'|strings -n8' or -Ftext/x-foo,,utf-16:'foo2utf16 %f %t'. filters are the moment. 💅
• -W, --worker=TYPE:WORKER — process files with MIME Content-Type TYPE using worker sub-process WORKER. WORKER is the name of the program to run to start the worker. If it has no path then it’s looked for in pkglibbindir (which can be overridden by setting environment variable XAPIAN_OMEGA_PKGLIBBINDIR). This invocation will look in: /usr/local/lib/xapian-omega/bin. worker bee behavior, honestly. 🐝
• --read-filters=FILE — bulk-load --filter arguments from FILE, which should contain one such argument per line (e.g. text/x-bar:bar2txt --utf8). Lines starting with # are treated as comments and ignored. bulk-loading? yes bestie. 📚
• --read-workers=FILE — bulk-load --worker arguments from FILE, which should contain one such argument per line (e.g. text/x-bar:omindex_libbar). Lines starting with # are treated as comments and ignored. worker bulk-load, slay. ⭐
• -l, --depth-limit=LIMIT — set recursion limit (0 = unlimited). go deep or don’t. 🌀
• -f, --follow — follow symbolic links. follow them like a loyal bestie. 🫶
• -i, --ignore-exclusions — ignore meta robots tags and similar exclusions. not today, exclusions. 💀
• -S, --spelling — index data for spelling correction. spelling era activated. ✏️
• -m, --max-size=N[SUFFIX] — maximum size of file to index (in bytes or with a suffix of 'K'/'k', 'M'/'m', 'G'/'g') (default: unlimited). big files? maybe not. 🍓
• --sample=SOURCE — what to use for the stored sample of text for HTML documents - SOURCE can be 'body' or 'description' (default: 'body'). body or description, choose your fighter. 🧚
• -E, --sample-size=SIZE — maximum size for the document text sample (supports the same formats as --max-size). (default: 512). sample size matters, bestie. 💜
• -T, --title-size=SIZE — maximum size for the document title (supports the same formats as --max-size). (default: 128). title girlies have a limit. 👑
• -R, --retry-failed — retry files which omindex failed to extract text from on a previous run. second chance arc. 💖
• --opendir-sleep=SECS — sleep for SECS seconds before opening each directory - sleeping for 2 seconds seems to reliably work around problems with indexing files on Microsoft DFS shares. yes, literally sleep on it. 😴
• -C, --track-ctime — track each file’s ctime so we can detect changes to ownership or permissions. ctime tracking, no cap. 🕵️
• --date-terms — index D, M and Y prefixed terms to support date range filtering using terms (we now recommend using a value slot for this instead). retro but noted. 📅
• --no-date-terms — ignored for compatibility with Omega 1.4.x. it’s giving legacy compatibility. 🫠
• -v, --verbose — show more information about what is happening. tell me everything. 🗣️
• --overwrite — create the database anew (the default is to update if the database already exists). fresh start or update era. 🌟
• -s, --stemmer=LANG — set the stemming language (default: english). Possible values: arabic armenian basque catalan danish dutch dutch_porter earlyenglish english esperanto estonian finnish french german greek hindi hungarian indonesian irish italian lithuanian lovins nepali norwegian polish porter portuguese romanian russian serbian spanish swedish tamil turkish yiddish (pass 'none' to disable stemming). stemmer buffet, honestly. 🍽️
• -h, --help — display this help and exit. help is there when you need it. 🆘
• -V, --version — output version information and exit. version check, periodt. 💫

Please report bugs at: https://xapian.org/bugs

---

k bye bestie — this iconic page was brought to you by xapian-omega 2.0.0, dated March 2026, and it’s the OMINDEX(1) manual. slay 💅✨