[thirdparty/openssl.git] / doc / man1 / openssl-prime.pod

=pod

=head1 NAME

openssl-prime - compute prime numbers

=head1 SYNOPSIS

B<openssl prime>
[B<-help>]
[B<-hex>]
[B<-generate>]
[B<-bits> I<num>]
[B<-safe>]
[B<-checks> I<num>]
[I<number...>]

=head1 DESCRIPTION

The B<prime> command checks if the specified numbers are prime.

If no numbers are given on the command line, the B<-generate> flag should
be used to generate primes according to the requirements specified by the
rest of the flags.

=head1 OPTIONS

=over 4

=item B<-help>

Display an option summary.

=item B<-hex>

Generate hex output.

=item B<-generate>

Generate a prime number.

=item B<-bits> I<num>

Generate a prime with B<num> bits.

=item B<-safe>

When used with B<-generate>, generates a "safe" prime. If the number
generated is B<n>, then check that B<(n-1)/2> is also prime.

=item B<-checks> I<num>

Perform the checks B<num> times to see that the generated number
is prime.  The default is 20.

=back

=head1 COPYRIGHT

Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut
Commit	Line	Data
e75138ab RS	1	=pod
	2
	3	=head1 NAME
	4
b6b66573	5	openssl-prime - compute prime numbers
e75138ab RS	6
	7	=head1 SYNOPSIS
	8
	9	B<openssl prime>
	10	[B<-help>]
	11	[B<-hex>]
	12	[B<-generate>]
e8769719	13	[B<-bits> I<num>]
e75138ab	14	[B<-safe>]
e8769719	15	[B<-checks> I<num>]
e75138ab RS	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
e8769719	30	=item B<-help>
e75138ab RS	31
	32	Display an option summary.
	33
e8769719	34	=item B<-hex>
e75138ab RS	35
	36	Generate hex output.
	37
e8769719	38	=item B<-generate>
e75138ab RS	39
	40	Generate a prime number.
	41
e8769719	42	=item B<-bits> I<num>
e75138ab RS	43
	44	Generate a prime with B<num> bits.
	45
e8769719	46	=item B<-safe>
e75138ab RS	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
e8769719	51	=item B<-checks> I<num>
e75138ab RS	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
b6b66573	60	Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved.
e75138ab	61
449040b4	62	Licensed under the Apache License 2.0 (the "License"). You may not use
e75138ab RS	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