From 131f20a0f7a1c91e214a71ef407825f5163f88a8 Mon Sep 17 00:00:00 2001 From: Michele Baldessari Date: Mon, 2 Mar 2015 20:34:26 +0100 Subject: [PATCH] Add missing manpage --- .gitignore | 1 - man/pcp2pdf.1 | 226 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 226 insertions(+), 1 deletion(-) create mode 100644 man/pcp2pdf.1 diff --git a/.gitignore b/.gitignore index 6796845..271e980 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,5 @@ outputs/ rpm-build.sh *.swp docs/_build -man/ *.egg-info src/pcp2pdf.egg-info/SOURCES.txt diff --git a/man/pcp2pdf.1 b/man/pcp2pdf.1 new file mode 100644 index 0000000..093856e --- /dev/null +++ b/man/pcp2pdf.1 @@ -0,0 +1,226 @@ +.\" Man page generated from reStructuredText. +. +.TH "PCP2PDF" "1" "March 02, 2015" "0.1" "pcp2pdf" +.SH NAME +pcp2pdf \- pcp2pdf Documentation +. +.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 +.. +.SH SYNOPSIS +.sp +\fBpcp2pdf\fP [\fIoptions\fP] \-a <\fIpcparchive\fP> +.SH DESCRIPTION +.sp +\fBpcp2pdf\fP generates a pdf report from a PCP archive. Per default, +the report contains a graph plotting each metric and its corresponding frequency +histogram. By default all the metrics contained in the archive will be plotted. +In order to limit or augment the plotted metrics in the report, use the +\fB\-\-include\fP, \fB\-\-exclude\fP or \fB\-\-custom\fP options. +.sp +\fBpcp2pdf\fP only operates on PCP archive files and cannot use live data. +.sp +\fBpcp2pdf\fP needs a locally running \fBpmcd\fP in order to fetch the +help text of each metric. Without it running the report won\(aqt have metrics help +text. +.SH OPTIONS +.INDENT 0.0 +.TP +.BI \-a \ +Sets the PCP archive name to be parsed +.TP +.BI \-i \ \fP,\fB \ \-\-include \ +Includes metrics which match the specified regular expression. +For example: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +\-\-include \(aqnetwork.*\(aq +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +will include only metrics starting with \(aqnetwork.\(aq. The option can be specified +multiple times. If only \fB\-\-include\fP is specified, only the matching metrics will +be included in the output. If both \fB\-\-include\fP and \fB\-\-exclude\fP are specified, +first all excluded metrics are evaluted, and then the ones explicitely included. +.TP +.BI \-e \ \fP,\fB \ \-\-exclude \ +Excludes metrics which match the specified regular expression. +For example: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +\-\-exclude \(aqproc.*\(aq +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +will exclude all metrics starting with \(aqproc.\(aq. The option can be specified +multiple times. If only \fB\-\-exclude\fP is specified, all metrics are shown except +the specified ones. +.TP +.BI \-c \ \fP,\fB \ \-\-custom \ +Add custom graphs with multiple metrics. +For example: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +\-\-custom \(aqtraffic:network.tcp.outrsts:.*,network.tcp.ofoqueue.*,network.interfaces.out.*:eth[0\-9]\(aq +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +will create a \(aqtraffic\(aq page with the each matched metric and the corresponding +matched indom single graph. The general syntax is the following: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +\-\-custom \(aq