Update SSL_CONF docs.
[openssl.git] / doc / ssl / SSL_CONF_cmd_argv.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_CONF_cmd_argv - SSL configuration command line processing.
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  int SSL_CONF_cmd_argv(SSL_CONF_CTX *cctx, int *pargc, char ***pargv);
12
13 =head1 DESCRIPTION
14
15 The function SSL_CONF_cmd_argv() processes at most two command line
16 arguments from B<pargv> and B<pargc>. The values of B<pargv> and B<pargc>
17 are updated to reflect the number of command options procesed. The B<pargc>
18 argument can be set to B<NULL> is it is not used.
19
20 =head1 RETURN VALUES
21
22 SSL_CONF_cmd_argv() returns the number of command arguments processed: 0, 1, 2
23 or a negative error code.
24
25 If -2 is returned then an argument for a command is missing.
26
27 If -1 is returned the command is recognised but couldn't be processed due
28 to an error: for example a syntax error in the argument.
29
30 =head1 SEE ALSO
31
32 L<SSL_CONF_CTX_new(3)|SSL_CONF_CTX_new(3)>,
33 L<SSL_CONF_CTX_set_flags(3)|SSL_CONF_CTX_set_flags(3)>,
34 L<SSL_CONF_CTX_set1_prefix(3)|SSL_CONF_CTX_set1_prefix(3)>,
35 L<SSL_CONF_CTX_set_ssl_ctx(3)|SSL_CONF_CTX_set_ssl_ctx(3)>,
36 L<SSL_CONF_cmd(3)|SSL_CONF_cmd(3)>
37
38 =head1 HISTORY
39
40 These functions were first added to OpenSSL 1.0.2
41
42 =cut