diff options
| author | Andrew Jorgensen <ajorgensen@novell.com> | 2008-01-31 20:04:34 +0300 |
|---|---|---|
| committer | Andrew Jorgensen <ajorgensen@novell.com> | 2008-01-31 20:04:34 +0300 |
| commit | 9de757d227454a83fdfdb202d7ba79e0b442817c (patch) | |
| tree | ac05dd06f003f5af5416bc093222cc8225d032d4 /gendarme/man | |
| parent | 21f12adb44c6317dfa3172a77b497612084bbcb2 (diff) | |
Move gendarme into mono-tools
svn path=/trunk/mono-tools/; revision=94478
Diffstat (limited to 'gendarme/man')
| -rw-r--r-- | gendarme/man/ChangeLog | 4 | ||||
| -rw-r--r-- | gendarme/man/Makefile.am | 3 | ||||
| -rw-r--r-- | gendarme/man/gendarme.1.in | 64 |
3 files changed, 71 insertions, 0 deletions
diff --git a/gendarme/man/ChangeLog b/gendarme/man/ChangeLog new file mode 100644 index 00000000..4047100a --- /dev/null +++ b/gendarme/man/ChangeLog @@ -0,0 +1,4 @@ +2006-09-17 Sebastien Pouliot <sebastien@ximian.com> + + * gendarme.1.in: Added documentation for new options (--quiet, --log, + --xml and --html). diff --git a/gendarme/man/Makefile.am b/gendarme/man/Makefile.am new file mode 100644 index 00000000..1da482b8 --- /dev/null +++ b/gendarme/man/Makefile.am @@ -0,0 +1,3 @@ +man_MANS = gendarme.1 +EXTRA_DIST = gendarme.1.in +DISTCLEANFILES = Makefile.in gendarme.1 diff --git a/gendarme/man/gendarme.1.in b/gendarme/man/gendarme.1.in new file mode 100644 index 00000000..9fd090f0 --- /dev/null +++ b/gendarme/man/gendarme.1.in @@ -0,0 +1,64 @@ +.\" +.\" Gendarme manual page. +.\" +.\" Author: +.\" Sebastien Pouliot <sebastien@ximian.com> +.\" +.\" Copyright (C) 2005-2006 Novell, Inc (http://www.novell.com) +.\" + +.de Sp +.if t .sp .5v +.if n .sp +.. +.TH Gendarme "Gendarme @VERSION@" +.SH NAME +Gendarme \- Rule-based assembly verifier +.SH SYNOPSIS +.PP +.B gendarme [--config configfile] [--set ruleset] [--log file | --xml file | --html file] [--quiet] [--debug] assemblies ... +.SH DESCRIPTION +\fIgendarme\fP is a rule-based assembly verifier. +.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 "--debug" +Enable debugging output. +.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-2006 Novell, Inc (http://www.novell.com) +.SH MAILING LISTS +Mailing lists are listed at the +http://www.mono-project.com/Mailing_Lists +.SH WEB SITE +http://www.mono-project.com/Gendarme +.SH SEE ALSO +.BR mono(1) |