summaryrefslogtreecommitdiffstats
path: root/doc/man/bcfg2-reports.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-reports.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-reports.txt')
-rw-r--r--doc/man/bcfg2-reports.txt96
1 files changed, 40 insertions, 56 deletions
diff --git a/doc/man/bcfg2-reports.txt b/doc/man/bcfg2-reports.txt
index dbc937711..201a379df 100644
--- a/doc/man/bcfg2-reports.txt
+++ b/doc/man/bcfg2-reports.txt
@@ -1,3 +1,4 @@
+.. -*- mode: rst -*-
.. vim: ft=rst
bcfg2-reports
@@ -25,8 +26,7 @@ standalone application. It does, however, use the models from
Options
-------
--h
- Shows help and usage info about :program:`bcfg2-reports`.
+-h Print usage information.
Modes
-----
@@ -36,74 +36,58 @@ The following are various modes available for :program:`bcfg2-reports`.
Single-Host Modes
+++++++++++++++++
--b, --bad *hostname*
- Shows bad entries from the current interaction of *hostname*.
-
--e, --extra *hostname*
- Shows extra entries from the current interaction of *hostname*.
-
--m, --modified *hostname*
- Shows modified entries from the current interaction of *hostname*.
-
--s, --show *hostname*
- Shows bad, modified, and extra entries from the current interaction
- of *hostname*.
-
--t, --total *hostname*
- Shows total number of managed and good entries from the current
- interaction of *hostname*.
-
--x, --expire *hostname*
- Toggles expired/unexpired state of *hostname*.
-
--a, --all
- Show all hosts, including expired hosts.
+-b, --bad hostname Shows bad entries from the current
+ interaction of *hostname*.
+-e, --extra hostname Shows extra entries from the current
+ interaction of *hostname*.
+-m, --modified hostname Shows modified entries from the current
+ interaction of *hostname*.
+-s, --show hostname Shows bad, modified, and extra entries from
+ the current interaction of *hostname*.
+-t, --total hostname Shows total number of managed and good
+ entries from the current interaction of
+ *hostname*.
+-x, --expire hostname Toggles expired/unexpired state of
+ *hostname*.
+-a, --all Show all hosts, including expired hosts.
Host Selection Modes
++++++++++++++++++++
--a, --all
- Show all hosts, including expired hosts.
-
--c, --clean
- Show only clean hosts.
-
--d, --dirty
- Show only dirty hosts.
-
---stale
- Show hosts that haven't run in the last 24 hours.
+-a, --all Show all hosts, including expired hosts.
+-c, --clean Show only clean hosts.
+-d, --dirty Show only dirty hosts.
+--stale Show hosts that haven't run in the last 24 hours.
Entry Modes
+++++++++++
---badentry=\ *entry type, entry name*
- Shows only hosts whose current interaction has bad entries of type
- *entry type* and name *entry name*.
-
---extraentry=\ *entry type, entry name*
- Shows only hosts whose current interaction has extra entries of type
- *entry type* and name *entry name*.
-
---entrystatus=\ *entry type, entry name*
- Shows the status of entry type *entry type* and name *entry name*
- on all hosts.
-
---modifiedentry
- Shows only hosts whose current interaction has modifiedentries of
- type *entry type* and name *entry name*.
+The following mode flags require either a comma-delimited list of any
+number of *<entry type>:<entry name>* arguments describing entries, or
+the *--file* option.
+
+--badentry=entrylist Shows only hosts whose current interaction
+ has bad entries matching the given entry or
+ entries.
+--extraentry=entrylist Shows only hosts whose current interaction
+ has extra entries matching the given entry
+ or entries.
+--entrystatus=entry Shows the status of the single entry (given
+ by *<entry type>:<entry name>*) on all
+ hosts.
+--modifiedentry=entrylist Shows only hosts whose current interaction
+ has modified entries matching the given
+ entry or entries.
Entry Options
^^^^^^^^^^^^^
The following options can be used with the above Entry Modes.
---fields=\ *FIELD,FIELD,...*
- Only display the listed fields.
-
---file=\ *FILE*
- Read TYPE:NAME pairs from the specified file instead of the command
- line.
+--fields=fields Only display the listed fields. Takes a
+ comma-delimited list of field names
+--file=file Read *<entry type>:<entry name>* pairs from the
+ specified file instead of the command line.
See Also
--------