Debian Codegraph @

upstream/debian-unstable/man3/SSL_CONF_cmd_argv.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "SSL_CONF_CMD_ARGV 3SSL"
58 .TH SSL_CONF_CMD_ARGV 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 SSL_CONF_cmd_argv \- SSL configuration command line processing
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& int SSL_CONF_cmd_argv(SSL_CONF_CTX *cctx, int *pargc, char ***pargv);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 The function \fBSSL_CONF_cmd_argv()\fR processes at most two command line
75 arguments from \fBpargv\fR and \fBpargc\fR. The values of \fBpargv\fR and \fBpargc\fR
76 are updated to reflect the number of command options processed. The \fBpargc\fR
77 argument can be set to \fBNULL\fR if it is not used.
78 .SH "RETURN VALUES"
79 .IX Header "RETURN VALUES"
80 \&\fBSSL_CONF_cmd_argv()\fR returns the number of command arguments processed: 0, 1, 2
81 or a negative error code.
82 .PP
83 If \-2 is returned then an argument for a command is missing.
84 .PP
85 If \-1 is returned the command is recognised but couldn't be processed due
86 to an error: for example a syntax error in the argument.
87 .SH "SEE ALSO"
88 .IX Header "SEE ALSO"
89 \&\fBssl\fR\|(7),
90 \&\fBSSL_CONF_CTX_new\fR\|(3),
91 \&\fBSSL_CONF_CTX_set_flags\fR\|(3),
92 \&\fBSSL_CONF_CTX_set1_prefix\fR\|(3),
93 \&\fBSSL_CONF_CTX_set_ssl_ctx\fR\|(3),
94 \&\fBSSL_CONF_cmd\fR\|(3)
95 .SH HISTORY
96 .IX Header "HISTORY"
97 These functions were added in OpenSSL 1.0.2.
98 .SH COPYRIGHT
99 .IX Header "COPYRIGHT"
100 Copyright 2012\-2016 The OpenSSL Project Authors. All Rights Reserved.
101 .PP
102 Licensed under the Apache License 2.0 (the "License"). You may not use
103 this file except in compliance with the License. You can obtain a copy
104 in the file LICENSE in the source distribution or at
105 <https://www.openssl.org/source/license.html>.