fc5ecaddd0
While stereotyped repetitions are frowned upon in literature, they serve a useful purpose in manual pages, because it is easier for the user to find certain information if it is always presented in the same way. For that reason, this commit harmonizes the varying formulations in the HISTORY section about which functions, flags, etc. were added in which OpenSSL version. It also attempts to make the pod files more grep friendly by avoiding to insert line breaks between the symbol names and the corresponding version number in which they were introduced (wherever possible). Some punctuation and typographical errors were fixed on the way. Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7854)
51 lines
1.3 KiB
Text
51 lines
1.3 KiB
Text
=pod
|
|
|
|
=head1 NAME
|
|
|
|
SSL_CONF_cmd_argv - SSL configuration command line processing
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/ssl.h>
|
|
|
|
int SSL_CONF_cmd_argv(SSL_CONF_CTX *cctx, int *pargc, char ***pargv);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The function SSL_CONF_cmd_argv() processes at most two command line
|
|
arguments from B<pargv> and B<pargc>. The values of B<pargv> and B<pargc>
|
|
are updated to reflect the number of command options processed. The B<pargc>
|
|
argument can be set to B<NULL> if it is not used.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
SSL_CONF_cmd_argv() returns the number of command arguments processed: 0, 1, 2
|
|
or a negative error code.
|
|
|
|
If -2 is returned then an argument for a command is missing.
|
|
|
|
If -1 is returned the command is recognised but couldn't be processed due
|
|
to an error: for example a syntax error in the argument.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<SSL_CONF_CTX_new(3)>,
|
|
L<SSL_CONF_CTX_set_flags(3)>,
|
|
L<SSL_CONF_CTX_set1_prefix(3)>,
|
|
L<SSL_CONF_CTX_set_ssl_ctx(3)>,
|
|
L<SSL_CONF_cmd(3)>
|
|
|
|
=head1 HISTORY
|
|
|
|
These functions were added in OpenSSL 1.0.2.
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2012-2016 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
Licensed under the Apache License 2.0 (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
|