changelog update

This emulates the while(<>) syntax in perl, and makes self-plotting data files
work again. These have been broken since that syntax was taken away in
4cfcf0fc35

Changes

@@ -1,3 +1,54 @@
+feedgnuplot (1.43)
+
+  * Added --image
+
+ -- Dima Kogan <dima@secretsauce.net>  Mon, 19 Jun 2017 13:12:38 -0700
+
+feedgnuplot (1.42)
+
+  * Data can now come from STDIN or files on the cmdline.
+    This fixes a regression. Self-plotting data files work again
+
+ -- Dima Kogan <dima@secretsauce.net>  Fri, 31 Mar 2017 15:38:47 -0700
+
+feedgnuplot (1.41)
+
+  * Histograms: --xlen can coexist with --xmin/--xmax
+  * Histograms: work as expected with --xlen and --monotonic
+  * Histograms: better sanity checking of options
+
+ -- Dima Kogan <dima@secretsauce.net>  Fri, 24 Feb 2017 23:42:28 -0800
+
+feedgnuplot (1.40)
+
+  * If the options couldn't be parsed I don't dump the whole manpage
+  * --style and --rangesize can now take a comma-separated list of IDs
+  * 'any' is from List::MoreUtils, not List::Util
+  * the sleep-forever delay at end is now > 1000 days
+
+ -- Dima Kogan <dima@secretsauce.net>  Fri, 25 Nov 2016 14:45:06 -0800
+
+feedgnuplot (1.39)
+
+  * by default, histograms are plotted in expected ways
+
+ -- Dima Kogan <dima@secretsauce.net>  Sat, 15 Oct 2016 20:45:15 -0700
+
+feedgnuplot (1.38)
+
+  * hardcopy defaults:
+   - no enhanced text mode
+   - larger font size
+
+ -- Dima Kogan <dima@secretsauce.net>  Wed, 27 Jul 2016 22:15:11 -0700
+
+feedgnuplot (1.37)
+
+  * At the end of a streaming plot, include the last chunk of data
+  * Added --equation to the completions
+
+ -- Dima Kogan <dima@secretsauce.net>  Fri, 01 Jan 2016 08:09:43 -0800
+
 feedgnuplot (1.36)
 
   * Added --equation to plot symbolic equations

Makefile.PL

@@ -64,6 +64,7 @@ WriteMakefile
    PL_FILES                   => {},
    EXE_FILES                  => [ 'bin/feedgnuplot' ],
    BUILD_REQUIRES             => { 'String::ShellQuote' => 0,
+                                   'List::MoreUtils'    => 0,
                                    'IPC::Run'           => 0},
    dist                       => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', },
    clean                      => { FILES => 'feedgnuplot-*' },

bin/feedgnuplot

@@ -9,12 +9,13 @@ use Time::HiRes qw( usleep gettimeofday tv_interval );
 use IO::Handle;
 use IO::Select;
 use List::Util qw( first );
+use List::MoreUtils 'any';
 use Scalar::Util qw( looks_like_number );
 use Text::ParseWords; # for shellwords
 use Pod::Usage;
 use Time::Piece;
 
-my $VERSION = 1.36;
+my $VERSION = 1.43;
 
 my %options;
 interpretCommandline();
@@ -40,22 +41,26 @@ my $last_replot_time = [gettimeofday];
 
 # whether the previous replot was timer based
 my $last_replot_is_from_timer = 1;
-
-
-my $prev_timed_replot_time = [gettimeofday];
 my $this_replot_is_from_timer;
-my $stdin    = IO::Handle->new();
-die "Couldn't open STDIN" unless $stdin->fdopen(fileno(STDIN),"r");
-my $selector = IO::Select->new( $stdin );
-
-
-
-mainThread();
 
 
 
 
 
+
+
+
+sub getRangeSize
+{
+    my ($id) = @_;
+
+    # I'd like to use //, but I guess some people are still on perl 5.8
+    return
+      exists $options{rangesize_hash}{$id} ?
+      $options{rangesize_hash}{$id} :
+      $options{rangesize_default};
+}
+
 sub interpretCommandline
 {
   # if I'm using a self-plotting data file with a #! line, then $ARGV[0] will contain ALL of the
@@ -104,14 +109,12 @@ sub interpretCommandline
              'style=s{2}', 'curvestyle=s{2}', 'curvestyleall=s', 'styleall=s', 'with=s', 'extracmds=s@', 'set=s@', 'unset=s@',
              'square!', 'square_xy!', 'hardcopy=s', 'maxcurves=i', 'monotonic!', 'timefmt=s',
              'equation=s@',
+             'image=s',
              'histogram=s@', 'binwidth=f', 'histstyle=s',
              'terminal=s',
              'rangesize=s{2}', 'rangesizeall=i', 'extraValuesPerPoint=i',
              'help', 'dump', 'exit', 'version',
-             'geometry=s') or pod2usage( -exitval => 1,
-                                         -verbose => 1, # synopsis and args
-                                         -output  => \*STDERR );
-
+             'geometry=s') or exit 1;
 
   # handle various cmdline-option errors
   if ( $options{help} )
@@ -127,29 +130,73 @@ sub interpretCommandline
     exit 0;
   }
 
+  # --style and --curvestyle are synonyms, as are --styleall and
+  # --curvestyleall, so fill that in
+  if( $options{styleall} )
+  {
+    if($options{curvestyleall} ) { $options{curvestyleall} .= " $options{styleall}"; }
+    else                         { $options{curvestyleall}  =   $options{styleall};  }
+    delete $options{styleall};
+  }
+
+  push @{$options{curvestyle}}, @{$options{style}};
+  delete $options{style};
+
+  if( $options{curvestyleall} && $options{with} )
+  {
+    print STDERR "--curvestyleall and --with are mutually exclusive. Please just use one.\n";
+    exit -1;
+  }
+  if( $options{with} )
+  {
+    $options{curvestyleall} = "with $options{with}";
+    delete $options{with};
+  }
+
+
   # expand options that are given as comma-separated lists
   for my $listkey (qw(histogram y2))
   {
     @{$options{$listkey}} = map split('\s*,\s*', $_), @{$options{$listkey}}
       if defined $options{$listkey};
   }
+  for my $listkey (qw(curvestyle rangesize))
+  {
+      next unless defined $options{$listkey};
+      my @in = @{$options{$listkey}};
+      my $N = @in / 2;
+      my @out;
+      for my $i (0..$N-1)
+      {
+          my $key   = $in[2*$i];
+          my $value = $in[2*$i + 1];
+          for my $key_new (split('\s*,\s*', $key))
+          {
+              push @out, $key_new, $value;
+          }
+      }
 
-  # --style and --curvestyle are synonyms, as are --styleall and
-  # --curvestyleall, so fill that in
-  if( $options{styleall} )
-  {
-    if($options{curvestyleall} )
-    {
-      $options{curvestyleall} .= " $options{styleall}";
+      @{$options{$listkey}} = @out;
   }
-    else
-    {
-      $options{curvestyleall} = $options{styleall};
-    }
-  }
-  push @{$options{curvestyle}}, @{$options{style}};
 
 
+  # If we're plotting histograms, then set the default histogram options for
+  # each histogram curve
+  #
+  # Apply this to plain (non-cumulative) histograms
+  if( !$options{curvestyleall} && $options{histstyle} =~ /freq|fnorm/ )
+  {
+      for my $hist_curve(@{$options{histogram}})
+      {
+          # If we don't specify any options specifically for this histogram, use
+          # the defaults: filled boxes with borders
+          if( !any { $options{curvestyle}[$_*2] eq $hist_curve } 0..(@{$options{curvestyle}}/2 - 1) )
+          {
+              push @{$options{curvestyle}}, ($hist_curve, 'with boxes fill solid border lt -1');
+          }
+      }
+  }
+
   # --legend and --curvestyle options are conceptually hashes, but are parsed as
   # arrays in order to preserve the ordering. I parse both of these into hashes
   # because those are useful to have later. After this I can access individual
@@ -179,7 +226,10 @@ sub interpretCommandline
 
 
   # I now set up the rangesize to always be
+  #
   #   $options{rangesize_hash}{$id} // $options{rangesize_default}
+  #
+  # which is available as getRangeSize($id)
   if ( $options{rangesizeall} )
   {
       $options{rangesize_default} = $options{rangesizeall};
@@ -231,17 +281,6 @@ sub interpretCommandline
     }
   }
 
-  if( $options{curvestyleall} && $options{with} )
-  {
-    print STDERR "--curvestyleall and --with are mutually exclusive. Please just use one.\n";
-    exit -1;
-  }
-  if( $options{with} )
-  {
-    $options{curvestyleall} = "with $options{with}";
-    $options{with} = '';
-  }
-
   if ($options{colormap})
   {
     # colormap styles all curves with palette. Seems like there should be a way to do this with a
@@ -249,6 +288,13 @@ sub interpretCommandline
     $options{curvestyleall} .= ' palette';
   }
 
+  if ( defined $options{binwidth} && !@{$options{histogram}} )
+  {
+    print STDERR "--binwidth doesn't make sense without any histograms\n";
+    exit -1;
+  }
+
+
   if ( $options{'3d'} )
   {
     if ( !$options{domain} )
@@ -281,7 +327,7 @@ sub interpretCommandline
       exit -1;
     }
 
-    if ( defined $options{binwidth} || @{$options{histogram}} )
+    if ( @{$options{histogram}} )
     {
       print STDERR "--3d does not make sense with histograms\n";
       exit -1;
@@ -315,6 +361,16 @@ sub interpretCommandline
       print STDERR "--square_xy only makes sense with --3d\n";
       exit -1;
     }
+
+    for my $hist_curve(@{$options{histogram}})
+    {
+        my $hist_dim = getRangeSize($hist_curve);
+        if( $hist_dim != 1 )
+        {
+            print STDERR "I only support 1D histograms, but curve '$hist_curve' has '$hist_dim'-D data\n";
+            exit -1;
+        }
+    }
   }
 
   if(defined $options{xlen} && !$options{stream} )
@@ -324,7 +380,8 @@ sub interpretCommandline
   }
 
   if($options{stream} && defined $options{xlen} &&
-     ( defined $options{xmin} || defined $options{xmax}))
+     ( defined $options{xmin} || defined $options{xmax}) &&
+    !defined $options{histogram})
   {
     print STDERR "With --stream and --xlen the X bounds are set, so neither --xmin nor --xmax make sense\n";
     exit -1;
@@ -333,9 +390,9 @@ sub interpretCommandline
   # --xlen implies an order to the data, so I force monotonicity
   $options{monotonic} = 1 if defined $options{xlen};
 
-  if( $options{histstyle} !~ /freq|cum|uniq|cnorm/ )
+  if( $options{histstyle} !~ /freq|cum|uniq|cnorm|fnorm/ )
   {
-    print STDERR "unknown histstyle. Allowed are 'freq...', 'cum...', 'uniq...', 'cnorm...'\n";
+    print STDERR "unknown histstyle. Allowed are 'freq...', 'fnorm...', 'cum...', 'uniq...', 'cnorm...'\n";
     exit -1;
   }
 
@@ -363,6 +420,27 @@ sub interpretCommandline
       }
     }
   }
+
+  # deal with --image. I just fill in --equation, and reverse the y extents if
+  # none are explicitly given
+  if( defined $options{image} )
+  {
+      # images generally have the origin at the top-left instead of the
+      # bottom-left, so given nothing else, I flip the y axis
+      if( !defined $options{ymin} && !defined $options{ymax} &&
+          ! any { /^ *yrange\b/ } @{$options{set}} )
+      {
+          push @{$options{set}}, "yrange [:] reverse";
+      }
+
+      if ( ! -r $options{image} )
+      {
+          die "Couldn't read image '$options{image}'";
+      }
+
+      push @{$options{equation}}, qq{"$options{image}" binary filetype=auto flipy with rgbimage};
+      delete $options{image};
+  }
 }
 
 sub getGnuplotVersion
@@ -415,16 +493,66 @@ sub makeDomainNumeric
 }
 
 
+my $prev_timed_replot_time = [gettimeofday];
+my $pipe_in;
+my $selector;
+my $line_number = 0;
+my $is_stdin = !@ARGV; # read stdin only if no data files given on the cmdline
+sub openNextFile
+{
+    my $fd;
+    if($is_stdin)
+    {
+        $fd = IO::Handle->new();
+        $fd->fdopen(fileno(STDIN), "r") or die "Couldn't open STDIN";
+    }
+    else
+    {
+        my $filename = shift @ARGV;
+        $fd = IO::File->new($filename, "r") or die "Couldn't open file '$filename'";
+    }
+
+    my $selector = IO::Select->new( $fd );
+    return ($fd, $selector);
+}
 sub getNextLine
 {
+    sub getline_internal
+    {
+        while(1)
+        {
+            my $line = $pipe_in->getline();
+            if( !$is_stdin && !defined $line && $pipe_in->eof() && @ARGV)
+            {
+                # I got to the end of one file, so open the next one (which I'm
+                # sure exists)
+                ($pipe_in, $selector) = openNextFile();
+                next;
+            }
+            return $line;
+        }
+    }
+
+
+
+
+
+    if( !defined $pipe_in )
+    {
+        ($pipe_in, $selector) = openNextFile();
+    }
+
     while(1)
     {
         $this_replot_is_from_timer = undef;
 
         # if we're not streaming, or we're doing triggered-only replotting, simply
         # do a blocking read
-        return $stdin->getline()
-          if (! $options{stream} || $options{stream} < 0);
+        if (! $options{stream} || $options{stream} < 0)
+        {
+            $line_number++;
+            return getline_internal();
+        }
 
 
         my $now = [gettimeofday];
@@ -439,7 +567,8 @@ sub getNextLine
 
         if ($selector->can_read($time_remaining))
         {
-            return $stdin->getline();
+            $line_number++;
+            return getline_internal();
         }
     }
 }
@@ -497,11 +626,11 @@ sub mainThread
       }
 
       my %terminalOpts =
-      ( eps  => 'postscript solid color enhanced eps',
-        ps   => 'postscript solid color landscape 10',
-        pdf  => 'pdfcairo solid color font ",10" size 11in,8.5in',
-        png  => 'png size 1280,1024',
-        svg  => 'svg');
+      ( eps  => 'postscript noenhanced solid color enhanced eps',
+        ps   => 'postscript noenhanced solid color landscape 12',
+        pdf  => 'pdfcairo noenhanced solid color font ",12" size 11in,8.5in',
+        png  => 'png noenhanced size 1280,1024',
+        svg  => 'svg noenhanced');
 
       if( !defined $options{terminal} &&
            defined $outputfileType    &&
@@ -552,7 +681,7 @@ sub mainThread
       print(PIPE "set view equal xy\n");
     }
 
-# For the specified values, set the legend entries to 'title "blah blah"'
+    # For the specified values, set the legend entries to 'title "blah blah"'
     if(@{$options{legend}})
     {
       # @{$options{legend}} is a list where consecutive pairs are (curveID,
@@ -567,13 +696,11 @@ sub mainThread
       }
     }
 
-# add the extra curve options
+    # add the extra curve options
     if(@{$options{curvestyle}})
     {
       # @{$options{curvestyle}} is a list where consecutive pairs are (curveID,
-      # style). I use $options{curvestyle} here instead of
-      # $options{curvestyle_hash} because I create a new curve when I see a new
-      # one, and the hash is unordered, thus messing up the ordering
+      # style).
       my $n = scalar @{$options{curvestyle}}/2;
       foreach my $idx (0..$n-1)
       {
@@ -582,22 +709,22 @@ sub mainThread
       }
     }
 
-# For the values requested to be printed on the y2 axis, set that
+    # For the values requested to be printed on the y2 axis, set that
     addCurveOption($_, 'axes x1y2') foreach (@{$options{y2}});
 
-# timefmt
+    # timefmt
     if( $options{timefmt} )
     {
       print(PIPE "set timefmt '$options{timefmt}'\n");
       print(PIPE "set xdata time\n");
     }
 
-# add the extra global options
+    # add the extra global options
     print(PIPE "$_\n")       foreach (@{$options{extracmds}});
     print(PIPE "set $_\n")   foreach (@{$options{set}});
     print(PIPE "unset $_\n") foreach (@{$options{unset}});
 
-# set up histograms
+    # set up histograms
     $options{binwidth} ||= 1;   # if no binwidth given, set it to 1
     print PIPE
       "set boxwidth $options{binwidth}\n" .
@@ -605,11 +732,6 @@ sub mainThread
 
     setCurveAsHistogram( $_ ) foreach (@{$options{histogram}});
 
-# set all the axis ranges
-    # If a bound isn't given I want to set it to the empty string, so I can communicate it simply to
-    # gnuplot
-    print PIPE "set xtics\n";
-
     if(@{$options{y2}})
     {
       print PIPE "set ytics nomirror\n";
@@ -716,7 +838,7 @@ sub mainThread
       }
       else
       {
-        $domain[0] = $.;
+        $domain[0] = $line_number;
         $domain0_numeric = makeDomainNumeric( $domain[0] );
       }
 
@@ -724,20 +846,10 @@ sub mainThread
 
       while(@fields)
       {
-          if($options{dataid})
-          {
-              $id = shift @fields;
-          }
-          else
-          {
-              $id++;
-          }
-
-          # I'd like to use //, but I guess some people are still on perl 5.8
-          my $rangesize = exists $options{rangesize_hash}{$id} ?
-            $options{rangesize_hash}{$id} :
-            $options{rangesize_default};
+          if($options{dataid}) { $id = shift @fields; }
+          else                 { $id++;               }
 
+          my $rangesize = getRangeSize($id);
           last if @fields < $rangesize;
 
           pushPoint(getCurve($id),
@@ -749,7 +861,7 @@ sub mainThread
     }
 
     # finished reading in all. Plot what we have
-    plotStoredData() unless $options{stream};
+    plotStoredData() unless $options{stream} && $options{exit};
 
     if ( defined $options{hardcopy})
     {
@@ -780,7 +892,7 @@ sub mainThread
     # we persist gnuplot, so we shouldn't need this sleep. However, once
     # gnuplot exits, but the persistent window sticks around, you can no
     # longer interactively zoom the plot. So we still sleep
-    sleep(100000) unless $options{dump} || $options{exit};
+    sleep(100000000) unless $options{dump} || $options{exit};
 }
 
 sub pruneOldData
@@ -851,19 +963,6 @@ sub updateCurveOptions
   { $title = $id; }
 
   my $titleoption = defined $title ? "title \"$title\"" : "notitle";
-
-  my ($curvestyleall);
-  if( defined $options{curvestyle_hash}{$id} )
-  {
-    # I have a curve-specific style set with --curvestyle. This style lives in
-    # $curve->{extraoptions}, and it overrides the global styles
-    $curvestyleall = '';
-  }
-  else
-  {
-    $curvestyleall = $options{curvestyleall};
-  }
-
   my $histoptions = $curve->{histoptions} || '';
 
   my $usingoptions = '';
@@ -874,17 +973,12 @@ sub updateCurveOptions
       # as 1 + rangesize). I also need to start the range at the first column
       # past the timefmt
 
-      # I'd like to use //, but I guess some people are still on perl 5.8
-      my $rangesize = exists $options{rangesize_hash}{$id} ?
-        $options{rangesize_hash}{$id} :
-        $options{rangesize_default};
-
-      my @rest = map {$_ + $options{timefmt_Ncols}} (1..$rangesize);
+      my @rest = map {$_ + $options{timefmt_Ncols}} (1..getRangeSize($id));
 
       $usingoptions = "using 1:" . join(':', @rest);
   }
 
-  $curve->{options} = "$histoptions $usingoptions $titleoption $curve->{extraoptions} $curvestyleall";
+  $curve->{options} = "$histoptions $usingoptions $titleoption $curve->{extraoptions} $options{curvestyleall}";
 }
 
 sub getCurve
@@ -910,6 +1004,22 @@ sub getCurve
     $curveIndices{$id} =  $#curves;
 
     updateCurveOptions($curves[$#curves], $id);
+
+
+    # --xlen has a meaning if we're not plotting histograms at all or if we're
+    # plotting ONLY histograms. If we're doing both at the same time, there's no
+    # consistent way to assign meaning to xlen
+    if ( defined $options{xlen} &&
+
+         # have at least some histograms
+         @{$options{histogram}} &&
+
+         # there are more curves than histogram curves, i.e. there're some
+         # non-histogram curves
+         @curves > @{$options{histogram}} ) {
+        print STDERR "--xlen only makes sense when plotting ONLY histograms or ONLY NON-histograms\n";
+        exit -1;
+    }
   }
   return $curves[$curveIndices{$id}];
 }
@@ -937,6 +1047,10 @@ sub setCurveAsHistogram
   my ($id, $str) = @_;
 
   my $curve = getCurve($id);
+
+  # With histograms I have 2d plots with rangesize=1. I thus give gnuplot two
+  # values for each point: a domain and a range. For histograms I ignore the
+  # domain, so I get the statistics of the 2nd column: $2
   $curve->{histoptions} = 'using (histbin($2)):(1.0) smooth ' . $options{histstyle};
 
   updateCurveOptions($curve, $id);
@@ -1004,7 +1118,11 @@ sub replot
         # seconds-since-the-epoch BACK to the timefmt. Sheesh
         ($xmin, $xmax) = map {Time::Piece->strptime( $_, '%s' )->strftime( $options{timefmt} ) } ($xmin, $xmax);
       }
-      sendRangeCommand( "xrange", $xmin, $xmax );
+
+      # if we have any histograms, then I'm not really visualizing the domain at
+      # all, and I don't set the range.
+      sendRangeCommand( "xrange", $xmin, $xmax )
+        unless @{$options{histogram}};
     }
 
     plotStoredData();
@@ -1029,6 +1147,9 @@ sub pushPoint
 }
 
 
+mainThread();
+
+
 =head1 NAME
 
 feedgnuplot - General purpose pipe-oriented plotting tool
@@ -1253,7 +1374,12 @@ windowsize> can be given. This will create an constantly-updating, scrolling
 view of the recent past. C<windowsize> should be replaced by the desired length
 of the domain window to plot, in domain units (passed-in values if C<--domain>
 or line numbers otherwise). If the domain is a time/date via C<--timefmt>, then
-C<windowsize> is and I<integer> in seconds.
+C<windowsize> is and I<integer> in seconds. If we're plotting a histogram, then
+C<--xlen> causes a histogram over a moving window to be computed. The subtlely
+here is that with a histogram you don't actually I<see> the domain since only
+the range is analyzed. But the domain is still there, and can be utilized with
+C<--xlen>. With C<--xlen> we can plot I<only> histograms or I<only>
+I<non>-histograms.
 
 =head3 Special data commands
 
@@ -1286,7 +1412,9 @@ This command causes feedgnuplot to exit.
 The script is able to produce hardcopy output with C<--hardcopy outputfile>. The
 output type can be inferred from the filename, if B<.ps>, B<.eps>, B<.pdf>,
 B<.svg> or B<.png> is requested. If any other file type is requested,
-C<--terminal> I<must> be passed in to tell gnuplot how to make the plot.
+C<--terminal> I<must> be passed in to tell gnuplot how to make the plot. If
+C<--terminal> is passed in, then the C<--hardcopy> argument only provides the
+output filename.
 
 =head2 Self-plotting data files
 
@@ -1485,7 +1613,12 @@ C<--xlen xxx>
 
 When using C<--stream>, sets the size of the x-window to plot. Omit this or set
 it to 0 to plot ALL the data. Does not make sense with 3d plots. Implies
-C<--monotonic>
+C<--monotonic>. If we're plotting a histogram, then C<--xlen> causes a histogram
+over a moving window to be computed. The subtlely here is that with a histogram
+you don't actually I<see> the domain since only the range is analyzed. But the
+domain is still there, and can be utilized with C<--xlen>. With C<--xlen> we can
+plot I<only> histograms or I<only> I<non>-histograms.
+
 
 =item
 
@@ -1521,14 +1654,15 @@ passing something like
 
 C<--histogram curveID>
 
-
 Set up a this specific curve to plot a histogram. The bin width is given with
-the C<--binwidth> option (assumed 1.0 if omitted). C<--histogram> does I<not>
-touch the drawing style. It is often desired to plot these with boxes, and this
-I<must> be explicitly requested by C<--with boxes>. This works with C<--domain>
+the C<--binwidth> option (assumed 1.0 if omitted). If a drawing style is not
+specified for this curve (C<--curvestyle>) or all curves (C<--with>,
+C<--curvestyleall>) then the default histogram style is set: filled boxes with
+borders. This is what the user generally wants. This works with C<--domain>
 and/or C<--stream>, but in those cases the x-value is used I<only> to cull old
-data because of C<--xlen> or C<--monotonic>. I.e. the x-values are I<not> drawn
-in any way. Can be passed multiple times, or passed a comma- separated list
+data because of C<--xlen> or C<--monotonic>. I.e. the domain values are I<not>
+drawn in any way. Can be passed multiple times, or passed a comma- separated
+list
 
 =item
 
@@ -1541,21 +1675,24 @@ in the plot. Defaults to 1.0 if not given.
 
 C<--histstyle style>
 
-Normally, histograms are generated with the 'smooth freq' gnuplot style.
-C<--histstyle> can be used to select different 'smooth' settings. Allowed are
-'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.
-'cumulative' is the integral of the "normal" histogram. 'cnormal' is like
-'cumulative', but rescaled to end up at 1.0.
+Normally, histograms are generated with the 'smooth frequency' gnuplot style.
+C<--histstyle> can be used to select different C<smooth> settings (see the
+gnuplot C<help smooth> page for more info). Allowed values are 'frequency' (the
+default), 'fnormal' (available in very recent gnuplots), 'unique', 'cumulative'
+and 'cnormal'. 'fnormal' is a normalized histogram. 'unique' indicates whether a
+bin has at least one item in it: instead of counting the items, it'll always
+report 0 or 1. 'cumulative' is the integral of the 'frequency' histogram.
+'cnormal' is like 'cumulative', but rescaled to end up at 1.0.
 
 =item
 
 C<--style curveID style>
 
 Additional styles per curve. With C<--dataid>, curveID is the ID. Otherwise,
-it's the index of the curve, starting at 0. Use this option multiple times for
-multiple curves. C<--styleall> does I<not> apply to curves that have a
-C<--style>
+it's the index of the curve, starting at 0. curveID can be a comma-separated
+list of IDs to which the given style should apply. Use this option multiple
+times for multiple curves. C<--styleall> does I<not> apply to curves that have a
+C<--style>.
 
 =item
 
@@ -1614,10 +1751,21 @@ times.
 
 =item
 
+C<--image filename>
+
+Overlays the data on top of a raster image given in C<filename>. This is passed
+through to gnuplot via C<--equation>, and is not interpreted by C<feedgnuplot>
+other than checking for existence. Usually images have their origin at the
+top-left corner, while plots have it in the bottom-left corner instead. Thus if
+the y-axis extents are not specified (C<--ymin>, C<--ymax>, C<--set 'yrange
+...'>) this option will also flip around the y axis to make the image appear
+properly. Since this option is just a passthrough to gnuplot, finer control can
+be achieved by passing in C<--equation> and C<--set yrange ...> directly.
+
 C<--equation xxx>
 
 Gnuplot can plot both data and symbolic equations. C<feedgnuplot> generally
-plots data, but with this option can plot symbolic equations /also/. This is
+plots data, but with this option can plot symbolic equations I<also>. This is
 generally intended to augment data plots, since for equation-only plots you
 don't need C<feedgnuplot>. C<--equation> can be passed multiple times for
 multiple equations. The given strings are passed to gnuplot directly without any
@@ -1629,7 +1777,7 @@ basic example:
                --equation 'sin(x)/x' --equation 'cos(x)/x with lines lw 4'
 
 Here I plot the incoming data (points along a line) with the given style (a line
-with thickness 3), /and/ I plot two damped sinusoids on the same plot. The
+with thickness 3), I<and> I plot two damped sinusoids on the same plot. The
 sinusoids are not affected by C<feedgnuplot> styling, so their styles are set
 separately, as in this example. More complicated example:
 
@@ -1638,7 +1786,7 @@ separately, as in this example. More complicated example:
                --set parametric --set "trange [0:2*3.14]" --equation "sin(t),cos(t)"
 
 Here the data I generate is points along the unit circle. I plot these as
-points, and I /also/ plot a true circle as a parametric equation.
+points, and I I<also> plot a true circle as a parametric equation.
 
 =item
 
@@ -1658,16 +1806,17 @@ For 3D plots, set square aspect ratio for ONLY the x,y axes
 C<--hardcopy xxx>
 
 If not streaming, output to a file specified here. Format inferred from
-filename, unless specified by C<--terminal>
+filename, unless specified by C<--terminal>. If C<--terminal> is given,
+C<--hardcopy> sets I<only> the output filename.
 
 =item
 
 C<--terminal xxx>
 
 String passed to 'set terminal'. No attempts are made to validate this.
-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
-C<--hardcopy> and C<--terminal>
+C<--hardcopy> sets this to some sensible defaults if C<--hardcopy> is set to a
+filename ending in C<.png>, C<.pdf>, C<.ps>, C<.eps> or C<.svg>. If any other
+file type is desired, use both C<--hardcopy> and C<--terminal>
 
 =item
 
@@ -1700,6 +1849,10 @@ C<--rangesize> is used to set how many values are needed to represent the range
 of a point for a particular curve. This overrides any defaults that may exist
 for this curve only.
 
+With C<--dataid>, curveID is the ID. Otherwise, it's the index of the curve,
+starting at 0. curveID can be a comma-separated list of IDs to which the given
+rangesize should apply.
+
 =item
 
 C<--rangesizeall xxx>
@@ -1727,16 +1880,15 @@ is possible to send the output produced this way to gnuplot directly.
 
 C<--exit>
 
-This controls the details of what happens when the input data is exhausted, or
-when some part of the C<feedgnuplot> pipeline is killed. This option does
-different things depending on whether C<--stream> is active, so read this
-closely.
+This controls what happens when the input data is exhausted, or when some part
+of the C<feedgnuplot> pipeline is killed. This option does different things
+depending on whether C<--stream> is active, so read this closely.
 
 With interactive gnuplot terminals (qt, x11, wxt), the plot windows live in a
 separate process from the main C<gnuplot> process. It is thus possible for the
 main C<gnuplot> process to exit, while leaving the plot windows up (a caveat is
-that such decapitated windows aren't interactive). To be clear, there are 3
-possible states:
+that such decapitated windows aren't interactive). There are 3 possible states
+of the polotting pipeline:
 
 =over
 
@@ -1751,35 +1903,35 @@ prompt available
 
 =back
 
-The C<--exit> option controls the details of this behavior. The possibilities
-are:
+The possibilities are:
 
 =over
 
-=item No C<--stream>, input pipe is exhausted (all data read in)
+=item No C<--stream>, all data read in
 
 =over
 
-=item default; no C<--exit>
+=item no C<--exit> (default)
 
 Alive. Need to Ctrl-C to get back into the shell
 
 =item C<--exit>
 
 Half-alive. Non-interactive prompt up, and the shell accepts new commands.
-Without C<--stream> the goal is to show a plot, so a Dead state is not useful
-here.
+Without C<--stream> the goal is to show a plot, so a Dead state would not be
+useful.
 
 =back
 
-=item C<--stream>, input pipe is exhausted (all data read in) or the
-C<feedgnuplot> process terminated
+=item C<--stream>, all data read in or the C<feedgnuplot> process terminated
 
 =over
 
-=item default; no C<--exit>
+=item no C<--exit> (default)
 
-Alive. Need to Ctrl-C to get back into the shell
+Alive. Need to Ctrl-C to get back into the shell. This means that when making
+live plots, the first Ctrl-C kills the data feeding process, but leaves the
+final plot up for inspection. A second Ctrl-C kills feedgnuplot as well.
 
 =item C<--exit>
 
@@ -1857,10 +2009,44 @@ in a Thinkpad.
 =head2 Plotting a histogram of file sizes in a directory, granular to 10MB
 
  $ ls -l | awk '{print $5/1e6}' |
-   feedgnuplot --histogram 0 --with boxes
-     --binwidth 10 --set 'style fill solid'
+   feedgnuplot --histogram 0
+     --binwidth 10
      --ymin 0 --xlabel 'File size (MB)' --ylabel Frequency
 
+=head2 Plotting a live histogram of the ping round-trip times for the past 20 seconds
+
+ $ ping -A -D 8.8.8.8 |
+   perl -anE 'BEGIN { $| = 1; }
+              $F[0] =~ s/[\[\]]//g or next;
+              $F[7] =~ s/.*=//g    or next;
+              say "$F[0] $F[7]"' |
+   feedgnuplot --stream --domain --histogram 0 --binwidth 10 \
+               --xlabel 'Ping round-trip time (s)'  \
+               --ylabel Frequency --xlen 20
+
+=head2 Plotting points on top of an existing image
+
+This can be done with C<--image>:
+
+ $ < features_xy.data
+   feedgnuplot --points --domain --image "image.png"
+
+or with C<--equation>:
+
+ $ < features_xy.data
+   feedgnuplot --points --domain
+     --equation '"image.png" binary filetype=auto flipy with rgbimage'
+     --set 'yrange [:] reverse'
+
+The C<--image> invocation is a convenience wrapper for the C<--equation>
+version. Finer control is available with C<--equation>.
+
+
+Here an existing image is given to gnuplot verbatim, and data to plot on top of
+it is interpreted by feedgnuplot as usual. C<flipy> is useful here because
+usually the y axis points up, but when looking at images, this is usually
+reversed: the origin is the top-left pixel.
+
 =head1 ACKNOWLEDGEMENT
 
 This program is originally based on the driveGnuPlots.pl script from

completions/bash/feedgnuplot

@@ -20,6 +20,8 @@ complete -W               \
     --extracmds           \
     --set                 \
     --unset               \
+    --equation            \
+    --image               \
     --geometry            \
     --hardcopy            \
     --help                \

completions/zsh/_feedgnuplot

@@ -32,6 +32,8 @@ _arguments -S
     '*--extracmds[Additional gnuplot commands]:command'                           \
     '*--set[Additional 'set' gnuplot commands]:set-option'                        \
     '*--unset[Additional 'unset' gnuplot commands]:unset-option'                  \
+    '*--equation[Raw symbolic equation]:equation'                                 \
+    '--image[Image file to render beneath the data]:image'                        \
     '--square[Plot data with square aspect ratio]'                                \
     '--square_xy[For 3D plots, set square aspect ratio for ONLY the x,y axes]'    \
     '--hardcopy[Plot to a file]:filename'                                         \

feedgnuplot.spec

@@ -0,0 +1,58 @@
+# Sample spec file for rpm-based systems. Debian-based systems already have this
+# packaged, so we do not ship those here
+
+Name:           feedgnuplot
+Version:        1.38
+Release:        1%{?dist}
+Summary:        Pipe-oriented frontend to Gnuplot
+BuildArch:      noarch
+
+License:        Artistic or GPL-1+
+URL:            https://www.github.com/dkogan/feedgnuplot/
+Source0:        https://www.github.com/dkogan/feedgnuplot/archive/v%{version}.tar.gz#/%{name}-%{version}.tar.gz
+
+BuildRequires:  /usr/bin/pod2html
+BuildRequires:  perl-String-ShellQuote
+BuildRequires:  perl-ExtUtils-MakeMaker
+BuildRequires:  perl
+BuildRequires:  gawk
+BuildRequires:  gnuplot
+BuildRequires:  perl-IPC-Run
+
+Requires:       gnuplot
+
+%description
+Flexible, command-line-oriented frontend to Gnuplot. Creates plots from data
+coming in on STDIN or given in a filename passed on the commandline. Various
+data representations are supported, as is hardcopy output and streaming display
+of live data.
+
+%prep
+%setup -q
+
+%build
+perl Makefile.PL INSTALLDIRS=vendor
+make
+pod2html --title=feedgnuplot bin/feedgnuplot > feedgnuplot.html
+
+%install
+make install DESTDIR=%{buildroot} PREFIX=/usr
+
+mkdir -p %{buildroot}%{_defaultdocdir}/%{name}
+cp Changes LICENSE feedgnuplot.html %{buildroot}%{_defaultdocdir}/%{name}
+
+mkdir -p %{buildroot}%{_datadir}/zsh/site-functions
+cp completions/zsh/* %{buildroot}%{_datadir}/zsh/site-functions
+
+mkdir -p %{buildroot}%{_datadir}/bash-completion/completions
+cp completions/bash/* %{buildroot}%{_datadir}/bash-completion/completions
+
+rm -rf %{buildroot}/usr/lib64
+
+
+%files
+%{_bindir}/*
+%{_datadir}/zsh/*
+%{_datadir}/bash-completion/*
+%doc %{_defaultdocdir}/%{name}/*
+%doc %{_mandir}