summaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLOPT_TCP_FASTOPEN.3
diff options
context:
space:
mode:
authorng0 <ng0@infotropique.org>2017-08-22 18:16:20 +0000
committerng0 <ng0@infotropique.org>2017-08-22 18:16:20 +0000
commit25a03ee9c6133cfe1ce809a8ab1528ae7328fe35 (patch)
tree5ee3f3450604faedd1d4a9e53a3982c6ffcfe5fc /docs/libcurl/opts/CURLOPT_TCP_FASTOPEN.3
parent535a1e532345d3760d496b5b21052f23e8965f4c (diff)
downloadgnurl-25a03ee9c6133cfe1ce809a8ab1528ae7328fe35.tar.gz
gnurl-25a03ee9c6133cfe1ce809a8ab1528ae7328fe35.tar.bz2
gnurl-25a03ee9c6133cfe1ce809a8ab1528ae7328fe35.zip
gnurl: Rename man3 files to avoid collisions.
This is necessary so that gnURL and cURL can co-exist on the same system. However renaming most of the files is not logical. Signed-off-by: ng0 <ng0@infotropique.org>
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_TCP_FASTOPEN.3')
-rw-r--r--docs/libcurl/opts/CURLOPT_TCP_FASTOPEN.354
1 files changed, 0 insertions, 54 deletions
diff --git a/docs/libcurl/opts/CURLOPT_TCP_FASTOPEN.3 b/docs/libcurl/opts/CURLOPT_TCP_FASTOPEN.3
deleted file mode 100644
index 0c3817411..000000000
--- a/docs/libcurl/opts/CURLOPT_TCP_FASTOPEN.3
+++ /dev/null
@@ -1,54 +0,0 @@
-.\" **************************************************************************
-.\" * _ _ ____ _
-.\" * Project ___| | | | _ \| |
-.\" * / __| | | | |_) | |
-.\" * | (__| |_| | _ <| |___
-.\" * \___|\___/|_| \_\_____|
-.\" *
-.\" * Copyright (C) 1998 - 2017, 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.haxx.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_TCP_FASTOPEN 3 "16 Feb 2016" "libcurl 7.49.0" "curl_easy_setopt options"
-.SH NAME
-CURLOPT_TCP_FASTOPEN \- enable TCP Fast Open
-.SH SYNOPSIS
-#include <gnurl/curl.h>
-
-CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TCP_FASTOPEN, long enable);
-.SH DESCRIPTION
-Pass a long as parameter set to 1L to enable or 0 to disable.
-
-TCP Fast Open (RFC7413) is a mechanism that allows data to be carried in the
-SYN and SYN-ACK packets and consumed by the receiving end during the initial
-connection handshake, saving up to one full round-trip time (RTT).
-.SH DEFAULT
-0
-.SH PROTOCOLS
-All
-.SH EXAMPLE
-.nf
-CURL *curl = curl_easy_init();
-if(curl) {
- curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
- curl_easy_setopt(curl, CURLOPT_TCP_FASTOPEN, 1L);
- curl_easy_perform(curl);
-}
-.fi
-.SH AVAILABILITY
-Added in 7.49.0. This option is currently only supported on Linux and OS X
-El Capitan.
-.SH RETURN VALUE
-Returns CURLE_OK if fast open is supported by the operating system, otherwise
-returns CURLE_NOT_BUILT_IN.