summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2010-12-19 12:59:06 +0100
committerDaniel Friesel <derf@finalrewind.org>2010-12-19 12:59:06 +0100
commitcb5119f38aed18044f79716bb6624049f2a6ee85 (patch)
treea876ff92ca693bc5793ac040f691d49493431570
parentab171d056a160dd16174316c5cbf84c9059ad712 (diff)
Add very basic documentation
-rwxr-xr-xbin/hashl44
1 files changed, 43 insertions, 1 deletions
diff --git a/bin/hashl b/bin/hashl
index dd80151..dee77ba 100755
--- a/bin/hashl
+++ b/bin/hashl
@@ -153,20 +153,62 @@ __END__
=head1 NAME
+B<hashl> - Create database with partial file hashes, check if other files are in it
+
=head1 SYNOPSIS
+B<hashl> [B<-d> I<dbfile>] I<action> [I<args>]
+
=head1 DESCRIPTION
+Actions:
+
+=over
+
+=item B<in-list> [I<file>]
+
+Checks if I<file> is in the database. Returns 0 if it is, 1 otherwise.
+
+If I<file> is not specified, B<hashl> reads filenames from stdin and returns
+those which are not already in the database.
+
+=item B<update>
+
+Update or create hash database. Iterates over all files below the current
+directory.
+
+=back
+
=head1 OPTIONS
-=head1 EXIT STATUS
+=over
+
+=item B<-d> I<dbfile>
+
+Use I<dbfile> instead of F<.hashl.db>
+
+=back
=head1 CONFIGURATION
+None, so far
+
=head1 DEPENDENCIES
+=over
+
+=item * autodie (included with perl E<gt>= 5.10.1)
+
+=item * Digest::SHA
+
+=item * Time::Progress
+
+=back
+
=head1 BUGS AND LIMITATIONS
+Unknown. This is alpha software.
+
=head1 AUTHOR
Copyright (C) 2010 by Daniel Friesel E<lt>derf@finalrewind.orgE<gt>