1
2Gendarme(Gendarme 4.2.0.0) Gendarme(Gendarme 4.2.0.0)
3
4
5
7 Gendarme - Rule-based code analysis for Mono.
8
10 gendarme [--config configfile] [--set ruleset] [--log file | --xml file
11 | --html file] [options] assemblies ...
12
14 Gendarme is a extensible rule-based tool used to find problems in .NET
15 applications and libraries. Gendarme inspects programs and libraries
16 that contain code in ECMA CIL format (Mono and .NET) and looks for com‐
17 mon problems with the code, problems that compilers do not typically
18 check or have historically not checked.
19
21 --config configfile
22 Specify the rule sets and rule settings. Default is 'rules.xml'.
23
24 --set ruleset
25 Specify a rule set from configfile. Defaults to 'default'.
26
27 --log file
28 Save the report, as a text file, to the specified file.
29
30 --xml file
31 Save the report, formatted as XML, to the specified file.
32
33 --html file
34 Save the report, formatted as HTML, to the specified file.
35
36 --console
37 Write the defects on stdout. This is the default (implicit)
38 behavior if none of --log, --xml, or --html options are speci‐
39 fied. If (explicitely) specified then the defects will be shown
40 on both stdout and inside text/xml/html report(s).
41
42 --ignore ignore-file
43 Do not report defects listed in the specified file.
44
45 --limit N
46 Stop reporting after N defects are found.
47
48 --severity [all | audit[+] | low[+|-] | medium[+|-] | high[+|-] | crit‐
49 ical[-]],...
50 Filter the reported defects to include the specified severity
51 levels. Default is 'medium+' (i.e. low and audit levels are
52 ignored).
53
54 --confidence [all | low[+] | normal[+|-] | high[+|-] | total[-]],...
55 Filter the reported defects to include the specified confidence
56 levels. Default is 'normal+' (i.e. low level is ignored).
57
58 --quiet
59 Used to disable progress and other information which is normally
60 written to stdout.
61
62 --v|verbose
63 When present additional progress information is written to std‐
64 out. May be used more than once to write even more info.
65
66 --version
67 Display Gendarme's version number. This will match the Mono ver‐
68 sion number that this copy of Gendarme was released with.
69
70 assemblies ...
71 Specify the assemblies to verify. You can specify multiple file‐
72 names, including masks (? and *). You can also provide a file
73 that lists several assemblies (one per line) by prefixing the
74 filename with @ on the command line.
75
77 ignore-file
78 This file is used to filter out defects from gendarme reports.
79
80 rules.xml
81 This file is used in conjunction with the --set option to con‐
82 trol and configure the rules used by Gendarme. It contains a set
83 of named rules (rule sets) and each rule set contains a list of
84 rules.
85
86 gendarme.exe.config
87 Used by debug versions of Gendarme to enable logging for rules.
88 It is useful for Gendarme's developers (i.e. not meant for end-
89 users).
90
92 GENDARME_COLOR
93 The runner will use colors when displaying defects on the con‐
94 sole. By default colors are dark in order to display correctly
95 on any background. You can change this default to "light"
96 (lighter colors looks nice on a dark background, or "none" so no
97 colors will be used. E.g.
98 GENDARME_COLOR=none gendarme ...
99
101 0 The runner returns 0 when no error has occurred. If some code
102 was analyzed then this also means that no defects were found and
103 reported.
104
105 1 The runner execution was successful but either some defects
106 where found or no assembly was specified.
107
108 2 The runner execution was interrupted by I/O errors (e.g. missing
109 files).
110
111 3 The runner founds errors in the (default or user supplied) con‐
112 figuration files. Specific error messages should be printed on
113 the console.
114
115 4 The runner execution was interrupted by a non-handled exception.
116 This is likely a bug inside Gendarme and should be reported on
117 Novell's bugzilla (http://bugzilla.novell.com) or on the mail‐
118 ing-list.
119
121 Copyright (C) 2005-2010 Novell, Inc (http://www.novell.com)
122
124 Mailing lists are listed at the http://groups.google.com/group/gendarme
125
127 http://www.mono-project.com/Gendarme
128
130 gendarme(5),[22mgd2i(1),mono(1)
131
132
133
134 Gendarme(Gendarme 4.2.0.0)