12a2ed970f
In every libcurl option man page there are now 8 mandatory sections that must use the right name in the correct order and test 1173 verifies this. Only 14 man pages needed adjustments. The sections and the order is as follows: - NAME - SYNOPSIS - DESCRIPTION - PROTOCOLS - EXAMPLE - AVAILABILITY - RETURN VALUE - SEE ALSO Reviewed-by: Daniel Gustafsson Closes #7656
58 lines
2.3 KiB
Groff
58 lines
2.3 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLOPT_SSL_FALSESTART 3 "14 Feb 2015" "libcurl 7.41.0" "curl_easy_setopt options"
|
|
.SH NAME
|
|
CURLOPT_SSL_FALSESTART \- enable TLS false start
|
|
.SH SYNOPSIS
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_FALSESTART, long enable);
|
|
.SH DESCRIPTION
|
|
Pass a long as parameter set to 1L to enable or 0 to disable.
|
|
|
|
This option determines whether libcurl should use false start during the TLS
|
|
handshake. False start is a mode where a TLS client will start sending
|
|
application data before verifying the server's Finished message, thus saving a
|
|
round trip when performing a full handshake.
|
|
.SH DEFAULT
|
|
0
|
|
.SH PROTOCOLS
|
|
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
|
|
.SH EXAMPLE
|
|
.nf
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
curl_easy_setopt(curl, CURLOPT_SSL_FALSESTART, 1L);
|
|
curl_easy_perform(curl);
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.42.0. This option is currently only supported by the NSS and
|
|
Secure Transport (on iOS 7.0 or later, or OS X 10.9 or later) TLS backends.
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if false start is supported by the SSL backend, otherwise
|
|
returns CURLE_NOT_BUILT_IN.
|
|
.SH SEE ALSO
|
|
.BR CURLOPT_TCP_FASTOPEN "(3), "
|