1
.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
4
.\" ========================================================================
5
.de Sp \" Vertical space (when we can't use .PP)
9
.de Vb \" Begin verbatim text
14
.de Ve \" End verbatim text
18
.\" Set up some character translations and predefined strings. \*(-- will
19
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
21
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23
.\" nothing in troff, for use with C<>.
25
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
29
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
43
.\" Escape single quotes in literal strings from groff's Unicode transform.
47
.\" If the F register is turned on, we'll generate index entries on stderr for
48
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49
.\" entries marked with X<> in POD. Of course, you'll have to process the
50
.\" output yourself in some meaningful fashion.
53
. tm Index:\\$1\t\\n%\t"\\$2"
63
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64
.\" Fear. Run. Save yourself. No user-serviceable parts.
65
. \" fudge factors for nroff and troff
74
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80
. \" simple accents for nroff and troff
90
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
97
. \" troff and (daisy-wheel) nroff accents
98
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105
.ds ae a\h'-(\w'a'u*4/10)'e
106
.ds Ae A\h'-(\w'A'u*4/10)'E
107
. \" corrections for vroff
108
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110
. \" for low resolution devices (crt and lpr)
111
.if \n(.H>23 .if \n(.V>19 \
124
.\" ========================================================================
127
.TH PCV 1 "2008-12-21" "perl v5.10.0" "Picviz Documentation"
128
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129
.\" way too many mistakes in technical documents.
133
pcv \- Picviz console veritable tool
135
.IX Header "SYNOPSIS"
136
\&\fBpcv\fR \fB\-T\fRoutput_plugin [\fB\-R\fRrender_plugin] [\fBoptions\fR] file.pcv ['filter']
138
.IX Header "DESCRIPTION"
139
\&\fBpcv\fR allows to compile \s-1PCV\s0 files into a plugin choosen format, such as \fBsvg\fR, \fBcsv\fR, \fBpng\fR
142
\&\fB\-Tplugin\fR Replace '\fBplugin\fR' with a output plugin name. See plugin section
144
\&\fB\-Rplugin\fR Replace '\fBplugin\fR' with a render plugin name. See plugin section
146
\&\fBoptions\fR can be either one or several among:
148
\&\fB\-A argument\fR Provides arguments to the render and output plugin
150
\&\fB\-a\fR Displays \fBall\fR text along with lines
152
\&\fB\-d\fR Activates debug mode
154
\&\fB\-Ln\fR Draw text every n line
156
\&\fB\-l\fR Skip learning mode
158
\&\fB\-o file\fR Output to the given file instead of stdout
160
\&\fB\-p file\fR Use given file to store \s-1PID\s0
162
\&\fB\-r...(rrr)\fR Increases image height and width
164
\&\fB\-s socket.name\fR Create the socket.name and listen to it (for real-time capabilities)
166
\&\fB\-t template\fR Use the given template when listening to a socket
168
\&\fB\-Warg\fR Use Picviz \fBwith\fR a special keyword. See keywords section
170
The filter parameter is explained in the filter section below.
173
Plugins are located with ld, search path can be overridden with \s-1PICVIZ_PLUGINS_PATH\s0 environment
176
.IX Subsection "Output"
177
Output data in the wanted file format. Available plugins are:
191
.IX Subsection "Render"
192
Modify data rendering. Available plugins are:
194
\&\fBheatline\fR: possible arguments (\fB\-A\fR): virus
198
.IX Header "KEYWORDS"
199
Keywords are special parameters given to picviz to use a library along with parsing and rendering. This is
200
deactivated by default because it makes the program slow, but it may be very usefull in certain cases.
202
Following keywords are accepted:
204
\&\fBpcre\fR: activates pcre pattern matching for filtering (pcv \-Tsvg \-Wpcre file.pcv 'show value = \*(L".*foo.*\*(R" on axis 1')
207
pcv allows filtering to choose data you want to see displayed. When the pcv language parser is called,
208
a Pcv Image Filter (\s-1PIF\s0) is applied. It allows to filter either before any data is calculated (\fBdata filter\fR),
209
once calculated and before adding the line to the image (\fBpre line filter\fR) or, once other lines have been added
210
and ask for specific removales (\fBpost line filter\fR).
212
.IX Subsection "Relations"
213
Filter relation can be either:
226
.SS "Selecting plot value"
227
.IX Subsection "Selecting plot value"
228
\&\fBplot\fR: Will select the value, as plotted by the engine. Accepted values can be the y position on the axis or
229
the relative percentage.
231
\&'show plot > 100 on axis 3': will display only lines which have their plot on the axis 3 greater than 100
232
can be called like this:
234
Example: pcv \-Tsvg file.pcv 'show plot > 100 on axis 3'
236
By default, the image height is 500 pixels, so this filter is equivalent than > 100:
238
\&'show plot > 20% on axis 3'.
240
It is possible to filter using multi-criterion values:
242
\&'show plot > 20% on axis 3 and plot < 42 on axis 5'
243
.SS "Pattern matching"
244
.IX Subsection "Pattern matching"
245
Values can be selected, either with their original text string, or by using pattern matching. By default,
246
pattern matching is \fBnot\fR activated.
248
Pattern matching activated is done with \fB\-Wpcre\fR argument. To filter values with \fB[0\-9][aA].*\fR, you can type:
250
pcv \-Tsvg file.pcv \-Wpcre 'show value = \*(L"[0\-9][aA].*\*(R" on axis 1'.
252
Note that with string comparisons (with \fBvalue\fR), only the equal (=) relation is accepted.
255
\&\fBpcv\fR \-Tsvg file.pcv
257
\&\fBpcv\fR \-Tpngcairo file.pcv \-rrrr \-a > file.png
259
\&\fBpcv\fR \-Tpngcairo \-Rheatline \-Avirus file.pcv > file.svg
261
\&\fBpcv\fR \-Tpngcairo \-s local.sock \-t file.pcv \-o file.png ''
264
If you are sure you are not dealing with a feature, you can report \s-1BUGS\s0 using the trac ticketing system
265
available at \fBhttp://www.wallinfire.net/picviz\fR.
268
Man page written by Sebastien Tricaud \fBtoady gscore org\fR.
added
removed
doc/pcv.1
