MKNMZ(1)

πŸ’– MKNMZ β€” bestie's guide to the Namazu indexer πŸ’–

okay so. welcome to mknmz, the indexer that belongs to the Namazu Project. this whole page is you getting the full download on it, and i promise it's gonna be less scary than it looks. grab a strawberry πŸ“ and let's go.


✨ NAME ✨

mknmz β€” an indexer of Namazu. that's it, that's the job, and it ate πŸ’…


🌸 SYNOPSIS 🌸

mknmz [options] <target>...

πŸ¦‹ DESCRIPTION πŸ¦‹

mknmz 2.0.21, an indexer of Namazu. that's the version we're living in, periodt.


πŸŽ€ Target files: (what even gets indexed)

  • -a, --all β€” target all files. every single one. no cap.
  • -t, --media-type=MTYPE β€” sets the media type for every target file to MTYPE. one type to rule them all πŸ‘‘
  • -h, --mailnews β€” literally the same as --media-type='message/rfc822'. same vibe, shorter to type.
  • --mhonarc β€” literally the same as --media-type='text/html; x-type=mhonarc'. again: shortcut szn.
  • -F, --target-list=FILE β€” loads FILE, which has a whole list of target files in it. so you don't have to type them all out, thank god 😭
  • --allow=PATTERN β€” sets PATTERN for the file names that should be allowed in.
  • --deny=PATTERN β€” sets PATTERN for the file names that should be denied. bye πŸ‘‹
  • --exclude=PATTERN β€” sets PATTERN for the pathnames that should be excluded entirely.
  • -e, --robots β€” excludes HTML files that contain <meta name="ROBOTS" content="NOINDEX">. the robots said no, so we respect the robots 🫢
  • -M, --meta β€” handles HTML meta tags so you can do field-specified search. fancy.
  • -r, --replace=CODE β€” sets CODE for replacing the URI.
  • --html-split β€” splits an HTML file at its <a name="..."> anchors. chop chop βœ‚οΈ
  • --mtime=NUM β€” limits by mtime, exactly like find(1)'s -mtime option. so like -50 means the recent 50 days, and +50 means older than 50 days. bestie this one is so useful.

🧚 Morphological Analysis (the japanese-language-girlie section)

  • -b, --use-mecab β€” uses MeCab for analyzing Japanese.
  • -c, --use-chasen β€” uses ChaSen for analyzing Japanese.
  • -k, --use-kakasi β€” uses KAKASI for analyzing Japanese.
  • -m, --use-chasen-noun β€” uses ChaSen but only extracts the nouns. nouns only, we're being picky today πŸ’…
  • -L, --indexing-lang=LANG β€” indexes with language specific processing for LANG.

🌈 Text Operations (glow-ups for your words)

  • -E, --no-edge-symbol β€” removes symbols sitting on the edge of a word.
  • -G, --no-okurigana β€” removes Okurigana inside a word.
  • -H, --no-hiragana β€” ignores words that consist of Hiragana only. not them.
  • -K, --no-symbol β€” removes symbols. all of them. gone.
  • --decode-base64 β€” decodes base64 bodies inside multipart entities. uncoded, as a treat πŸŽ€

πŸ‘‘ Summarization

  • -U, --no-encode-uri β€” does not encode the URI. leave it alone, it's fine as is.
  • -x, --no-heading-summary β€” does not make a summary out of the HTML's headings. no heading-based summary for you.

πŸ’œ Index Construction (building the thing)

  • --update=INDEX β€” sets INDEX for updating. it's giving incremental.
  • -z, --check-filesize β€” detects when a file's size changed.
  • -Y, --no-delete β€” does not detect removed documents. they're gone but we're pretending 🀫
  • -Z, --no-update β€” does not detect updated or deleted documents. full denial mode, iconic.

πŸ”₯ Miscellaneous (the everything-else drawer)

  • -s, --checkpoint β€” turns on the checkpoint mechanism.
  • -C, --show-config β€” shows the current configuration. vibe check on your setup ✨
  • -f, --config=FILE β€” uses FILE as the config file.
  • -I, --include=FILE β€” includes your customization FILE.
  • -O, --output-dir=DIR β€” sets DIR as where the index gets output.
  • -T, --template-dir=DIR β€” sets DIR as the one holding NMZ.{head,foot,body}.*.
  • -q, --quiet β€” suppresses the status messages while it runs. shhh 🀫
  • -v, --version β€” shows the version of namazu and exits.
  • -V, --verbose β€” be verbose. tell me everything, i want the tea 🍡
  • -d, --debug β€” be in debug mode.
  • --help β€” shows this help and exits.
  • --norc β€” does not read the personal initialization files. no rc, no drama.
  • -- β€” terminates the option list. everything after this is not an option, bestie, i promise.

😭 REPORTING BUGS 😭

found a bug? report it to <http://www.namazu.org/trac-namazu/trac.cgi> or to <bug-namazu@namazu.org>. they wanna hear it fr fr, don't be shy.


Copyright Β© 1997-1999 Satoru Takabayashi All rights reserved. Copyright Β© 2000-2009 Namazu Project All rights reserved.

This is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

no warranty bestie. none. zero. the GPL said what it said πŸ’€

and that's the whole page!! this was mknmz of Namazu 2.0.21, from July 2011 πŸ¦‹ you understood all of it, i know you did. so proud. go index something πŸ’…βœ¨