From 3d8cd6ef61524b3d8e3edf55da25ad0f252c085c Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Tue, 6 Nov 2012 17:08:29 -0600 Subject: 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 --- doc/man/bcfg2-build-reports.txt | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 doc/man/bcfg2-build-reports.txt (limited to 'doc/man/bcfg2-build-reports.txt') 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)` -- cgit v1.2.3-1-g7c22