diff options
| author | Richard Levitte <levitte@openssl.org> | 2019-10-01 19:43:36 +0200 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2019-10-09 10:44:32 +0200 |
| commit | 35a810bb1d6af5a71170c5c4b506f7665d573a3e (patch) | |
| tree | cc1b6aff27a2680f956ace2adf5331367970be52 /doc/man1/openssl-pkcs8.pod | |
| parent | 2f0ea9365806895c313b6d8e2ce33428260e856c (diff) | |
Command docs: fix up command references
Almost all OpenSSL commands are in reality 'openssl cmd', so make sure
they are refered to like that and not just as the sub-command.
Self-references are avoided as much as is possible, and replaced with
"this command". In some cases, we even avoid that with a slight
rewrite of the sentence or paragrah they were in. However, in the few
cases where a self-reference is still admissible, they are done in
bold, i.e. openssl-speed.pod references itself like this:
B<openssl speed>
References to other commands are done as manual links, i.e. CA.pl.pod
references 'openssl req' like this: L<openssl-req(1)>
Some commands are examples rather than references; we enclose those in
C<>.
While we are it, we abolish "utility", replacing it with "command", or
remove it entirely in some cases.
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10065)
Diffstat (limited to 'doc/man1/openssl-pkcs8.pod')
| -rw-r--r-- | doc/man1/openssl-pkcs8.pod | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/man1/openssl-pkcs8.pod b/doc/man1/openssl-pkcs8.pod index fe8ff8ea38..601a638eaf 100644 --- a/doc/man1/openssl-pkcs8.pod +++ b/doc/man1/openssl-pkcs8.pod @@ -34,7 +34,7 @@ B<openssl> B<pkcs8> =head1 DESCRIPTION -The B<pkcs8> command processes private keys in PKCS#8 format. It can handle +This command processes private keys in PKCS#8 format. It can handle both unencrypted PKCS#8 PrivateKeyInfo format and EncryptedPrivateKeyInfo format with a variety of PKCS#5 (v1.5 and v2.0) and PKCS#12 algorithms. @@ -142,7 +142,7 @@ If not specified PKCS#5 v2.0 form is used. =item B<-engine> I<id> -Specifying an engine (by its unique I<id> string) will cause B<pkcs8> +Specifying an engine (by its unique I<id> string) will cause this command 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. @@ -162,7 +162,7 @@ Sets the scrypt I<N>, I<r> or I<p> parameters. =head1 KEY FORMATS -Various different formats are used by the pkcs8 utility. These are detailed +Various different formats are used by this command. These are detailed below. If a key is being converted from PKCS#8 form (i.e. the B<-topk8> option is |