usr.bin/cksum/cksum.1

   1 .\" Copyright (c) 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the Institute of Electrical and Electronics Engineers, Inc.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgement:
  17 .\"     This product includes software developed by the University of
  18 .\"     California, Berkeley and its contributors.
  19 .\" 4. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\"     @(#)cksum.1     8.2 (Berkeley) 4/28/95
  36 .\" $FreeBSD$
  37 .\"
  38 .Dd April 28, 1995
  39 .Dt CKSUM 1
  40 .Os BSD 4.4
  41 .Sh NAME
  42 .Nm cksum ,
  43 .Nm sum
  44 .Nd display file checksums and block counts
  45 .Sh SYNOPSIS
  46 .Nm cksum
  47 .Oo
  48 .Fl o Ar \&1 Xo
  49 .No \&|
  50 .Ar \&2
  51 .No \&|
  52 .Ar \&3
  53 .Xc
  54 .Oc
  55 .Op Ar file ...
  56 .Nm sum
  57 .Op Ar file ...
  58 .Sh DESCRIPTION
  59 The
  60 .Nm cksum
  61 utility writes to the standard output three whitespace separated
  62 fields for each input file.
  63 These fields are a checksum
  64 .Tn CRC ,
  65 the total number of octets in the file and the file name.
  66 If no file name is specified, the standard input is used and no file name
  67 is written.
  68 .Pp
  69 The
  70 .Nm sum
  71 utility is identical to the
  72 .Nm cksum
  73 utility, except that it defaults to using historic algorithm 1, as
  74 described below.
  75 It is provided for compatibility only.
  76 .Pp
  77 The options are as follows:
  78 .Bl -tag -width indent
  79 .It Fl o
  80 Use historic algorithms instead of the (superior) default one.
  81 .Pp
  82 Algorithm 1 is the algorithm used by historic
  83 .Bx
  84 systems as the
  85 .Xr sum 1
  86 algorithm and by historic
  87 .At V
  88 systems as the
  89 .Xr sum
  90 algorithm when using the
  91 .Fl r
  92 option.
  93 This is a 16-bit checksum, with a right rotation before each addition;
  94 overflow is discarded.
  95 .Pp
  96 Algorithm 2 is the algorithm used by historic
  97 .At V
  98 systems as the
  99 default
 100 .Xr sum
 101 algorithm.
 102 This is a 32-bit checksum, and is defined as follows:
 103 .Bd -unfilled -offset indent
 104 s = sum of all bytes;
 105 r = s % 2^16 + (s % 2^32) / 2^16;
 106 cksum = (r % 2^16) + r / 2^16;
 107 .Ed
 108 .Pp
 109 Algorithm 3 is what is commonly called the
 110 .Ql 32bit CRC
 111 algorithm.
 112 This is a 32-bit checksum.
 113 .Pp
 114 Both algorithm 1 and 2 write to the standard output the same fields as
 115 the default algorithm except that the size of the file in bytes is
 116 replaced with the size of the file in blocks.
 117 For historic reasons, the block size is 1024 for algorithm 1 and 512
 118 for algorithm 2.
 119 Partial blocks are rounded up.
 120 .El
 121 .Pp
 122 The default
 123 .Tn CRC
 124 used is based on the polynomial used for
 125 .Tn CRC
 126 error checking
 127 in the networking standard
 128 .St -iso8802-3
 129 The
 130 .Tn CRC
 131 checksum encoding is defined by the generating polynomial:
 132 .Pp
 133 .Bd -unfilled -offset indent
 134 G(x) = x^32 + x^26 + x^23 + x^22 + x^16 + x^12 +
 135      x^11 + x^10 + x^8 + x^7 + x^5 + x^4 + x^2 + x + 1
 136 .Ed
 137 .Pp
 138 Mathematically, the
 139 .Tn CRC
 140 value corresponding to a given file is defined by
 141 the following procedure:
 142 .Bd -filled -offset indent
 143 The
 144 .Ar n
 145 bits to be evaluated are considered to be the coefficients of a mod 2
 146 polynomial M(x) of degree
 147 .Ar n Ns \-1 .
 148 These
 149 .Ar n
 150 bits are the bits from the file, with the most significant bit being the most
 151 significant bit of the first octet of the file and the last bit being the least
 152 significant bit of the last octet, padded with zero bits (if necessary) to
 153 achieve an integral number of octets, followed by one or more octets
 154 representing the length of the file as a binary value, least significant octet
 155 first.
 156 The smallest number of octets capable of representing this integer are used.
 157 .Pp
 158 M(x) is multiplied by x^32 (i.e., shifted left 32 bits) and divided by
 159 G(x) using mod 2 division, producing a remainder R(x) of degree <= 31.
 160 .Pp
 161 The coefficients of R(x) are considered to be a 32-bit sequence.
 162 .Pp
 163 The bit sequence is complemented and the result is the CRC.
 164 .Ed
 165 .Pp
 166 The
 167 .Nm cksum
 168 and
 169 .Nm sum
 170 utilities exit 0 on success, and >0 if an error occurs.
 171 .Sh SEE ALSO
 172 .Xr md5 1
 173 .Rs
 174 The default calculation is identical to that given in pseudo-code
 175 in the following
 176 .Tn ACM
 177 article.
 178 .Rs
 179 .%T "Computation of Cyclic Redundancy Checks Via Table Lookup"
 180 .%A Dilip V. Sarwate
 181 .%J "Communications of the \\*(tNACM\\*(sP"
 182 .%D "August 1988"
 183 .Re
 184 .Sh STANDARDS
 185 The
 186 .Nm cksum
 187 utility is expected to conform to
 188 .St -p1003.2-92 .
 189 .Sh HISTORY
 190 The
 191 .Nm cksum
 192 utility appeared in
 193 .Bx 4.4 .