zhangyiss/feedgnuplot
1
0
Fork 0
mirror of https://github.com/dkogan/feedgnuplot.git synced 2025-05-05 22:11:12 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs now escape cmdline options with C<>

Browse Source
This commit is contained in:
Dima Kogan 2014-01-24 15:47:34 -08:00
parent c21c4d7e70
commit f38a00bfd1
1 changed files with 76 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

151
bin/feedgnuplot
View File

@ -1085,7 +1085,7 @@ interpreted as the I<X>-value for the rest of the data on that line. Without
C<--domain> the I<X>-value is the line number, and the first value on a line is C<--domain> the I<X>-value is the line number, and the first value on a line is
a plain data point like the others. Default is C<--nodomain>. Thus the original a plain data point like the others. Default is C<--nodomain>. Thus the original
example above produces 2 curves, with B<1,2,3,4,5> as the I<X>-values. If we run example above produces 2 curves, with B<1,2,3,4,5> as the I<X>-values. If we run
the same command with --domain: the same command with C<--domain>:
$ seq 5 | awk '{print 2*$1, $1*$1}' | feedgnuplot --domain $ seq 5 | awk '{print 2*$1, $1*$1}' | feedgnuplot --domain
@ -1305,14 +1305,14 @@ it to the plotter.
=item =item
--[no]domain --C<[no]domain>
If enabled, the first element of each line is the domain variable. If not, the If enabled, the first element of each line is the domain variable. If not, the
point index is used point index is used
=item =item
--[no]dataid --C<[no]dataid>
If enabled, each data point is preceded by the ID of the data set that point If enabled, each data point is preceded by the ID of the data set that point
corresponds to. This ID is interpreted as a string, NOT as just a number. If not corresponds to. This ID is interpreted as a string, NOT as just a number. If not
@ -1324,23 +1324,23 @@ As an example, if line 3 of the input is "0 9 1 20" then
=item =item
'--nodomain --nodataid' would parse the 4 numbers as points in 4 different C<--nodomain --nodataid> would parse the 4 numbers as points in 4 different
curves at x=3 curves at x=3
=item =item
'--domain --nodataid' would parse the 4 numbers as points in 3 different C<--domain --nodataid> would parse the 4 numbers as points in 3 different
curves at x=0. Here, 0 is the x-variable and 9,1,20 are the data values curves at x=0. Here, 0 is the x-variable and 9,1,20 are the data values
=item =item
'--nodomain --dataid' would parse the 4 numbers as points in 2 different C<--nodomain --dataid> would parse the 4 numbers as points in 2 different
curves at x=3. Here 0 and 1 are the data IDs and 9 and 20 are the curves at x=3. Here 0 and 1 are the data IDs and 9 and 20 are the
data values data values
=item =item
'--domain --dataid' would parse the 4 numbers as a single point at C<--domain --dataid> would parse the 4 numbers as a single point at
x=0. Here 9 is the data ID and 1 is the data value. 20 is an extra x=0. Here 9 is the data ID and 1 is the data value. 20 is an extra
value, so it is ignored. If another value followed 20, we'd get another value, so it is ignored. If another value followed 20, we'd get another
point in curve ID 20 point in curve ID 20
@ -1349,20 +1349,20 @@ point in curve ID 20
=item =item
--[no]3d C<--[no]3d>
Do [not] plot in 3D. This only makes sense with --domain. Each domain here is an Do [not] plot in 3D. This only makes sense with C<--domain>. Each domain here is
(x,y) tuple an (x,y) tuple
=item =item
--timefmt [format] --C<timefmt [format]>
Interpret the X data as a time/date, parsed with the given format Interpret the X data as a time/date, parsed with the given format
=item =item
--colormap C<--colormap>
Show a colormapped xy plot. Requires extra data for the color. zmin/zmax can be Show a colormapped xy plot. Requires extra data for the color. zmin/zmax can be
used to set the extents of the colors. Automatically increments used to set the extents of the colors. Automatically increments
@ -1370,7 +1370,7 @@ C<--extraValuesPerPoint>
=item =item
--stream [period] C<--stream [period]>
Plot the data as it comes in, in realtime. If period is given, replot every Plot the data as it comes in, in realtime. If period is given, replot every
period seconds. If no period is given, replot at 1Hz. If the period is given as period seconds. If no period is given, replot at 1Hz. If the period is given as
@ -1379,19 +1379,19 @@ L</"Real-time streaming data"> section of the man page.
=item =item
--[no]lines C<--[no]lines>
Do [not] draw lines to connect consecutive points Do [not] draw lines to connect consecutive points
=item =item
--[no]points C<--[no]points>
Do [not] draw points Do [not] draw points
=item =item
--circles C<--circles>
Plot with circles. This requires a radius be specified for each point. Plot with circles. This requires a radius be specified for each point.
Automatically increments C<--extraValuesPerPoint>). C<Not> supported for 3d Automatically increments C<--extraValuesPerPoint>). C<Not> supported for 3d
@ -1399,35 +1399,35 @@ plots.
=item =item
--title xxx C<--title xxx>
Set the title of the plot Set the title of the plot
=item =item
--legend curveID legend C<--legend curveID legend>
Set the label for a curve plot. Use this option multiple times for multiple Set the label for a curve plot. Use this option multiple times for multiple
curves. With --dataid, curveID is the ID. Otherwise, it's the index of the curves. With C<--dataid>, curveID is the ID. Otherwise, it's the index of the
curve, starting at 0 curve, starting at 0
=item =item
--autolegend C<--autolegend>
Use the curve IDs for the legend. Titles given with --legend override these Use the curve IDs for the legend. Titles given with C<--legend> override these
=item =item
--xlen xxx C<--xlen xxx>
When using --stream, sets the size of the x-window to plot. Omit this or set it When using C<--stream>, sets the size of the x-window to plot. Omit this or set
to 0 to plot ALL the data. Does not make sense with 3d plots. Implies it to 0 to plot ALL the data. Does not make sense with 3d plots. Implies
--monotonic C<--monotonic>
=item =item
--xmin/xmax/ymin/ymax/y2min/y2max/zmin/zmax xxx C<--xmin/xmax/ymin/ymax/y2min/y2max/zmin/zmax xxx>
Set the range for the given axis. These x-axis bounds are ignored in a streaming Set the range for the given axis. These x-axis bounds are ignored in a streaming
plot. The y2-axis bound do not apply in 3d plots. The z-axis bounds apply plot. The y2-axis bound do not apply in 3d plots. The z-axis bounds apply
@ -1435,52 +1435,52 @@ I<only> to 3d plots or colormaps.
=item =item
--xlabel/ylabel/y2label/zlabel xxx C<--xlabel/ylabel/y2label/zlabel xxx>
Label the given axis. The y2-axis label does not apply to 3d plots while the Label the given axis. The y2-axis label does not apply to 3d plots while the
z-axis label applies I<only> to 3d plots. z-axis label applies I<only> to 3d plots.
=item =item
--y2 xxx C<--y2 xxx>
Plot the data specified by this curve ID on the y2 axis. Without --dataid, the Plot the data specified by this curve ID on the y2 axis. Without C<--dataid>,
ID is just an ordered 0-based index. Does not apply to 3d plots. Can be passed the ID is just an ordered 0-based index. Does not apply to 3d plots. Can be
multiple times, or passed a comma-separated list. By default the y2-axis curves passed multiple times, or passed a comma-separated list. By default the y2-axis
look the same as the y-axis ones. I.e. the viewer of the resulting plot has to curves look the same as the y-axis ones. I.e. the viewer of the resulting plot
be told which is which via an axes label, legend, etc. Prior to version 1.25 of has to be told which is which via an axes label, legend, etc. Prior to version
feedgnuplot the curves plotted on the y2 axis were drawn with a thicker line. 1.25 of feedgnuplot the curves plotted on the y2 axis were drawn with a thicker
This is no longer the case, but that behavior can be brought back by passing line. This is no longer the case, but that behavior can be brought back by
something like passing something like
--y2 curveid --style curveid 'linewidth 3' --y2 curveid --style curveid 'linewidth 3'
=item =item
--histogram curveID C<--histogram curveID>
Set up a this specific curve to plot a histogram. The bin width is given with Set up a this specific curve to plot a histogram. The bin width is given with
the --binwidth option (assumed 1.0 if omitted). --histogram does NOT touch the the C<--binwidth> option (assumed 1.0 if omitted). C<--histogram> does I<not>
drawing style. It is often desired to plot these with boxes, and this MUST be touch the drawing style. It is often desired to plot these with boxes, and this
explicitly requested by C<--with boxes>. This works with --domain and/or I<must> be explicitly requested by C<--with boxes>. This works with C<--domain>
--stream, but in those cases the x-value is used ONLY to cull old data because and/or C<--stream>, but in those cases the x-value is used I<only> to cull old
of --xlen or --monotonic. I.e. the x-values are NOT drawn in any way. Can be data because of C<--xlen> or C<--monotonic>. I.e. the x-values are I<not> drawn
passed multiple times, or passed a comma- separated list in any way. Can be passed multiple times, or passed a comma- separated list
=item =item
--binwidth width C<--binwidth width>
The width of bins when making histograms. This setting applies to ALL histograms The width of bins when making histograms. This setting applies to ALL histograms
in the plot. Defaults to 1.0 if not given. in the plot. Defaults to 1.0 if not given.
=item =item
--histstyle style C<--histstyle style>
Normally, histograms are generated with the 'smooth freq' gnuplot style. Normally, histograms are generated with the 'smooth freq' gnuplot style.
--histstyle can be used to select different 'smooth' settings. Allowed are C<--histstyle> can be used to select different 'smooth' settings. Allowed are
'unique', 'cumulative' and 'cnormal'. 'unique' indicates whether a bin has at 'unique', 'cumulative' and 'cnormal'. 'unique' indicates whether a bin has at
least one item in it: instead of counting the items, it'll always report 0 or 1. least one item in it: instead of counting the items, it'll always report 0 or 1.
'cumulative' is the integral of the "normal" histogram. 'cnormal' is like 'cumulative' is the integral of the "normal" histogram. 'cnormal' is like
@ -1488,34 +1488,35 @@ least one item in it: instead of counting the items, it'll always report 0 or 1.
=item =item
--style curveID style C<--style curveID style>
Additional styles per curve. With --dataid, curveID is the ID. Otherwise, it's Additional styles per curve. With C<--dataid>, curveID is the ID. Otherwise,
the index of the curve, starting at 0. Use this option multiple times for it's the index of the curve, starting at 0. Use this option multiple times for
multiple curves. --styleall does I<not> apply to curves that have a --style multiple curves. C<--styleall> does I<not> apply to curves that have a
C<--style>
=item =item
--curvestyle curveID C<--curvestyle curveID>
Synonym for C<--style> Synonym for C<--style>
=item =item
--styleall xxx C<--styleall xxx>
Additional styles for all curves that have no C<--style>. This is overridden by Additional styles for all curves that have no C<--style>. This is overridden by
any applicable C<--style>. Exclusive with C<--with>. any applicable C<--style>. Exclusive with C<--with>.
=item =item
--curvestyleall xxx C<--curvestyleall xxx>
Synonym for C<--styleall> Synonym for C<--styleall>
=item =item
--with xxx C<--with xxx>
Same as C<--styleall>, but prefixed with "with". Thus Same as C<--styleall>, but prefixed with "with". Thus
@ -1529,21 +1530,21 @@ Exclusive with C<--styleall>.
=item =item
--extracmds xxx C<--extracmds xxx>
Additional commands to pass on to gnuplot verbatim. These could contain extra Additional commands to pass on to gnuplot verbatim. These could contain extra
global styles for instance. Can be passed multiple times. global styles for instance. Can be passed multiple times.
=item =item
--set xxx C<--set xxx>
Additional 'set' commands to pass on to gnuplot verbatim. C<--set 'a b c'> will Additional 'set' commands to pass on to gnuplot verbatim. C<--set 'a b c'> will
result in gnuplot seeing a C<set a b c> command. Can be passed multiple times. result in gnuplot seeing a C<set a b c> command. Can be passed multiple times.
=item =item
--unset xxx C<--unset xxx>
Additional 'unset' commands to pass on to gnuplot verbatim. C<--unset 'a b c'> Additional 'unset' commands to pass on to gnuplot verbatim. C<--unset 'a b c'>
will result in gnuplot seeing a C<unset a b c> command. Can be passed multiple will result in gnuplot seeing a C<unset a b c> command. Can be passed multiple
@ -1551,36 +1552,36 @@ times.
=item =item
--square C<--square>
Plot data with aspect ratio 1. For 3D plots, this controls the aspect ratio for Plot data with aspect ratio 1. For 3D plots, this controls the aspect ratio for
all 3 axes all 3 axes
=item =item
--square_xy C<--square_xy>
For 3D plots, set square aspect ratio for ONLY the x,y axes For 3D plots, set square aspect ratio for ONLY the x,y axes
=item =item
--hardcopy xxx C<--hardcopy xxx>
If not streaming, output to a file specified here. Format inferred from If not streaming, output to a file specified here. Format inferred from
filename, unless specified by --terminal filename, unless specified by C<--terminal>
=item =item
--terminal xxx C<--terminal xxx>
String passed to 'set terminal'. No attempts are made to validate this. String passed to 'set terminal'. No attempts are made to validate this.
--hardcopy sets this to some sensible defaults if --hardcopy is given .png, C<--hardcopy> sets this to some sensible defaults if --hardcopy is given .png,
.pdf, .ps, .eps or .svg. If any other file type is desired, use both --hardcopy .pdf, .ps, .eps or .svg. If any other file type is desired, use both
and --terminal C<--hardcopy> and C<--terminal>
=item =item
--maxcurves xxx C<--maxcurves xxx>
The maximum allowed number of curves. This is 100 by default, but can be reset The maximum allowed number of curves. This is 100 by default, but can be reset
with this option. This exists purely to prevent perl from allocating all of the with this option. This exists purely to prevent perl from allocating all of the
@ -1588,17 +1589,17 @@ system's memory when reading bogus data
=item =item
--monotonic C<--monotonic>
If --domain is given, checks to make sure that the x- coordinate in the input If C<--domain> is given, checks to make sure that the x- coordinate in the input
data is monotonically increasing. If a given x-variable is in the past, all data data is monotonically increasing. If a given x-variable is in the past, all data
currently cached for this curve is purged. Without --monotonic, all data is currently cached for this curve is purged. Without C<--monotonic>, all data is
kept. Does not make sense with 3d plots. No --monotonic by default. The data is kept. Does not make sense with 3d plots. No C<--monotonic> by default. The data is
replotted before being purged replotted before being purged
=item =item
--extraValuesPerPoint xxx C<--extraValuesPerPoint xxx>
How many extra values are given for each data point. Normally this is 0, and How many extra values are given for each data point. Normally this is 0, and
does not need to be specified, but sometimes we want extra data, like for colors does not need to be specified, but sometimes we want extra data, like for colors
@ -1608,14 +1609,14 @@ styles are used, with C<--styleall> or C<--with> for instance
=item =item
--dump C<--dump>
Instead of printing to gnuplot, print to STDOUT. Very useful for debugging. It Instead of printing to gnuplot, print to STDOUT. Very useful for debugging. It
is possible to send the output produced this way to gnuplot directly. is possible to send the output produced this way to gnuplot directly.
=item =item
--exit C<--exit>
Terminate the feedgnuplot process after passing data to gnuplot. The window will Terminate the feedgnuplot process after passing data to gnuplot. The window will
persist but will not be interactive. Without this option feedgnuplot keeps persist but will not be interactive. Without this option feedgnuplot keeps
@ -1624,13 +1625,13 @@ later versions of gnuplot and only with some gnuplot terminals.
=item =item
--geometry C<--geometry>
If using X11, specifies the size, position of the plot window If using X11, specifies the size, position of the plot window
=item =item
--version C<--version>
Print the version and exit Print the version and exit