summaryrefslogtreecommitdiff
path: root/support/dktools/man/man1/dk-fic.1
blob: 079571f32c8af649214bf9bb76a0305f853efb72 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
'\" t
.\"     Title: dk-fic
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 03/24/2020
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "DK\-FIC" "1" "03/24/2020" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
dk-fic \- File integrity checker
.SH "SYNOPSIS"
.sp
\fBdk\-fic\fR [\fIoptions\fR] [\fIfile(s)\fR]
.SH "DESCRIPTION"
.sp
The program can either build file checksum list or check (verify) checksum lists\&. A checksum list contains message digests (MD5, SHA\-1, RIPEMD\-160 and SHA\-512), file size and file name\&. If support for the SHA\-512 message digest algorithm was not found during build process, the SHA\-512 message digest is skipped\&. Message digests are converted to text using ASCII\-85 encoding, not ASCII\-Hex\&. When building a file checksum list, the files specified as command line arguments contain lists of file names to produce checksums for\&. If no file is specified as argument, the list of file names is read from standard input\&. When verifying checksum lists, the files specified as command line arguments contain checksum lists previously produced\&. If no file is specified as argument, the checksum list is read from standard input\&.
.SH "OPTIONS"
.PP
\fB\-c\fR, \fB\-\-check\fR
.RS 4
Check (verify) a checksum list\&. Without this option the program produces a checksum list\&.
.RE
.PP
\fB\-v\fR, \fB\-\-verbose\fR
.RS 4
Messages for succeeded tests too when checking\&. By default a message is only produced for failed tests\&.
.RE
.PP
\fB\-q\fR, \fB\-\-quiet\fR
.RS 4
No output for failed tests when checking a checksum list\&. Options \-v and \-q are mutually exclusive\&.
.RE
.PP
\fB\-l\fR \fIsize\fR, \fB\-\-line\-size=\fR\fIsize\fR
.RS 4
Input line buffer size\&.
.RE
.SH "EXIT STATUS"
.sp
The program returns exit status code 0 on success, all other values indicate errors\&.
.SH "PREFERENCES"
.PP
\fBline\&.size\fR
.RS 4
Line buffer size if the \-l option was not used\&.
.RE
.SH "EXAMPLES"
.PP
Produce a checksum list on Windows
.RS 4
dk\-ls \-r \-tf \-pn <directory> | dk\-fic > checklist\&.txt
.RE
.PP
Produce a checksum list on non\-Windows systems
.RS 4
find <directory> \-type f | dk\-fic > checklist\&.txt
.RE
.PP
Verify a checksum list
.RS 4
dk\-fic \-c < checklist\&.txt
.RE
.sp
When creating a checksum list, make sure the checksum list file is not included in the checksum list itself\&.
.SH "RESTRICTIONS"
.sp
On Windows the file name length is restricted to _MAX_PATH (260) characters if the file name contains a wildcard (* or ? character)\&.
.SH "NOTES"
.sp
This program uses DK libraries version 4\&.
.SH "AUTHOR"
.sp
Dirk Krause
.SH "COPYRIGHT AND LICENSE"
.sp
Copyright (c) 2015\-2016, Dirk Krause
.sp
All rights reserved\&.
.sp
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Neither the name of the copyright holder(s) nor the names of contributors may be used to endorse or promote products derived from this software without specific prior written permission\&.
.RE
.sp
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \(lqAS IS\(rq AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED\&. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE\&.
.sp
This product includes cryptographic software written by Eric Young (eay@cryptsoft\&.com)\&. This product includes software written by Tim Hudson (tjh@cryptsoft\&.com)\&.
.SH "SEE ALSO"
.PP
http://sourceforge\&.net/p/dktools/wiki/Home/
.RS 4
Project homepage\&.
.RE