diff options
author | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2011-04-21 08:50:06 -0400 |
---|---|---|
committer | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2011-04-21 08:50:06 -0400 |
commit | 6da7d24710fe67c80c4a71f227cd01675eebca88 (patch) | |
tree | f8aae1f09b879d58e8fab10db1b896284b44e32d /man/bcfg2-lint.conf.5 | |
parent | 57f6972c4ff063a0fdeff832772af8c18f2ea044 (diff) | |
download | bcfg2-6da7d24710fe67c80c4a71f227cd01675eebca88.tar.gz bcfg2-6da7d24710fe67c80c4a71f227cd01675eebca88.tar.bz2 bcfg2-6da7d24710fe67c80c4a71f227cd01675eebca88.zip |
Lots of cleanup for bcfg2-repo-validate rewrite:
* Changed all references to bcfg2-repo-validate in the documentation
to bcfg2-lint
* Wrote man pages for bcfg2-lint and bcfg2-lint.conf
* Cleaned up straggling references to bcfg2-repo-validate in
Makefiles, spec files, and the POSIX tool
* A few minor bug fixes
Diffstat (limited to 'man/bcfg2-lint.conf.5')
-rw-r--r-- | man/bcfg2-lint.conf.5 | 155 |
1 files changed, 155 insertions, 0 deletions
diff --git a/man/bcfg2-lint.conf.5 b/man/bcfg2-lint.conf.5 new file mode 100644 index 000000000..2c89a1161 --- /dev/null +++ b/man/bcfg2-lint.conf.5 @@ -0,0 +1,155 @@ +.TH bcfg2-lint.conf 5 + +.SH NAME +bcfg2-lint.conf - configuration parameters for bcfg2-lint + +.SH DESCRIPTION +.TP +bcfg2-lint.conf includes configuration parameters for +.I bcfg2-lint + +.SH FILE FORMAT +The file is INI-style and consists of sections and options. A section +begins with the name of the sections in square brackets and continues +until the next section begins. + +Options are specified in the form 'name = value'. + +The file is line-based each newline-terminated line represents either +a comment, a section name or an option. + +Any line beginning with a hash (#) is ignored, as are lines containing +only whitespace. + +.SH GLOBAL OPTIONS +These options apply to +.I bcfg2-lint +generally, and must be in the +.I [main] +section. + +.TP +.BR plugins +A comma-delimited list of plugins to run. By default, all plugins are +run. This can be overridden by listing plugins on the command line. +See +.B bcfg2-lint(1) +for a list of the available plugins. + +.SH PLUGIN OPTIONS + +These options apply only to a single plugin. Each option should be in +a section named for its plugin; for instance, options for the InfoXML +plugin would be in a section called +.I [InfoXML] +. + +If a plugin is not listed below, then it has no configuration. + +.TP +.BR Comments + +The +.I Comments +plugin configuration specifies which VCS keywords and comments are +required for which file types. The valid types of file are +.I "global" +(all file types), +.I "bundler" +(non-templated bundle files), +.I "sgenshi" +(templated bundle files), +.I "properties" +(property files), +.I "cfg" +(non-templated Cfg files), +.I "tgenshi" +(templated Cfg files), +.I "infoxml" +(info.xml files), and +.I "probe" +(probe files). + +The specific types (i.e., types other than "global") all supplement +global; they do not override it. The exception is if you specify an +empty option, e.g.: + +.nf +cfg_keywords = +.fi + +By default, the +.I $Id$ +keyword is checked for and nothing else. + +Multiple keywords or comments should be comma-delimited. + +\(bu +.B <type>_keywords + +Ensure that files of the specified type have the given VCS keyword. +Do +.I not +include the dollar signs. I.e.: + +.nf +infoxml_keywords = Revision +.fi + +.I not: + +.nf +infoxml_keywords = $Revision$ +.fi + +\(bu +.B <type>_comments + +Ensure that files of the specified type have a comment containing the +given string. In XML files, only comments are checked. In plain text +files, all lines are checked since comment characters may vary. + +.TP +.BR InfoXML + +\(bu +.B required_attrs +A comma-delimited list of attributes to require on +.I <Info> +tags. Default is "owner,group,perms". + +\(bu +.B require_paranoid +Ensure that paranoid mode is on for all files. This can be +accomplished by either setting the global paranoid value (and not +overriding it. Default is false. + +\(bu +.B require +Require an +.I info.xml +file for all Cfg files. Default is false. + +.TP +.BR Validate + +\(bu +.B schema +The full path to the XML Schema files. Default is +"/usr/share/bcfg2/schema". This can be overridden with the +.I --schema +command-line option + +\(bu +.B properties_schema +If set to +.I "warn" +, will warn if a property files does not have a matching schema file. +If set to +.I "require" +, will produce an error if a property files does not have a matching +schema file. Default is to neither warn nor require. + +.SH SEE ALSO +.BR bcfg2-lint(1) + |