gendarme(1)

1
2Gendarme(Gendarme 2.6.2.0)                          Gendarme(Gendarme 2.6.2.0)
3
4
5

NAME

7       Gendarme - Rule-based code analysis for Mono.
8

SYNOPSIS

10       gendarme [--config configfile] [--set ruleset] [--log file | --xml file
11       | --html file] [options] assemblies ...
12

DESCRIPTION

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

OPTIONS

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 to the specified file. If none of --log,  --xml,
29              or --html are used then the report is written to stdout.
30
31       --xml file
32              Save the report, formatted as XML, to the specified file.
33
34       --html file
35              Save the report, formatted as HTML, to the specified file.
36
37       --ignore ignore-file
38              Do not report defects listed in the specified file.
39
40       --limit N
41              Stop reporting after N defects are found.
42
43       --severity [all | audit[+] | low[+|-] | medium[+|-] | high[+|-] | crit‐
44       ical[-]],...
45              Filter the reported defects to include  the  specified  severity
46              levels.   Default  is  'medium+'  (i.e. low and audit levels are
47              ignored).
48
49       --confidence [all | low[+] | normal[+|-] | high[+|-] | total[-]],...
50              Filter the reported defects to include the specified  confidence
51              levels.  Default is 'normal+' (i.e. low level is ignored).
52
53       --quiet
54              Used to disable progress and other information which is normally
55              written to stdout.
56
57       --v|verbose
58              When present additional progress information is written to  std‐
59              out. May be used more than once to write even more info.
60
61       --version
62              Display Gendarme's version number. This will match the Mono ver‐
63              sion number that this copy of Gendarme was released with.
64
65       assemblies ...
66              Specify the assemblies to verify. You can specify multiple file‐
67              names,  including  masks  (? and *). You can also provide a file
68              that lists several assemblies (one per line)  by  prefixing  the
69              filename with @ on the command line.
70

FILES

72       ignore-file
73              This file is used to filter out defects from gendarme reports.
74
75       rules.xml
76              This  file  is used in conjunction with the --set option to con‐
77              trol and configure the rules used by Gendarme. It contains a set
78              of  named rules (rule sets) and each rule set contains a list of
79              rules.
80
81       gendarme.exe.config
82              Used by debug versions of Gendarme to enable logging for  rules.
83              It  is useful for Gendarme's developers (i.e. not meant for end-
84              users).
85

ENVIRONMENT VARIABLES

87       GENDARME_COLOR
88              The runner will use colors when displaying defects on  the  con‐
89              sole.   By default colors are dark in order to display correctly
90              on any background.  You  can  change  this  default  to  "light"
91              (lighter colors looks nice on a dark background, or "none" so no
92              colors will be used.  E.g.
93                  GENDARME_COLOR=none gendarme ...
94

COPYRIGHT

96       Copyright (C) 2005-2009 Novell, Inc (http://www.novell.com)
97

MAILING LISTS

99       Mailing lists are listed at the http://groups.google.com/group/gendarme
100

WEB SITE

102       http://www.mono-project.com/Gendarme
103