openssl/doc/man1/openssl-prime.pod
Richard Levitte 35a810bb1d 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)
2019-10-09 10:44:32 +02:00

68 lines
1.2 KiB
Plaintext

=pod
=head1 NAME
openssl-prime - compute prime numbers
=head1 SYNOPSIS
B<openssl prime>
[B<-help>]
[B<-hex>]
[B<-generate>]
[B<-bits> I<num>]
[B<-safe>]
[B<-checks> I<num>]
[I<number> ...]
=head1 DESCRIPTION
This command checks if the specified numbers are prime.
If no numbers are given on the command line, the B<-generate> flag should
be used to generate primes according to the requirements specified by the
rest of the flags.
=head1 OPTIONS
=over 4
=item B<-help>
Display an option summary.
=item B<-hex>
Generate hex output.
=item B<-generate>
Generate a prime number.
=item B<-bits> I<num>
Generate a prime with I<num> bits.
=item B<-safe>
When used with B<-generate>, generates a "safe" prime. If the number
generated is I<n>, then check that C<(I<n>-1)/2> is also prime.
=item B<-checks> I<num>
Perform the checks I<num> times to see that the generated number
is prime. The default is 20.
=back
=head1 COPYRIGHT
Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut