From: Richard Levitte Date: Tue, 1 Oct 2019 08:00:14 +0000 (+0200) Subject: Command docs: remove ellipses for '-rand' X-Git-Tag: openssl-3.0.0-alpha1~1192 X-Git-Url: https://git.openssl.org/?p=openssl.git;a=commitdiff_plain;h=fed8bd90e4cf02066eeed9426e29d709e3630cc9 Command docs: remove ellipses for '-rand' Ellipses were used to express that the '-rand' value can specify multiple files, like this: B<-rand> I Because there are conventions around ellipses, this becomes confusing, because '-rand file...' is normally intepreted to mean that '-rand file1 file2 file3' would be processed as three randomness files, which makes no sense. Rather than making things complicated with more elaborate syntax, we change it to: B<-rand> I Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/10065) --- diff --git a/doc/man1/openssl-ca.pod b/doc/man1/openssl-ca.pod index c53ba4fa33..4ba230f46b 100644 --- a/doc/man1/openssl-ca.pod +++ b/doc/man1/openssl-ca.pod @@ -54,7 +54,7 @@ B B [B<-create_serial>] [B<-rand_serial>] [B<-multivalue-rdn>] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-sm2-id> I] [B<-sm2-hex-id> I] @@ -293,10 +293,9 @@ I If -multi-rdn is not used then the UID value is I<123456+CN=John Doe>. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-cms.pod b/doc/man1/openssl-cms.pod index d9f5a3bf47..1de618d0c7 100644 --- a/doc/man1/openssl-cms.pod +++ b/doc/man1/openssl-cms.pod @@ -96,7 +96,7 @@ B B [B<-inkey> I] [B<-keyopt> I:I] [B<-passin> I] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-to> I] [B<-from> I] @@ -476,10 +476,9 @@ or to modify default parameters for ECDH. The private key password source. For more information about the format of B see L. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-dgst.pod b/doc/man1/openssl-dgst.pod index 026b42d6b1..ebafece6d8 100644 --- a/doc/man1/openssl-dgst.pod +++ b/doc/man1/openssl-dgst.pod @@ -24,7 +24,7 @@ B [B<-sigopt> I:I] [B<-hmac> I] [B<-fips-fingerprint>] -[B<-rand> I] +[B<-rand> I] [B<-engine> I] [B<-engine_impl>] [I ...] @@ -161,10 +161,9 @@ for example exactly 32 chars for gost-mac. The L command should be preferred to using this command line option. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-dhparam.pod b/doc/man1/openssl-dhparam.pod index 26b080f4f6..79fda3d48b 100644 --- a/doc/man1/openssl-dhparam.pod +++ b/doc/man1/openssl-dhparam.pod @@ -20,7 +20,7 @@ B [B<-2>] [B<-3>] [B<-5>] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-engine> I] [I] @@ -86,10 +86,9 @@ input file is ignored and parameters are generated instead. If not present but B is present, parameters are generated with the default generator 2. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-dsaparam.pod b/doc/man1/openssl-dsaparam.pod index 68e960a0df..133c206461 100644 --- a/doc/man1/openssl-dsaparam.pod +++ b/doc/man1/openssl-dsaparam.pod @@ -15,7 +15,7 @@ B [B<-noout>] [B<-text>] [B<-C>] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-genkey>] [B<-engine> I] @@ -76,10 +76,9 @@ be loaded by calling the get_dsaXXX() function. This option will generate a DSA either using the specified or generated parameters. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-ecparam.pod b/doc/man1/openssl-ecparam.pod index bd946f10c5..e8de181c23 100644 --- a/doc/man1/openssl-ecparam.pod +++ b/doc/man1/openssl-ecparam.pod @@ -22,7 +22,7 @@ B [B<-conv_form> I] [B<-param_enc> I] [B<-no_seed>] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-genkey>] [B<-engine> I] @@ -125,10 +125,9 @@ is included in the ECParameters structure (see RFC 3279). This option will generate an EC private key using the specified parameters. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-enc.pod b/doc/man1/openssl-enc.pod index 498df90b1f..9c4954f1bc 100644 --- a/doc/man1/openssl-enc.pod +++ b/doc/man1/openssl-enc.pod @@ -35,7 +35,7 @@ B [B<-nopad>] [B<-debug>] [B<-none>] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-engine> I] @@ -185,10 +185,9 @@ or zlib-dynamic option. Use NULL cipher (no encryption or decryption of input). -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-gendsa.pod b/doc/man1/openssl-gendsa.pod index a5d001acc6..445c176c84 100644 --- a/doc/man1/openssl-gendsa.pod +++ b/doc/man1/openssl-gendsa.pod @@ -21,7 +21,7 @@ B B [B<-des>] [B<-des3>] [B<-idea>] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-engine> I] [B<-verbose>] @@ -53,10 +53,9 @@ These options encrypt the private key with specified cipher before outputting it. A pass phrase is prompted for. If none of these options is specified no encryption is used. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-genrsa.pod b/doc/man1/openssl-genrsa.pod index 81ede1b8c6..829b4a4a48 100644 --- a/doc/man1/openssl-genrsa.pod +++ b/doc/man1/openssl-genrsa.pod @@ -24,7 +24,7 @@ B B [B<-idea>] [B<-f4>] [B<-3>] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-engine> I] [B<-primes> I] @@ -66,10 +66,9 @@ for if it is not supplied via the B<-passout> argument. The public exponent to use, either 65537 or 3. The default is 65537. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-passwd.pod b/doc/man1/openssl-passwd.pod index 755e80a22e..a312030835 100644 --- a/doc/man1/openssl-passwd.pod +++ b/doc/man1/openssl-passwd.pod @@ -20,7 +20,7 @@ B [B<-noverify>] [B<-quiet>] [B<-table>] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] {I} @@ -92,10 +92,9 @@ Don't output warnings when passwords given at the command line are truncated. In the output list, prepend the cleartext password and a TAB character to each password hash. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-pkcs12.pod b/doc/man1/openssl-pkcs12.pod index f309bcd1b8..72f601a555 100644 --- a/doc/man1/openssl-pkcs12.pod +++ b/doc/man1/openssl-pkcs12.pod @@ -36,7 +36,7 @@ B B [B<-password> I] [B<-passin> I] [B<-passout> I] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-CAfile> I] [B<-CApath> I] @@ -280,10 +280,9 @@ to be needed to use MAC iterations counts but they are now used by default. Don't attempt to provide the MAC integrity. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-pkcs8.pod b/doc/man1/openssl-pkcs8.pod index e1cc0b38a5..1dcda10310 100644 --- a/doc/man1/openssl-pkcs8.pod +++ b/doc/man1/openssl-pkcs8.pod @@ -17,7 +17,7 @@ B B [B<-passout> I] [B<-iter> I] [B<-noiter>] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-nocrypt>] [B<-traditional>] @@ -105,10 +105,9 @@ This option does not encrypt private keys at all and should only be used when absolutely necessary. Certain software such as some versions of Java code signing software used unencrypted private keys. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-pkeyutl.pod b/doc/man1/openssl-pkeyutl.pod index a0f4555764..3532fa676c 100644 --- a/doc/man1/openssl-pkeyutl.pod +++ b/doc/man1/openssl-pkeyutl.pod @@ -33,7 +33,7 @@ B B [B<-pkeyopt_passin> I] [B<-hexdump>] [B<-asn1parse>] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-engine> I] [B<-engine_impl>] @@ -177,10 +177,9 @@ hex dump the output data. Parse the ASN.1 output data, this is useful when combined with the B<-verifyrecover> option when an ASN1 structure is signed. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-rand.pod b/doc/man1/openssl-rand.pod index 4d57265b13..ca62afb415 100644 --- a/doc/man1/openssl-rand.pod +++ b/doc/man1/openssl-rand.pod @@ -9,7 +9,7 @@ openssl-rand - generate pseudo-random bytes B [B<-help>] [B<-out> I] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-base64>] [B<-hex>] @@ -38,10 +38,9 @@ Print out a usage message. Write to I instead of standard output. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-req.pod b/doc/man1/openssl-req.pod index e010e00f01..30c339b01a 100644 --- a/doc/man1/openssl-req.pod +++ b/doc/man1/openssl-req.pod @@ -20,7 +20,7 @@ B B [B<-verify>] [B<-modulus>] [B<-new>] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-newkey> I] [B<-newkey> I] @@ -142,10 +142,9 @@ in the configuration file and any requested extensions. If the B<-key> option is not used it will generate a new RSA private key using information specified in the configuration file. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-rsautl.pod b/doc/man1/openssl-rsautl.pod index fccd7a1ad7..9c2f6577e4 100644 --- a/doc/man1/openssl-rsautl.pod +++ b/doc/man1/openssl-rsautl.pod @@ -18,7 +18,7 @@ B B [B<-verify>] [B<-encrypt>] [B<-decrypt>] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-pkcs>] [B<-ssl>] @@ -84,10 +84,9 @@ Encrypt the input data using an RSA public key. Decrypt the input data using an RSA private key. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-s_client.pod b/doc/man1/openssl-s_client.pod index 3baacd3f73..ddf3f48864 100644 --- a/doc/man1/openssl-s_client.pod +++ b/doc/man1/openssl-s_client.pod @@ -125,7 +125,7 @@ B B [B<-no_ticket>] [B<-sess_out> I] [B<-sess_in> I] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-serverinfo> I] [B<-status>] @@ -673,10 +673,9 @@ to attempt to obtain a functional reference to the specified engine, thus initialising it if needed. The engine will then be set as the default for all available algorithms. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-s_server.pod b/doc/man1/openssl-s_server.pod index 69275ed976..8c3e790f04 100644 --- a/doc/man1/openssl-s_server.pod +++ b/doc/man1/openssl-s_server.pod @@ -52,7 +52,7 @@ B B [B<-tlsextdebug>] [B<-HTTP>] [B<-id_prefix> I] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-keymatexport> I] [B<-keymatexportlen> I<+int>] @@ -446,10 +446,9 @@ for testing any SSL/TLS code (eg. proxies) that wish to deal with multiple servers, when each of which might be generating a unique range of session IDs (eg. with a certain prefix). -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-smime.pod b/doc/man1/openssl-smime.pod index 84549c4c68..5fbbcae2d0 100644 --- a/doc/man1/openssl-smime.pod +++ b/doc/man1/openssl-smime.pod @@ -65,7 +65,7 @@ B B [B<-indef>] [B<-noindef>] [B<-stream>] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-md> I] I ... @@ -298,10 +298,9 @@ specified, the argument is given to the engine as a key identifier. The private key password source. For more information about the format of B see L. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-speed.pod b/doc/man1/openssl-speed.pod index 9216cd4a63..cd64684974 100644 --- a/doc/man1/openssl-speed.pod +++ b/doc/man1/openssl-speed.pod @@ -14,7 +14,7 @@ B [B<-hmac> I] [B<-cmac> I] [B<-decrypt>] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-primes> I] [B<-seconds> I] @@ -70,10 +70,9 @@ Time the CMAC algorithm using the specified cipher e.g. B. Time the decryption instead of encryption. Affects only the EVP testing. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-srp.pod b/doc/man1/openssl-srp.pod index 7504f88994..0323940fc5 100644 --- a/doc/man1/openssl-srp.pod +++ b/doc/man1/openssl-srp.pod @@ -17,7 +17,7 @@ B [B<-config> I] [B<-srpvfile> I] [B<-gn> I] -[B<-userinfo> I] +[B<-userinfo> I] [B<-passin> I] [B<-passout> I] [I ...] diff --git a/doc/man1/openssl-ts.pod b/doc/man1/openssl-ts.pod index 40906452f1..d9dd7e48d6 100644 --- a/doc/man1/openssl-ts.pod +++ b/doc/man1/openssl-ts.pod @@ -8,7 +8,7 @@ openssl-ts - Time Stamping Authority tool (client/server) B B B<-query> -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-config> I] [B<-data> I] @@ -134,10 +134,9 @@ request with the following options: =over 4 -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl-x509.pod b/doc/man1/openssl-x509.pod index 99d06d025c..bd653ed8cb 100644 --- a/doc/man1/openssl-x509.pod +++ b/doc/man1/openssl-x509.pod @@ -63,7 +63,7 @@ B B [B<-extfile> I] [B<-extensions> I
] [B<-sigopt> I:I] -[B<-rand> I] +[B<-rand> I] [B<-writerand> I] [B<-engine> I] [B<-preserve_dates>] @@ -122,10 +122,9 @@ Any digest supported by the OpenSSL B command can be used. If not specified then SHA1 is used with B<-fingerprint> or the default digest for the signing algorithm is used, typically SHA256. -=item B<-rand> I +=item B<-rand> I -A file or files containing random data used to seed the random number -generator. +The files containing random data used to seed the random number generator. Multiple files can be specified separated by an OS-dependent character. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for all others. diff --git a/doc/man1/openssl.pod b/doc/man1/openssl.pod index dade253e71..baa7bde379 100644 --- a/doc/man1/openssl.pod +++ b/doc/man1/openssl.pod @@ -549,7 +549,7 @@ Read the password from standard input. =over 4 -=item BI +=item BI[,...] Enable tracing output of OpenSSL library, by name. This output will only make sense if you know OpenSSL internals well.