Scroll to navigation

MKID(1) User Commands MKID(1)

NAME

mkid - build an identifier database

SYNOPSIS

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

DESCRIPTION

Build an identifier database.

file name of ID database output
synonym for --output
include languages in LANGS (default: "C C++ asm")
exclude languages in LANGS

-l, --lang-option=L:OPT pass OPT as a default for language L (see below)

use MAPFILE to map file names onto source language
make LANG the default source language
exclude the named files and/or directories
report per file statistics
report statistics at end of run
tokenize only the files specified by NUL-terminated names in file F
display this help and exit
output version information and exit

FILE may be a file name, or a directory name to recursively search. If no FILE is given, the current directory is searched by default. Note that the `--include' and `--exclude' options are mutually-exclusive.

The following arguments apply to the language-specific scanners:

C language:

Allow CHARS in single-token strings, keep the result
Allow CHARS in single-token strings, toss the result
Strip a leading underscore from single-token strings

C++ language:

Allow CHARS in single-token strings, keep the result
Allow CHARS in single-token strings, toss the result
Strip a leading underscore from single-token strings

Java language:

Allow CHARS in single-token strings, keep the result
Allow CHARS in single-token strings, toss the result
Strip a leading underscore from single-token strings

Assembly language:

Any of CHARS starts a comment until end-of-line
Allow CHARS in tokens, and keep the result
Allow CHARS in tokens, and toss the result
Strip a leading underscore from tokens
Don't handle C pre-processor directives

Text language:

Treat characters of CHAR-CLASS as token constituents
Treat characters of CHAR-CLASS as token delimiters

Perl language:

Treat characters of CHAR-CLASS as token constituents
Treat characters of CHAR-CLASS as token delimiters
Include documentation tags

Lisp language:

REPORTING BUGS

Report bugs to bug-idutils@gnu.org

SEE ALSO

The full documentation for mkid is maintained as a Texinfo manual. If the info and mkid programs are properly installed at your site, the command

info mkid

should give you access to the complete manual.

February 2012 mkid - 4.6