File: mkid.1

package info (click to toggle)
id-utils 4.6.28-20200521ss15dab
  • links: PTS
  • area: main
  • in suites: bullseye, trixie
  • size: 13,176 kB
  • sloc: ansic: 90,321; sh: 10,115; perl: 558; makefile: 209; lisp: 29; sed: 16
file content (135 lines) | stat: -rw-r--r-- 3,678 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
.TH MKID "1" "May 2020" "mkid - 4.6.28-15da" "User Commands"
.SH NAME
mkid \- build an identifier database
.SH SYNOPSIS
.B mkid
[\fI\,OPTION\/\fR]... [\fI\,FILE\/\fR]...
.SH DESCRIPTION
.\" Add any additional description here
.PP
Build an identifier database.
.TP
\fB\-o\fR, \fB\-\-output\fR=\fI\,OUTFILE\/\fR
file name of ID database output
.TP
\fB\-f\fR, \fB\-\-file\fR=\fI\,OUTFILE\/\fR
synonym for \fB\-\-output\fR
.TP
\fB\-i\fR, \fB\-\-include\fR=\fI\,LANGS\/\fR
include languages in LANGS (default: "C C++ asm")
.TP
\fB\-x\fR, \fB\-\-exclude\fR=\fI\,LANGS\/\fR
exclude languages in LANGS
.HP
\fB\-l\fR, \fB\-\-lang\-option\fR=\fI\,L\/\fR:OPT pass OPT as a default for language L (see below)
.TP
\fB\-m\fR, \fB\-\-lang\-map\fR=\fI\,MAPFILE\/\fR
use MAPFILE to map file names onto source language
.TP
\fB\-d\fR, \fB\-\-default\-lang\fR=\fI\,LANG\/\fR
make LANG the default source language
.TP
\fB\-p\fR, \fB\-\-prune\fR=\fI\,NAMES\/\fR
exclude the named files and/or directories
.TP
\fB\-v\fR, \fB\-\-verbose\fR
report per file statistics
.TP
\fB\-s\fR, \fB\-\-statistics\fR
report statistics at end of run
.TP
\fB\-\-files0\-from\fR=\fI\,F\/\fR
tokenize only the files specified by
NUL\-terminated names in file F
.TP
\fB\-\-help\fR
display this help and exit
.TP
\fB\-\-version\fR
output version information and exit
.PP
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.
.PP
The following arguments apply to the language\-specific scanners:
.SS "C language:"
.TP
\fB\-k\fR,\-\-keep=CHARS
Allow CHARS in single\-token strings, keep the result
.TP
\fB\-i\fR,\-\-ignore=CHARS
Allow CHARS in single\-token strings, toss the result
.TP
\fB\-u\fR,\-\-strip\-underscore
Strip a leading underscore from single\-token strings
.SS "C++ language:"
.TP
\fB\-k\fR,\-\-keep=CHARS
Allow CHARS in single\-token strings, keep the result
.TP
\fB\-i\fR,\-\-ignore=CHARS
Allow CHARS in single\-token strings, toss the result
.TP
\fB\-u\fR,\-\-strip\-underscore
Strip a leading underscore from single\-token strings
.SS "Java language:"
.TP
\fB\-k\fR,\-\-keep=CHARS
Allow CHARS in single\-token strings, keep the result
.TP
\fB\-i\fR,\-\-ignore=CHARS
Allow CHARS in single\-token strings, toss the result
.TP
\fB\-u\fR,\-\-strip\-underscore
Strip a leading underscore from single\-token strings
.SS "Assembly language:"
.TP
\fB\-c\fR,\-\-comment=CHARS
Any of CHARS starts a comment until end\-of\-line
.TP
\fB\-k\fR,\-\-keep=CHARS
Allow CHARS in tokens, and keep the result
.TP
\fB\-i\fR,\-\-ignore=CHARS
Allow CHARS in tokens, and toss the result
.TP
\fB\-u\fR,\-\-strip\-underscore
Strip a leading underscore from tokens
.TP
\fB\-n\fR,\-\-no\-cpp
Don't handle C pre\-processor directives
.SS "Text language:"
.TP
\fB\-i\fR,\-\-include=CHAR\-CLASS
Treat characters of CHAR\-CLASS as token constituents
.TP
\fB\-x\fR,\-\-exclude=CHAR\-CLASS
Treat characters of CHAR\-CLASS as token delimiters
.SS "Perl language:"
.TP
\fB\-i\fR,\-\-include=CHAR\-CLASS
Treat characters of CHAR\-CLASS as token constituents
.TP
\fB\-x\fR,\-\-exclude=CHAR\-CLASS
Treat characters of CHAR\-CLASS as token delimiters
.TP
\fB\-d\fR,\-\-dtags
Include documentation tags
.PP
Lisp language:
.SH "REPORTING BUGS"
Report bugs to bug\-idutils@gnu.org
.SH "SEE ALSO"
The full documentation for
.B mkid
is maintained as a Texinfo manual.  If the
.B info
and
.B mkid
programs are properly installed at your site, the command
.IP
.B info mkid
.PP
should give you access to the complete manual.