.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "PCV 1"
.TH PCV 1 "2008-12-21" "perl v5.10.0" "Picviz Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
pcv \- Picviz console veritable tool
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBpcv\fR \fB\-T\fRoutput_plugin [\fB\-R\fRrender_plugin] [\fBoptions\fR] file.pcv ['filter']
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBpcv\fR allows to compile \s-1PCV\s0 files into a plugin choosen format, such as \fBsvg\fR, \fBcsv\fR, \fBpng\fR
or other.
.PP
\&\fB\-Tplugin\fR Replace '\fBplugin\fR' with a output plugin name. See plugin section
.PP
\&\fB\-Rplugin\fR Replace '\fBplugin\fR' with a render plugin name. See plugin section
.PP
\&\fBoptions\fR can be either one or several among:
.PP
\&\fB\-A argument\fR Provides arguments to the render and output plugin
.PP
\&\fB\-a\fR Displays \fBall\fR text along with lines
.PP
\&\fB\-d\fR Activates debug mode
.PP
\&\fB\-Ln\fR Draw text every n line
.PP
\&\fB\-l\fR Skip learning mode
.PP
\&\fB\-o file\fR Output to the given file instead of stdout
.PP
\&\fB\-p file\fR Use given file to store \s-1PID\s0
.PP
\&\fB\-r...(rrr)\fR Increases image height and width
.PP
\&\fB\-s socket.name\fR Create the socket.name and listen to it (for real-time capabilities)
.PP
\&\fB\-t template\fR Use the given template when listening to a socket
.PP
\&\fB\-Warg\fR Use Picviz \fBwith\fR a special keyword. See keywords section
.PP
The filter parameter is explained in the filter section below.
.SH "PLUGINS"
.IX Header "PLUGINS"
Plugins are located with ld, search path can be overridden with \s-1PICVIZ_PLUGINS_PATH\s0 environment
variable.
.SS "Output"
.IX Subsection "Output"
Output data in the wanted file format. Available plugins are:
.PP
\&\fBsvg\fR
.PP
\&\fBplplot\fR
.PP
\&\fBcsv\fR
.PP
\&\fBsdl\fR
.PP
\&\fBpngcairo\fR
.PP
\&\fBdebug\fR
.SS "Render"
.IX Subsection "Render"
Modify data rendering. Available plugins are:
.PP
\&\fBheatline\fR: possible arguments (\fB\-A\fR): virus
.PP
\&\fBdebug\fR
.SH "KEYWORDS"
.IX Header "KEYWORDS"
Keywords are special parameters given to picviz to use a library along with parsing and rendering. This is
deactivated by default because it makes the program slow, but it may be very usefull in certain cases.
.PP
Following keywords are accepted:
.PP
\&\fBpcre\fR: activates pcre pattern matching for filtering (pcv \-Tsvg \-Wpcre file.pcv 'show value = \*(L".*foo.*\*(R" on axis 1')
.SH "FILTER"
.IX Header "FILTER"
pcv allows filtering to choose data you want to see displayed. When the pcv language parser is called,
a Pcv Image Filter (\s-1PIF\s0) is applied. It allows to filter either before any data is calculated (\fBdata filter\fR),
once calculated and before adding the line to the image (\fBpre line filter\fR) or, once other lines have been added
and ask for specific removales (\fBpost line filter\fR).
.SS "Relations"
.IX Subsection "Relations"
Filter relation can be either:
.PP
= equal
.PP
!= not equal
.PP
< less than
.PP
> greater than
.PP
<= less or equal
.PP
>= greater or equal
.SS "Selecting plot value"
.IX Subsection "Selecting plot value"
\&\fBplot\fR: Will select the value, as plotted by the engine. Accepted values can be the y position on the axis or
the relative percentage.
.PP
\&'show plot > 100 on axis 3': will display only lines which have their plot on the axis 3 greater than 100
can be called like this:
.PP
Example: pcv \-Tsvg file.pcv 'show plot > 100 on axis 3'
.PP
By default, the image height is 500 pixels, so this filter is equivalent than > 100:
.PP
\&'show plot > 20% on axis 3'.
.PP
It is possible to filter using multi-criterion values:
.PP
\&'show plot > 20% on axis 3 and plot < 42 on axis 5'
.SS "Pattern matching"
.IX Subsection "Pattern matching"
Values can be selected, either with their original text string, or by using pattern matching. By default,
pattern matching is \fBnot\fR activated.
.PP
Pattern matching activated is done with \fB\-Wpcre\fR argument. To filter values with \fB[0\-9][aA].*\fR, you can type:
.PP
pcv \-Tsvg file.pcv \-Wpcre 'show value = \*(L"[0\-9][aA].*\*(R" on axis 1'.
.PP
Note that with string comparisons (with \fBvalue\fR), only the equal (=) relation is accepted.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
\&\fBpcv\fR \-Tsvg file.pcv
.PP
\&\fBpcv\fR \-Tpngcairo file.pcv \-rrrr \-a > file.png
.PP
\&\fBpcv\fR \-Tpngcairo \-Rheatline \-Avirus file.pcv > file.svg
.PP
\&\fBpcv\fR \-Tpngcairo \-s local.sock \-t file.pcv \-o file.png ''
.SH "BUGS"
.IX Header "BUGS"
If you are sure you are not dealing with a feature, you can report \s-1BUGS\s0 using the trac ticketing system
available at \fBhttp://www.wallinfire.net/picviz\fR.
.SH "AUTHORS"
.IX Header "AUTHORS"
Man page written by Sebastien Tricaud \fBtoady gscore org\fR.