| blob | f029b3b9a9cf2fc0c7ed19377baadfb81d0636a7 |
1 .\"
2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 .\" permission to reproduce portions of its copyrighted documentation.
4 .\" Original documentation from The Open Group can be obtained online at
5 .\" http://www.opengroup.org/bookstore/.
6 .\"
7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 .\" Group, have given us permission to reprint portions of their
9 .\" documentation.
10 .\"
11 .\" In the following statement, the phrase ``this text'' refers to portions
12 .\" of the system documentation.
13 .\"
14 .\" Portions of this text are reprinted and reproduced in electronic form
15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 .\" Standard for Information Technology -- Portable Operating System
17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 .\" Engineers, Inc and The Open Group. In the event of any discrepancy
20 .\" between these versions and the original IEEE and The Open Group
21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 .\" document. The original Standard can be obtained online at
23 .\" http://www.opengroup.org/unix/online.html.
24 .\"
25 .\" This notice shall appear on any product containing this material.
26 .\"
27 .\" The contents of this file are subject to the terms of the
28 .\" Common Development and Distribution License (the "License").
29 .\" You may not use this file except in compliance with the License.
30 .\"
31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 .\" or http://www.opensolaris.org/os/licensing.
33 .\" See the License for the specific language governing permissions
34 .\" and limitations under the License.
35 .\"
36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 .\" If applicable, add the following below this CDDL HEADER, with the
39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
41 .\"
42 .\"
43 .\" Copyright 1989 AT&T
44 .\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved
45 .\" Portions Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
46 .\"
47 .TH SUM 1 "Aug 11, 2009"
48 .SH NAME
49 sum \- print checksum and block count for a file
50 .SH SYNOPSIS
51 .LP
52 .nf
53 \fB/usr/bin/sum\fR [-abBchHlLpPrRstTw] [-x method] [\fIfile\fR...]
54 .fi
56 .SS "ksh93"
57 .LP
58 .nf
59 sum [-abBchHlLpPrRstTw] [-x method] [\fIfile\fR...]
60 .fi
62 .SH DESCRIPTION
63 .sp
64 .LP
65 The \fBsum\fR utility and ksh93 built-in command list the checksum, and for
66 most methods the block count, for each file argument. The standard input is
67 read if there are no file arguments.
68 .sp
69 .LP
70 The \fBgetconf\fR(1) \fBUNIVERSE\fR determines the default sum method: att for
71 the att universe, bsd otherwise. The default for the other commands is the
72 command name itself. The att method is a true sum, all others are order
73 dependent.
74 .sp
75 .LP
76 Method names consist of a leading identifier and 0 or more options separated by
77 -.
78 .sp
79 .LP
80 \fBgetconf\fR \fBPATH_RESOLVE\fR determines how symbolic links are handled.
81 This can be explicitly overridden by the \fB--logical\fR, \fB--metaphysical\fR,
82 and \fB--physical\fR options below. \fBPATH_RESOLVE\fR can be one of:
83 .sp
84 .ne 2
85 .na
86 \fB\fB--logical\fR\fR
87 .ad
88 .RS 18n
89 Follow all symbolic links.
90 .RE
92 .sp
93 .ne 2
94 .na
95 \fB\fB--metaphysical\fR\fR
96 .ad
97 .RS 18n
98 Follow command argument symbolic links, otherwise do not follow.
99 .RE
101 .sp
102 .ne 2
103 .na
104 \fB\fB--physical\fR\fR
105 .ad
106 .RS 18n
107 Do not follow symbolic links.
108 .RE
110 .SH OPTIONS
111 .sp
112 .LP
113 The following options are supported for \fB/usr/bin/sum\fR:
114 .sp
115 .ne 2
116 .na
117 \fB\fB-a\fR\fR
118 .ad
119 .br
120 .na
121 \fB\fB--all\fR\fR
122 .ad
123 .sp .6
124 .RS 4n
125 List the checksum for all files. Use with \fB--total\fR to list both individual
126 and total checksums and block counts.
127 .RE
129 .sp
130 .ne 2
131 .na
132 \fB\fB-b\fR\fR
133 .ad
134 .br
135 .na
136 \fB\fB--binary\fR\fR
137 .ad
138 .sp .6
139 .RS 4n
140 Read files in binary mode. This is the default.
141 .RE
143 .sp
144 .ne 2
145 .na
146 \fB\fB-B\fR\fR
147 .ad
148 .br
149 .na
150 \fB\fB--scale=scale\fR\fR
151 .ad
152 .sp .6
153 .RS 4n
154 Block count scale (bytes per block) override for methods that include size in
155 the output. The default is method-specific.
156 .RE
158 .sp
159 .ne 2
160 .na
161 \fB\fB-c\fR\fR
162 .ad
163 .br
164 .na
165 \fB\fB--check\fR\fR
166 .ad
167 .sp .6
168 .RS 4n
169 Each file is interpreted as the output from a previous sum. If \fB--header\fR
170 or \fB--permissions\fR was specified in the previous sum then the checksum
171 method is automatically determined, otherwise \fB--method\fR must be specified.
172 The listed checksum is compared with the current value and a warning is issued
173 for each file that does not match. If file was generated by
174 \fB--permissions\fR, then the file mode, user and group are also checked. Empty
175 lines, lines starting with #<space>, or the line # are ignored. Lines
176 containing no blanks are interpreted as [no]name[=\fIvalue\fR] options:
177 .sp
178 .ne 2
179 .na
180 \fB\fBmethod=name\fR\fR
181 .ad
182 .sp .6
183 .RS 4n
184 Checksum method to apply to subsequent lines.
185 .RE
187 .sp
188 .ne 2
189 .na
190 \fB\fBpermissions\fR\fR
191 .ad
192 .sp .6
193 .RS 4n
194 Subsequent lines were generated with \fB--permissions\fR.
195 .RE
197 .RE
199 .sp
200 .ne 2
201 .na
202 \fB\fB-h\fR\fR
203 .ad
204 .br
205 .na
206 \fB\fB--header\fR\fR
207 .ad
208 .sp .6
209 .RS 4n
210 Print the checksum method as the first output line. Used with \fB--check\fR and
211 \fB--permissions\fR.
212 .RE
214 .sp
215 .ne 2
216 .na
217 \fB\fB-l\fR\fR
218 .ad
219 .br
220 .na
221 \fB\fB--list\fR\fR
222 .ad
223 .sp .6
224 .RS 4n
225 Each file is interpreted as a list of files, one per line, that is checksummed.
226 .RE
228 .sp
229 .ne 2
230 .na
231 \fB\fB-p\fR\fR
232 .ad
233 .br
234 .na
235 \fB\fB--permissions\fR\fR
236 .ad
237 .sp .6
238 .RS 4n
239 If \fB--check\fR is not specified then list the file mode, user and group
240 between the checksum and path. User and group matching the caller are output as
241 -. If \fB--check\fR is specified then the mode, user and group for each path in
242 file are updated if necessary to match those in file. A warning is printed on
243 the standard error for each changed file.
244 .RE
246 .sp
247 .ne 2
248 .na
249 \fB\fB-R\fR\fR
250 .ad
251 .br
252 .na
253 \fB\fB--recursive\fR\fR
254 .ad
255 .sp .6
256 .RS 4n
257 Recursively checksum the contents of directories.
258 .RE
260 .sp
261 .ne 2
262 .na
263 \fB\fB-t\fR\fR
264 .ad
265 .br
266 .na
267 \fB\fB--total\fR\fR
268 .ad
269 .sp .6
270 .RS 4n
271 List only the total checksum and block count of all files. \fB--all\fR
272 \fB--total\fR lists each checksum and the total. The total checksum and block
273 count may be different from the checksum and block count of the catenation of
274 all files due to partial blocks that may occur when the files are treated
275 separately.
276 .RE
278 .sp
279 .ne 2
280 .na
281 \fB\fB-T\fR\fR
282 .ad
283 .br
284 .na
285 \fB\fB--text\fR\fR
286 .ad
287 .sp .6
288 .RS 4n
289 Read files in text mode (for example, treat \er\en as \en).
290 .RE
292 .sp
293 .ne 2
294 .na
295 \fB\fB-w\fR\fR
296 .ad
297 .br
298 .na
299 \fB\fB--warn\fR\fR
300 .ad
301 .sp .6
302 .RS 4n
303 Warn about invalid \fB--check\fR lines. On by default; \fB-w\fR means
304 \fB--nowarn\fR.
305 .RE
307 .sp
308 .ne 2
309 .na
310 \fB\fB-x\fR\fR
311 .ad
312 .br
313 .na
314 \fB\fB--method|algorithm=method\fR\fR
315 .ad
316 .sp .6
317 .RS 4n
318 Specifies the checksum method to apply. Parenthesized method options are
319 readonly implementation details.
320 .sp
321 .ne 2
322 .na
323 \fB\fBatt\fR|\fBsys5\fR|\fBs5\fR|\fBdefault\fR\fR
324 .ad
325 .sp .6
326 .RS 4n
327 The system 5 release 4 checksum. This is the default for sum when \fBgetconf\fR
328 \fBUNIVERSE\fR is \fBatt\fR. This is the only true sum; all of the other
329 methods are order dependent.
330 .RE
332 .sp
333 .ne 2
334 .na
335 \fB\fBast4\fR|\fB32x4\fR|\fBtw\fR\fR
336 .ad
337 .sp .6
338 .RS 4n
339 The \fBast\fR 128 bit \fBPRNG\fR hash generated by catenating 4 separate 32 bit
340 \fBPNRG\fR hashes. The block count is not printed.
341 .RE
343 .sp
344 .ne 2
345 .na
346 \fB\fBbsd\fR|\fBucb\fR\fR
347 .ad
348 .sp .6
349 .RS 4n
350 The BSD checksum.
351 .RE
353 .sp
354 .ne 2
355 .na
356 \fB\fBcrc\fR\fR
357 .ad
358 .sp .6
359 .RS 4n
360 32 bit CRC (cyclic redundancy check).
361 .sp
362 .ne 2
363 .na
364 \fB\fBpolynomial\fR=\fImask\fR\fR
365 .ad
366 .sp .6
367 .RS 4n
368 The 32 bit \fBcrc\fR polynomial bitmask with implicit bit 32. The default value
369 is 0xedb88320.
370 .RE
372 .sp
373 .ne 2
374 .na
375 \fB\fBdone\fR[=\fInumber\fR]\fR
376 .ad
377 .sp .6
378 .RS 4n
379 XOR the final \fBcrc\fR value with number. 0xffffffff is used if number is
380 omitted. The option value may be omitted. The default value is 0.
381 .RE
383 .sp
384 .ne 2
385 .na
386 \fB\fBinit\fR[=\fInumber\fR]\fR
387 .ad
388 .sp .6
389 .RS 4n
390 The initial \fBcrc\fR value. 0xffffffff is used if number is omitted. The
391 option value may be omitted. The default value is 0.
392 .RE
394 .sp
395 .ne 2
396 .na
397 \fB\fBrotate\fR\fR
398 .ad
399 .sp .6
400 .RS 4n
401 XOR each input character with the high order \fBcrc\fR byte (instead of the low
402 order).
403 .RE
405 .sp
406 .ne 2
407 .na
408 \fB\fBsize\fR[=\fInumber\fR]\fR
409 .ad
410 .sp .6
411 .RS 4n
412 Include the total number of bytes in the crc. number, if specified, is first
413 XOR'd into the size. The option value may be omitted. The default value is 0.
414 .RE
416 .RE
418 .sp
419 .ne 2
420 .na
421 \fB\fBprng\fR\fR
422 .ad
423 .sp .6
424 .RS 4n
425 32 bit \fBPRNG\fR (pseudo random number generator) hash.
426 .sp
427 .ne 2
428 .na
429 \fB\fBmpy\fR=\fInumber\fR\fR
430 .ad
431 .RS 17n
432 The 32 bit \fBPRNG\fR multiplier. The default value is 0x01000193.
433 .RE
435 .sp
436 .ne 2
437 .na
438 \fB\fBadd\fR=\fInumber\fR\fR
439 .ad
440 .RS 17n
441 The 32 bit \fBPRNG\fR addend. The default value is 0.
442 .RE
444 .sp
445 .ne 2
446 .na
447 \fB\fBinit\fR[=\fInumber\fR]\fR
448 .ad
449 .RS 17n
450 The \fBPRNG\fR initial value. 0xffffffff is used if number is omitted. The
451 option value may be omitted. The default value is 0x811c9dc5.
452 .RE
454 .RE
456 .sp
457 .ne 2
458 .na
459 \fB\fBmd4\fR|\fBMD4\fR\fR
460 .ad
461 .sp .6
462 .RS 4n
463 \fBRFC1320\fR \fBMD4\fR message digest. Cryptographically weak. The block count
464 is not printed. (version) \fBmd4\fR (\fBsolaris\fR \fB-lmd\fR) 2005-07-26
465 .RE
467 .sp
468 .ne 2
469 .na
470 \fB\fBmd5\fR|\fBMD5\fR\fR
471 .ad
472 .sp .6
473 .RS 4n
474 \fBRFC1321\fR \fBMD5\fR message digest. Cryptographically weak. The block count
475 is not printed. (version) \fBmd5\fR (\fBsolaris\fR \fB-lmd\fR) 2005-07-26
476 .RE
478 .sp
479 .ne 2
480 .na
481 \fB\fBsha1\fR|\fBSHA1\fR|\fBsha-1\fR|\fBSHA-1\fR\fR
482 .ad
483 .sp .6
484 .RS 4n
485 \fBRFC3174\fR / \fBFIPS 180-1\fR \fBSHA-1\fR secure hash algorithm 1.
486 Cryptographically weak. The block count is not printed. (version) \fBsha1\fR
487 (\fBsolaris\fR \fB-lmd\fR) 2005-07-26
488 .RE
490 .sp
491 .ne 2
492 .na
493 \fB\fBsha256\fR|\fBsha-256\fR|\fBSHA256\fR|\fBSHA-256\fR\fR
494 .ad
495 .sp .6
496 .RS 4n
497 \fBFIPS 180-2\fR \fBSHA256\fR secure hash algorithm. The block count is not
498 printed. (version) \fBsha256\fR (\fBsolaris\fR \fB-lmd\fR) 2005-07-26
499 .RE
501 .sp
502 .ne 2
503 .na
504 \fB\fBsha384\fR|\fBsha-384\fR|\fBSHA384\fR|\fBSHA-384\fR\fR
505 .ad
506 .sp .6
507 .RS 4n
508 \fBFIPS 180-2\fR \fBSHA384\fR secure hash algorithm. The block count is not
509 printed. (version) \fBsha384\fR (\fBsolaris\fR \fB-lmd\fR) 2005-07-26
510 .RE
512 .sp
513 .ne 2
514 .na
515 \fB\fBsha512\fR|\fBsha-512\fR|\fBSHA512\fR|\fBSHA-512\fR\fR
516 .ad
517 .sp .6
518 .RS 4n
519 \fBFIPS 180-2\fR \fBSHA512\fR secure hash algorithm. The block count is not
520 printed. (version) \fBsha512\fR (\fBsolaris\fR \fB-lmd\fR) 2005-07-26
521 .RE
523 .sp
524 .ne 2
525 .na
526 \fB\fBposix\fR|\fBcksum\fR|\fBstd\fR|\fBstandard\fR\fR
527 .ad
528 .sp .6
529 .RS 4n
530 The \fBposix 1003.2-1992\fR 32 bit \fBcrc\fR checksum. This is the default
531 \fBcksum\fR(1) method. Shorthand for \fBcrc-0x04c11db7-rotate-done-size\fR.
532 .RE
534 .sp
535 .ne 2
536 .na
537 \fB\fBzip\fR\fR
538 .ad
539 .sp .6
540 .RS 4n
541 The \fBzip\fR(1) \fBcrc\fR. Shorthand for \fBcrc-0xedb88320-init-done\fR.
542 .RE
544 .sp
545 .ne 2
546 .na
547 \fB\fBfddi\fR\fR
548 .ad
549 .sp .6
550 .RS 4n
551 The \fBFDDI\fR \fBcrc\fR. Shorthand for
552 \fBcrc-0xedb88320-size\fR=\fB0xcc55cc55\fR.
553 .RE
555 .sp
556 .ne 2
557 .na
558 \fB\fBfnv\fR|\fBfnv1\fR\fR
559 .ad
560 .sp .6
561 .RS 4n
562 The \fBFowler-Noll-Vo\fR 32 bit \fBPRNG\fR hash with non-zero initializer
563 (\fBFNV-1\fR). Shorthand for \fBprng-0x01000193-init\fR=\fB0x811c9dc5\fR.
564 .RE
566 .sp
567 .ne 2
568 .na
569 \fB\fBast\fR|\fBstrsum\fR\fR
570 .ad
571 .sp .6
572 .RS 4n
573 The \fBast\fR \fBstrsum\fR \fBPRNG\fR hash. Shorthand for
574 \fBprng-0x63c63cd9-add\fR=\fB0x9c39c33d\fR.
575 .RE
577 .RE
579 .sp
580 .ne 2
581 .na
582 \fB\fB-L\fR\fR
583 .ad
584 .br
585 .na
586 \fB\fB--logical\fR|\fBfollow\fR\fR
587 .ad
588 .sp .6
589 .RS 4n
590 Follow symbolic links when traversing directories. The default is determined by
591 \fBgetconf\fR \fBPATH_RESOLVE\fR.
592 .RE
594 .sp
595 .ne 2
596 .na
597 \fB\fB-H\fR\fR
598 .ad
599 .br
600 .na
601 \fB\fB--metaphysical\fR\fR
602 .ad
603 .sp .6
604 .RS 4n
605 Follow command argument symbolic links, otherwise do not follow symbolic links
606 when traversing directories. The default is determined by \fBgetconf\fR
607 \fBPATH_RESOLVE\fR.
608 .RE
610 .sp
611 .ne 2
612 .na
613 \fB\fB-P\fR\fR
614 .ad
615 .br
616 .na
617 \fB\fB--physical\fR\fR
618 .ad
619 .sp .6
620 .RS 4n
621 Do not follow symbolic links when traversing directories. The default is
622 determined by \fBgetconf\fR \fBPATH_RESOLVE\fR.
623 .RE
625 .sp
626 .ne 2
627 .na
628 \fB\fB-r\fR\fR
629 .ad
630 .br
631 .na
632 \fB\fB--bsd\fR\fR
633 .ad
634 .sp .6
635 .RS 4n
636 Equivalent to \fB--method=bsd\fR \fB--scale=512\fR for compatibility with other
637 sum implementations.
638 .RE
640 .sp
641 .ne 2
642 .na
643 \fB\fB-s\fR\fR
644 .ad
645 .br
646 .na
647 \fB\fB--sysv\fR\fR
648 .ad
649 .sp .6
650 .RS 4n
651 Equivalent to \fB--method=sys5\fR for compatibility with other sum
652 implementations.
653 .RE
655 .sp
656 .ne 2
657 .na
658 \fB\fB-S\fR\fR
659 .ad
660 .br
661 .na
662 \fB\fB--silent\fR|\fBstatus\fR\fR
663 .ad
664 .sp .6
665 .RS 4n
666 No output for \fB--check\fR; 0 exit status means all sums matched, non-0 means
667 at least one sum failed to match. Ignored for \fB--permissions\fR.
668 .RE
670 .SH OPERANDS
671 .sp
672 .LP
673 The following operands are supported:
674 .sp
675 .ne 2
676 .na
677 \fB\fIfile\fR\fR
678 .ad
679 .RS 8n
680 A path name of a file. If no files are named, the standard input is used.
681 .RE
683 .SH ENVIRONMENT VARIABLES
684 .sp
685 .LP
686 See \fBenviron\fR(5) for descriptions of the following environment variables
687 that affect the execution of \fBsum\fR: \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and
688 \fBNLSPATH\fR.
689 .SH EXIT STATUS
690 .sp
691 .LP
692 The following exit values are returned.
693 .sp
694 .ne 2
695 .na
696 \fB\fB0\fR\fR
697 .ad
698 .RS 6n
699 Successful completion.
700 .RE
702 .sp
703 .ne 2
704 .na
705 \fB\fB>0\fR\fR
706 .ad
707 .RS 6n
708 An error occurred.
709 .RE
711 .SH ATTRIBUTES
712 .sp
713 .LP
714 See \fBattributes\fR(5) for descriptions of the following attributes:
715 .sp
717 .sp
718 .TS
719 box;
720 c | c
721 l | l .
722 ATTRIBUTE TYPE ATTRIBUTE VALUE
723 _
724 CSI Enabled
725 .TE
727 .SH SEE ALSO
728 .sp
729 .LP
730 \fBcksum\fR(1), \fBgetconf\fR(1), \fBksh93\fR(1), \fBsum\fR(1B), \fBwc\fR(1),
731 \fBzip\fR(1) , \fBlibmd\fR(3LIB), \fBattributes\fR(5), \fBenviron\fR(5)
732 .SH DIAGNOSTICS
733 .sp
734 .LP
735 \fBRead error\fR is indistinguishable from end of file on most devices. Check
736 the block count.
737 .SH NOTES
738 .sp
739 .LP
740 Portable applications should use \fBcksum\fR(1). The default algorithm for this
741 command is defined in the POSIX standard and is identical across platforms.