DWWW-INDEX++(8)

✨ DWWW-INDEX++(8) ✨

okay bestie, pull up a chair, we're talking about dwww-index++ from the Debian manual pages, section 8 🎀

💖 NAME 💖

dwww-index++ — bestie, it builds the index of registered Debian documentation. That's the whole job. She's an index builder. Iconic behaviour, honestly. 👑

🦋 SYNOPSIS 🦋

dwww-index++ [-f] [-i] [-l] [-v] [-- swish_option [...]]

look at her. so compact. so powerful. 💅

🌸 DESCRIPTION 🌸

so dwww-index++ is part of the dwww package, which is the thing that gives you access to on-line documentation on a Debian system via WWW. yes girl, docs on the web, we love to see it. 🌈

and here's the tea: dwww-index++ uses the index++(1) program from the swish++ package to generate an index of all the Debian documentation files that got registered with doc-base. so like, doc-base says "hey here's a doc" and dwww-index++ goes "noted, indexed, slayed." 🔥

💅 OPTIONS 💅

• -f — force the generation of the full documentation index even if it's disabled in the configuration file. like, the config said no but you said yes, and you win. periodt.
• -i — force the generation of the incremental documentation index even if it's disabled in the configuration file. same energy, smaller scope, still serving. ✨
• -l — print a list of files which would be indexed, straight to standard output. and bestie, you can use this together with -f or -i to show the files which would be indexed by full or incremental indexing respectively. peek behind the curtain, it's giving transparency. 🫶
• -v — be more verbose. she talks more. we listen. 💖
• -- — anything after -- is passed directly to index++(1). so it's not even your flag anymore, it's swish's flag. for example, to see which files are indexed, use:

dwww-index++ -- -v4

🎀 CONFIGURATION FILE ITEMS 🎀

• DWWW_INDEX_DOCUMENTATION — if this is set to yes (and yes, that's the default, bestie 💅), then the documentation index gets generated. this setting can be overridden with the -f option. so -f is the main character here, lowkey.
• DWWW_MERGE_MAN2HTML_INDEX — if this is set to yes, then the index of registered documentation files gets merged with the index of man pages generated by the man2html package (if it's available). two indexes, one vibe, merged. 🦋
• DWWW_INDEX_FULL_TIME_INTERVAL — specifies how often, in days, dwww-index++(8) will generate a full index of documentation. the default value is 28. so roughly every lunar-ish cycle, she does the big one. 🌙
• DWWW_INDEX_INCREMENTAL_TIME_INTERVAL — specifies how often, in days, dwww-index++(8) will run incremental indexing of new documentation files. the default value is 7. weekly lil refresh, self-care. 🍓

🌈 FILES 🌈

• /etc/dwww/dwww.conf — configuration file for dwww. the brain, the blueprint, the source of truth.
• /etc/cron.weekly/dwww — a Bourne shell script which calls dwww-index++. she's the alarm clock. ⏰
• /usr/share/dwww/swish++.conf — the Swish++ configuration file, used by dwww-index++. this is what swish eats for breakfast.
• /var/cache/dwww/dwww.swish++.index — the generated index file. the final product. the glow-up. ✨
• /var/cache/dwww/index.files.db — list of already indexed files. the receipts. 🧾
• /var/cache/dwww/index.runinfo — timestamps of the latest full and incremental index generations. so you know exactly when she last showed up. 📅

👑 SEE ALSO 👑

dwww(7), dwww-find(8), index++(1), install-docs(8), Debian doc-base Manual in /usr/share/doc/doc-base/doc-base.html/index.html.

go read those too, bestie, iykyk. 💜

🧚 AUTHOR 🧚

Robert Luberda <robert@debian.org>. see dwww(7) for copyrights and stuff.

no cap, that's the whole page. every flag, every variable, every path, every default — all present, all accounted for. 💖

and that's a wrap on the dwww package, version 1.11.1, dated February 15th, 2009 — mwah, kiss the manual page goodbye, she ate and left no crumbs. 💅✨🎀