minimal documentation and help options

[barcat.git] / graph

diff --git a/graph b/graph
index 0a02d3e997ee407611f6d7cf4f3c1da62f9da9be..16af69ab31f609d651c5bd38f3121dcde019a429 100755 (executable)
--- a/graph
+++ b/graph
@@ -1,21 +1,29 @@
 #!/usr/bin/env perl
 use 5.014;
 use warnings;
-use List::Util qw( max );
+use List::Util qw( max sum );
 
-my $width = $ENV{COLUMNS} || 80;
+our $VERSION = '1.00';
 
-my @lines = readline;
+use Getopt::Long '2.33';
+GetOptions(\my %opt,
+       'width|w=i',
+) or exit 64;  # EX_USAGE
+$opt{width} ||= $ENV{COLUMNS} || 80;
+
+my @lines = readline or exit;
 chomp for @lines;
 my @values = map { s/^\h*([0-9]*)// and $1 } @lines;
 my @order  = sort { $b <=> $a } @values;
 my $lenval = 1 + int log($order[0]) / log 10;  # max string length
 my $len    = 1 + max map { length } @lines;  # left padding
-my $size   = ($width - $lenval - $len) / $order[0];  # bar multiplication
+my $size   = ($opt{width} - $lenval - $len) / $order[0];  # bar multiplication
 
+sub orderpos { ($order[$_[0]] + $order[$_[0] + .5]) / 2 * $size }
 my @barmark;
-my $mean   = ($order[$#order / 2] + $order[$#order / 2 + .5]) / 2;
-$barmark[ $mean * $size ] = '+';  # mean
+$barmark[ sum(@values) / @values * $size ] = '=';  # average
+$barmark[ orderpos($#order / 2) ] = '+';  # mean
+defined and $_ = "\e[36m$_\e[0m" for @barmark;
 
 for my $nr (0 .. $#lines) {
        my $val = $values[$nr];
@@ -30,3 +38,38 @@ for my $nr (0 .. $#lines) {
        print $barmark[$_] // '-' for 1 .. $val * $size;
        say '';
 }
+
+__END__
+
+=head1 NAME
+
+graph - append bar chart to input numbers
+
+=head1 SYNOPSIS
+
+B<graph> [<options>] [<input>]
+
+cat ... | uniq -c | graph
+
+=head1 DESCRIPTION
+
+Each line starting with a number is given a bar to visualise relative sizes.
+
+=head1 OPTIONS
+
+=over
+
+=item -w, --width=<columns>
+
+Override the maximum number of columns to use.
+Appended graphics will extend to fill up the entire screen.
+
+=back
+
+=head1 AUTHOR
+
+Mischa POSLAWSKY <perl@shiar.org>
+
+=head1 LICENSE
+
+GPL3+.