summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSol Jerome <sol.jerome@gmail.com>2013-07-27 16:51:38 -0500
committerSol Jerome <sol.jerome@gmail.com>2013-07-27 16:51:38 -0500
commit3435963a7c715bd3e6e912c6224fc8b893b1abe4 (patch)
treea2fe4be2435f5ff4f27d19e7b1f88a9c99ff612f
parent330f3ba3fa22b39ee1dcc6bbbbbe29a0a18778ab (diff)
downloadbcfg2-3435963a7c715bd3e6e912c6224fc8b893b1abe4.tar.gz
bcfg2-3435963a7c715bd3e6e912c6224fc8b893b1abe4.tar.bz2
bcfg2-3435963a7c715bd3e6e912c6224fc8b893b1abe4.zip
man: Add bcfg2-report-collector manpage
Signed-off-by: Sol Jerome <sol.jerome@gmail.com>
-rw-r--r--doc/conf.py2
-rw-r--r--doc/man/bcfg2-report-collector.txt40
-rw-r--r--doc/man/bcfg2-server.txt3
-rw-r--r--man/bcfg2-report-collector.879
-rw-r--r--man/bcfg2-server.85
5 files changed, 124 insertions, 5 deletions
diff --git a/doc/conf.py b/doc/conf.py
index 9862603d7..d1bb029d2 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -254,6 +254,8 @@ man_pages = [
[], 8),
('man/bcfg2-lint.conf', 'bcfg2-lint.conf',
'Configuration parameters for bcfg2-lint', [], 5),
+ ('man/bcfg2-report-collector', 'bcfg2-report-collector',
+ 'Reports collection daemon', [], 8),
('man/bcfg2-reports', 'bcfg2-reports',
'Query reporting system for client status', [], 8),
('man/bcfg2-server', 'bcfg2-server',
diff --git a/doc/man/bcfg2-report-collector.txt b/doc/man/bcfg2-report-collector.txt
new file mode 100644
index 000000000..07c618537
--- /dev/null
+++ b/doc/man/bcfg2-report-collector.txt
@@ -0,0 +1,40 @@
+.. -*- mode: rst -*-
+.. vim: ft=rst
+
+
+bcfg2-report-collector
+======================
+
+.. program:: bcfg2-report-collector
+
+Synopsis
+--------
+
+**bcfg2-report-collector** [*options*]
+
+Description
+-----------
+
+:program:`bcfg2-report-collector` runs a daemon to collect logs from the
+LocalFilesystem :ref:`Bcfg2 Reports <reports-dynamic>` transport object
+and add them to the Reporting storage backend.
+
+Options
+-------
+
+-C configfile Specify alternate bcfg2.conf location.
+-D pidfile Daemonize, placing the program pid in *pidfile*.
+-E encoding Specify the encoding of config files.
+-Q path Specify the path to the server repository.
+-W configfile Specify the path to the web interface
+ configuration file.
+-d Enable debugging output.
+-h Print usage information.
+-o path Set path of file log
+-v Run in verbose mode.
+--version Print the version and exit
+
+See Also
+--------
+
+:manpage:`bcfg2-server(8)`, :manpage:`bcfg2-reports(8)`
diff --git a/doc/man/bcfg2-server.txt b/doc/man/bcfg2-server.txt
index d5945cad6..3f8f3ea21 100644
--- a/doc/man/bcfg2-server.txt
+++ b/doc/man/bcfg2-server.txt
@@ -23,8 +23,7 @@ Options
-------
-C configfile Specify alternate bcfg2.conf location.
--D pidfile Daemonize, placing the program pid in the specified
- pidfile.
+-D pidfile Daemonize, placing the program pid in *pidfile*.
-E encoding Specify the encoding of config files.
-Q path Specify the path to the server repository.
-S server Manually specify the server location (as opposed to
diff --git a/man/bcfg2-report-collector.8 b/man/bcfg2-report-collector.8
new file mode 100644
index 000000000..195b15ec8
--- /dev/null
+++ b/man/bcfg2-report-collector.8
@@ -0,0 +1,79 @@
+.TH "BCFG2-REPORT-COLLECTOR" "8" "July 27, 2013" "1.3" "Bcfg2"
+.SH NAME
+bcfg2-report-collector \- Reports collection daemon
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.\" Man page generated from reStructuredText.
+.
+.SH SYNOPSIS
+.sp
+\fBbcfg2\-report\-collector\fP [\fIoptions\fP]
+.SH DESCRIPTION
+.sp
+\fBbcfg2\-report\-collector\fP runs a daemon to collect logs from the
+LocalFilesystem \fIBcfg2 Reports\fP transport object
+and add them to the Reporting storage backend.
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.BI \-C \ configfile
+Specify alternate bcfg2.conf location.
+.TP
+.BI \-D \ pidfile
+Daemonize, placing the program pid in \fIpidfile\fP.
+.TP
+.BI \-E \ encoding
+Specify the encoding of config files.
+.TP
+.BI \-Q \ path
+Specify the path to the server repository.
+.TP
+.BI \-W \ configfile
+Specify the path to the web interface
+configuration file.
+.TP
+.B \-d
+Enable debugging output.
+.TP
+.B \-h
+Print usage information.
+.TP
+.BI \-o \ path
+Set path of file log
+.TP
+.B \-v
+Run in verbose mode.
+.TP
+.B \-\-version
+Print the version and exit
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIbcfg2\-server(8)\fP, \fIbcfg2\-reports(8)\fP
+.\" Generated by docutils manpage writer.
+.
diff --git a/man/bcfg2-server.8 b/man/bcfg2-server.8
index 27f6a7b01..dcec03252 100644
--- a/man/bcfg2-server.8
+++ b/man/bcfg2-server.8
@@ -1,4 +1,4 @@
-.TH "BCFG2-SERVER" "8" "March 18, 2013" "1.3" "Bcfg2"
+.TH "BCFG2-SERVER" "8" "July 27, 2013" "1.3" "Bcfg2"
.SH NAME
bcfg2-server \- Server for client configuration specifications
.
@@ -46,8 +46,7 @@ configurations to clients based on the data in its repository.
Specify alternate bcfg2.conf location.
.TP
.BI \-D \ pidfile
-Daemonize, placing the program pid in the specified
-pidfile.
+Daemonize, placing the program pid in \fIpidfile\fP.
.TP
.BI \-E \ encoding
Specify the encoding of config files.