Deprecate unprefixed manual entries for openssl commands
[openssl.git] / doc / man1 / openssl-prime.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-prime - compute prime numbers
6
7 =head1 SYNOPSIS
8
9 B<openssl prime>
10 [B<-help>]
11 [B<-hex>]
12 [B<-generate>]
13 [B<-bits>]
14 [B<-safe>]
15 [B<-checks>]
16 [I<number...>]
17
18 =head1 DESCRIPTION
19
20 The B<prime> command checks if the specified numbers are prime.
21
22 If no numbers are given on the command line, the B<-generate> flag should
23 be used to generate primes according to the requirements specified by the
24 rest of the flags.
25
26 =head1 OPTIONS
27
28 =over 4
29
30 =item [B<-help>]
31
32 Display an option summary.
33
34 =item [B<-hex>]
35
36 Generate hex output.
37
38 =item [B<-generate>]
39
40 Generate a prime number.
41
42 =item [B<-bits num>]
43
44 Generate a prime with B<num> bits.
45
46 =item [B<-safe>]
47
48 When used with B<-generate>, generates a "safe" prime. If the number
49 generated is B<n>, then check that B<(n-1)/2> is also prime.
50
51 =item [B<-checks num>]
52
53 Perform the checks B<num> times to see that the generated number
54 is prime.  The default is 20.
55
56 =back
57
58 =head1 COPYRIGHT
59
60 Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved.
61
62 Licensed under the Apache License 2.0 (the "License").  You may not use
63 this file except in compliance with the License.  You can obtain a copy
64 in the file LICENSE in the source distribution or at
65 L<https://www.openssl.org/source/license.html>.
66
67 =cut