4
4
." Please read man-pages(7) and groff_man(7) about the manual page format.
5
5
." If you're missing groff_man.7, install groff. Solid documentation.
6
6
."
7
- .TH ddh 1 "December 2020 " dd86k "User manual"
7
+ .TH ddh 1 "September 2021 " dd86k "User manual"
8
8
.SH NAME
9
9
ddh \(em Generic hasher
10
10
@@ -13,9 +13,6 @@ ddh \(em Generic hasher
13
13
.B {list|ver|help|version|license}
14
14
.SY ddh
15
15
.B alias
16
- .OP -
17
- .SY ddh
18
- .B alias
19
16
.OP options...
20
17
.B {files|-}...
21
18
.YS
@@ -25,12 +22,13 @@ ddh \(em Generic hasher
25
22
is a generic hasher. The main goal of this utility is to centralize
26
23
the various options into one package for multiple systems.
27
24
28
- The output matches the one of the coreutils sum (e.g., sha1sum) utilities for
29
- compability reasons.
25
+ By default, the GNU-style checksums are used. You can use
26
+ .I --tag
27
+ to switch to the BSD-style checksums. This affects reading lists.
30
28
31
- The default operating mode is FILE for being the best case scenario for
29
+ The default entry mode is File for being the best case scenario for
32
30
behaving better on zero-length files, network shares, and on most
33
- operating systems.
31
+ operating systems. The Mmfile option is good for performance reasons.
34
32
35
33
.SH EXAMPLES
36
34
@@ -63,16 +61,17 @@ Use SHA-256 to hash all files in the
63
61
folder.
64
62
65
63
.TP
66
- .BI ddh\ md5 \ -Ms \ *.{json,md}
64
+ .BI ddh\ md5 \ -Ms \ " *.{json,md}"
67
65
Use MD5 to hash all files in sub-directories
68
66
.RI ( -s )
69
67
that end with .json or .md using the memory-mapped file option
70
- .RI ( -M ).
68
+ .RI ( -M )
69
+ using the embedded glob matcher.
71
70
72
71
.TP
73
72
.BI ddh\ sha256 \ -c\ list
74
73
Use SHA-256 to verify the integrity a list of files. This is similar to
75
- .BR sha1sum \ -c\ list .
74
+ .BR sha256sum \ -c\ list .
76
75
77
76
.SH ALIASES
78
77
@@ -84,42 +83,48 @@ Below is a list of supported checksum and hash algorithms.
84
83
85
84
86
85
.TS
87
- l l .
88
- Alias Name
86
+ l l l .
87
+ Alias Name Tag
89
88
.T&
90
- lB l .
89
+ lB l l .
91
90
_
92
- crc32 CRC-32
93
- crc64iso CRC-64-ISO
94
- crc64ecma CRC-64-ECMA
95
- md5 MD5-128
96
- ripemd160 RIDEMD -160
97
- sha1 SHA-1-160
98
- sha224 SHA-2-224
99
- sha256 SHA-2-256
100
- sha384 SHA-2-384
101
- sha512 SHA-2-512
102
- sha3-224 SHA-3-224
103
- sha3-256 SHA-3-256
104
- sha3-384 SHA-3-384
105
- sha3-512 SHA-3-512
106
- shake128 SHAKE-128
107
- shake256 SHAKE-256
91
+ crc32 CRC-32 CRC32
92
+ crc64iso CRC-64-ISO CRC64ISO
93
+ crc64ecma CRC-64-ECMA CRC64ECMA
94
+ md5 MD5-128 MD5
95
+ ripemd160 RIPEMD -160 RIPEMD160
96
+ sha1 SHA-1-160 SHA1
97
+ sha224 SHA-2-224 SHA224
98
+ sha256 SHA-2-256 SHA256
99
+ sha384 SHA-2-384 SHA384
100
+ sha512 SHA-2-512 SHA512
101
+ sha3-224 SHA-3-224 SHA3_224
102
+ sha3-256 SHA-3-256 SHA3_256
103
+ sha3-384 SHA-3-384 SHA3_384
104
+ sha3-512 SHA-3-512 SHA3_512
105
+ shake128 SHAKE-128 SHAKE128
106
+ shake256 SHAKE-256 SHAKE256
108
107
.TE
109
108
110
109
.SH OPTIONS
111
110
112
- Options beforehand the
113
- .I files...
114
- specification affects the set of all current and future files unless new
115
- options are defined for the current and future set of files.
116
-
117
111
Short options can be combined. Options that expect an additional argument
118
112
(i.e., the following argument) should not be combined, this includes
119
113
.I -c
120
114
and
121
115
.IR -a .
122
116
117
+ .SS Entry methods
118
+ .TS
119
+ l l .
120
+ Option Description
121
+ .T&
122
+ lB l .
123
+ -a, --arg Hash argument text as UTF-8.
124
+ -c, --check Check hashes against a file.
125
+ - Set input mode to stdin.
126
+ .TE
127
+
123
128
.SS File input modes
124
129
.TS
125
130
l l .
131
136
-b, --binary File: Set read mode to binary (default).
132
137
-t, --text File: Set read mode to text.
133
138
-M, --mmfile Set input mode to memory-mapped file.
134
- -a, --arg Hash the follow argument as text (UTF-8).
135
- -c, --check Set input mode to check file.
136
- - Set input mode to stdin.
137
139
.TE
138
140
139
141
.SS Embedded globber engine
@@ -157,23 +159,20 @@ Option Description
157
159
.T&
158
160
lB l .
159
161
_
160
- -- Stop argument parsing, forever.
162
+ --tag Create or read BSD-style checksums.
163
+ -- Stop parsing arguments.
161
164
.TE
162
165
163
166
.SH WARNINGS
164
167
165
- The \-\- mmfile option does not support files of size zero.
168
+ None for the moment!
166
169
167
170
.SH NOTES
168
171
169
172
UNIX-like shells use their own globbing mechanism. To use the embedded
170
173
globbing mechanism, use '*' or \\* .
171
174
172
- The garbage collector is explicitly configured to be disabled when the program
173
- is started, and avoids collecting when the program stops for performance
174
- reasons. It is only re-enabled when the user specifies \-\- mmfile.
175
-
176
- Release versions of this utility has the druntime gcopts command-line
175
+ Release versions of this utility has the druntime GC command-line
177
176
interface disabled.
178
177
179
178
.SH AUTHOR
0 commit comments