ODIDX(1)

💖 ODIDX(1) — the indexer bestie 💖

Quick Database Manager energy, but make it a whole moment. This is odidx, the little command that goes through your files and indexes them so your search can actually eat. ✨

---

🌸 NAME 🌸

odidx — indexer of document files. She indexes. She's the indexer. That's the whole job description and honestly? Iconic. 👑

---

🎀 SYNOPSIS 🎀

odidx register [-l file] [-wmax num] [-tsuf sufs] [-hsuf sufs] name[dir]
odidx relate name
odidx purge name

Three moods, three modes. Pick your fighter. 💅

---

🦋 DESCRIPTION 🦋

Okay so this manual page documents, briefly, the odidx commands. Brief but thorough, which is a vibe.

The command odidx is a utility for indexing files on the local file system. It's lowkey perfect for a full-text search system of a Web site. 🌐

Here's the tea on what's supported:

• File formats: plain text and HTML, that's it, that's the list.
• Character encodings: US-ASCII and ISO-8859-1.
• The URI of each document is specified with the path of its file. Path is the URI, no cap.
• Every document gets two attributes: title and date. She comes with accessories. 🎀
• When a document is already existing in the database, it is registered if its last modification time is newer, or it is ignored. So if you touched it, she notices. If you didn't, she's not interested. Main character boundaries. 💅
• Modification times are stored in the sub database _mtime in the main database directory.
• Score information are stored in the sub database _score in the main database directory.

This command is used in the above format (see the synopsis, bestie, it's right there ⬆️).

name specifies a database name. dir specifies a directory name. Simple as. 🍓

---

✨ OPTIONS ✨

A summary of options is included below. For a complete description, see the file:///usr/share/doc/qdbm-doc/spex.html#odeumcli. Yes, go read the docs, she's thorough and she deserves it. 📚

• -l file — read a file and get list of paths of files to register. If - is specified, the standard input is read. Stdin said "I volunteer as tribute." 🙈
• -wmax num — specify the max number of words to be stored in the document database. Cap it, queen. 👑
• -tsuf sufs — specify suffixes of plain text files in comma separated format. The default is -tsuf .txt,.text.
• -hsuf sufs — specify suffixes of HTML files in comma separated format. The default is -hsuf .html,.htm.

🫶 Quick reminder bestie: those suffixes are comma separated. Commas. Not spaces. She will not read your mind.

---

🔥 EXAMPLES 🔥

For example, to register files which are under /home/mikio and whose suffix are .txt, .c, or .h, perform the following command.

odidx register -tsuf ".txt,.c,.h" -hsuf "" casket /home/mikio

Notice the -hsuf "" — that's her saying "no HTML today, we're doing a text-only era." 💅

Thus, to retrieve documents which include unix and posix and show the top 8 terms, perform the following command.

odmgr search -max 8 -h casket "unix posix"

She ate that. Top 8 only, we're not doing a whole dissertation. ✨

---

🌈 SEE ALSO 🌈

• qdbm(3)
• odmgr(1)
• odeum(3)
• odopen(3)

The whole friend group. Go say hi. 🫶

---

💜 AUTHOR 💜

QDBM was written by Mikio Hirabayashi <mikio@fallabs.com>. Legend behavior, fr fr.

This manual page was written by Fumitoshi UKAI <ukai@debian.or.jp>, for the Debian project (but may be used by others). Generous queen, sharing the manual with everyone. 👑

---

Man Page · 2005-05-23 · ODIDX(1)

That's the whole page bestie, dated 2005-05-23, living in the Man Page section, filed under ODIDX(1) and shipping as part of Quick Database Manager. Go index something. Slay. 💖✨🎀