diff options
author | Sol Jerome <sol.jerome@gmail.com> | 2012-11-06 17:08:29 -0600 |
---|---|---|
committer | Sol Jerome <sol.jerome@gmail.com> | 2012-11-06 17:11:30 -0600 |
commit | 3d8cd6ef61524b3d8e3edf55da25ad0f252c085c (patch) | |
tree | 91415649412ad858a580e69dbd7c4638d8fb97a2 /doc/man/bcfg2-build-reports.txt | |
parent | b7294206ffd1248997679eaaf5daa53a0a315054 (diff) | |
download | bcfg2-3d8cd6ef61524b3d8e3edf55da25ad0f252c085c.tar.gz bcfg2-3d8cd6ef61524b3d8e3edf55da25ad0f252c085c.tar.bz2 bcfg2-3d8cd6ef61524b3d8e3edf55da25ad0f252c085c.zip |
doc: Add man pages to Sphinx documentation
This allows you to generate our manpages directly from the Sphinx
documentation. This commit is more or less copied directly from the
current man pages.
The goal is to integrate these more closely with the current Sphinx
documentation via include directives to prevent duplication and keep all
documentation consistent.
Signed-off-by: Sol Jerome <sol.jerome@gmail.com>
Diffstat (limited to 'doc/man/bcfg2-build-reports.txt')
-rw-r--r-- | doc/man/bcfg2-build-reports.txt | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/man/bcfg2-build-reports.txt b/doc/man/bcfg2-build-reports.txt new file mode 100644 index 000000000..8d859fe26 --- /dev/null +++ b/doc/man/bcfg2-build-reports.txt @@ -0,0 +1,39 @@ +.. vim: ft=rst + +bcfg2-build-reports +=================== + +.. program:: bcfg2-build-reports + +Synopsis +-------- + +**bcfg2-build-reports** [*-A*] [*-c*] [*-s*] + +Description +----------- + +:program:`bcfg2-build-reports` is used to build all client state +reports. See the Bcfg2 manual for report setup information. + +Options +------- + +-A + Displays all data. + +-c *configuration file* + Specify an alternate report configuration path. The default is + `repo/etc/reports-configuration.xml`. + +-h + Produce a help message. + +-s *statistics path* + Use an alternative path for the statistics file. The default is + `repo/etc/statistics.xml`. + +See Also +-------- + +:manpage:`bcfg2(1)`, :manpage:`bcfg2-server(8)` |