md5(1): fix style in man page

Fix a bunch of style problems reported by mandoc(1) and igor:

mandoc: ./md5.1:19:71: STYLE: no blank before trailing delimiter: Nm ... rmd160,
mandoc: ./md5.1:20:23: STYLE: no blank before trailing delimiter: Nm ...  skein512,
mandoc: ./md5.1:33:2: STYLE: useless macro: Tn
mandoc: ./md5.1:33:2: STYLE: useless macro: Tn
mandoc: ./md5.1:33:2: STYLE: useless macro: Tn
mandoc: ./md5.1:33:2: STYLE: useless macro: Tn
mandoc: ./md5.1:35:2: STYLE: useless macro: Tn
mandoc: ./md5.1:42:2: STYLE: useless macro: Tn
mandoc: ./md5.1:45:2: STYLE: useless macro: Tn
mandoc: ./md5.1:47:2: STYLE: useless macro: Tn
mandoc: ./md5.1:56:2: STYLE: useless macro: Tn
mandoc: ./md5.1:58:2: STYLE: useless macro: Tn
mandoc: ./md5.1:61:2: STYLE: useless macro: Tn
mandoc: ./md5.1:66:2: STYLE: useless macro: Tn
mandoc: ./md5.1:68:2: STYLE: useless macro: Tn
mandoc: ./md5.1:104:24: STYLE: no blank before trailing delimiter: Nm skein512,
mandoc: ./md5.1:117:6: STYLE: referenced manual not found: Xr sha224 3

igor:
md5.1:46:no comma after "i.e.":either algorithm, [i.e.] to find an input that produces a specific

Approved by:	bcr@
Differential Revision: https://reviews.freebsd.org/D25277
This commit is contained in:
fernape 2020-06-15 10:08:02 +00:00
parent ad49a04033
commit 26a7d00cd4

View File

@ -1,5 +1,5 @@
.\" $FreeBSD$ .\" $FreeBSD$
.Dd July 9, 2018 .Dd June 15, 2020
.Dt MD5 1 .Dt MD5 1
.Os .Os
.Sh NAME .Sh NAME
@ -16,8 +16,8 @@
(All other hashes have the same options and usage.) (All other hashes have the same options and usage.)
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm md5 , sha1 , sha224 , sha256 , sha384 , sha512, sha512t256, rmd160, .Nm md5 , sha1 , sha224 , sha256 , sha384 , sha512 , sha512t256 , rmd160 ,
.Nm skein256, skein512, .Nm skein256 , skein512 ,
and and
.Nm skein1024 .Nm skein1024
utilities take as input a message of arbitrary length and produce as utilities take as input a message of arbitrary length and produce as
@ -29,43 +29,29 @@ of the input.
It is conjectured that it is computationally infeasible to It is conjectured that it is computationally infeasible to
produce two messages having the same message digest, or to produce any produce two messages having the same message digest, or to produce any
message having a given prespecified target message digest. message having a given prespecified target message digest.
The The SHA-224 , SHA-256 , SHA-384 , SHA-512, RIPEMD-160,
.Tn SHA-224 , SHA-256 , SHA-384 , SHA-512, RIPEMD-160, and SKEIN
and
.Tn SKEIN
algorithms are intended for digital signature applications, where a algorithms are intended for digital signature applications, where a
large file must be large file must be
.Dq compressed .Dq compressed
in a secure manner before being encrypted with a private in a secure manner before being encrypted with a private
(secret) (secret)
key under a public-key cryptosystem such as key under a public-key cryptosystem such as RSA.
.Tn RSA .
.Pp .Pp
The The MD5 and SHA-1 algorithms have been proven to be vulnerable to practical
.Tn MD5 collision attacks and should not be relied upon to produce unique outputs,
and
.Tn SHA-1
algorithms have been proven to be vulnerable to practical collision
attacks and should not be relied upon to produce unique outputs,
.Em nor should they be used as part of a cryptographic signature scheme. .Em nor should they be used as part of a cryptographic signature scheme.
As of 2017-03-02, there is no publicly known method to As of 2017-03-02, there is no publicly known method to
.Em reverse .Em reverse
either algorithm, i.e. to find an input that produces a specific either algorithm, i.e., to find an input that produces a specific
output. output.
.Pp .Pp
.Tn SHA-512t256 SHA-512t256 is a version of SHA-512 truncated to only 256 bits.
is a version of On 64-bit hardware, this algorithm is approximately 50% faster than SHA-256 but
.Tn SHA-512 with the same level of security.
truncated to only 256 bits.
On 64-bit hardware, this algorithm is approximately 50% faster than
.Tn SHA-256
but with the same level of security.
The hashes are not interchangeable. The hashes are not interchangeable.
.Pp .Pp
It is recommended that all new applications use It is recommended that all new applications use SHA-512 or SKEIN-512
.Tn SHA-512
or
.Tn SKEIN-512
instead of one of the other hash functions. instead of one of the other hash functions.
.Pp .Pp
The following options may be used in any combination and must The following options may be used in any combination and must
@ -101,7 +87,7 @@ Run a built-in test script.
.Sh EXIT STATUS .Sh EXIT STATUS
The The
.Nm md5 , sha1 , sha224 , sha256 , sha512 , sha512t256 , rmd160 , .Nm md5 , sha1 , sha224 , sha256 , sha512 , sha512t256 , rmd160 ,
.Nm skein256 , skein512, .Nm skein256 , skein512 ,
and and
.Nm skein1024 .Nm skein1024
utilities exit 0 on success, utilities exit 0 on success,
@ -114,7 +100,6 @@ option.
.Xr md5 3 , .Xr md5 3 ,
.Xr ripemd 3 , .Xr ripemd 3 ,
.Xr sha 3 , .Xr sha 3 ,
.Xr sha224 3 ,
.Xr sha256 3 , .Xr sha256 3 ,
.Xr sha384 3 , .Xr sha384 3 ,
.Xr sha512 3 , .Xr sha512 3 ,