minimal documentation and help options v1.00
authorMischa POSLAWSKY <perl@shiar.org>
Wed, 4 Sep 2019 16:52:19 +0000 (18:52 +0200)
committerMischa POSLAWSKY <perl@shiar.org>
Thu, 5 Sep 2019 03:11:33 +0000 (05:11 +0200)
graph

diff --git a/graph b/graph
index 6fa5845b349540070fc85d72876ff564cabad7eb..16af69ab31f609d651c5bd38f3121dcde019a429 100755 (executable)
--- a/graph
+++ b/graph
@@ -3,13 +3,15 @@ use 5.014;
 use warnings;
 use List::Util qw( max sum );
 
-use Getopt::Long;
+our $VERSION = '1.00';
+
+use Getopt::Long '2.33';
 GetOptions(\my %opt,
        'width|w=i',
 ) or exit 64;  # EX_USAGE
 $opt{width} ||= $ENV{COLUMNS} || 80;
 
-my @lines = readline;
+my @lines = readline or exit;
 chomp for @lines;
 my @values = map { s/^\h*([0-9]*)// and $1 } @lines;
 my @order  = sort { $b <=> $a } @values;
@@ -36,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+.