.\" 
.\" Gendarme manual page.
.\"
.\" Author:
.\"	Sebastien Pouliot  <sebastien@ximian.com>
.\"
.\" Copyright (C) 2005-2006,2008 Novell, Inc (http://www.novell.com)
.\"

.de Sp
.if t .sp .5v
.if n .sp
..
.TH Gendarme "Gendarme @GENDARME_VERSION@"
.SH NAME
Gendarme \- Rule-based code analysis for Mono::
.SH SYNOPSIS
.PP
.B gendarme [--config configfile] [--set ruleset] [--log file | --xml file | --html file] [--quiet] [--debug] assemblies ...
.SH DESCRIPTION
\fIGendarme\fP is a extensible rule-based tool to find problems in .NET 
applications and libraries. Gendarme inspects programs and libraries that
contain code in ECMA CIL format (Mono and .NET) and looks for common 
problems with the code, problems that compiler do not typically check or
have not historically checked.
.SH OPTIONS
.TP
.I "--config configfile"
Specify the configuration file. Default is 'rules.xml'.
.TP
.I "--set ruleset"
Specify the set of rules to verify. Default is '*'.
.TP
.I "--log file"
Save the text output to the specified file.
.TP
.I "--xml file"
Save the output, formatted as XML, to the specified file.
.TP
.I "--html file"
Save the output, formatted as HTML, to the specified file.
.TP
.I "--quiet"
Display minimal output (results) from the runner.
.TP
.I "--v|verbose"
Enable debugging output. You can supply several -v to augment debugging verbosity.
.TP
.I "assemblies ..."
Specify the assemblies to verify. You can specify multiple filenames, 
including masks (? and *). You can also provide a file that list several
assemblies (one by line) by prefixing the filename with @ on the command 
line.
.SH FILES
.TP
.I rules.xml
This files contains a list of all the rulesets available to Gendarme. Each 
ruleset includes a list of assemblies in which some, or all, rules can be
verified (include) or not (exclude).
.SH COPYRIGHT
Copyright (C) 2005-2008 Novell, Inc (http://www.novell.com)
.SH MAILING LISTS
Mailing lists are listed at the
http://groups.google.com/group/gendarme
.SH WEB SITE
http://www.mono-project.com/Gendarme
.SH SEE ALSO
.BR mono(1)