diff options
author | Sol Jerome <sol.jerome@gmail.com> | 2012-06-03 16:58:00 -0500 |
---|---|---|
committer | Sol Jerome <sol.jerome@gmail.com> | 2012-06-03 16:58:00 -0500 |
commit | 9a6cae4e5ed2c8615c17d462d5aa5b7828cdb23b (patch) | |
tree | a640aba51d2e1e4e9a80764dbe00f676d165b86f /man/bcfg2-lint.conf.5 | |
parent | 55a09f413871f6f8288a2f2f1d14b5831e3acaf5 (diff) | |
download | bcfg2-9a6cae4e5ed2c8615c17d462d5aa5b7828cdb23b.tar.gz bcfg2-9a6cae4e5ed2c8615c17d462d5aa5b7828cdb23b.tar.bz2 bcfg2-9a6cae4e5ed2c8615c17d462d5aa5b7828cdb23b.zip |
man: Clean up man pages
Created new rst files with man page information so that generating man
pages is easier and more consistent throughout bcfg2.
Signed-off-by: Sol Jerome <sol.jerome@gmail.com>
Diffstat (limited to 'man/bcfg2-lint.conf.5')
-rw-r--r-- | man/bcfg2-lint.conf.5 | 259 |
1 files changed, 92 insertions, 167 deletions
diff --git a/man/bcfg2-lint.conf.5 b/man/bcfg2-lint.conf.5 index 10a812874..467a717b0 100644 --- a/man/bcfg2-lint.conf.5 +++ b/man/bcfg2-lint.conf.5 @@ -1,174 +1,99 @@ -.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. - -The file consists of one -.I [lint] -section, up to one -.I [errors] -section, and then any number of plugin-specific sections, documented below. (Note that this makes it quite feasible to combine your -.B bcfg2-lint.conf -into your -.B bcfg2.conf(5) -file, if you so desire.) - -.SH GLOBAL OPTIONS -These options apply to -.I bcfg2-lint -generally, and must be in the -.I [lint] -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(8) -for a list of the available plugins. - -.SH ERROR HANDLING -Error handling is configured in the -.I [errors] -section. Each option should be the name of an error and one of -.I "error" -, -.I "warning" -, or -.I "silent" -, which tells -.B bcfg2-lint(8) -how to handle the warning. Error names and their defaults can be -displayed by running -.B bcfg2-lint(8) -with the -.B --list-errors -option. - -.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. - -In many cases, the behavior of a plugin can be configured by modifying -how errors from it are handled. See -.B ERROR HANDLING -, above. - +. +.TH "BCFG2\-LINT\.CONF" "5" "June 2012" "" "" +. +.SH "NAME" +\fBbcfg2\-lint\.conf\fR \- configuration parameters for bcfg2\-lint +. +.SH "DESCRIPTION" +\fBbcfg2\-lint\.conf\fR includes configuration parameters for \fBbcfg2\-lint\fR\. +. +.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\. +. +.P +Options are specified in the form "name=value"\. +. +.P +The file is line\-based each newline\-terminated line represents either a comment, a section name or an option\. +. +.P +Any line beginning with a hash (#) is ignored, as are lines containing only whitespace\. +. +.P +The file consists of one \fB[lint]\fR section, up to one \fB[errors]\fR section, and then any number of plugin\-specific sections, documented below\. (Note that this makes it quite feasible to combine your \fBbcfg2\-lint\.conf\fR into your \fBbcfg2\.conf\fR(5) file, if you so desire)\. +. +.SH "GLOBAL OPTIONS" +These options apply to \fBbcfg2\-lint\fR generally, and must be in the \fB[lint]\fR section\. +. .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 +\fBplugins\fR +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 \fBbcfg2\-lint\fR(8) for a list of the available plugins\. +. +.SH "ERROR HANDLING" +Error handling is configured in the \fB[errors]\fR section\. Each option should be the name of an error and one of \fIerror\fR, \fIwarning\fR, or \fIsilent\fR, which tells \fBbcfg2\-lint\fR(8) how to handle the warning\. Error names and their defaults can be displayed by running \fBbcfg2\-lint\fR(8) with the \fB\-\-list\-errors\fR option\. +. +.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 \fB[InfoXML]\fR\. +. +.P +If a plugin is not listed below, then it has no configuration\. +. +.P +In many cases, the behavior of a plugin can be configured by modifying how errors from it are handled\. See \fI\fBERROR HANDLING\fR\fR, above\. +. +.SS "Comments" +The \fBComments\fR plugin configuration specifies which VCS keywords and comments are required for which file types\. The valid types of file are \fIglobal\fR (all file types), \fIbundler\fR (non\-templated bundle files), \fIsgenshi\fR (templated bundle files), \fIproperties\fR (property files), \fIcfg\fR (non\-templated Cfg files), \fItgenshi\fR (templated Cfg files), \fIinfoxml\fR (info\.xml files), and \fIprobe\fR (probe files)\. +. +.P +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\.: +. +.P 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 +. +.P +By default, the \fI$Id$\fR keyword is checked for and nothing else\. +. +.P +Multiple keywords or comments should be comma\-delimited\. +. +.P +· \fB<type>_keywords\fR +. +.P +Ensure that files of the specified type have the given VCS keyword\. Do \fInot\fR include the dollar signs\. I\.e\.: +. +.P infoxml_keywords = Revision -.fi - -.I not: - -.nf +. +.P +\fInot\fR: +. +.P 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. - +. +.P +\fB· <type>_comments\fR +. +.P +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\. +. +.SS "InfoXML" +. .TP -.BR InfoXML - -\(bu -.B required_attrs -A comma-delimited list of attributes to require on -.I <Info> -tags. Default is "owner,group,perms". - +\fBrequired_attrs\fR +A comma\-delimited list of attributes to require on \fB<Info>\fR tags\. Default is "owner,group,perms"\. +. +.SS "MergeFiles" +. .TP -.BR MergeFiles - -\(bu -.B threshold -The threshold at which MergeFiles will suggest merging config files -and probes. Default is 75% similar. - +\fBthreshold\fR +The threshold at which MergeFiles will suggest merging config files and probes\. Default is 75% similar\. +. +.SS "Validate" +. .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 - -.SH SEE ALSO -.BR bcfg2-lint(8) - +\fBschema\fR +The full path to the XML Schema files\. Default is \fB/usr/share/bcfg2/schema\fR\. This can be overridden with the \fI\-\-schema\fR command\-line option +. +.SH "SEE ALSO" +bcfg2\-lint(8) |