From cb5119f38aed18044f79716bb6624049f2a6ee85 Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Sun, 19 Dec 2010 12:59:06 +0100 Subject: Add very basic documentation --- bin/hashl | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) 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 - Create database with partial file hashes, check if other files are in it + =head1 SYNOPSIS +B [B<-d> I] I [I] + =head1 DESCRIPTION +Actions: + +=over + +=item B [I] + +Checks if I is in the database. Returns 0 if it is, 1 otherwise. + +If I is not specified, B reads filenames from stdin and returns +those which are not already in the database. + +=item B + +Update or create hash database. Iterates over all files below the current +directory. + +=back + =head1 OPTIONS -=head1 EXIT STATUS +=over + +=item B<-d> I + +Use I instead of F<.hashl.db> + +=back =head1 CONFIGURATION +None, so far + =head1 DEPENDENCIES +=over + +=item * autodie (included with perl E= 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 Ederf@finalrewind.orgE -- cgit v1.2.3