Commit 1a627771 authored by Rich Salz's avatar Rich Salz
Browse files

Various doc fixes. 



Cannot nest B<> tags
Document "openssl speed" command.
Fix doc nits: missing NAME/SYNOPSIS stuff

Reviewed-by: default avatarTim Hudson <tjh@openssl.org>
parent 29df3061

doc/apps/list.pod

0 → 100644
+81 −0
Original line number Diff line number Diff line 
=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

doc/apps/speed.pod

+3 −25
Original line number Diff line number Diff line
@@ -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

doc/crypto/HMAC.pod

+2 −2
Original line number Diff line number Diff line
@@ -87,9 +87,9 @@ of an B<HMAC_CTX> in this function. B<N.B. HMAC_Init() had this undocumented 
behaviour in previous versions of OpenSSL - failure to switch to HMAC_Init_ex()

in programs that expect it will cause them to stop working>.



B<NB: if HMAC_Init_ex() is called with B<key> NULL and B<evp_md> is not the

B<NOTE:> If HMAC_Init_ex() is called with B<key> NULL and B<evp_md> is not the

same as the previous digest used by B<ctx> then an error is returned

because reuse of an existing key with a different digest is not supported.>

because reuse of an existing key with a different digest is not supported.



HMAC_Update() can be called repeatedly with chunks of the message to

be authenticated (B<len> bytes at B<data>).

doc/crypto/OCSP_resp_find_status.pod

+2 −0
Original line number Diff line number Diff line
@@ -2,6 +2,8 @@ 


=head1 NAME



OCSP_resp_get0_certs,

OCSP_resp_get0_id,

OCSP_resp_get0_produced_at,

OCSP_resp_find_status, OCSP_resp_count, OCSP_resp_get0, OCSP_resp_find,

OCSP_single_get0_status, OCSP_check_validity

doc/crypto/X509_STORE_CTX_set_verify_cb.pod

+11 −0
Original line number Diff line number Diff line
@@ -2,6 +2,17 @@ 


=head1 NAME



X509_STORE_CTX_get_cleanup,

X509_STORE_CTX_get_lookup_crls,

X509_STORE_CTX_get_lookup_certs,

X509_STORE_CTX_get_check_policy,

X509_STORE_CTX_get_cert_crl,

X509_STORE_CTX_get_check_crl,

X509_STORE_CTX_get_get_crl,

X509_STORE_CTX_get_check_revocation,

X509_STORE_CTX_get_check_issued,

X509_STORE_CTX_get_get_issuer,

X509_STORE_CTX_get_verify,

X509_STORE_CTX_get_verify_cb,

X509_STORE_CTX_set_verify_cb - get and set verification callback