usr.sbin/ckdist/ckdist.1

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