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