Commit 35cb565a authored by Rich Salz's avatar Rich Salz Committed by Rich Salz
Browse files

Turn B<...()> into ...() 



For all functions, consistently use asdf() not B<asdf()>

Reviewed-by: default avatarKurt Roeckx <kurt@openssl.org>
parent e61434b4

doc/apps/config.pod

+2 −2
Original line number Diff line number Diff line
@@ -47,7 +47,7 @@ or B<${section::name}>. By using the form B<$ENV::name> environment 
variables can be substituted. It is also possible to assign values to

environment variables by using the name B<ENV::name>, this will work

if the program looks up environment variables using the B<CONF> library

instead of calling B<getenv()> directly.

instead of calling getenv() directly.



It is possible to escape certain characters by using any kind of quote

or the B<\> character. By making the last character of a line a B<\>
@@ -165,7 +165,7 @@ then an attempt will be made to initialize the ENGINE after all commands in 
its section have been processed.



The command B<default_algorithms> sets the default algorithms an ENGINE will

supply using the functions B<ENGINE_set_default_string()>

supply using the functions ENGINE_set_default_string().



If the name matches none of the above command names it is assumed to be a

ctrl command which is sent to the ENGINE. The value of the command is the

doc/apps/dsaparam.pod

+1 −1
Original line number Diff line number Diff line
@@ -62,7 +62,7 @@ this option prints out the DSA parameters in human readable form. 
=item B<-C>



this option converts the parameters into C code. The parameters can then

be loaded by calling the B<get_dsaXXX()> function.

be loaded by calling the get_dsaXXX() function.



=item B<-genkey>

doc/apps/ecparam.pod

+1 −1
Original line number Diff line number Diff line
@@ -66,7 +66,7 @@ This option prints out the EC parameters in human readable form. 
=item B<-C>



This option converts the EC parameters into C code. The parameters can then

be loaded by calling the B<get_ec_group_XXX()> function.

be loaded by calling the get_ec_group_XXX() function.



=item B<-check>

doc/crypto/CMS_sign.pod

+1 −1
Original line number Diff line number Diff line
@@ -95,7 +95,7 @@ suitable for many purposes. For finer control of the output format the 
B<certs>, B<signcert> and B<pkey> parameters can all be B<NULL> and the

B<CMS_PARTIAL> flag set. Then one or more signers can be added using the

function CMS_sign_add1_signer(), non default digests can be used and custom

attributes added. B<CMS_final()> must then be called to finalize the

attributes added. CMS_final() must then be called to finalize the

structure if streaming is not enabled. 



=head1 BUGS

doc/crypto/CRYPTO_set_ex_data.pod

+7 −7
Original line number Diff line number Diff line
@@ -19,22 +19,22 @@ These functions are used internally by OpenSSL to manipulate application 
specific data attached to a specific structure.



These functions should only be used by applications to manipulate

B<CRYPTO_EX_DATA> structures passed to the B<new_func()>, B<free_func()> and

B<dup_func()> callbacks: as passed to B<RSA_get_ex_new_index()> for example.

B<CRYPTO_EX_DATA> structures passed to the new_func(), free_func() and

dup_func() callbacks: as passed to RSA_get_ex_new_index() for example.



B<CRYPTO_set_ex_data()> is used to set application specific data, the data is

CRYPTO_set_ex_data() is used to set application specific data, the data is

supplied in the B<arg> parameter and its precise meaning is up to the

application.



B<CRYPTO_get_ex_data()> is used to retrieve application specific data. The data

CRYPTO_get_ex_data() is used to retrieve application specific data. The data

is returned to the application, this will be the same value as supplied to

a previous B<CRYPTO_set_ex_data()> call.

a previous CRYPTO_set_ex_data() call.



=head1 RETURN VALUES



B<CRYPTO_set_ex_data()> returns 1 on success or 0 on failure.

CRYPTO_set_ex_data() returns 1 on success or 0 on failure.



B<CRYPTO_get_ex_data()> returns the application data or 0 on failure. 0 may also

CRYPTO_get_ex_data() returns the application data or 0 on failure. 0 may also

be valid application data but currently it can only fail if given an invalid B<idx>

parameter.