summaryrefslogtreecommitdiffstats
path: root/doc/man1/prime.pod
diff options
context:
space:
mode:
authorRich Salz <rsalz@openssl.org>2017-08-14 09:32:07 -0400
committerRich Salz <rsalz@openssl.org>2017-08-14 09:32:07 -0400
commite75138abea25659d304feb880cf54d760245e2f3 (patch)
tree6386dba01100f9ecde3541db8613d5fa82e26b15 /doc/man1/prime.pod
parentbc5145e372db24e8382c34fd191614805164b28b (diff)
Doc fixes
Write missing prime.pod and srp.pod Implement -c in find-doc-nits (for command options) Other fixes to some manpages Use B<-I<digest|cipher>> notation Split up multiple flags into a single entry in the synopsis. Add -1 and missing-help to list command. Reviewed-by: Andy Polyakov <appro@openssl.org> (Merged from https://github.com/openssl/openssl/pull/4144)
Diffstat (limited to 'doc/man1/prime.pod')
-rw-r--r--doc/man1/prime.pod67
1 files changed, 67 insertions, 0 deletions
diff --git a/doc/man1/prime.pod b/doc/man1/prime.pod
new file mode 100644
index 0000000000..f6f6158581
--- /dev/null
+++ b/doc/man1/prime.pod
@@ -0,0 +1,67 @@
+=pod
+
+=head1 NAME
+
+prime - compute prime numbers
+
+=head1 SYNOPSIS
+
+B<openssl prime>
+[B<-help>]
+[B<-hex>]
+[B<-generate>]
+[B<-bits>]
+[B<-safe>]
+[B<-checks>]
+[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 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 num>]
+
+Perform the checks B<num> times to see that the generated number
+is prime. The default is 20.
+
+=back
+
+=head1 COPYRIGHT
+
+Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
+
+Licensed under the OpenSSL license (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