Skip Menu |

This queue is for tickets about the Digest-SHA CPAN distribution.

Report information
The Basics
Id: 15898
Status: resolved
Worked: 30 min
Priority: 0/
Queue: Digest-SHA

People
Owner: mshelor [...] cpan.org
Requestors: gwolf [...] debian.org
Cc:
AdminCc:

Bug Information
Severity: Wishlist
Broken in: 5.31
Fixed in: 5.32



Subject: Added manpage for the 'shasum' binary
The provided script, shasum, does not have a manpage - Debian requires a manpage for all the files installed in the /usr/bin directory. I did a small patch to your file, basically copying the 'usage' information to POD. I also escaped some backticks/apostrophes in the usage information that made it awkward to be edited in Emacs, as they broke syntax-highlighting. Thanks a lot!
Index: shasum =================================================================== --- shasum (revision 1507) +++ shasum (revision 1508) @@ -7,7 +7,45 @@ # Version: 5.31 # Mon Sep 5 00:52:42 MST 2005 +=head1 NAME +shasum - Print or check SHA checksums + +=head1 SYNOPSIS + +Usage: shasum [OPTION] [FILE]... + or: shasum [OPTION] --check [FILE] +Print or check SHA checksums. +With no FILE, or when FILE is -, read standard input. + + -a, --algorithm 1 (default), 224, 256, 384, 512 + -b, --binary read files in binary mode (default on DOS/Windows) + -c, --check check SHA sums against given list + -t, --text read files in text mode (default) + +The following two options are useful only when verifying checksums: + --status don't output anything, status code shows success + -w, --warn warn about improperly formatted MD5 checksum lines + + --help display this help and exit + --version output version information and exit + +The sums are computed as described in FIPS PUB 180-2. When checking, +the input should be a former output of this program. The default +mode is to print a line with checksum, a character indicating type +(`*' for binary, ` ' for text), and name for each FILE. + +=head1 AUTHOR + +Copyright (c) 2003-2005 Mark Shelor <mshelor@cpan.org>. + +=head1 SEE ALSO + +Shasum is implemented using the Perl module L<Digest::SHA> or +L<Digest::SHA::PurePerl>. + +=cut + use strict; use Getopt::Long; @@ -48,7 +86,7 @@ -t, --text read files in text mode (default) The following two options are useful only when verifying checksums: - --status don't output anything, status code shows success + --status don\'t output anything, status code shows success -w, --warn warn about improperly formatted MD5 checksum lines --help display this help and exit @@ -57,7 +95,7 @@ The sums are computed as described in FIPS PUB 180-2. When checking, the input should be a former output of this program. The default mode is to print a line with checksum, a character indicating type -(`*' for binary, ` ' for text), and name for each FILE. +(\`*\' for binary, \` \' for text), and name for each FILE. Report bugs to <mshelor@cpan.org>. END_OF_USAGE