1semind(1)                   General Commands Manual                  semind(1)
2
3
4

NAME

6       semind - Semantic Indexer for C
7

SYNOPSIS

9       semind [options]
10       semind   [options]   add  [command  options]  [--]  [compiler  options]
11       [files...]
12       semind [options] rm [command options] pattern
13       semind [options] search [command options] [pattern]
14       semind [options] search [command options] (-e|-l)  filename:linenr:col‐
15       umn
16

DESCRIPTION

18       semind  is  the simple to use cscope-like tool based on sparse/dissect.
19       Unlike cscope it runs after pre-processor and thus it can't  index  the
20       code filtered out by ifdef's, but otoh it understands how the symbol is
21       used and it can track the usage of struct members.
22

SUBCOMMANDS

24       add    generates or updates semantic index file.
25
26       rm     removes files from the  index  by  pattern.  The  pattern  is  a
27              glob(7) wildcard pattern.
28
29       search queries  information  about  symbol by pattern. The pattern is a
30              glob(7) wildcard pattern.
31

COMMON OPTIONS

33       -D, --database=FILE
34              specify database file (default: ./semind.sqlite).
35
36       -v, --verbose
37              show information about what is being done.
38
39       -h, --help
40              show this text and exit.
41

ADD OPTIONS

43       --include-local-syms
44              include into the index local symbols.
45

SEARCH OPTIONS

47       -f, --format=STRING
48              specify an output  format.  Default:  '(%m)  %f\t%l\t%c\t%C\t%s'
49              (see FORMAT below).
50
51       -p, --path=PATTERN
52              search symbols only in specified directories.
53
54       -m, --mode=MODE
55              search only the specified type of access (see MODE below).
56
57       -k, --kind=KIND
58              specify a kind of symbol (see KIND below).
59
60       -e, --explain
61              Show what happens in the specified file position;
62
63       -l, --location
64              Show usage of symbols from a specific file position;
65
66       -v, --verbose
67              show information about what is being done;
68
69       -h, --help
70              show this text and exit.
71

FORMAT

73       %m     access mode in human readable form (see MODE below).
74
75       %f     file name.
76
77       %l     line number.
78
79       %c     column number.
80
81       %C     the name of the function in which the symbol occurs.
82
83       %n     symbol name.
84
85       %s     source  code line. Indexer does not save source code lines. They
86              are read from the file during the search.
87

KIND

89       f      function
90
91       s      strict
92
93       m      struct member
94

MODE

96       The MODE is dumped as a  3-letter  string.  The  first  letter  denotes
97       address  of  part,  2-nd - access by value, 3-rd - access by pointer. A
98       special value 'def' means a symbol definition.
99
100       r      read
101
102       w      write
103
104       m      read and write
105

SEE ALSO

107       sparse(1)
108

HOMEPAGE

110       https://sparse.docs.kernel.org
111

MAILING LIST

113       linux-sparse@vger.kernel.org
114
115
116
117
118                                                                     semind(1)