summaryrefslogtreecommitdiffstats
path: root/doc/man/bcfg2-lint.txt
diff options
context:
space:
mode:
authorChris St. Pierre <chris.a.st.pierre@gmail.com>2012-11-07 13:34:35 -0500
committerChris St. Pierre <chris.a.st.pierre@gmail.com>2012-11-07 13:34:35 -0500
commita732f8499e1b21df4704d2d8b046c0c7dcc4f7a3 (patch)
tree638991e9865fcf2bfb7306384106dbbdb853d7c6 /doc/man/bcfg2-lint.txt
parentbf74317fdb4940eded368d12ce4e4877f72e3a45 (diff)
downloadbcfg2-a732f8499e1b21df4704d2d8b046c0c7dcc4f7a3.tar.gz
bcfg2-a732f8499e1b21df4704d2d8b046c0c7dcc4f7a3.tar.bz2
bcfg2-a732f8499e1b21df4704d2d8b046c0c7dcc4f7a3.zip
doc: made format of man page option lists consistent
Diffstat (limited to 'doc/man/bcfg2-lint.txt')
-rw-r--r--doc/man/bcfg2-lint.txt56
1 files changed, 26 insertions, 30 deletions
diff --git a/doc/man/bcfg2-lint.txt b/doc/man/bcfg2-lint.txt
index 1cfedad4e..b7206bd31 100644
--- a/doc/man/bcfg2-lint.txt
+++ b/doc/man/bcfg2-lint.txt
@@ -1,3 +1,4 @@
+.. -*- mode: rst -*-
.. vim: ft=rst
bcfg2-lint
@@ -27,36 +28,31 @@ tool.
Options
-------
--C *configfile*
- Specify alternate bcfg2.conf location.
-
--Q
- Specify the server repository path.
-
--v
- Be verbose.
-
---lint-config
- Specify path to bcfg2-lint.conf (default ``/etc/bcfg2-lint.conf``).
-
---stdin
- Rather than operating on all files in the Bcfg2 specification, only
- validate a list of files supplied on stdin. This mode is
- particularly useful in pre-commit hooks.
-
- This makes a few assumptions:
-
- Metadata files will only be checked if a valid chain of
- XIncludes can be followed all the way from clients.xml or
- groups.xml. Since there are multiple formats of metadata stored
- in Metadata/ (i.e., clients and groups), there is no way to
- determine which sort of data a file contains unless there is a
- valid chain of XIncludes. It may be useful to always specify all
- metadata files should be checked, even if not all of them have
- changed.
-
- Property files will only be validated if both the property file
- itself and its matching schema are included on stdin.
+-C configfile Specify alternate bcfg2.conf location.
+-Q path Specify the path to the server repository.
+-v Be verbose.
+--lint-config Specify path to bcfg2-lint.conf (default
+ ``/etc/bcfg2-lint.conf``).
+--stdin Rather than operating on all files in the Bcfg2
+ specification, only validate a list of files
+ supplied on stdin. This mode is particularly useful
+ in pre-commit hooks.
+
+ This makes a few assumptions:
+
+ Metadata files will only be checked if a valid chain
+ of XIncludes can be followed all the way from
+ clients.xml or groups.xml. Since there are multiple
+ formats of metadata stored in Metadata/ (i.e.,
+ clients and groups), there is no way to determine
+ which sort of data a file contains unless there is a
+ valid chain of XIncludes. It may be useful to always
+ specify all metadata files should be checked, even
+ if not all of them have changed.
+
+ Property files will only be validated if both the
+ property file itself and its matching schema are
+ included on stdin.
Plugins
-------