Fix descriptions of credentials and verification options for various apps
[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 {- $OpenSSL::safe::opt_provider_synopsis -}
17 [B<-checks> I<num>]
18 [I<number> ...]
19
20 =head1 DESCRIPTION
21
22 This command checks if the specified numbers are prime.
23
24 If no numbers are given on the command line, the B<-generate> flag should
25 be used to generate primes according to the requirements specified by the
26 rest of the flags.
27
28 =head1 OPTIONS
29
30 =over 4
31
32 =item B<-help>
33
34 Display an option summary.
35
36 =item B<-hex>
37
38 Generate hex output.
39
40 =item B<-generate>
41
42 Generate a prime number.
43
44 =item B<-bits> I<num>
45
46 Generate a prime with I<num> bits.
47
48 =item B<-safe>
49
50 When used with B<-generate>, generates a "safe" prime. If the number
51 generated is I<n>, then check that C<(I<n>-1)/2> is also prime.
52
53 {- $OpenSSL::safe::opt_provider_item -}
54
55 =item B<-checks> I<num>
56
57 This parameter is ignored.
58
59 =back
60
61 =head1 COPYRIGHT
62
63 Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved.
64
65 Licensed under the Apache License 2.0 (the "License").  You may not use
66 this file except in compliance with the License.  You can obtain a copy
67 in the file LICENSE in the source distribution or at
68 L<https://www.openssl.org/source/license.html>.
69
70 =cut