summaryrefslogtreecommitdiffabout
path: root/doc/cflow.1
blob: def149674a3da145ad669f50ef502cf40d236fb9 (plain)
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
.\" This file is part of Cflow -*- nroff -*-
.\" Copyright (C) 2014 Sergey Poznyakoff
.\"
.\" Cflow is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3, or (at your option)
.\" any later version.
.\"
.\" Cflow is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with Cflow.  If not, see <http://www.gnu.org/licenses/>.
.TH CFLOW 1 "February 27, 2014" "CFLOW"
.SH NAME
cflow \- generate a C-language flowgraph
.SH SYNOPSIS
.nh
.na
\fBcflow\fB [\fB\-rxaSblnTv\fR] [\fB\-d\fR \fINUMBER\fR]\
 [\fB\-f\fR \fINAME\fR] [\fB\-i\fR \fICLASSES\fR] [\fB\-o\fR \fIFILE\fR]\
 [\fB\-D\fR \fINAME\fR[\fB=\fIDEFN\fR]] [\fB\-I\fR \fIDIR\fR]\
 [\fB\-m\fR \fINAME\fR] [\fB\-p\fR \fINUMBER\fR]\
 [\fB\-s\fR \fISYMBOL\fB:\fR[\fB=\fR]\fITYPE\fR] [\fB\-U\fR \fINAME\fR]\
 [\fB\-\-depth=\fINUMBER\fR] [\fB\-\-format=\fINAME\fR]\
 [\fB\-\-include=\fICLASSES\fR] [\fB\-\-output=\fIFILE\fR]\
 [\fB\-\-reverse\fR] [\fB\-\-xref\fR] [\fB\-\-ansi\fR]\
 [\fB\-\-define=\fINAME\fR[\fB=DEFN\fR]]\
 [\fB\-\-include\-dir=\fIDIR\fR] [\fB\-\-main=\fINAME\fR]\
 [\fB\-\-pushdown=\fINUMBER\fR] [\fB\-\-preprocess\fR[\fB=\fICOMMAND\fR]]\
 [\fB\-\-cpp\fR[\fB=\fICOMMAND\fR]]\
 [\fB\-\-symbol=\fISYMBOL\fB:\fR[\fB=\fR]\fITYPE\fR]\
 [\fB\-\-use\-indentation\fR] [\fB\-\-undefine=\fINAME\fR]\
 [\fB\-\-brief\fR] [\fB\-\-emacs\fR] [\fB\-\-print\-level\fR]\
 [\fB\-\-level\-indent=\fIELEMENT\fR]\
 [\fB\-\-number\fR] [\fB\-\-omit\-arguments\fR]\
 [\fB\-\-omit\-symbol\-names\fR] [\fB\-\-tree\fR]\
 [\fB\-\-debug\fR[\fB=\fINUMBER\fR]] [\fB\-\-verbose\fR] \fBFILE\fR...
.PP
\fBcflow\fR [\fB\-?V\fR] [\fB\-\-help\fR] [\fB\-\-usage\fR] [\fB\-\-version\fR]
.ad
.hy
.SH NOTE
This manpage is a short description of GNU \fBcflow\fR.  For a detailed
discussion, including examples and usage recommendations, refer to the
\fBGNU Cflow Manual\fR available in texinfo format.  If the \fBinfo\fR
reader and the cflow documentation are properly installed on your
system, the command
.PP
.RS +4
.B info cflow
.RE
.PP
should give you access to the complete manual.
.PP
You can also view the manual using the info mode in
.BR emacs (1),
or find it in various formats online at
.PP
.RS +4
.B http://www.gnu.org/software/cflow/manual
.RE
.PP
If any discrepancies occur between this manpage and the
\fBGNU Cflow Manual\fR, the later shall be considered the authoritative
source.
.SH DESCRIPTION
.B Cflow
analyzes a collection of input files written in \fBC\fR programming
language and writes to standard output a graph charting dependencies
between various functions.
.SH OPTIONS
.SS General-purpose options
.TP
\fB\-d\fR, \fB\-\-depth=\fINUMBER\fR
Set the depth at which the flowgraph is cut off.  By default the depth
is not limited.
.TP
\fB\-\-debug\fR[\fB=\fINUMBER\fR]
Set debugging level.
.TP
\fB\-f\fR, \fB\-\-format=\fINAME\fR
Use given output format \fINAME\fR. Valid names are \fBgnu\fR (the
default) and \fBposix\fR.
.TP
\fB\-i\fR, \fB\-\-include=\fICLASSES\fR
Include specified classes of symbols.  The
.BR ^ or -
symbol excludes the classes that follow it.  Valid classes are:
.RS
.TP
.BR _  (underscore)
Symbols whose names begin with an underscore.
.TP
.B s
Static symbols
.TP
.B t
Typedefs (for cross-references only).
.TP
.B x
All data symbols, both external and static
.RE
.TP
\fB\-o\fR, \fB\-\-output=\fIFILE\fR
Set output file name (default is \fB\-\fR, meaning stdout).
.TP
\fB\-r\fR, \fB\-\-reverse\fR
Print reverse call tree.
.TP
\fB\-\-no\-reverse\fR
Disable the effect of the previous \fB\-\-reverse\fR option.
.TP
\fB\-x\fR, \fB\-\-xref\fR
Produce cross-reference listing only.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Enable verbose error diagnostics.
.SS Parser control
.TP
\fB\-a\fR, \fB\-\-ansi\fR
Accept only sources in ANSI C.
.TP
\fB\-\-no\-ansi\fR
Don't assume input files are written in ANSI C.
.TP
\fB\-D\fR, \fB\-\-define=\fINAME\fR[\fB=\fIDEFN\fR]
Predefine \fINAME\fR as a macro.
.TP
\fB\-I\fR, \fB\-\-include\-dir=\fIDIR\fR
Add the directory \fIDIR\fR to the list of directories to be searched
for header files.
.TP
\fB\-m\fR, \fB\-\-main=\fINAME\fR
Assume main function is \fINAME\fR
.TP
\fB\-p\fR, \fB\-\-pushdown=\fINUMBER\fR
Set initial token stack size to \fINUMBER\fR.
.TP
\fB\-\-preprocess\fR[\fB=\fICOMMAND\fR], \fB\-\-cpp\fR[\fB=\fICOMMAND\fR]
Run the specified preprocessor command.
.TP
\fB\-\-no\-preprocess\fR, \fB\-\-no\-cpp\fR
Disable preprocessing.
.TP
\fB\-s\fR, \fB\-\-symbol=\fISYMBOL\fB:\fR[\fB=\fR]\fITYPE\fR
Register \fISYMBOL\fR with given \fITYPE\fR, or define an alias (if
\fB:=\fR is used). Valid types are:
.BR keyword (or kw ), 
.BR modifier ,
.BR qualifier ,
.BR identifier ,
.BR type ,
and
.BR wrapper .
Any unambiguous abbreviation of the above is also accepted.
.TP
\fB\-S\fR, \fB\-\-use\-indentation\fR
Rely on indentation to solve suspicious constructs.
.TP
\fB\-\-no\-use\-indentation\fR
Don't use indentation in parsing (default).
.TP
\fB\-U\fR, \fB\-\-undefine=\fINAME\fR
Cancel any previous definition of \fINAME\fR.
.SS Output control
.TP
\fB\-b\fR, \fB\-\-brief\fR
Brief output.
.TP
\fB\-\-no\-brief\fR
Disable brief output.
.TP
\fB\-\-emacs\fR
Format output for use with GNU Emacs.
.TP
\fB\-\-no\-emacs\fR
Disable the effect of the previous \fB\-\-emacs\fR option.
.TP
\fB\-l\fR, \fB\-\-print\-level\fR
Print nesting level along with the call tree.
.TP
\fB\-\-no\-print\-level\fR
Don't print nesting level.
.TP
\fB\-\-level\-indent=\fIELEMENT\fR
Control graph appearance.
.TP
\fB\-n\fR, \fB\-\-number\fR
Print line numbers.
.TP
\fB\-\-no\-number\fR
Don't print line numbers.
.TP
\fB\-\-omit\-arguments\fR
Do not print argument lists in function declarations.
.TP
\fB\-\-no\-omit\-arguments\fR
Print argument lists in function declarations (the default).
.TP
\fB\-\-omit\-symbol\-names\fR
Do not print symbol names in declaration strings.
.TP
\fB\-\-no\-omit\-symbol\-names\fR
Print symbol names in declaration strings (the default).
.TP
\fB\-T\fR, \fB\-\-tree\fR
Draw ASCII art tree.
.TP
\fB\-\-no\-tree\fR
Disable tree output.
.SS Informational options
These options instruct the program to output the requested piece of
information and exit.
.TP
\fB\-?\fR, \fB\-\-help\fR
Print a short help summary.
.TP
\fB\-\-usage\fR
Print a summary of available options.
.TP
\fB\-V\fR, \fB\-\-version\fR
Print program version.
.SH "RETURN VALUE"
.TP
.B 0
Successful completion.
.TP
.B 1
Fatal error occurred.
.TP
.B 2
Some input files cannot be read or parsed.
.TP
.B 3
Command line usage error.
.SH "SEE ALSO"
Online copies of \fBGNU cflow\fR documentation in various formats can be
found at:
.PP
.in +4
.B http://www.gnu.org/software/cflow/manual
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
Report bugs to <bug\-cflow@gnu.org>.
.SH COPYRIGHT
Copyright \(co 2014 Sergey Poznyakoff
.br
.na
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
.br
.ad
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.\" Local variables:
.\" eval: (add-hook 'write-file-hooks 'time-stamp)
.\" time-stamp-start: ".TH [A-Z_][A-Z0-9_.\\-]* [0-9] \""
.\" time-stamp-format: "%:B %:d, %:y"
.\" time-stamp-end: "\""
.\" time-stamp-line-limit: 20
.\" end:

Return to:

Send suggestions and report system problems to the System administrator.