xref: /netbsd-src/crypto/external/bsd/openssl.old/dist/doc/man1/prime.pod (revision 4724848cf0da353df257f730694b7882798e5daf)
1*4724848cSchristos=pod
2*4724848cSchristos
3*4724848cSchristos=head1 NAME
4*4724848cSchristos
5*4724848cSchristosopenssl-prime,
6*4724848cSchristosprime - compute prime numbers
7*4724848cSchristos
8*4724848cSchristos=head1 SYNOPSIS
9*4724848cSchristos
10*4724848cSchristosB<openssl prime>
11*4724848cSchristos[B<-help>]
12*4724848cSchristos[B<-hex>]
13*4724848cSchristos[B<-generate>]
14*4724848cSchristos[B<-bits>]
15*4724848cSchristos[B<-safe>]
16*4724848cSchristos[B<-checks>]
17*4724848cSchristos[I<number...>]
18*4724848cSchristos
19*4724848cSchristos=head1 DESCRIPTION
20*4724848cSchristos
21*4724848cSchristosThe B<prime> command checks if the specified numbers are prime.
22*4724848cSchristos
23*4724848cSchristosIf no numbers are given on the command line, the B<-generate> flag should
24*4724848cSchristosbe used to generate primes according to the requirements specified by the
25*4724848cSchristosrest of the flags.
26*4724848cSchristos
27*4724848cSchristos=head1 OPTIONS
28*4724848cSchristos
29*4724848cSchristos=over 4
30*4724848cSchristos
31*4724848cSchristos=item [B<-help>]
32*4724848cSchristos
33*4724848cSchristosDisplay an option summary.
34*4724848cSchristos
35*4724848cSchristos=item [B<-hex>]
36*4724848cSchristos
37*4724848cSchristosGenerate hex output.
38*4724848cSchristos
39*4724848cSchristos=item [B<-generate>]
40*4724848cSchristos
41*4724848cSchristosGenerate a prime number.
42*4724848cSchristos
43*4724848cSchristos=item [B<-bits num>]
44*4724848cSchristos
45*4724848cSchristosGenerate a prime with B<num> bits.
46*4724848cSchristos
47*4724848cSchristos=item [B<-safe>]
48*4724848cSchristos
49*4724848cSchristosWhen used with B<-generate>, generates a "safe" prime. If the number
50*4724848cSchristosgenerated is B<n>, then check that B<(n-1)/2> is also prime.
51*4724848cSchristos
52*4724848cSchristos=item [B<-checks num>]
53*4724848cSchristos
54*4724848cSchristosPerform the checks B<num> times to see that the generated number
55*4724848cSchristosis prime.  The default is 20.
56*4724848cSchristos
57*4724848cSchristos=back
58*4724848cSchristos
59*4724848cSchristos=head1 COPYRIGHT
60*4724848cSchristos
61*4724848cSchristosCopyright 2017 The OpenSSL Project Authors. All Rights Reserved.
62*4724848cSchristos
63*4724848cSchristosLicensed under the OpenSSL license (the "License").  You may not use
64*4724848cSchristosthis file except in compliance with the License.  You can obtain a copy
65*4724848cSchristosin the file LICENSE in the source distribution or at
66*4724848cSchristosL<https://www.openssl.org/source/license.html>.
67*4724848cSchristos
68*4724848cSchristos=cut
69