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-req.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-req.pod')
-rw-r--r-- | doc/man1/openssl-req.pod | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/man1/openssl-req.pod b/doc/man1/openssl-req.pod index d380be7147..ef90a78db8 100644 --- a/doc/man1/openssl-req.pod +++ b/doc/man1/openssl-req.pod @@ -55,7 +55,7 @@ B<openssl> B<req> =head1 DESCRIPTION -The B<req> command primarily creates and processes certificate requests +This command primarily creates and processes certificate requests in PKCS#10 format. It can additionally create self signed certificates for use as root CAs for example. @@ -164,7 +164,7 @@ in size. If I<nbits> is omitted, i.e. B<-newkey> I<rsa> specified, the default key size, specified in the configuration file is used. All other algorithms support the B<-newkey> I<alg>:I<file> form, where file -may be an algorithm parameter file, created with B<genpkey -genparam> +may be an algorithm parameter file, created with C<openssl genpkey -genparam> or an X.509 certificate for a key with appropriate algorithm. B<param:>I<file> generates a key using the parameter file or certificate @@ -331,7 +331,7 @@ Print extra details about the operations being performed. =item B<-engine> I<id> -Specifying an engine (by its unique I<id> string) will cause B<req> +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. @@ -485,8 +485,8 @@ just consist of field names and values: for example, OU=My Organization emailAddress=someone@somewhere.org -This allows external programs (e.g. GUI based) to generate a template file -with all the field names and values and just pass it to B<req>. An example +This allows external programs (e.g. GUI based) to generate a template file with +all the field names and values and just pass it to this command. An example of this kind of configuration file is contained in the B<EXAMPLES> section. Alternatively if the B<prompt> option is absent or not set to B<no> then the |