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