diff options
author | Pauli <paul.dale@oracle.com> | 2020-02-27 07:45:31 +1000 |
---|---|---|
committer | Pauli <paul.dale@oracle.com> | 2020-03-07 11:46:47 +1000 |
commit | 5e98904c231f5a40c6ce291df85799cca7c8d125 (patch) | |
tree | 70e2069ad42554c250543a44a2d4607ed5b39390 /doc/man1/openssl-prime.pod.in | |
parent | 55f02cb6849f0366dd8b787dbe8e74b56c15bfd1 (diff) | |
download | openssl-5e98904c231f5a40c6ce291df85799cca7c8d125.zip openssl-5e98904c231f5a40c6ce291df85799cca7c8d125.tar.gz openssl-5e98904c231f5a40c6ce291df85799cca7c8d125.tar.bz2 |
man1: make all openssl command line tool documentation generated.
With the introduction of provider command line options which are applicable to
almost all of the command line tools, it seemed reasonable to make them all
generated. This simplifes the .gitignore and avoids having to keep two lists
in sync.
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/11167)
Diffstat (limited to 'doc/man1/openssl-prime.pod.in')
-rw-r--r-- | doc/man1/openssl-prime.pod.in | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/doc/man1/openssl-prime.pod.in b/doc/man1/openssl-prime.pod.in new file mode 100644 index 0000000..9aafabe --- /dev/null +++ b/doc/man1/openssl-prime.pod.in @@ -0,0 +1,67 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=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 + +This 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 I<num> bits. + +=item B<-safe> + +When used with B<-generate>, generates a "safe" prime. If the number +generated is I<n>, then check that C<(I<n>-1)/2> is also prime. + +=item B<-checks> I<num> + +This parameter is ignored. + +=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 |