diff options
author | Rich Salz <rsalz@openssl.org> | 2016-07-28 17:00:05 -0400 |
---|---|---|
committer | Rich Salz <rsalz@openssl.org> | 2016-07-28 17:00:05 -0400 |
commit | 1a627771634adba9d4f3b5cf7be74d6bab428a5f (patch) | |
tree | 182ece217c2dbe9ed37b23e00a71096b14ca837a /doc/apps | |
parent | 29df3061b3cba1e343a76e69e47149f1dc526361 (diff) |
Various doc fixes.
Cannot nest B<> tags
Document "openssl speed" command.
Fix doc nits: missing NAME/SYNOPSIS stuff
Reviewed-by: Tim Hudson <tjh@openssl.org>
Diffstat (limited to 'doc/apps')
-rw-r--r-- | doc/apps/list.pod | 81 | ||||
-rw-r--r-- | doc/apps/speed.pod | 28 |
2 files changed, 84 insertions, 25 deletions
diff --git a/doc/apps/list.pod b/doc/apps/list.pod new file mode 100644 index 0000000000..e6e1f17617 --- /dev/null +++ b/doc/apps/list.pod @@ -0,0 +1,81 @@ +=pod + +=head1 NAME + +list - list algorithms and features + +=head1 SYNOPSIS + +B<openssl list> +[B<-help>] +[B<-commands>] +[B<-digest-commands>] +[B<-digest-algorithms>] +[B<-cipher-commands>] +[B<-cipher-algorithms>] +[B<-public-key-algorithms>] +[B<-disabled>] + +=head1 DESCRIPTION + +This command is used to generate list of algorithms or disabled +features. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Display out a usage message. + +=item B<-commands> + +Display a list of standard commands. + +=item B<-digest-commands> + +Display a list of message digest commands, which are typically used +as input to the L<dgst(1)> or L<speed(1)> commands. + +=item B<-digest-algorithms> + +Display a list of message digest algorithms. +If a line is of the form + foo => bar +then B<foo> is an alias for the official algorithm name, B<bar>. + +=item B<-cipher-commands> + +Display a list of cipher commands, which are typically used as input +to the L<dgst(1)> or L<speed(1)> commands. + +=item B<-cipher-algorithms> + +Display a list of cipher algorithms. +If a line is of the form + foo => bar +then B<foo> is an alias for the official algorithm name, B<bar>. + +=item B<-public-key-algorithms> + +Display a list of public key algorithms, with each algorithm as +a block of multiple lines, all but the first are indented. + +=item B<-disabled> + +Display a list of disabled features, those that were compiled out +of the installation. + +=back + +=head1 COPYRIGHT + +Copyright 2016 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 diff --git a/doc/apps/speed.pod b/doc/apps/speed.pod index ab2c7d76ac..ad81bfbc74 100644 --- a/doc/apps/speed.pod +++ b/doc/apps/speed.pod @@ -12,35 +12,13 @@ B<openssl speed> [B<-elapsed>] [B<-evp algo>] [B<-decrypt>] -[B<md2>] -[B<mdc2>] -[B<md5>] -[B<hmac>] -[B<sha1>] -[B<rmd160>] -[B<idea-cbc>] -[B<rc2-cbc>] -[B<rc5-cbc>] -[B<bf-cbc>] -[B<des-cbc>] -[B<des-ede3>] -[B<rc4>] -[B<rsa512>] -[B<rsa1024>] -[B<rsa2048>] -[B<rsa4096>] -[B<dsa512>] -[B<dsa1024>] -[B<dsa2048>] -[B<idea>] -[B<rc2>] -[B<des>] -[B<rsa>] -[B<blowfish>] +[B<algorithm...>] =head1 DESCRIPTION This command is used to test the performance of cryptographic algorithms. +To see the list of supported algorithms, use the I<list --digest-commands> +or I<list --cipher-commands> command. =head1 OPTIONS |