xref: /dragonfly/usr.sbin/ckdist/ckdist.1 (revision 7ff0fc30)
1.\" Copyright (c) 1997 Robert Nordier
2.\" All rights reserved.
3.\"
4.\" $FreeBSD: head/usr.sbin/ckdist/ckdist.1 213573 2010-10-08 12:40:16Z uqs $
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 May 8, 2018
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
41The
42.Nm
43utility reads
44.Dq checksum
45files (which are assumed to specify components
46of a software distribution) and verifies the integrity of the
47distribution by validating the checksum of each component file.
48Both MD5 (128-bit
49.Dq "message digest" )
50and
51.Pa .inf
52(32-bit CRC) checksum
53formats are supported.
54.Pp
55The
56.Ar file
57operands may refer to regular files or to directories.
58Regular files
59named
60.Pa md5 ,
61or which have an
62.Pa .md5
63or an
64.Pa .inf
65extension, are
66assumed to be of the implied type, otherwise format is determined from
67content.
68If a directory is specified, it is searched for
69appropriately-named files only.
70.Pp
71The options are as follows:
72.\"Bl -tag -width ".Fl n Ar name"
73.Bl -tag -width 8n -offset indent
74.It Fl a
75Report on all distribution components, not just those in respect of
76which errors are detected.
77.It Fl i
78Ignore missing distribution components.
79.It Fl r
80Search specified directories recursively.
81.It Fl s
82Suppress complaints about inaccessible checksum files and directories.
83.It Fl x
84Verify the existence of distribution components (and also check sizes,
85in the case of
86.Pa .inf
87files), but omit the more time-consuming step of
88actually computing and comparing checksums.
89.It Fl d Ar dir
90Look for distribution components in the directory
91.Ar dir .
92.It Fl n Ar name
93Access distribution components using the filename
94.Ar name .
95When accessing
96.Pa .inf
97file components, append the appropriate
98extension to the filename.
99.It Fl t Ar type
100Assume that all specified checksum files are of the format
101.Ar type ,
102and search directories only for files in this format (where
103.Ar type
104is either
105.Cm md5
106or
107.Cm inf ) .
108.El
109.Sh EXIT STATUS
110The
111.Nm
112utility exits with one of the following values:
113.Bl -tag -width indent
114.It 0
115No errors were detected.
116.It 1
117Errors were found in a distribution.
118.It 2
119Usage errors, inaccessible input files, or
120other system errors were encountered.
121.El
122.Sh SEE ALSO
123.Xr cksum 1 ,
124.Xr md5 1
125.Sh NOTES
126Both
127.Bx
128and
129.Tn DOS
130versions of
131.Nm
132are available.
133