Skip to content

Commit 9597656

Browse files
committed
Update manual
1 parent d8153f9 commit 9597656

File tree

1 file changed

+44
-45
lines changed

1 file changed

+44
-45
lines changed

man/ddh.1

+44-45
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
." Please read man-pages(7) and groff_man(7) about the manual page format.
55
." If you're missing groff_man.7, install groff. Solid documentation.
66
."
7-
.TH ddh 1 "December 2020" dd86k "User manual"
7+
.TH ddh 1 "September 2021" dd86k "User manual"
88
.SH NAME
99
ddh \(em Generic hasher
1010

@@ -13,9 +13,6 @@ ddh \(em Generic hasher
1313
.B {list|ver|help|version|license}
1414
.SY ddh
1515
.B alias
16-
.OP -
17-
.SY ddh
18-
.B alias
1916
.OP options...
2017
.B {files|-}...
2118
.YS
@@ -25,12 +22,13 @@ ddh \(em Generic hasher
2522
is a generic hasher. The main goal of this utility is to centralize
2623
the various options into one package for multiple systems.
2724

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.
3028

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
3230
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.
3432

3533
.SH EXAMPLES
3634

@@ -63,16 +61,17 @@ Use SHA-256 to hash all files in the
6361
folder.
6462

6563
.TP
66-
.BI ddh\ md5 \ -Ms \ *.{json,md}
64+
.BI ddh\ md5 \ -Ms \ "*.{json,md}"
6765
Use MD5 to hash all files in sub-directories
6866
.RI ( -s )
6967
that end with .json or .md using the memory-mapped file option
70-
.RI ( -M ).
68+
.RI ( -M )
69+
using the embedded glob matcher.
7170

7271
.TP
7372
.BI ddh\ sha256 \ -c\ list
7473
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 .
7675

7776
.SH ALIASES
7877

@@ -84,42 +83,48 @@ Below is a list of supported checksum and hash algorithms.
8483

8584

8685
.TS
87-
l l.
88-
Alias Name
86+
l l l.
87+
Alias Name Tag
8988
.T&
90-
lB l.
89+
lB l l.
9190
_
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
108107
.TE
109108

110109
.SH OPTIONS
111110

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-
117111
Short options can be combined. Options that expect an additional argument
118112
(i.e., the following argument) should not be combined, this includes
119113
.I -c
120114
and
121115
.IR -a .
122116

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+
123128
.SS File input modes
124129
.TS
125130
l l.
@@ -131,9 +136,6 @@ _
131136
-b, --binary File: Set read mode to binary (default).
132137
-t, --text File: Set read mode to text.
133138
-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.
137139
.TE
138140

139141
.SS Embedded globber engine
@@ -157,23 +159,20 @@ Option Description
157159
.T&
158160
lB l.
159161
_
160-
-- Stop argument parsing, forever.
162+
--tag Create or read BSD-style checksums.
163+
-- Stop parsing arguments.
161164
.TE
162165

163166
.SH WARNINGS
164167

165-
The \-\-mmfile option does not support files of size zero.
168+
None for the moment!
166169

167170
.SH NOTES
168171

169172
UNIX-like shells use their own globbing mechanism. To use the embedded
170173
globbing mechanism, use '*' or \\*.
171174

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
177176
interface disabled.
178177

179178
.SH AUTHOR

0 commit comments

Comments
 (0)