Add built local::lib
[catagits/Gitalist.git] / local-lib5 / man / man1 / shasum.1p
1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "SHASUM 1"
127 .TH SHASUM 1 "2010-01-04" "perl v5.8.8" "User Contributed Perl Documentation"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 shasum \- Print or Check SHA Checksums
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 .Vb 4
137 \& Usage: shasum [OPTION] [FILE]...
138 \&    or: shasum [OPTION] \-\-check [FILE]
139 \& Print or check SHA checksums.
140 \& With no FILE, or when FILE is \-, read standard input.
141 \&
142 \&  \-a, \-\-algorithm    1 (default), 224, 256, 384, 512
143 \&  \-b, \-\-binary       read files in binary mode (default on DOS/Windows)
144 \&  \-c, \-\-check        check SHA sums against given list
145 \&  \-p, \-\-portable     read files in portable mode
146 \&                         produces same digest on Windows/Unix/Mac
147 \&  \-t, \-\-text         read files in text mode (default)
148 \&
149 \& The following two options are useful only when verifying checksums:
150 \&
151 \&  \-s, \-\-status       don\*(Aqt output anything, status code shows success
152 \&  \-w, \-\-warn         warn about improperly formatted SHA checksum lines
153 \&
154 \&  \-h, \-\-help         display this help and exit
155 \&  \-v, \-\-version      output version information and exit
156 \&
157 \& The sums are computed as described in FIPS PUB 180\-2.  When checking,
158 \& the input should be a former output of this program.  The default mode
159 \& is to print a line with checksum, a character indicating type (\`*\*(Aq
160 \& for binary, \`?\*(Aq for portable, \` \*(Aq for text), and name for each FILE.
161 .Ve
162 .SH "DESCRIPTION"
163 .IX Header "DESCRIPTION"
164 The \fIshasum\fR script provides the easiest and most convenient way to
165 compute \s-1SHA\s0 message digests.  Rather than writing a program, the user
166 simply feeds data to the script via the command line, and waits for
167 the results to be printed on standard output.  Data can be fed to
168 \&\fIshasum\fR through files, standard input, or both.
169 .PP
170 The following command shows how easy it is to compute digests for typical
171 inputs such as the \s-1NIST\s0 test vector \*(L"abc\*(R":
172 .PP
173 .Vb 1
174 \&        perl \-e "print qq(abc)" | shasum
175 .Ve
176 .PP
177 Or, if you want to use \s-1SHA\-256\s0 instead of the default \s-1SHA\-1\s0, simply say:
178 .PP
179 .Vb 1
180 \&        perl \-e "print qq(abc)" | shasum \-a 256
181 .Ve
182 .PP
183 Since \fIshasum\fR uses the same interface employed by the familiar
184 \&\fIsha1sum\fR program (and its somewhat outmoded anscestor \fImd5sum\fR),
185 you can install this script as a convenient drop-in replacement.
186 .SH "AUTHOR"
187 .IX Header "AUTHOR"
188 Copyright (c) 2003\-2010 Mark Shelor <mshelor@cpan.org>.
189 .SH "SEE ALSO"
190 .IX Header "SEE ALSO"
191 shasum is implemented using the Perl module Digest::SHA or
192 Digest::SHA::PurePerl.