Fix doc example code to follow coding style
[openssl.git] / doc / man3 / OpenSSL_add_all_algorithms.pod
1 =pod
2
3 =head1 NAME
4
5 OpenSSL_add_all_algorithms, OpenSSL_add_all_ciphers, OpenSSL_add_all_digests, EVP_cleanup -
6 add algorithms to internal table
7
8 =head1 SYNOPSIS
9
10  #include <openssl/evp.h>
11
12 Deprecated since OpenSSL 1.1.0, can be hidden entirely by defining
13 B<OPENSSL_API_COMPAT> with a suitable version value, see
14 L<openssl_user_macros(7)>:
15
16  void OpenSSL_add_all_algorithms(void);
17  void OpenSSL_add_all_ciphers(void);
18  void OpenSSL_add_all_digests(void);
19
20  void EVP_cleanup(void)
21
22 =head1 DESCRIPTION
23
24 OpenSSL keeps an internal table of digest algorithms and ciphers. It uses
25 this table to lookup ciphers via functions such as EVP_get_cipher_byname().
26
27 OpenSSL_add_all_digests() adds all digest algorithms to the table.
28
29 OpenSSL_add_all_algorithms() adds all algorithms to the table (digests and
30 ciphers).
31
32 OpenSSL_add_all_ciphers() adds all encryption algorithms to the table including
33 password based encryption algorithms.
34
35 In versions prior to 1.1.0 EVP_cleanup() removed all ciphers and digests from
36 the table. It no longer has any effect in OpenSSL 1.1.0.
37
38 =head1 RETURN VALUES
39
40 None of the functions return a value.
41
42 =head1 SEE ALSO
43
44 L<evp(7)>, L<EVP_DigestInit(3)>,
45 L<EVP_EncryptInit(3)>
46
47 =head1 HISTORY
48
49 The OpenSSL_add_all_algorithms(), OpenSSL_add_all_ciphers(),
50 OpenSSL_add_all_digests(), and EVP_cleanup(), functions
51 were deprecated in OpenSSL 1.1.0 by OPENSSL_init_crypto() and should
52 not be used.
53
54 =head1 COPYRIGHT
55
56 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
57
58 Licensed under the Apache License 2.0 (the "License").  You may not use
59 this file except in compliance with the License.  You can obtain a copy
60 in the file LICENSE in the source distribution or at
61 L<https://www.openssl.org/source/license.html>.
62
63 =cut