-
Notifications
You must be signed in to change notification settings - Fork 7
/
cinclude2dot.1
75 lines (75 loc) · 1.46 KB
/
cinclude2dot.1
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
.TH CINCLUDE2DOT 1
.SH NAME
cinclude2dot \- generate graphs of #include dependencies
.SH SYNOPSIS
.B cinclude2dot
.SH DESCRIPTION
.I cinclude2dot
writes a
.IR graphviz (dot)
graph of the
.B #include
relationships of the
.BR .c ,
.BR .cc ,
.BR .cpp ,
.BR .cxx ,
.BR .h ,
.BR .hpp " and"
.BR .hxx
files of the current directory to standard output.
.SH OPTIONS
.TP
.B \--debug
Write various debugging information.
.TP
.B \--exclude
Specify a regular expression of filenames to be ignored - for example, your test harnesses.
.TP
.BI \--merge " arg"
Specify the granularity of the diagram -
.IR arg " ="
.B file
is the default, which treats each file as being separate;
.IR arg " ="
.B module
merges .c/.cc/.cpp/.cxx and .h/.hpp/.hxx pairs;
.IR arg " ="
.B directory
merges directories into one node.
.TP
.B \--groups
Cluster files or modules into directory groups.
.TP
.B \--help
Write a usage message for this command.
.TP
.BI \--include " pathlist"
Set the directory search path to be the supplied comma-separated list of directories.
.TP
.B \--paths
Leaves relative paths in displayed filenames.
.TP
.BI \--quotetypes " arg"
.IR arg " ="
.B both
is the default, parse all headers;
.IR arg " = "
.B angle
includes only system headers quoted with angle brackets;
.IR arg " = "
.B quote
includes only user headers included with double quotes.
.SH EXAMPLES
.nf
$ ls
hello.c
$ cinclude2dot -i /usr/include hello.c
$ ls
hello.c hello.dot
$
.fi
.SH SEE ALSO
.IR dot (1),
.IR dotty (1),
.IR neato (1).