Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.sbin / ckdist / ckdist.1
1 .\" Copyright (c) 1997 Robert Nordier
2 .\" All rights reserved.
3 .\"
4 .\" $FreeBSD: src/usr.sbin/ckdist/ckdist.1,v 1.4.2.3 2001/08/16 15:55:45 ru Exp $
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS
16 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 .\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
19 .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
23 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
24 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 .\" POSSIBILITY OF SUCH DAMAGE.
26 .\"
27 .Dd January 20, 1997
28 .Dt CKDIST 1
29 .Os
30 .Sh NAME
31 .Nm ckdist
32 .Nd check software distributions
33 .Sh SYNOPSIS
34 .Nm
35 .Bq Fl airsx
36 .Bq Fl d Ar dir
37 .Bq Fl n Ar name
38 .Bq Fl t Ar type
39 .Ar
40 .Sh DESCRIPTION
41 The
42 .Nm
43 utility reads "checksum" files (which are assumed to specify components
44 of a software distribution) and verifies the integrity of the
45 distribution by validating the checksum of each component file.
46 Both MD5 (128-bit "message digest") and .inf (32-bit CRC) checksum
47 formats are supported.
48 .Pp
49 The
50 .Ar file
51 operands may refer to regular files or to directories.  Regular files
52 named "md5", or which have an ".md5" or an ".inf" extension, are
53 assumed to be of the implied type, otherwise format is determined from
54 content.  If a directory is specified, it is searched for
55 appropriately-named files only.
56 .Pp
57 Options are as follows:
58 .Bl -tag -width 8n -offset indent
59 .It Fl a
60 Report on all distribution components, not just those in respect of
61 which errors are detected.
62 .It Fl i
63 Ignore missing distribution components.
64 .It Fl r
65 Search specified directories recursively.
66 .It Fl s
67 Suppress complaints about inaccessible checksum files and directories.
68 .It Fl x
69 Verify the existence of distribution components (and also check sizes,
70 in the case of .inf files), but omit the more time-consuming step of
71 actually computing and comparing checksums.
72 .It Fl d Ar dir
73 Look for distribution components in the directory
74 .Ar dir .
75 .It Fl n Ar name
76 Access distribution components using the filename
77 .Ar name .
78 When accessing .inf file components, append the appropriate
79 extension to the filename.
80 .It Fl t Ar type
81 Assume that all specified checksum files are of the format
82 .Ar type ,
83 and search directories only for files in this format (where
84 .Ar type
85 is either "md5" or "inf").
86 .El
87 .Sh SEE ALSO
88 .Xr cksum 1 ,
89 .Xr md5 1
90 .Sh DIAGNOSTICS
91 Exit status is 0 if no errors were detected, 1 if errors were found in
92 a distribution, and 2 if usage errors, inaccessible input files, or
93 other system errors were encountered.
94 .Sh NOTES
95 Both
96 .Bx
97 and
98 .Tn DOS
99 versions of
100 .Nm
101 are available.