gendarme(5) [suse man page]

Gendarme(Gendarme 2.6.2.0)												Gendarme(Gendarme 2.6.2.0)

NAME

       Gendarme - Rule-based code analysis for Mono.

FILE FORMATS

       ignore-file
	      This file is used to filter out defects from gendarme reports. It uses a line oriented file format where the first characters of the
	      line control the interpretation of the line:
	      # - means that the line is a comment.
	      R: - if the full name of a rule to be filtered.
	      A: - is used to filter out an assembly (the extension can be omitted).
	      T: - is used to filter out a namespace qualified type name.
	      M: - is used to filter out a method. It must contain the full method name as it appears in the report.

       rules.xml
	      This file is used in conjunction with the --set option to control and configure the rules used by Gendarme. It  contains	a  set	of
	      named  rules  (rule  sets)  and  each  rule  set contains a list of rules. Rules have required from and include attributes, optional
	      exclude and applyTo attributes, and optional parameter child elements.

	      The from attribute is the path of a dll to load ("Gendarme.Rules.BadPractice.dll").  Relative paths are  relative  to  the  gendarme
	      executable.

	      The include attribute may be "*" to match every rule in the dll or a list of rule names separated by '|' ("WhizBangRule | MyRule").

	      The  exclude  attribute is a list of rule names separated by '|' ("IckyRule").  These will override any rules matched by the include
	      attribute.

	      The applyTo attribute may be "all", "visible", or "nonvisible". If it is all (the default) then all  types  in  the  assemblies  are
	      checked,	if  it is visible then only the externally visible types are checked, if it is nonvisible then only the internally visible
	      types are checked.

	      The parameter child element is used to customize the behavior of a rule within a dll.  It has three required attributes: rule, prop-
	      erty,  and  value. rule is the name of the applicable rule ("AvoidSmallNamespaceRule"), property is the name of a public property in
	      the rule ("Minimum"), value is the value to assign to the property ("10").

       gendarme.exe.config
	      Used by debug versions of Gendarme to enable logging for rules. A config file will be generated automatically by the make  file.	To
	      enable logging for a rule edit the config file, add a switch using the rule's name, and set the value to 1.

COPYRIGHT

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

MAILING LISTS

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

WEB SITE

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

SEE ALSO

       gendarme(1)

															Gendarme(Gendarme 2.6.2.0)

vxse(1M)																  vxse(1M)

NAME

       vxse - Storage Expert rules

SYNOPSIS

       /opt/VRTS/vxse/vxvm/vxse_rule [-g diskgroup] [-d defaults_file] [-v] check

       /opt/VRTS/vxse/vxvm/vxse_rule [-g diskgroup] [-d defaults_file] [-v] info

       /opt/VRTS/vxse/vxvm/vxse_rule [-g diskgroup] [-d defaults_file] [-v] list

       /opt/VRTS/vxse/vxvm/vxse_rule [-g diskgroup] [-d defaults_file] [-v] run [attribute=value...]

DESCRIPTION

       Storage	Expert	consists  of a set of simple commands that collects VxVM configuration data and compares it with "best practice."  Storage
       Expert then produces a summary report that shows which objects do not meet these criteria and makes recommendations for VxVM  configuration
       improvements.

       These  user-configurable tools help you as an administrator to verify and validate systems and non-optimal configurations in both small and
       large VxVM installations.

       Storage Expert components include a set of rule scripts and a rules engine.  The rules engine runs the scripts and produces  ASCII  output,
       which  is  organized and archived by Storage Expert's report generator.	This output contains information about areas of VxVM configuration
       that do not meet the set criteria.  By default, output is sent to the screen, but you can redirect it to a file using standard  UNIX  redi-
       rection.

KEYWORDS

       check	 Lists the default values used by a rule's attributes.

       info	 Describes what a rule does.

       list	 Lists the attributes of a rule that can be set.

       run	 Runs a rule.  If one or more attribute-value pairs are specified, these override the values set in the defaults file.

OPTIONS

       -d defaults_file
		 Specifies an alternate default attribute-values file to the standard file, /etc/default/vxse.

       -g diskgroup
		 Specifies the disk group to be examined instead of the default disk group (see vxdg(1M)).

       -v	 Specifies verbose output format.

EXAMPLES

       Note:  The  executable  rule  files  are located in the directory, /opt/VRTS/vxse/vxvm.	These examples assume that this directory has been
       added to the PATH variable.

       Discover what the vxse_stripes2 rule does:

	      vxse_stripes2 info

       Display the attributes that are available for the vxse_drl1 rule:

	      vxse_drl1 list

       Display the default values of the attributes for the vxse_stripes2 rule:

	      vxse_stripes2 check

       Run the vxse_volplex rule on the mydg disk group:

	      vxse_volplex -g mydg run

       Run the vxse_drl2 rule on the mydg disk group with the value of the large_mirror_size attribute set to 30MB:

	      vxse_drl2 -g mydg run large_mirror_size=30m

       Run the vxse_srl2 rule using the default attribute values that are set in the file mydefaultsfile:

	      vxse_drl2 -d mydefaultsfile -g mydg run

FILES

       /etc/default/vxse   Standard attribute values file for vxse rules.

       /opt/VRTS/vxse/vxvm Directory containing executable rules.

NOTES

       See the "Using Veritas Storage Expert" chapter in the Veritas Volume Manager Administrator's Guide for a description of the rules and their
       attributes.

SEE ALSO

       vxdg(1M), vxintro(1M)

       Veritas Volume Manager Administrator's Guide

VxVM 5.0.31.1							    24 Mar 2008 							  vxse(1M)