MKID(1)

💖 MKID — the manual page, bestie edition 💖

okay so you found mkid and you're like "what is this" — don't worry, I got you. it's the mkid command from the User Commands corner of the manual, and it's literally the thing that builds your identifier database. iconic behavior. let's go. 🦋

---

✨ NAME ✨

mkid — Build an identifier database. that's it, that's the whole job, and she does it flawlessly. 💅

---

🌸 SYNOPSIS 🌸

mkid [OPTION]... [FILE]...

---

🎀 DESCRIPTION 🎀

Build an identifier database. no cap, that's the vibe: you point it at files, it hands you back a database of identifiers.

here's the whole option menu, and I mean the whole menu — every single one:

• -o, --output=OUTFILE — the file name of your ID database output. this is where the magic gets written. ✨
• -f, --file=OUTFILE — literally just a synonym for --output. same energy, different name.
• -i, --include=LANGS — include the languages in LANGS (default: "C C++ asm").
• -x, --exclude=LANGS — exclude the languages in LANGS.
• -l, --lang-option=L:OPT — pass OPT as a default for language L (see below 👇).
• -m, --lang-map=MAPFILE — use MAPFILE to map file names onto source language.
• -d, --default-lang=LANG — make LANG the default source language.
• -p, --prune=NAMES — exclude the named files and/or directories. bye bestie, not you. 🙈
• -v, --verbose — report per file statistics.
• -s, --statistics — report statistics at end of run.
• --files0-from=F — tokenize only the files specified by NUL-terminated names in file F.
• --help — display this help and exit. 🫶
• --version — output version information and exit.

FILE may be a file name, or a directory name to recursively search. and if you give it no FILE at all? it just searches the current directory by default. easy.

⚠️ heads up bestie: the --include and --exclude options are mutually-exclusive. pick a lane. 😭

The following arguments apply to the language-specific scanners:

🧚 C language:

• -k,--keep=CHARS — Allow CHARS in single-token strings, keep the result.
• -i,--ignore=CHARS — Allow CHARS in single-token strings, toss the result.
• -u,--strip-underscore — Strip a leading underscore from single-token strings.

💜 C++ language:

• -k,--keep=CHARS — Allow CHARS in single-token strings, keep the result.
• -i,--ignore=CHARS — Allow CHARS in single-token strings, toss the result.
• -u,--strip-underscore — Strip a leading underscore from single-token strings.

🍓 Java language:

• -k,--keep=CHARS — Allow CHARS in single-token strings, keep the result.
• -i,--ignore=CHARS — Allow CHARS in single-token strings, toss the result.
• -u,--strip-underscore — Strip a leading underscore from single-token strings.

🔥 Assembly language:

• -c,--comment=CHARS — Any of CHARS starts a comment until end-of-line.
• -k,--keep=CHARS — Allow CHARS in tokens, and keep the result.
• -i,--ignore=CHARS — Allow CHARS in tokens, and toss the result.
• -u,--strip-underscore — Strip a leading underscore from tokens.
• -n,--no-cpp — Don't handle C pre-processor directives.

🌈 Text language:

• -i,--include=CHAR-CLASS — Treat characters of CHAR-CLASS as token constituents.
• -x,--exclude=CHAR-CLASS — Treat characters of CHAR-CLASS as token delimiters.

⭐ Perl language:

• -i,--include=CHAR-CLASS — Treat characters of CHAR-CLASS as token constituents.
• -x,--exclude=CHAR-CLASS — Treat characters of CHAR-CLASS as token delimiters.
• -d,--dtags — Include documentation tags.

💀 Lisp language:

...that's it. that's the whole list. Lisp gets a heading and absolutely nothing under it and honestly? main character energy. 👑

---

😭 REPORTING BUGS 😭

Report bugs to bug-idutils@gnu.org. tell them everything, they want to know. 🫶

---

👀 SEE ALSO 👀

The full documentation for the id-utils package is maintained as a Texinfo manual. If the info and id-utils packages are properly installed, the command

info 'ID database'

should give you access to the complete manual. iykyk. ✨

---

and that's the whole page, bestie! this one's from mkid, version 4.6.28-15da, dated May 2020. go build that database, you're gonna slay. 💖🎀🦋