9aafabe60249e538a28f5790d433032feb23a8cd
[openssl.git] / doc / man1 / openssl-prime.pod.in
1 =pod
2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4 =head1 NAME
5
6 openssl-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> I<num>]
15 [B<-safe>]
16 [B<-checks> I<num>]
17 [I<number> ...]
18
19 =head1 DESCRIPTION
20
21 This 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> I<num>
44
45 Generate a prime with I<num> bits.
46
47 =item B<-safe>
48
49 When used with B<-generate>, generates a "safe" prime. If the number
50 generated is I<n>, then check that C<(I<n>-1)/2> is also prime.
51
52 =item B<-checks> I<num>
53
54 This parameter is ignored.
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