- CURLOPT_HTTPAUTH (3)
TLS-backend:
- [name]
+ Added-in: [version or "n/a"]
---
All curldown files *must* have all the headers present and at least one
Source: curl-config
See-also:
- curl (1)
+Added-in: 7.7.2
---
# NAME
- curl_multi_remove_handle (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.1
-
# RETURN VALUE
None
- curl_global_init (3)
Protocol:
- All
+Added-in: 7.9
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.9
-
# RETURN VALUE
If this function returns NULL, something went wrong and no valid handle was
- curl_url_get (3)
Protocol:
- All
+Added-in: 7.15.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.15.4 and replaces the old curl_escape(3) function.
-
# RETURN VALUE
A pointer to a null-terminated string or NULL if it failed.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.4.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.4.1
-
# RETURN VALUE
If the operation was successful, CURLE_OK is returned. Otherwise an
- libcurl-errors (3)
Protocol:
- HTTP
+Added-in: 7.83.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.83.0. Officially supported since 7.84.0.
-
# RETURN VALUE
This function returns a CURLHcode indicating success or error.
- curl_multi_init (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
If this function returns NULL, something went wrong and you cannot use the
- curl_easy_perform (3)
Protocol:
- HTTP
+Added-in: 7.83.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.83.0. Officially supported since 7.84.0.
-
# RETURN VALUE
This function returns the next header, or NULL when there are no more
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.73.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-This function was added in libcurl 7.73.0
-
# RETURN VALUE
A pointer to the *curl_easyoption* struct for the option or NULL.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.73.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-This function was added in libcurl 7.73.0
-
# RETURN VALUE
A pointer to the *curl_easyoption* struct for the option or NULL.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.73.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-This function was added in libcurl 7.73.0
-
# RETURN VALUE
A pointer to the *curl_easyoption* struct for the next option or NULL if
- curl_easy_reset (3)
Protocol:
- All
+Added-in: 7.18.0
---
# NAME
transfer is paused. This means that if a window size of 64 MB is used, libcurl
might end up having to cache 64 MB of data.
-# AVAILABILITY
-
-Added in 7.18.0.
-
# RETURN VALUE
CURLE_OK (zero) means that the option was set properly, and a non-zero return
- libcurl-errors (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
CURLE_OK (0) means everything was OK, non-zero means an error occurred as
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.18.2
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.18.2.
-
# RETURN VALUE
On success, returns **CURLE_OK**, stores the received data into
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.12.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-This function was added in libcurl 7.12.1
-
# RETURN VALUE
Nothing
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.18.2
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.18.2.
-
# RETURN VALUE
On success, returns **CURLE_OK** and stores the number of bytes actually
- curl_multi_setopt (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# ENCRYPTED CLIENT HELLO OPTIONS
-
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
*CURLE_OK* (zero) means that the option was set properly, non-zero means an
- libcurl-errors (3)
Protocol:
- All
+Added-in: 7.12.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-This function was added in libcurl 7.12.0
-
# RETURN VALUE
A pointer to a null-terminated string.
- curl_url_get (3)
Protocol:
- All
+Added-in: 7.15.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.15.4 and replaces the old curl_unescape(3) function.
-
# RETURN VALUE
A pointer to a null-terminated string or NULL if it failed.
- CURLOPT_TCP_KEEPIDLE (3)
Protocol:
- All
+Added-in: 7.62.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.62.0.
-
# RETURN VALUE
On success, returns **CURLE_OK**.
- curl_unescape (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
+# HISTORY
Since 7.15.4, curl_easy_escape(3) should be used. This function might be
removed in a future release.
- curl_mime_init (3)
Protocol:
- HTTP
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
Deprecated in 7.56.0. Before this release, field names were allowed to contain
zero-valued bytes. The pseudo-filename "-" to read stdin is discouraged
- curl_mime_init (3)
Protocol:
- HTTP
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
Deprecated in 7.56.0.
- curl_mime_init (3)
Protocol:
- HTTP
+Added-in: 7.15.5
---
# NAME
# DESCRIPTION
+The form API (including this function) is deprecated since libcurl 7.56.0.
+
curl_formget() serializes data previously built with curl_formadd(3). It
-accepts a void pointer as second argument named *userp* which is passed as
-the first argument to the curl_formget_callback function.
+accepts a void pointer as second argument named *userp* which is passed as the
+first argument to the curl_formget_callback function.
~~~c
typedef size_t (*curl_formget_callback)(void *userp, const char *buf,
return the buffer length passed to it on success.
If the **CURLFORM_STREAM** option is used in the formpost, it prevents
-curl_formget(3) from working until you have performed the actual HTTP
-request. This, because first then does libcurl known which actual read
-callback to use!
+curl_formget(3) from working until you have performed the actual HTTP request.
+This, because first then does libcurl known which actual read callback to use!
# EXAMPLE
}
~~~
-# AVAILABILITY
-
-This function was added in libcurl 7.15.5. The form API is deprecated in
-libcurl 7.56.0.
-
# RETURN VALUE
0 means everything was OK, non-zero means an error occurred
- curl_easy_unescape (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
None
- curl_easy_unescape (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
These formats are the only ones RFC 7231 says HTTP applications may use.
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
This function returns -1 when it fails to parse the date string. Otherwise it
- getenv (3C)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
A pointer to a null-terminated string or NULL if it failed to find the
- libcurl-thread (3)
Protocol:
- All
+Added-in: 7.8
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.8
-
# RETURN VALUE
None
- libcurl (3)
Protocol:
- All
+Added-in: 7.8
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.8
-
# RETURN VALUE
If this function returns non-zero, something went wrong and you cannot use the
- curl_global_init (3)
Protocol:
- All
+Added-in: 7.12.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.12.0
-
# RETURN VALUE
CURLE_OK (0) means everything was OK, non-zero means an error occurred as
- libcurl (3)
Protocol:
- All
+Added-in: 7.56.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-This function was added in libcurl 7.56.0. Before this version, there was no
-support for choosing SSL backends at runtime.
-
# RETURN VALUE
If this function returns *CURLSSLSET_OK*, the backend was successfully
- libcurl (3)
Protocol:
- All
+Added-in: 8.3
---
# NAME
...
~~~
-# AVAILABILITY
-
-Added in 8.3
-
# RETURN VALUE
If this function returns non-zero, something went wrong and the configuration
- HTTP
- IMAP
- SMTP
+Added-in: 7.56.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
-
# RETURN VALUE
A mime part structure handle, or NULL upon failure.
- HTTP
- IMAP
- SMTP
+Added-in: 7.56.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
-
# RETURN VALUE
CURLE_OK or a CURL error code upon failure.
- HTTP
- IMAP
- SMTP
+Added-in: 7.56.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
-
# RETURN VALUE
CURLE_OK or a CURL error code upon failure.
- HTTP
- IMAP
- SMTP
+Added-in: 7.56.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
-
# RETURN VALUE
CURLE_OK or a CURL error code upon failure.
- HTTP
- IMAP
- SMTP
+Added-in: 7.56.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
-
# RETURN VALUE
CURLE_OK or a CURL error code upon failure. CURLE_READ_ERROR is only an
- HTTP
- IMAP
- SMTP
+Added-in: 7.56.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
-
# RETURN VALUE
CURLE_OK or a CURL error code upon failure.
- HTTP
- IMAP
- SMTP
+Added-in: 7.56.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
-
# RETURN VALUE
None
- HTTP
- IMAP
- SMTP
+Added-in: 7.56.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
-
# RETURN VALUE
CURLE_OK or a CURL error code upon failure.
- HTTP
- IMAP
- SMTP
+Added-in: 7.56.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
-
# RETURN VALUE
A mime struct handle, or NULL upon failure.
- HTTP
- IMAP
- SMTP
+Added-in: 7.56.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
-
# RETURN VALUE
CURLE_OK or a CURL error code upon failure.
- HTTP
- IMAP
- SMTP
+Added-in: 7.56.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
-
# RETURN VALUE
CURLE_OK or a CURL error code upon failure.
- HTTP
- IMAP
- SMTP
+Added-in: 7.56.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
-
# RETURN VALUE
CURLE_OK or a CURL error code upon failure.
- vprintf (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-These functions might be removed from the public libcurl API in the future. Do
-not use them in new programs or projects.
-
# RETURN VALUE
The **curl_maprintf** and **curl_mvaprintf** functions return a pointer to
- curl_multi_socket_action (3)
Protocol:
- All
+Added-in: 7.9.6
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.9.6
-
# RETURN VALUE
CURLMcode type, general libcurl multi interface error code.
- curl_multi_socket_action (3)
Protocol:
- All
+Added-in: 7.15.5
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.15.5
-
-# RETURN VALUE
-
-The standard CURLMcode for multi interface error codes.
-
# TYPICAL USAGE
In a typical application you allocate a struct or at least use some kind of
the curl_multi_socket_action(3) approach.
When our socket-callback gets called by libcurl and we get to know about yet
-another socket to wait for, we can use curl_multi_assign(3) to point out
-the particular data so that when we get updates about this same socket again,
-we do not have to find the struct associated with this socket by ourselves.
+another socket to wait for, we can use curl_multi_assign(3) to point out the
+particular data so that when we get updates about this same socket again, we
+do not have to find the struct associated with this socket by ourselves.
+
+# RETURN VALUE
+
+The standard CURLMcode for multi interface error codes.
- curl_multi_init (3)
Protocol:
- All
+Added-in: 7.9.6
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.9.6
-
# RETURN VALUE
CURLMcode type, general libcurl multi interface error code. On success,
- select (2)
Protocol:
- All
+Added-in: 7.9.6
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.9.6
-
# RETURN VALUE
**CURLMcode** type, general libcurl multi interface error code. See
- curl_multi_remove_handle (3)
Protocol:
- All
+Added-in: 8.4.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 8.4.0
-
# RETURN VALUE
Returns NULL on failure. Otherwise it returns a pointer to an allocated array.
- curl_multi_perform (3)
Protocol:
- All
+Added-in: 7.9.6
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.9.6
-
# RETURN VALUE
A pointer to a filled-in struct, or NULL if it failed or ran out of
- curl_multi_get_handles (3)
Protocol:
- All
+Added-in: 7.9.6
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.9.6
-
# RETURN VALUE
If this function returns NULL, something went wrong and you cannot use the
- libcurl-errors (3)
Protocol:
- All
+Added-in: 7.9.6
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.9.6
-
# RETURN VALUE
CURLMcode type, general libcurl multi interface error code.
- curl_multi_wakeup (3)
Protocol:
- All
+Added-in: 7.66.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.66.0.
-
# RETURN VALUE
CURLMcode type, general libcurl multi interface error code. See
- curl_multi_init (3)
Protocol:
- All
+Added-in: 7.9.6
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.9.6
-
# RETURN VALUE
CURLMcode type, general libcurl multi interface error code.
- curl_multi_socket (3)
Protocol:
- All
+Added-in: 7.15.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.15.4
-
# RETURN VALUE
The standard CURLMcode for multi interface error codes. Note that it returns a
- the hiperfifo.c example
Protocol:
- All
+Added-in: 7.15.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-This function was added in libcurl 7.15.4, and is deemed stable since
-7.16.0.
+# DEPRECATED
curl_multi_socket(3) is deprecated, use curl_multi_socket_action(3) instead!
- the hiperfifo.c example
Protocol:
- All
+Added-in: 7.15.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-This function was added in libcurl 7.15.4, and is deemed stable since 7.16.0.
-
# RETURN VALUE
CURLMcode type, general libcurl multi interface error code. See
---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
-Title: curl_multi_socket
+Title: curl_multi_socket_all
Section: 3
Source: libcurl
See-also:
- the hiperfifo.c example
Protocol:
- All
+Added-in: 7.15.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-This function was added in libcurl 7.15.4, and is deemed stable since 7.16.0.
-
-curl_multi_socket_all(3) is deprecated, use
-curl_multi_socket_action(3) instead!
-
# RETURN VALUE
CURLMcode type, general libcurl multi interface error code.
- libcurl-errors (3)
Protocol:
- All
+Added-in: 7.12.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-This function was added in libcurl 7.12.0
-
# RETURN VALUE
A pointer to a null-terminated string.
- curl_multi_socket (3)
Protocol:
- All
+Added-in: 7.15.4
---
# NAME
When there is activity or timeout, call curl_multi_perform(3) and then
loop - until all transfers are complete.
-# AVAILABILITY
-
-This function was added in libcurl 7.15.4.
-
# RETURN VALUE
The standard CURLMcode for multi interface error codes.
- curl_multi_poll (3)
Protocol:
- All
+Added-in: 7.28.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-This function was added in libcurl 7.28.0.
-
# RETURN VALUE
CURLMcode type, general libcurl multi interface error code. See
- curl_multi_fdset (3)
Protocol:
- All
+Added-in: 8.8.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 8.8.0
-
# RETURN VALUE
**CURLMcode** type, general libcurl multi interface error code. See
- curl_multi_wait (3)
Protocol:
- All
+Added-in: 7.68.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.68.0
-
# RETURN VALUE
CURLMcode type, general libcurl multi interface error code.
- curl_pushheader_bynum (3)
Protocol:
- HTTP
+Added-in: 7.44.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.44.0
-
# RETURN VALUE
Returns a pointer to the header field content or NULL.
- curl_pushheader_byname (3)
Protocol:
- HTTP
+Added-in: 7.44.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.44.0
-
# RETURN VALUE
Returns a pointer to the header field content or NULL.
- curl_share_setopt (3)
Protocol:
- All
+Added-in: 7.10
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10
-
# RETURN VALUE
CURLSHE_OK (zero) means that the option was set properly, non-zero means an
- curl_share_setopt (3)
Protocol:
- All
+Added-in: 7.10
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10
-
# RETURN VALUE
If this function returns NULL, something went wrong (out of memory, etc.)
- curl_share_init (3)
Protocol:
- All
+Added-in: 7.10
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10
-
# RETURN VALUE
CURLSHE_OK (zero) means that the option was set properly, non-zero means an
- libcurl-errors (3)
Protocol:
- All
+Added-in: 7.12.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-This function was added in libcurl 7.12.0
-
# RETURN VALUE
A pointer to a null-terminated string.
- curl_slist_free_all (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
A null pointer is returned if anything went wrong, otherwise the new list
- curl_slist_append (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Nothing.
- strcmp (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Non-zero if the strings are identical. Zero if they are not.
---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
-Title: curl_strequal
+Title: curl_strnequal
Section: 3
Source: libcurl
See-also:
- strcmp (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Non-zero if the strings are identical. Zero if they are not.
- curl_free (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
# DESCRIPTION
-Obsolete function. Use curl_easy_unescape(3) instead.
+Deprecated. Use curl_easy_unescape(3) instead.
This function converts the URL encoded string **input** to a "plain string"
and return that as a new allocated string. All input characters that are URL
}
~~~
-# AVAILABILITY
+# DEPRECATED
Since 7.15.4, curl_easy_unescape(3) should be used. This function might
be removed in a future release.
- curl_url_strerror (3)
Protocol:
- All
+Added-in: 7.62.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.62.0
-
# RETURN VALUE
Returns a **CURLU *** if successful, or NULL if out of memory.
- curl_url_set (3)
Protocol:
- All
+Added-in: 7.62.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.62.0
-
# RETURN VALUE
none
- curl_url_set (3)
Protocol:
- All
+Added-in: 7.62.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.62.0
-
# RETURN VALUE
Returns a new handle or NULL if out of memory.
- curl_url_strerror (3)
Protocol:
- All
+Added-in: 7.62.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.62.0. CURLUPART_ZONEID was added in 7.65.0.
-
# RETURN VALUE
Returns a CURLUcode error value, which is CURLUE_OK (0) if everything went
- curl_url_strerror (3)
Protocol:
- All
+Added-in: 7.78.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.62.0. CURLUPART_ZONEID was added in 7.65.0.
-
# RETURN VALUE
Returns a *CURLUcode* error value, which is CURLUE_OK (0) if everything
- libcurl-errors (3)
Protocol:
- All
+Added-in: 7.80.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.80.0
-
# RETURN VALUE
A pointer to a null-terminated string.
- curl_version_info (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
A pointer to a null-terminated string. The string resides in a statically
- curl_version (3)
Protocol:
- All
+Added-in: 7.10.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10
-
# RETURN VALUE
A pointer to a curl_version_info_data struct.
- libcurl-ws (3)
Protocol:
- WS
+Added-in: 7.86.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.86.0.
-
# RETURN VALUE
This function returns a pointer to a *curl_ws_frame* struct with read-only
- libcurl-ws (3)
Protocol:
- WS
+Added-in: 7.86.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.86.0.
-
# RETURN VALUE
Returns **CURLE_OK** if everything is okay, and a non-zero number for
- libcurl-ws (3)
Protocol:
- WS
+Added-in: 7.86.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.86.0.
-
# RETURN VALUE
*CURLE_OK* (zero) means that the data was sent properly, non-zero means an
---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
-Title: libcurl
+Title: libcurl-easy
Section: 3
Source: libcurl
See-also:
- libcurl-multi (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
- libcurl-env (3)
Protocol:
- All
+Added-in: n/a
---
# NAME
- libcurl-env-dbg (3)
Protocol:
- All
+Added-in: n/a
---
# NAME
- curl_url_strerror (3)
Protocol:
- All
+Added-in: n/a
---
# NAME
- libcurl-errors (3)
Protocol:
- All
+Added-in: 7.9.6
---
# NAME
- libcurl-thread (3)
Protocol:
- All
+Added-in: n/a
---
<!-- markdown-link-check-disable -->
# NAME
- libcurl-multi (3)
Protocol:
- All
+Added-in: n/a
---
# NAME
- libcurl-security (3)
Protocol:
- All
+Added-in: n/a
---
# NAME
- libcurl-url (3)
Protocol:
- All
+Added-in: n/a
---
# NAME
---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
-Title: libcurl
+Title: libcurl-url
Section: 3
Source: libcurl
See-also:
- curl_url_strerror (3)
Protocol:
- All
+Added-in: 7.62.0
---
# NAME
https://example.com/?shoes=2&hat=1&candy=N%26N
~~~
-# AVAILABILITY
-
-The URL API was introduced in libcurl 7.62.0.
+# NOTES
A URL with a literal IPv6 address can be parsed even when IPv6 support is not
enabled.
---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
-Title: libcurl
+Title: libcurl-ws
Section: 3
Source: libcurl
See-also:
- curl_ws_send (3)
Protocol:
- All
+Added-in: 7.86.0
---
# NAME
and use curl_ws_recv(3) and curl_ws_send(3) freely to exchange
WebSocket messages with the server.
-# AVAILABILITY
+# EXPERIMENTAL
The WebSocket API was introduced as experimental in 7.86.0 and is still
experimental today.
- libcurl-thread (3)
Protocol:
- All
+Added-in: n/a
---
# NAME
- libcurl-multi (3)
- libcurl-security (3)
- libcurl-thread (3)
+Added-in: n/a
---
# libcurl symbols
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.45.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.45.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.19.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.19.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.61.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.61.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- TLS
TLS-backend:
- All
+Added-in: 7.84.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.84.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- GnuTLS
- mbedTLS
- wolfSSL
+Added-in: 7.84.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.84.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- GnuTLS
- Schannel
- Secure Transport
+Added-in: 7.19.1
---
# NAME
See also the *certinfo.c* example.
-# AVAILABILITY
+# NOTES
-This option is only working in libcurl built with OpenSSL, GnuTLS, Schannel,
-Secure Transport or mbedTLS. GnuTLS support added in 7.42.0. Schannel support
-added in 7.50.0. Secure Transport support added in 7.79.0. mbedTLS support added
-in 8.9.0.
-
-Added in 7.19.1
+GnuTLS support added in 7.42.0. Schannel support added in 7.50.0. Secure
+Transport support added in 7.79.0. mbedTLS support added in 8.9.0.
# RETURN VALUE
- curl_easy_setopt (3)
Protocol:
- HTTP
+Added-in: 7.19.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.19.4
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.4.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.4.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.61.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.61.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 8.2.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 8.2.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.6.1
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
-Added in 7.6.1. Deprecated since 7.55.0.
+Deprecated since 7.55.0.
# RETURN VALUE
- curl_easy_setopt (3)
Protocol:
- HTTP
+Added-in: 7.55.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.55.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.6.1
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
-Added in 7.6.1. Deprecated since 7.55.0.
+Deprecated since 7.55.0.
# RETURN VALUE
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.55.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.55.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- HTTP
+Added-in: 7.9.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.9.4
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- HTTP
+Added-in: 7.14.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.14.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- HTTP
+Added-in: 7.72.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.72.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- HTTP
+Added-in: 7.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.4
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- HTTP
- FTP
- SFTP
+Added-in: 7.5
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.5
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
-Title: CURLINFO_FILETIME
+Title: CURLINFO_FILETIME_T
Section: 3
Source: libcurl
See-also:
- HTTP
- FTP
- SFTP
+Added-in: 7.59.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.59.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- FTP
+Added-in: 7.15.4
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
-Added in 7.15.4. Works for SFTP since 7.21.4
+Works for SFTP since 7.21.4
# RETURN VALUE
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.4.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.4.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- HTTP
+Added-in: 7.10.8
---
# NAME
Pass a pointer to a long to receive a bitmask indicating the authentication
method(s) available according to the previous response. The meaning of the
-bits is explained in the CURLOPT_HTTPAUTH(3) option for
-curl_easy_setopt(3).
+bits is explained in the CURLOPT_HTTPAUTH(3) option for curl_easy_setopt(3).
# EXAMPLE
}
~~~
-# AVAILABILITY
-
-Added RFC 2617 in 7.10.8
-Added RFC 7616 in 7.57.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- HTTP
+Added-in: 7.10.7
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10.7
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- HTTP
+Added-in: 7.50.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.50.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.15.2
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.15.2
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.21.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.21.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLINFO_PRIMARY_PORT (3)
- curl_easy_getinfo (3)
- curl_easy_setopt (3)
+Added-in: 7.21.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.21.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.4.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.4.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.61.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.61.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.12.3
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.12.3
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.12.2
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.12.2
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.4.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.4.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.61.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.61.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.19.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.19.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.21.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.21.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.10.3
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10.3
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
-Added in 7.52.0. Deprecated since 7.85.0.
+Deprecated since 7.85.0.
# RETURN VALUE
- curl_easy_setopt (3)
Protocol:
- HTTP
+Added-in: 7.10.8
---
# NAME
Pass a pointer to a long to receive a bitmask indicating the authentication
method(s) available according to the previous response. The meaning of the
-bits is explained in the CURLOPT_PROXYAUTH(3) option for
-curl_easy_setopt(3).
+bits is explained in the CURLOPT_PROXYAUTH(3) option for curl_easy_setopt(3).
# EXAMPLE
}
~~~
-# AVAILABILITY
-
-Added RFC 2617 in 7.10.8
-Added RFC 7616 in 7.57.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- libcurl-errors (3)
Protocol:
- All
+Added-in: 7.73.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.73.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
TLS-backend:
- OpenSSL
- GnuTLS
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 8.6.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 8.6.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.9.7
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.9.7
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- HTTP
+Added-in: 7.9.7
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.9.7
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- HTTP
+Added-in: 7.61.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.61.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- HTTP
+Added-in: 7.18.2
---
# NAME
# DESCRIPTION
-Pass a pointer to a char pointer to receive the URL a redirect *would*
-take you to if you would enable CURLOPT_FOLLOWLOCATION(3). This can come
-handy if you think using the built-in libcurl redirect logic is not good enough
-for you but you would still prefer to avoid implementing all the magic of
-figuring out the new URL.
+Pass a pointer to a char pointer to receive the URL a redirect *would* take
+you to if you would enable CURLOPT_FOLLOWLOCATION(3). This can come handy if
+you think using the built-in libcurl redirect logic is not good enough for you
+but you would still prefer to avoid implementing all the magic of figuring out
+the new URL.
-This URL is also set if the CURLOPT_MAXREDIRS(3) limit prevented a
-redirect to happen (since 7.54.1).
+This URL is also set if the CURLOPT_MAXREDIRS(3) limit prevented a redirect to
+happen (since 7.54.1).
# EXAMPLE
}
~~~
-# AVAILABILITY
-
-Added in 7.18.2
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- HTTP
+Added-in: 7.76.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.76.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.4.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.4.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- FTP
- SMTP
- LDAP
+Added-in: 7.10.8
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
-Added in 7.10.8. CURLINFO_HTTP_CODE was added in 7.4.1.
-Support for SMTP responses added in 7.25.0, for OpenLDAP in 7.81.0.
+The former name, CURLINFO_HTTP_CODE, was added in 7.4.1. Support for SMTP
+responses added in 7.25.0, for OpenLDAP in 7.81.0.
# RETURN VALUE
- curl_easy_header (3)
Protocol:
- All
+Added-in: 7.66.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.66.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- RTSP
+Added-in: 7.20.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.20.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- RTSP
+Added-in: 7.20.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.20.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- RTSP
+Added-in: 7.20.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.20.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- RTSP
+Added-in: 7.20.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.20.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.4.1
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
-Added in 7.4.1. Deprecated since 7.55.0.
+Deprecated since 7.55.0.
# RETURN VALUE
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.55.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.55.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.4.1
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
-Added in 7.4.1. Deprecated since 7.55.0.
+Deprecated since 7.55.0.
# RETURN VALUE
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.55.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.55.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.4.1
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
-Added in 7.4.1. Deprecated since 7.55.0.
+Deprecated since 7.55.0.
# RETURN VALUE
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.55.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.55.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.4.1
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
-Added in 7.4.1. Deprecated since 7.55.0.
+Deprecated since 7.55.0.
# RETURN VALUE
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.55.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.55.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- TLS
TLS-backend:
- OpenSSL
+Added-in: 7.12.3
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.12.3. Available in OpenSSL builds with "engine" support.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
TLS-backend:
- OpenSSL
- GnuTLS
+Added-in: 7.5
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.5. Only set by the OpenSSL/LibreSSL/BoringSSL and GnuTLS backends.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.9.2
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.9.2
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.61.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.61.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
TLS-backend:
- OpenSSL
- GnuTLS
+Added-in: 7.34.0
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
-Added in 7.34.0. Deprecated since 7.48.0 and supported by OpenSSL and GnuTLS
-only up until this version was released.
+Deprecated since 7.48.0
# RETURN VALUE
- Schannel
- Secure Transport
- wolfSSL
+Added-in: 7.48.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.48.0.
+# NOTES
This option supersedes CURLINFO_TLS_SESSION(3) which was added in 7.34.0.
This option is exactly the same as that option except in the case of OpenSSL.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.4.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.4.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 7.61.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.61.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 8.7.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 8.7.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_easy_setopt (3)
Protocol:
- All
+Added-in: 8.2.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 8.2.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLMOPT_PIPELINING (3)
Protocol:
- HTTP
+Added-in: 7.30.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.30.0
-
# RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
- CURLMOPT_PIPELINING (3)
Protocol:
- HTTP
+Added-in: 7.30.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.30.0
-
# RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
- CURLOPT_MAXCONNECTS (3)
Protocol:
- All
+Added-in: 7.16.3
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.16.3
-
# RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
- CURLOPT_MAXCONNECTS (3)
Protocol:
- HTTP
+Added-in: 7.67.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.67.0
-
# RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
- CURLMOPT_MAX_TOTAL_CONNECTIONS (3)
Protocol:
- All
+Added-in: 7.30.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.30.0
-
# RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
- CURLMOPT_PIPELINING (3)
Protocol:
- All
+Added-in: 7.30.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.30.0
-
# RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
- CURLMOPT_MAX_HOST_CONNECTIONS (3)
Protocol:
- All
+Added-in: 7.30.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.30.0
-
# RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
- CURLMOPT_PIPELINING_SITE_BL (3)
Protocol:
- HTTP
+Added-in: 7.16.0
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
-Added in 7.16.0. Multiplex support bit added in 7.43.0. HTTP/1 Pipelining
-support was disabled in 7.62.0.
+The multiplex support bit was added in 7.43.0. HTTP/1 Pipelining support was
+disabled in 7.62.0.
# RETURN VALUE
- CURLMOPT_PIPELINING_SITE_BL (3)
Protocol:
- HTTP
+Added-in: 7.30.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.30.0
-
# RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
- CURLMOPT_PIPELINING_SERVER_BL (3)
Protocol:
- HTTP
+Added-in: 7.30.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.30.0
-
# RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
- RFC 7540
Protocol:
- HTTP
+Added-in: 7.44.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.44.0
-
# RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
- RFC 7540
Protocol:
- HTTP
+Added-in: 7.44.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.44.0
-
# RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
- curl_multi_socket_action (3)
Protocol:
- All
+Added-in: 7.15.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.15.4
-
# RETURN VALUE
Returns CURLM_OK.
- curl_multi_socket_action (3)
Protocol:
- All
+Added-in: 7.15.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.15.4
-
# RETURN VALUE
Returns CURLM_OK.
- CURLMOPT_TIMERFUNCTION (3)
Protocol:
- All
+Added-in: 7.16.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.16.0
-
# RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
- CURLMOPT_TIMERDATA (3)
Protocol:
- All
+Added-in: 7.16.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.16.0
-
# RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
- unix (7)
Protocol:
- All
+Added-in: 7.53.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.53.0.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_STDERR (3)
Protocol:
- FTP
+Added-in: 7.24.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.24.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_TRANSFER_ENCODING (3)
Protocol:
- HTTP
+Added-in: 7.21.6
---
# NAME
The application does not have to keep the string around after setting this
option.
+# NOTES
+
+This option was called CURLOPT_ENCODING before 7.21.6
+
+The specific libcurl you are using must have been built with zlib to be able to
+decompress gzip and deflate responses, with the brotli library to
+decompress brotli responses and with the zstd library to decompress zstd
+responses.
+
# DEFAULT
NULL
}
~~~
-# AVAILABILITY
-
-This option was called CURLOPT_ENCODING before 7.21.6
-
-The specific libcurl you are using must have been built with zlib to be able to
-decompress gzip and deflate responses, with the brotli library to
-decompress brotli responses and with the zstd library to decompress zstd
-responses.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_STDERR (3)
Protocol:
- All
+Added-in: 7.19.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.19.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_RESOLVE (3)
Protocol:
- HTTP
+Added-in: 7.64.1
---
<!-- markdown-link-check-disable -->
# NAME
Integer priority value (not currently used)
-# AVAILABILITY
-
-Added in 7.64.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_RESOLVE (3)
Protocol:
- HTTP
+Added-in: 7.64.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.64.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_UPLOAD (3)
Protocol:
- FTP
+Added-in: 7.17.0
---
# NAME
}
~~~
-# AVAILABILITY
+# HISTORY
This option was known as CURLOPT_FTPAPPEND up to 7.16.4
- CURLOPT_REFERER (3)
Protocol:
- HTTP
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with HTTP
-
# RETURN VALUE
Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_PROXYAUTH (3)
Protocol:
- HTTP
+Added-in: 7.75.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.75.0
-
-# RETURN VALUE
-
-Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
-
# NOTES
This option overrides the other auth types you might have set in
-CURLOPT_HTTPAUTH(3) which should be highlighted as this makes this auth
-method special. This method cannot be combined with other auth types.
+CURLOPT_HTTPAUTH(3) which should be highlighted as this makes this auth method
+special. This method cannot be combined with other auth types.
A sha256 checksum of the request payload is used as input to the signature
calculation. For POST requests, this is a checksum of the provided
requests like PUT, you can provide your own checksum in an HTTP header named
**x-provider2-content-sha256**.
-For **aws:s3**, a **x-amz-content-sha256** header is added to every request
-if not already present. For s3 requests with unknown payload, this header takes
+For **aws:s3**, a **x-amz-content-sha256** header is added to every request if
+not already present. For s3 requests with unknown payload, this header takes
the special value "UNSIGNED-PAYLOAD".
+
+# RETURN VALUE
+
+Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_WRITEFUNCTION (3)
Protocol:
- All
+Added-in: 7.10
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10. Growing the buffer was added in 7.53.0.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- TLS
TLS-backend:
- All
+Added-in: 7.4.2
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
Schannel support added in libcurl 7.60.
- wolfSSL
- Secure Transport
- Schannel
+Added-in: 7.77.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.77.0.
+# NOTES
This option is supported by the BearSSL (since 7.79.0), mbedTLS (since
7.81.0), rustls (since 7.82.0), wolfSSL (since 8.2.0), OpenSSL, Secure
- GnuTLS
- mbedTLS
- wolfSSL
+Added-in: 7.9.8
---
# NAME
}
~~~
-# AVAILABILITY
-
-This option is supported by the OpenSSL, GnuTLS, mbedTLS and wolfSSL backends.
-
# RETURN VALUE
CURLE_OK if supported; or an error such as:
- OpenSSL
- Schannel
- wolfSSL
+Added-in: 7.87.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-This option was added in curl 7.87.0.
+# NOTES
This option is supported by OpenSSL and its forks (since 7.87.0), Schannel
(since 8.5.0), wolfSSL (since 8.9.0) and GnuTLS (since 8.9.0).
- GnuTLS
- Schannel
- Secure Transport
+Added-in: 7.19.1
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
Schannel support added in 7.50.0. Secure Transport support added in 7.79.0.
mbedTLS support added in 8.9.0.
- CURLOPT_WILDCARDMATCH (3)
Protocol:
- FTP
+Added-in: 7.21.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-This was added in 7.21.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_WILDCARDMATCH (3)
Protocol:
- FTP
+Added-in: 7.21.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.21.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_WILDCARDMATCH (3)
Protocol:
- FTP
+Added-in: 7.21.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.21.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_OPENSOCKETFUNCTION (3)
Protocol:
- All
+Added-in: 7.21.7
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.21.7
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_OPENSOCKETFUNCTION (3)
Protocol:
- All
+Added-in: 7.21.7
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.21.7
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_TIMEOUT (3)
Protocol:
- All
+Added-in: 7.7
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK. Returns CURLE_BAD_FUNCTION_ARGUMENT if set to a negative
- CURLOPT_TIMEOUT_MS (3)
Protocol:
- All
+Added-in: 7.16.2
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- curl_easy_send (3)
Protocol:
- All
+Added-in: 7.15.2
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
-Added in 7.15.2. WS and WSS support added in 7.86.0.
+WS and WSS support added in 7.86.0.
# RETURN VALUE
- CURLOPT_URL (3)
Protocol:
- All
+Added-in: 7.49.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.49.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_CONV_TO_NETWORK_FUNCTION (3)
Protocol:
- All
+Added-in: 7.15.4
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
Not available and deprecated since 7.82.0.
See-also:
- CURLOPT_CONV_FROM_NETWORK_FUNCTION (3)
- CURLOPT_CONV_TO_NETWORK_FUNCTION (3)
+Added-in: 7.15.4
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
Not available and deprecated since 7.82.0.
- CURLOPT_CONV_FROM_UTF8_FUNCTION (3)
Protocol:
- All
+Added-in: 7.15.4
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
Not available and deprecated since 7.82.0.
- CURLOPT_HTTPHEADER (3)
Protocol:
- HTTP
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-If HTTP is enabled
-
# RETURN VALUE
Returns CURLE_OK if HTTP is enabled, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_COOKIESESSION (3)
Protocol:
- HTTP
+Added-in: 7.1
---
# NAME
The cookie file format and general cookie concepts in curl are described
online here: https://curl.se/docs/http-cookies.html
-# AVAILABILITY
-
-As long as HTTP is supported
-
# RETURN VALUE
Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_COOKIELIST (3)
Protocol:
- HTTP
+Added-in: 7.9
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with HTTP
-
# RETURN VALUE
Returns CURLE_OK if HTTP is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_COOKIEJAR (3)
Protocol:
- HTTP
+Added-in: 7.14.1
---
# NAME
The cookie file format and general cookie concepts in curl are described
online here: https://curl.se/docs/http-cookies.html
-# AVAILABILITY
+# NOTES
**ALL** was added in 7.14.1
- CURLOPT_COOKIEJAR (3)
Protocol:
- HTTP
+Added-in: 7.9.7
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with HTTP
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_UPLOAD (3)
Protocol:
- HTTP
+Added-in: 7.17.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.17.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_CONV_TO_NETWORK_FUNCTION (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-SMTP since 7.40.0, other protocols since they were introduced
-
# RETURN VALUE
Returns CURLE_OK
- GnuTLS
- mbedTLS
- OpenSSL
+Added-in: 7.19.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.19.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- curl_url_strerror (3)
Protocol:
- All
+Added-in: 7.63.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.63.0.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- IMAP
- POP3
- SMTP
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-IMAP is supported since 7.30.0, POP3 since 7.26.0 and SMTP since 7.34.0.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_STDERR (3)
Protocol:
- All
+Added-in: 7.9.6
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- curl_global_trace (3)
Protocol:
- All
+Added-in: 7.9.6
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_URL (3)
Protocol:
- All
+Added-in: 7.45.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.45.0
-
# RETURN VALUE
CURLE_OK if the option is supported.
- FTP
- SFTP
- POP3
+Added-in: 7.17.0
---
# NAME
}
~~~
-# AVAILABILITY
+# HISTORY
This option was known as CURLOPT_FTPLISTONLY up to 7.16.4. POP3 is supported
since 7.21.5.
- libcurl-security (3)
Protocol:
- All
+Added-in: 7.61.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.61.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_RESOLVE (3)
Protocol:
- All
+Added-in: 7.9.3
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_INTERFACE (3)
Protocol:
- All
+Added-in: 7.33.0
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
-Added in 7.33.0. This option also requires that libcurl was built with a
-resolver backend that supports this operation. The c-ares backend is the only
-such one.
+This option requires that libcurl was built with a resolver backend that
+supports this operation. The c-ares backend is the only such one.
# RETURN VALUE
- CURLOPT_DNS_SERVERS (3)
Protocol:
- All
+Added-in: 7.33.0
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
This option requires that libcurl was built with a resolver backend that
supports this operation. The c-ares backend is the only such one.
-Added in 7.33.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not,
- CURLOPT_DNS_SERVERS (3)
Protocol:
- All
+Added-in: 7.33.0
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
This option requires that libcurl was built with a resolver backend that
supports this operation. The c-ares backend is the only such one.
-Added in 7.33.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not,
- CURLOPT_DNS_LOCAL_IP6 (3)
Protocol:
- All
+Added-in: 7.24.0
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
This option requires that libcurl was built with a resolver backend that
supports this operation. The c-ares backend is the only such one.
-Added in 7.24.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not,
- CURLOPT_IPRESOLVE (3)
Protocol:
- All
+Added-in: 7.60.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.60.0
-
# RETURN VALUE
CURLE_OK or an error such as CURLE_UNKNOWN_OPTION.
- CURLOPT_SHARE (3)
Protocol:
- All
+Added-in: 7.9.3
---
# NAME
~~~
-# AVAILABILITY
+# DEPRECATED
-Deprecated since 7.11.1. Function removed in 7.62.0.
+Deprecated since 7.11.1. Functionality removed in 7.62.0.
# RETURN VALUE
- TLS
TLS-backend:
- All
+Added-in: 7.76.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.76.0
-
-If built TLS enabled.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- TLS
TLS-backend:
- All
+Added-in: 7.76.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.76.0
-
-If built TLS enabled.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
TLS-backend:
- OpenSSL
- GnuTLS
+Added-in: 7.76.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.76.0.
-
# RETURN VALUE
Returns CURLE_OK if OCSP stapling is supported by the SSL backend, otherwise
- CURLOPT_VERBOSE (3)
Protocol:
- All
+Added-in: 7.62.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.62.0
-
# RETURN VALUE
Returns CURLE_OK on success or CURLE_OUT_OF_MEMORY if there was insufficient
TLS-backend:
- OpenSSL
- wolfSSL
+Added-in: 8.8.0
---
# NAME
curl_easy_perform(curl);
}
~~~
-# AVAILABILITY
-
-Added in 8.8.0
-
# RETURN VALUE
Returns CURLE_OK on success or CURLE_OUT_OF_MEMORY if there was insufficient
- TLS
TLS-backend:
- OpenSSL
+Added-in: 7.7
---
# NAME
NULL
-# AVAILABILITY
+# DEPRECATED
This option was deprecated in 7.84.0.
- curl_url_strerror (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_POST (3)
Protocol:
- HTTP
+Added-in: 7.36.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.36.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_KEEP_SENDING_ON_ERROR (3)
Protocol:
- HTTP
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with HTTP.
-
# RETURN VALUE
Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.
- SFTP
- FILE
- SMB
+Added-in: 7.5
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always, for SFTP since 7.49.0
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_WILDCARDMATCH (3)
Protocol:
- FTP
+Added-in: 7.21.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.21.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_WILDCARDMATCH (3)
Protocol:
- FTP
+Added-in: 7.21.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.21.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_REDIR_PROTOCOLS_STR (3)
Protocol:
- HTTP
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with HTTP
-
# RETURN VALUE
Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_MAXLIFETIME_CONN (3)
Protocol:
- All
+Added-in: 7.7
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_FORBID_REUSE (3)
- CURLOPT_MAXAGE_CONN (3)
- CURLOPT_MAXLIFETIME_CONN (3)
+Added-in: 7.7
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
See-also:
- CURLOPT_FTP_USE_EPRT (3)
- CURLOPT_FTP_USE_EPSV (3)
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Port range support was added in 7.19.5
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
See-also:
- CURLOPT_FTP_SSL_CCC (3)
- CURLOPT_USE_SSL (3)
+Added-in: 7.12.2
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.12.2
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
See-also:
- CURLOPT_PASSWORD (3)
- CURLOPT_USERNAME (3)
+Added-in: 7.13.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.13.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_FTP_SKIP_PASV_IP (3)
- CURLOPT_SERVER_RESPONSE_TIMEOUT (3)
- CURLOPT_USERNAME (3)
+Added-in: 7.15.5
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.15.5
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
See-also:
- CURLOPT_FTP_FILEMETHOD (3)
- CURLOPT_FTP_USE_EPSV (3)
+Added-in: 7.10.7
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10.7. SFTP support added in 7.16.3. The retry option was added in
-7.19.4.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if the
See-also:
- CURLOPT_DIRLISTONLY (3)
- CURLOPT_FTP_SKIP_PASV_IP (3)
+Added-in: 7.15.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.15.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
See-also:
- CURLOPT_FTPPORT (3)
- CURLOPT_FTP_USE_EPRT (3)
+Added-in: 7.15.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.14.2
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_FTPSSLAUTH (3)
- CURLOPT_PROTOCOLS_STR (3)
- CURLOPT_USE_SSL (3)
+Added-in: 7.16.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.16.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
See-also:
- CURLOPT_FTPPORT (3)
- CURLOPT_FTP_USE_EPSV (3)
+Added-in: 7.10.5
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10.5
-
# RETURN VALUE
Returns CURLE_OK
See-also:
- CURLOPT_FTPPORT (3)
- CURLOPT_FTP_USE_EPRT (3)
+Added-in: 7.9.2
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with FTP
-
# RETURN VALUE
Returns CURLE_OK if FTP is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_FTP_USE_EPSV (3)
Protocol:
- FTP
+Added-in: 7.20.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.20.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
See-also:
- CURLOPT_HTTPAUTH (3)
- CURLOPT_PROXYAUTH (3)
+Added-in: 7.22.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.22.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_CONNECTTIMEOUT_MS (3)
- CURLOPT_LOW_SPEED_LIMIT (3)
- CURLOPT_TIMEOUT (3)
+Added-in: 7.59.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.59.0
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_PROXY (3)
Protocol:
- All
+Added-in: 7.60.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with HTTP. Added in 7.60.0.
-
# RETURN VALUE
Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.
See-also:
- CURLOPT_HAPROXYPROTOCOL (3)
- CURLOPT_PROXY (3)
+Added-in: 8.2.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with HTTP. Added in 8.2.0.
-
# RETURN VALUE
Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.
See-also:
- CURLOPT_HEADERFUNCTION (3)
- CURLOPT_HTTPHEADER (3)
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Provided in all libcurl versions.
-
# RETURN VALUE
Returns CURLE_OK.
- curl_easy_header (3)
Protocol:
- All
+Added-in: 7.10
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- POP3
- IMAP
- SMTP
+Added-in: 7.7.2
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
See-also:
- CURLOPT_HTTPHEADER (3)
- CURLOPT_PROXYHEADER (3)
+Added-in: 7.37.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.37.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_ALTSVC (3)
- CURLOPT_HSTS_CTRL (3)
- CURLOPT_RESOLVE (3)
+Added-in: 7.74.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.74.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_HSTSREADFUNCTION (3)
- CURLOPT_HSTSWRITEDATA (3)
- CURLOPT_HSTSWRITEFUNCTION (3)
+Added-in: 7.74.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.74.0
-
# RETURN VALUE
This returns CURLE_OK.
- CURLOPT_HSTSREADDATA (3)
- CURLOPT_HSTSWRITEFUNCTION (3)
- CURLOPT_HSTS_CTRL (3)
+Added-in: 7.74.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.74.0
-
# RETURN VALUE
This returns CURLE_OK.
- CURLOPT_HSTSREADDATA (3)
- CURLOPT_HSTSREADFUNCTION (3)
- CURLOPT_HSTSWRITEFUNCTION (3)
+Added-in: 7.74.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.74.0
-
# RETURN VALUE
This returns CURLE_OK.
- CURLOPT_HSTSWRITEDATA (3)
- CURLOPT_HSTSWRITEFUNCTION (3)
- CURLOPT_HSTS_CTRL (3)
+Added-in: 7.74.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.74.0
-
# RETURN VALUE
This returns CURLE_OK.
- CURLOPT_CONNECT_TO (3)
- CURLOPT_HSTS (3)
- CURLOPT_RESOLVE (3)
+Added-in: 7.74.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.74.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
See-also:
- CURLOPT_HTTP_VERSION (3)
- CURLOPT_SSLVERSION (3)
+Added-in: 7.64.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Option added in 7.64.0, present along with HTTP.
-
# RETURN VALUE
Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
See-also:
- CURLOPT_HTTP09_ALLOWED (3)
- CURLOPT_HTTP_VERSION (3)
+Added-in: 7.10.3
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10.3
-
# RETURN VALUE
Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_PASSWORD (3)
- CURLOPT_PROXYAUTH (3)
- CURLOPT_USERNAME (3)
+Added-in: 7.10.6
---
# NAME
}
~~~
-# AVAILABILITY
-
-Option Added in 7.10.6.
+# NOTES
CURLAUTH_DIGEST_IE was added in 7.19.3
- CURLOPT_POST (3)
- CURLOPT_UPLOAD (3)
- curl_easy_reset (3)
+Added-in: 7.8.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with HTTP
-
# RETURN VALUE
Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_MIMEPOST (3)
- CURLOPT_PROXYHEADER (3)
- curl_mime_init (3)
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
-As long as HTTP is enabled. Use in MIME mail added in 7.56.0.
+Use for MIME mail added in 7.56.0.
# RETURN VALUE
- curl_formadd (3)
- curl_formfree (3)
- curl_mime_init (3)
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
-As long as HTTP is enabled. Deprecated in 7.56.0.
+Deprecated in 7.56.0.
# RETURN VALUE
- CURLOPT_PROXY (3)
- CURLOPT_PROXYPORT (3)
- CURLOPT_PROXYTYPE (3)
+Added-in: 7.3
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_ACCEPT_ENCODING (3)
- CURLOPT_DEBUGFUNCTION (3)
- CURLOPT_STDERR (3)
+Added-in: 7.16.2
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.16.2
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
See-also:
- CURLOPT_ACCEPT_ENCODING (3)
- CURLOPT_HTTP_CONTENT_DECODING (3)
+Added-in: 7.16.2
---
# NAME
transfer decoding is disabled, if set to 1 it is enabled (default). libcurl
does chunked transfer decoding by default unless this option is set to zero.
+# NOTES
+
+This option does not work with the hyper backend as that always has transfer
+decoding enabled.
+
# DEFAULT
1
}
~~~
-# AVAILABILITY
-
-Added in 7.16.2 Does not work with the hyper backend (it always has transfer
-decoding enabled).
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_HTTP09_ALLOWED (3)
- CURLOPT_HTTP200ALIASES (3)
- CURLOPT_SSLVERSION (3)
+Added-in: 7.9.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with HTTP
-
# RETURN VALUE
Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
See-also:
- CURLOPT_HTTP_VERSION (3)
- CURLOPT_MAXFILESIZE_LARGE (3)
+Added-in: 7.14.1
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
-Added in 7.14.1. Support for FTP added in 7.46.0. This option is not working
-for HTTP when libcurl is built to use the hyper backend.
+Support for FTP added in 7.46.0. This option is not working for HTTP when
+libcurl is built to use the hyper backend.
# RETURN VALUE
- CURLOPT_UPLOAD (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
SMTP support added in 7.23.0
- CURLOPT_UPLOAD (3)
Protocol:
- All
+Added-in: 7.11.0
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
SMTP support added in 7.23.0
- CURLOPT_SOCKOPTFUNCTION (3)
- CURLOPT_TCP_NODELAY (3)
- CURLOPT_LOCALPORT (3)
+Added-in: 7.3
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
The `if!` and `host!` syntax was added in 7.24.0.
See-also:
- CURLOPT_INTERLEAVEFUNCTION (3)
- CURLOPT_RTSP_REQUEST (3)
+Added-in: 7.20.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.20.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_RTSP_REQUEST (3)
Protocol:
- RTSP
+Added-in: 7.20.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.20.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_SEEKFUNCTION (3)
Protocol:
- All
+Added-in: 7.12.3
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
-Added in 7.12.3. Deprecated since 7.18.0.
+Deprecated since 7.18.0.
# RETURN VALUE
See-also:
- CURLOPT_IOCTLDATA (3)
- CURLOPT_SEEKFUNCTION (3)
+Added-in: 7.12.3
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
-Added in 7.12.3. Deprecated since 7.18.0.
+Deprecated since 7.18.0.
# RETURN VALUE
- CURLOPT_SSLVERSION (3)
Protocol:
- All
+Added-in: 7.10.8
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
TLS-backend:
- OpenSSL
- GnuTLS
+Added-in: 7.19.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-If built TLS enabled
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- TLS
TLS-backend:
- OpenSSL
+Added-in: 7.71.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.71.0. This option is supported by the OpenSSL backends.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_HTTPHEADER (3)
Protocol:
- HTTP
+Added-in: 7.51.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with HTTP. Added in 7.51.0.
-
# RETURN VALUE
Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.
- mbedTLS
- Schannel
- wolfSSL
+Added-in: 7.17.0
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
This option was known as CURLOPT_SSLKEYPASSWD up to 7.16.4 and
CURLOPT_SSLCERTPASSWD up to 7.9.2.
- CURLOPT_USE_SSL (3)
Protocol:
- FTP
+Added-in: 7.16.4
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
This option was known as CURLOPT_KRB4LEVEL up to 7.16.3
- CURLOPT_LOCALPORTRANGE (3)
Protocol:
- All
+Added-in: 7.15.2
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.15.2
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_LOCALPORT (3)
Protocol:
- All
+Added-in: 7.15.2
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.15.2
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- LDAP
- POP3
- SMTP
+Added-in: 7.34.0
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
-Added in 7.34.0. Support for OpenLDAP added in 7.82.0.
+Support for OpenLDAP added in 7.82.0.
# RETURN VALUE
- CURLOPT_TIMEOUT (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_TIMEOUT (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_MAIL_RCPT (3)
Protocol:
- SMTP
+Added-in: 7.25.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.25.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_MAIL_RCPT (3)
Protocol:
- SMTP
+Added-in: 7.20.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.20.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_MAIL_FROM (3)
Protocol:
- SMTP
+Added-in: 7.20.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.20.0. The **VRFY** and **EXPN** logic was added in 7.34.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_MAIL_RCPT (3)
Protocol:
- SMTP
+Added-in: 8.2.0
---
# NAME
}
~~~
-# AVAILABILITY
+# HISTORY
-This option was called CURLOPT_MAIL_RCPT_ALLLOWFAILS before 8.2.0
-
-Added in 7.69.0.
+This option was called CURLOPT_MAIL_RCPT_ALLLOWFAILS (with three instead of
+two letter L) before 8.2.0
# RETURN VALUE
- CURLOPT_TIMEOUT (3)
Protocol:
- All
+Added-in: 7.65.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.65.0
-
# RETURN VALUE
Returns CURLE_OK.
- CURLOPT_MAXREDIRS (3)
Protocol:
- All
+Added-in: 7.7
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_MAX_RECV_SPEED_LARGE (3)
Protocol:
- All
+Added-in: 7.10.8
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK if the size passed is valid or CURLE_BAD_FUNCTION_ARGUMENT if
- FTP
- HTTP
- MQTT
+Added-in: 7.11.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.11.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_TIMEOUT (3)
Protocol:
- All
+Added-in: 7.80.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.80.0
-
# RETURN VALUE
Returns CURLE_OK.
- CURLOPT_FOLLOWLOCATION (3)
Protocol:
- HTTP
+Added-in: 7.5
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with HTTP
-
# RETURN VALUE
Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_TIMEOUT (3)
Protocol:
- All
+Added-in: 7.15.5
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.15.5
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_MAX_RECV_SPEED_LARGE (3)
Protocol:
- All
+Added-in: 7.15.5
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.15.5
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- HTTP
- SMTP
- IMAP
+Added-in: 7.56.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.56.0
-
# RETURN VALUE
This returns CURLE_OK.
- HTTP
- IMAP
- SMTP
+Added-in: 7.81.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Option added in 7.81.0.
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_USERPWD (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_USERNAME (3)
Protocol:
- All
+Added-in: 7.11.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10.9
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- SFTP
- SCP
- FILE
+Added-in: 7.16.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.16.4
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- SFTP
- SCP
- FILE
+Added-in: 7.16.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.16.4
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_UPLOAD (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_XFERINFOFUNCTION (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK.
- CURLOPT_PROXY (3)
- CURLOPT_PROXYAUTH (3)
- CURLOPT_PROXYTYPE (3)
+Added-in: 7.19.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.19.4
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_TIMEOUT (3)
Protocol:
- All
+Added-in: 7.10
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_SOCKOPTFUNCTION (3)
Protocol:
- All
+Added-in: 7.17.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.17.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_SOCKOPTFUNCTION (3)
Protocol:
- All
+Added-in: 7.17.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.17.1.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_USERPWD (3)
Protocol:
- All
+Added-in: 7.19.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.19.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- curl_url_set (3)
Protocol:
- All
+Added-in: 7.42.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.42.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- mbedTLS
- Secure Transport
- Schannel
+Added-in: 7.39.0
---
# NAME
-----END PUBLIC KEY-----
~~~
-# AVAILABILITY
+# NOTES
## PEM/DER support
- CURLOPT_FRESH_CONNECT (3)
Protocol:
- HTTP
+Added-in: 7.43.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.43.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_URL (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_HTTPPOST (3)
- CURLOPT_POSTFIELDS (3)
- CURLOPT_UPLOAD (3)
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with HTTP
-
# RETURN VALUE
Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
Protocol:
- HTTP
- MQTT
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_POSTFIELDSIZE_LARGE (3)
Protocol:
- HTTP
+Added-in: 7.2
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with HTTP
-
# RETURN VALUE
Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_POSTFIELDSIZE (3)
Protocol:
- HTTP
+Added-in: 7.11.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with HTTP
-
# RETURN VALUE
Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
Protocol:
- FTP
- SFTP
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-If support for the protocols are built-in.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_POSTFIELDS (3)
Protocol:
- HTTP
+Added-in: 7.19.1
---
# NAME
}
~~~
-# AVAILABILITY
+# HISTORY
-Added in 7.17.1. This option was known as CURLOPT_POST301 up to 7.19.0 as it
-only supported the 301 then. CURL_REDIR_POST_303 was added in 7.26.0.
+This option was known as CURLOPT_POST301 up to 7.19.0 as it only supported the
+301 then. CURL_REDIR_POST_303 was added in 7.26.0.
# RETURN VALUE
- CURLOPT_QUOTE (3)
Protocol:
- FTP
+Added-in: 7.9.5
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with the protocol support
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_PREREQFUNCTION (3)
Protocol:
- All
+Added-in: 7.80.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.80.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_PREREQDATA (3)
Protocol:
- All
+Added-in: 7.80.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.80.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_PROXY (3)
Protocol:
- All
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0
-
# RETURN VALUE
Returns CURLE_OK if proxies are supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_VERBOSE (3)
Protocol:
- All
+Added-in: 7.10.3
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10.3
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_XFERINFOFUNCTION (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_XFERINFOFUNCTION (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
Deprecated since 7.32.0.
- CURLOPT_URL (3)
Protocol:
- All
+Added-in: 7.19.4
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
-Added in 7.19.4. Deprecated since 7.85.0.
+Deprecated since 7.85.0.
# RETURN VALUE
- curl_version_info (3)
Protocol:
- All
+Added-in: 7.85.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.85.0
-
# RETURN VALUE
Returns CURLE_UNKNOWN_OPTION if the option is not implemented,
- CURLOPT_PROXYTYPE (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
Since 7.14.1 the proxy environment variable names can include the protocol
scheme.
- CURLOPT_PROXYUSERPWD (3)
Protocol:
- All
+Added-in: 7.10.7
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10.7
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_HTTPHEADER (3)
Protocol:
- All
+Added-in: 7.37.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.37.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_PROXYUSERNAME (3)
Protocol:
- All
+Added-in: 7.19.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.19.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_PROXYTYPE (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_PROXYPORT (3)
Protocol:
- All
+Added-in: 7.10
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_USERNAME (3)
Protocol:
- All
+Added-in: 7.19.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.19.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_PROXYUSERNAME (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK if proxies are supported, CURLE_UNKNOWN_OPTION if not, or
- TLS
TLS-backend:
- All
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0
+# NOTES
For TLS backends that do not support certificate files, the
CURLOPT_PROXY_CAINFO(3) option is ignored. Refer to
- rustls
- Secure Transport
- Schannel
+Added-in: 7.77.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.77.0.
-
-This option is supported by the rustls (since 7.82.0), OpenSSL, Secure
-Transport and Schannel backends.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- OpenSSL
- GnuTLS
- mbedTLS
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0
-
-mbedTLS support added in 7.56.0.
-
# RETURN VALUE
CURLE_OK if supported; or an error such as:
- GnuTLS
- mbedTLS
- OpenSSL
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
TLS-backend:
- OpenSSL
- GnuTLS
+Added-in: 7.71.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.71.0. This option is supported by the OpenSSL and GnuTLS backends.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- TLS
TLS-backend:
- OpenSSL
+Added-in: 7.71.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.71.0. This option is supported by the OpenSSL backends.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- mbedTLS
- Schannel
- wolfSSL
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0
-
# RETURN VALUE
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
- GnuTLS
- mbedTLS
- wolfSSL
+Added-in: 7.52.0
---
# NAME
-----END PUBLIC KEY-----
~~~
-# AVAILABILITY
+# NOTES
PEM/DER support:
- CURLOPT_SERVICE_NAME (3)
Protocol:
- All
+Added-in: 7.43.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.43.0 for HTTP proxies, 7.49.0 for SOCKS5 proxies.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- Schannel
- Secure Transport
- wolfSSL
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0
-
# RETURN VALUE
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
- Schannel
- Secure Transport
- wolfSSL
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0
-
-If built TLS enabled.
-
# RETURN VALUE
Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
- OpenSSL
- Schannel
- Secure Transport
+Added-in: 7.71.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.71.0.
-
# RETURN VALUE
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
- mbedTLS
- Schannel
- wolfSSL
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0
-
-If built TLS enabled.
-
# RETURN VALUE
Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
- OpenSSL
- BearSSL
- wolfSSL
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0
-
# RETURN VALUE
Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
- TLS
TLS-backend:
- OpenSSL
+Added-in: 7.71.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.71.0. This option is supported by the OpenSSL backends.
-
# RETURN VALUE
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
- TLS
TLS-backend:
- All
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- wolfSSL
- GnuTLS
- mbedTLS
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0, in 7.83.0 for BearSSL, in 8.8.0 for mbedTLS
-
-If built TLS enabled.
-
# RETURN VALUE
Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
- TLS
TLS-backend:
- All
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- TLS
TLS-backend:
- All
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0.
-
-If built TLS enabled.
-
# RETURN VALUE
Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not.
- TLS
TLS-backend:
- All
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0
-
-If built TLS enabled.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
TLS-backend:
- OpenSSL
- Schannel
+Added-in: 7.61.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.61.0.
-Available when built with OpenSSL \>= 1.1.1.
-
# RETURN VALUE
Returns CURLE_OK if supported, CURLE_NOT_BUILT_IN otherwise.
TLS-backend:
- OpenSSL
- GnuTLS
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
TLS-backend:
- OpenSSL
- GnuTLS
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0
-
-You need to build libcurl with GnuTLS or OpenSSL with TLS-SRP support for this
-to work.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
TLS-backend:
- OpenSSL
- GnuTLS
+Added-in: 7.52.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.52.0.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_TRANSFERTEXT (3)
Protocol:
- All
+Added-in: 7.18.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.18.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if the
- CURLOPT_UPLOAD (3)
Protocol:
- HTTP
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
-Deprecated since 7.12.1. Do not use.
+Deprecated since 7.12.1.
# RETURN VALUE
- CURLOPT_RESOLVE (3)
Protocol:
- All
+Added-in: 7.87.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.87.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
Protocol:
- FTP
- SFTP
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
SFTP support added in 7.16.3. *-prefix for SFTP added in 7.24.0
- TLS
TLS-backend:
- OpenSSL
+Added-in: 7.7
---
# NAME
NULL, not used
-# AVAILABILITY
+# DEPRECATED
-This option was deprecated in 7.84.0.
+Deprecated since 7.84.0.
# RETURN VALUE
- FILE
- RTSP
- SFTP
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
FILE since 7.18.0, RTSP since 7.20.0
- CURLOPT_WRITEFUNCTION (3)
Protocol:
- All
+Added-in: 7.9.7
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
This option was once known by the older name CURLOPT_INFILE, the name
CURLOPT_READDATA(3) was introduced in 7.9.7.
- CURLOPT_WRITEFUNCTION (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
CURL_READFUNC_PAUSE return code was added in 7.18.0 and CURL_READFUNC_ABORT
was added in 7.12.1.
- CURLOPT_REDIR_PROTOCOLS_STR (3)
Protocol:
- HTTP
+Added-in: 7.19.4
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
-Added in 7.19.4, before then it would follow all protocols. Deprecated
-since 7.85.0.
+Deprecated since 7.85.0.
# RETURN VALUE
- CURLOPT_REDIR_PROTOCOLS (3)
Protocol:
- HTTP
+Added-in: 7.85.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.85.0.
-
# RETURN VALUE
Returns CURLE_UNKNOWN_OPTION if the option is not implemented,
- CURLOPT_USERAGENT (3)
Protocol:
- HTTP
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-If built with HTTP support
-
# RETURN VALUE
Returns CURLE_OK if HTTP support is enabled, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_URL (3)
Protocol:
- HTTP
+Added-in: 7.55.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.55.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_IPRESOLVE (3)
Protocol:
- All
+Added-in: 7.21.3
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
Added in 7.21.3. Removal support added in 7.42.0.
- CURLOPT_RESOLVER_START_FUNCTION (3)
Protocol:
- All
+Added-in: 7.59.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.59.0
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_RESOLVER_START_DATA (3)
Protocol:
- All
+Added-in: 7.59.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.59.0
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_RESUME_FROM_LARGE (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_RESUME_FROM (3)
Protocol:
- All
+Added-in: 7.11.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.11.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_RTSP_SERVER_CSEQ (3)
Protocol:
- RTSP
+Added-in: 7.20.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.20.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_RTSP_STREAM_URI (3)
Protocol:
- RTSP
+Added-in: 7.20.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.20.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_RTSP_STREAM_URI (3)
Protocol:
- RTSP
+Added-in: 7.20.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.20.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_RTSP_STREAM_URI (3)
Protocol:
- RTSP
+Added-in: 7.20.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.20.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_RTSP_TRANSPORT (3)
Protocol:
- RTSP
+Added-in: 7.20.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.20.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_RTSP_SESSION_ID (3)
Protocol:
- RTSP
+Added-in: 7.20.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.20.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_USERPWD (3)
Protocol:
- IMAP
+Added-in: 7.66.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.66.0. Support for OpenLDAP added in 7.82.0.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
Protocol:
- SMTP
- IMAP
+Added-in: 7.31.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.31.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_STDERR (3)
Protocol:
- All
+Added-in: 7.18.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.18.0
-
# RETURN VALUE
- CURLOPT_STDERR (3)
Protocol:
- All
+Added-in: 7.18.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.18.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- SMTP
- SFTP
- SCP
+Added-in: 7.20.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10.8. Used under this name since 7.20.0
-
-Support for SSH is predicated on a new enough (1.11.0) version of libssh2
-being available when compiling libcurl.
-
# RETURN VALUE
Returns CURLE_OK if supported, and CURLE_UNKNOWN_OPTION if not. Returns
- SMTP
- SFTP
- SCP
+Added-in: 8.6.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 8.6.0.
-
# RETURN VALUE
Returns CURLE_OK if supported, and CURLE_UNKNOWN_OPTION if not. Returns
- POP3
- SMTP
- LDAP
+Added-in: 7.43.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.43.0 for HTTP, 7.49.0 for FTP, IMAP, POP3 and SMTP,
-7.82.0 for OpenLDAP.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLSHOPT_SHARE (3)
Protocol:
- All
+Added-in: 7.10
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_SOCKOPTFUNCTION (3)
Protocol:
- All
+Added-in: 7.16.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.16.0
-
# RETURN VALUE
Returns *CURLE_OK* if the option is supported, and *CURLE_UNKNOWN_OPTION* if not.
- CURLOPT_SOCKOPTDATA (3)
Protocol:
- All
+Added-in: 7.16.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.16.0. The *CURL_SOCKOPT_ALREADY_CONNECTED* return code was
-added in 7.21.5.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_PROXYTYPE (3)
Protocol:
- All
+Added-in: 7.55.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.55.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_PROXY_SERVICE_NAME (3)
Protocol:
- All
+Added-in: 7.19.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.19.4
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_PROXYTYPE (3)
Protocol:
- All
+Added-in: 7.19.4
---
# NAME
}
~~~
-# AVAILABILITY
+# DEPRECATED
-Added in 7.19.4, deprecated in 7.49.0
+Deprecated since 7.49.0
# RETURN VALUE
Protocol:
- SFTP
- SCP
+Added-in: 7.16.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-CURLSSH_AUTH_HOST was added in 7.16.1, CURLSSH_AUTH_AGENT was added in 7.28.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
Protocol:
- SFTP
- SCP
+Added-in: 7.56.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.56.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
-Title: CURLOPT_SSH_KEYDATA
+Title: CURLOPT_SSH_HOSTKEYDATA
Section: 3
Source: libcurl
See-also:
Protocol:
- SFTP
- SCP
+Added-in: 7.84.0
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
-Added in 7.84.0, works only with libssh2 backend.
+Works only with the libssh2 backend.
# RETURN VALUE
Protocol:
- SFTP
- SCP
+Added-in: 7.84.0
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
-Added in 7.84.0 , work only with libssh2 backend.
+Work only with the libssh2 backend.
# RETURN VALUE
Protocol:
- SFTP
- SCP
+Added-in: 7.17.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.17.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
Protocol:
- SFTP
- SCP
+Added-in: 7.80.0
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
-Added in 7.80.0
Requires the libssh2 backend.
# RETURN VALUE
Protocol:
- SFTP
- SCP
+Added-in: 7.19.6
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.19.6
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
Protocol:
- SFTP
- SCP
+Added-in: 7.19.6
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.19.6
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
Protocol:
- SFTP
- SCP
+Added-in: 7.19.6
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.19.6
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
Protocol:
- SFTP
- SCP
+Added-in: 7.16.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.16.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
Protocol:
- SFTP
- SCP
+Added-in: 7.16.1
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
The "" trick was added in 7.26.0
- Schannel
- Secure Transport
- wolfSSL
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-If built TLS enabled.
-
# RETURN VALUE
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
- Schannel
- Secure Transport
- wolfSSL
+Added-in: 7.9.3
---
# NAME
}
~~~
-# AVAILABILITY
-
-If built TLS enabled. Added in 7.9.3
-
# RETURN VALUE
Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
- Secure Transport
- Schannel
- mbedTLS
+Added-in: 7.71.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.71.0. This option is supported by the OpenSSL, Secure Transport,
-Schannel and mbedTLS (since 7.78.0) backends.
-
# RETURN VALUE
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
- TLS
TLS-backend:
- OpenSSL
+Added-in: 7.9.3
---
# NAME
}
~~~
-# AVAILABILITY
-
-Only if OpenSSL is built with engine support.
-
# RETURN VALUE
CURLE_OK - Engine found.
- TLS
TLS-backend:
- OpenSSL
+Added-in: 7.9.3
---
# NAME
}
~~~
-# AVAILABILITY
-
-Only if the SSL backend is OpenSSL built with engine support.
-
# RETURN VALUE
CURLE_OK - Engine set as default.
- mbedTLS
- Schannel
- wolfSSL
+Added-in: 7.9.3
---
# NAME
}
~~~
-# AVAILABILITY
-
-If built TLS enabled.
-
# RETURN VALUE
Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
- OpenSSL
- BearSSL
- wolfSSL
+Added-in: 7.9.3
---
# NAME
}
~~~
-# AVAILABILITY
-
-If built TLS enabled.
-
# RETURN VALUE
Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
- TLS
TLS-backend:
- OpenSSL
+Added-in: 7.71.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.71.0. This option is supported by the OpenSSL backends.
-
# RETURN VALUE
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
- TLS
TLS-backend:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
+# HISTORY
SSLv2 and SSLv3 are refused completely since curl 7.77.0
- wolfSSL
- GnuTLS
- mbedTLS
+Added-in: 7.9
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
Added in 7.9, in 7.83.0 for BearSSL, in 8.8.0 for mbedTLS
-If built TLS enabled.
-
# RETURN VALUE
Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
- wolfSSL
- mbedTLS
- BearSSL
+Added-in: 7.10.6
---
# NAME
}
~~~
-# AVAILABILITY
+# HISTORY
Added in 7.11.0 for OpenSSL, in 7.42.0 for wolfSSL, in 7.54.0 for mbedTLS,
in 7.83.0 in BearSSL.
- wolfSSL
- mbedTLS
- BearSSL
+Added-in: 7.10.6
---
# NAME
}
~~~
-# AVAILABILITY
-
-OpenSSL (added in 7.11.0), wolfSSL (added in 7.42.0), mbedTLS (added in
-7.54.0) or BearSSL (added in 7.83.0)
-
# RETURN VALUE
CURLE_OK if supported; or an error such as:
TLS-backend:
- OpenSSL
- wolfSSL
+Added-in: 7.73.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.73.0. Supported by the OpenSSL backend.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- TLS
TLS-backend:
- All
+Added-in: 7.36.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.36.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- TLS
TLS-backend:
- All
+Added-in: 7.36.0
---
# NAME
# DESCRIPTION
-Deprecated in 7.86.0. Setting this option has no function.
+Deprecated since 7.86.0. Setting this option has no function.
Pass a long as parameter, 0 or 1 where 1 is for enable and 0 for disable. This
option enables/disables NPN in the SSL handshake (if the SSL backend libcurl
}
~~~
-# AVAILABILITY
+# DEPRECATED
-Added in 7.36.0. Deprecated in 7.86.0.
+Deprecated since 7.86.0.
# RETURN VALUE
- TLS
TLS-backend:
- Secure Transport
+Added-in: 7.42.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.42.0. This option is currently only supported by the Secure
-Transport (on iOS 7.0 or later, or OS X 10.9 or later) TLS backend.
-
# RETURN VALUE
Returns CURLE_OK if false start is supported by the SSL backend, otherwise
- TLS
TLS-backend:
- All
+Added-in: 7.25.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.25.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- TLS
TLS-backend:
- All
+Added-in: 7.16.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.16.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- TLS
TLS-backend:
- All
+Added-in: 7.8.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-If built TLS enabled.
-
# RETURN VALUE
Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not.
- TLS
TLS-backend:
- All
+Added-in: 7.4.2
---
# NAME
}
~~~
-# AVAILABILITY
-
-If built TLS enabled.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
TLS-backend:
- OpenSSL
- GnuTLS
+Added-in: 7.41.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.41.0. This option is currently only supported by the OpenSSL and
-GnuTLS TLS backends.
-
# RETURN VALUE
Returns CURLE_OK if OCSP stapling is supported by the SSL backend, otherwise
- CURLOPT_VERBOSE (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_STREAM_WEIGHT (3)
Protocol:
- HTTP
+Added-in: 7.46.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.46.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_STREAM_WEIGHT (3)
Protocol:
- HTTP
+Added-in: 7.46.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.46.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_STREAM_DEPENDS_E (3)
Protocol:
- HTTP
+Added-in: 7.46.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.46.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_PROXY (3)
Protocol:
- All
+Added-in: 7.54.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.54.0
-
# RETURN VALUE
CURLE_OK or an error such as CURLE_UNKNOWN_OPTION.
- CURLOPT_SSL_FALSESTART (3)
Protocol:
- All
+Added-in: 7.49.0
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
-Added in 7.49.0. This option is currently only supported on Linux and macOS
-10.11 or later.
+This option is only supported on Linux and macOS 10.11 or later.
# RETURN VALUE
- CURLOPT_TCP_KEEPCNT (3)
Protocol:
- TCP
+Added-in: 7.25.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.25.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_TCP_KEEPINTVL (3)
Protocol:
- TCP
+Added-in: 8.9.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in v8.9.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_TCP_KEEPCNT (3)
Protocol:
- TCP
+Added-in: 7.25.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.25.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_TCP_KEEPCNT (3)
Protocol:
- TCP
+Added-in: 7.25.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_TCP_KEEPALIVE (3)
Protocol:
- TCP
+Added-in: 7.11.2
---
# NAME
}
~~~
-# AVAILABILITY
+# HISTORY
-Always. The default was changed to 1 from 0 in 7.50.2.
+The default was changed to 1 from 0 in 7.50.2.
# RETURN VALUE
- CURLOPT_QUOTE (3)
Protocol:
- TELNET
+Added-in: 7.7
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with TELNET
-
# RETURN VALUE
Returns CURLE_OK if TELNET is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_MAXFILESIZE (3)
Protocol:
- TFTP
+Added-in: 7.19.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.19.4
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_TFTP_BLKSIZE (3)
Protocol:
- TFTP
+Added-in: 7.48.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.48.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_TIMEVALUE (3)
Protocol:
- HTTP
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_TIMEOUT_MS (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK. Returns CURLE_BAD_FUNCTION_ARGUMENT if set to a negative
- CURLOPT_TIMEOUT (3)
Protocol:
- All
+Added-in: 7.16.2
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_TIMEVALUE_LARGE (3)
Protocol:
- HTTP
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_TIMEVALUE (3)
Protocol:
- HTTP
+Added-in: 7.59.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.59.0.
-
# RETURN VALUE
Returns CURLE_OK
TLS-backend:
- OpenSSL
- Schannel
+Added-in: 7.61.0
---
# NAME
}
~~~
-# AVAILABILITY
+# NOTES
Added in 7.61.0 for OpenSSL. Available when built with OpenSSL \>= 1.1.1.
TLS-backend:
- OpenSSL
- GnuTLS
+Added-in: 7.21.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.21.4, for the OpenSSL and GnuTLS backends only
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
TLS-backend:
- OpenSSL
- GnuTLS
+Added-in: 7.21.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-You need to build libcurl with GnuTLS or OpenSSL with TLS-SRP support for this
-to work. Added in 7.21.4
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
TLS-backend:
- OpenSSL
- GnuTLS
+Added-in: 7.21.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.21.4, for the OpenSSL and GnuTLS backends only
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_WRITEFUNCTION (3)
Protocol:
- HTTP
+Added-in: 7.64.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-This option was added in curl 7.64.0 and is present if HTTP support is enabled
-
# RETURN VALUE
Returns CURLE_OK.
- CURLOPT_WRITEFUNCTION (3)
Protocol:
- HTTP
+Added-in: 7.64.0
---
# NAME
}
}
~~~
-# AVAILABILITY
-
-This option was added in curl 7.64.0 and is present if HTTP support is enabled.
# RETURN VALUE
- CURLOPT_CRLF (3)
Protocol:
- All
+Added-in: 7.1.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with FTP
-
# RETURN VALUE
Returns CURLE_OK if FTP is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_HTTP_TRANSFER_DECODING (3)
Protocol:
- HTTP
+Added-in: 7.21.6
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.21.6
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- unix (7)
Protocol:
- All
+Added-in: 7.40.0
---
# NAME
/* Be sure to keep dirfd valid until you discard the handle */
~~~
-# AVAILABILITY
-
-Added in 7.40.0.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_USERPWD (3)
Protocol:
- HTTP
+Added-in: 7.10.4
---
# NAME
}
~~~
-# AVAILABILITY
-
-Along with HTTP
-
# RETURN VALUE
Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_TCP_KEEPALIVE (3)
Protocol:
- All
+Added-in: 7.62.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.62.0
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_READFUNCTION (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_TCP_NODELAY (3)
Protocol:
- All
+Added-in: 7.62.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.62.0.
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- curl_url_set (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-POP3 and SMTP were added in 7.31.0
-
# RETURN VALUE
Returns CURLE_OK on success or CURLE_OUT_OF_MEMORY if there was insufficient
- CURLOPT_REQUEST_TARGET (3)
Protocol:
- HTTP
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-As long as HTTP is supported
-
# RETURN VALUE
Returns CURLE_OK if HTTP is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_USERPWD (3)
Protocol:
- All
+Added-in: 7.19.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.19.1
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLOPT_USERNAME (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK on success or
- SMTP
- POP3
- IMAP
+Added-in: 7.17.0
---
# NAME
}
~~~
-# AVAILABILITY
+# HISTORY
-Added in 7.11.0. This option was known as CURLOPT_FTP_SSL up to 7.16.4, and
-the constants were known as CURLFTPSSL_*
-Handled by LDAP since 7.81.0. Fully supported by the OpenLDAP backend only.
+This option was known as CURLOPT_FTP_SSL up to 7.16.4, and the constants were
+known as CURLFTPSSL_* Handled by LDAP since 7.81.0. Fully supported by the
+OpenLDAP backend only.
# RETURN VALUE
- curl_global_trace (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
-
-Always
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_URL (3)
Protocol:
- FTP
+Added-in: 7.21.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.21.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_WRITEFUNCTION (3)
Protocol:
- All
+Added-in: 7.9.7
---
# NAME
A common technique is to use the write callback to store the incoming data
into a dynamically growing allocated buffer, and then this
-CURLOPT_WRITEDATA(3) is used to point to a struct or the buffer to store
-data in. Like in the getinmemory example:
+CURLOPT_WRITEDATA(3) is used to point to a struct or the buffer to store data
+in. Like in the getinmemory example:
https://curl.se/libcurl/c/getinmemory.html
-# AVAILABILITY
+# HISTORY
-Available in all libcurl versions. This option was formerly known as
-CURLOPT_FILE, the name CURLOPT_WRITEDATA(3) was added in 7.9.7.
+This option was formerly known as CURLOPT_FILE, the name CURLOPT_WRITEDATA(3)
+was added in 7.9.7.
# RETURN VALUE
- CURLOPT_WRITEDATA (3)
Protocol:
- All
+Added-in: 7.1
---
# NAME
}
~~~
-# AVAILABILITY
+# HISTORY
Support for the CURL_WRITEFUNC_PAUSE return code was added in version 7.18.0.
- curl_ws_send (3)
Protocol:
- WS
+Added-in: 7.86.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.86.0
-
# RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- CURLOPT_XFERINFOFUNCTION (3)
Protocol:
- All
+Added-in: 7.32.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.32.0
-
# RETURN VALUE
Returns CURLE_OK
- CURLOPT_XFERINFODATA (3)
Protocol:
- All
+Added-in: 7.32.0
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.32.0. This callback replaces CURLOPT_PROGRESSFUNCTION(3)
-
# RETURN VALUE
Returns CURLE_OK.
- LDAP
- POP3
- SMTP
+Added-in: 7.33.0
---
# NAME
}
~~~
-# AVAILABILITY
+# HISTORY
-Added in 7.33.0. Support for OpenLDAP added in 7.82.0.
+Support for OpenLDAP added in 7.82.0.
# RETURN VALUE
- curl_share_setopt (3)
Protocol:
- All
+Added-in: 7.10.3
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10
-
# RETURN VALUE
CURLSHE_OK (zero) means that the option was set properly, non-zero means an
- curl_share_setopt (3)
Protocol:
- All
+Added-in: 7.10.3
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10
-
# RETURN VALUE
CURLSHE_OK (zero) means that the option was set properly, non-zero means an
- curl_share_setopt (3)
Protocol:
- All
+Added-in: 7.10.3
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10
-
# RETURN VALUE
CURLSHE_OK (zero) means that the option was set properly, non-zero means an
- curl_share_setopt (3)
Protocol:
- All
+Added-in: 7.10.3
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10
-
# RETURN VALUE
CURLSHE_OK (zero) means that the option was set properly, non-zero means an
- curl_share_setopt (3)
Protocol:
- All
+Added-in: 7.10.3
---
# NAME
}
~~~
-# AVAILABILITY
-
-Added in 7.10
-
# RETURN VALUE
CURLSHE_OK (zero) means that the option was set properly, non-zero means an
Source: mk-ca-bundle
See-also:
- curl (1)
+Added-in: n/a
---
# NAME
my $tlslist;
my $section;
my $source;
+ my $addedin;
my $spdx;
my $start = 0;
my $title;
elsif(/^TLS-backend:/i) {
$list = 3; # 3 for TLS backend
}
+ elsif(/^Added-in: *(.*)/i) {
+ $addedin=$1;
+ if(($addedin !~ /^[0-9.]+[0-9]\z/) &&
+ ($addedin ne "n/a")) {
+ print STDERR "$f:$line:1:ERROR: invalid version number in Added-in line: $addedin\n";
+ return 2;
+ }
+ }
elsif(/^ +- (.*)/i) {
# the only lists we support are see-also and protocol
if($list == 1) {
elsif(/^---/) {
# end of the header section
if(!$title) {
- print STDERR "ERROR: no 'Title:' in $f\n";
+ print STDERR "$f:$line:1:ERROR: no 'Title:' in $f\n";
return 1;
}
if(!$section) {
- print STDERR "ERROR: no 'Section:' in $f\n";
+ print STDERR "$f:$line:1:ERROR: no 'Section:' in $f\n";
+ return 2;
+ }
+ if(!$source) {
+ print STDERR "$f:$line:1:ERROR: no 'Source:' in $f\n";
+ return 2;
+ }
+ if(!$addedin) {
+ print STDERR "$f:$line:1:ERROR: no 'Added-in:' in $f\n";
return 2;
}
if(!$seealso[0]) {
if($word eq "PROTOCOLS") {
print STDERR "$f:$line:1:WARN: PROTOCOLS section in source file\n";
}
+ elsif($word eq "AVAILABILITY") {
+ print STDERR "$f:$line:1:WARN: AVAILABILITY section in source file\n";
+ }
elsif($word eq "EXAMPLE") {
# insert the generated PROTOCOLS section before EXAMPLE
push @desc, outprotocols(@proto);
push @desc, outtls(@tls);
}
}
+ elsif($word eq "RETURN VALUE") {
+ if($addedin ne "n/a") {
+ # insert the generated AVAILABILITY section before RETURN VALUE
+ push @desc, ".SH AVAILABILITY\n";
+ push @desc, "Added in curl $addedin\n";
+ }
+ }
push @desc, ".SH $word\n";
$header = 1;
}
test1276.pl \
test1477.pl \
test1486.pl \
+ test1488.pl \
test1544.pl \
test971.pl
test1463 test1464 test1465 test1466 test1467 test1468 test1469 test1470 \
test1471 test1472 test1473 test1474 test1475 test1476 test1477 test1478 \
test1479 test1480 test1481 test1482 test1483 test1484 test1485 test1486 \
-test1487 \
+test1487 test1488 \
\
test1500 test1501 test1502 test1503 test1504 test1505 test1506 test1507 \
test1508 test1509 test1510 test1511 test1512 test1513 test1514 test1515 \
--- /dev/null
+<testcase>
+<info>
+<keywords>
+documentation
+symbols-in-versions
+manpages
+</keywords>
+</info>
+
+#
+# Client-side
+<client>
+<server>
+none
+</server>
+
+<name>
+symbols-in-versions and manpages agree on added-in versions
+</name>
+
+<command type="perl">
+%SRCDIR/test1488.pl %SRCDIR/.. ../include/curl
+</command>
+</client>
+
+<verify>
+<stdout>
+OK
+</stdout>
+</verify>
+</testcase>
s/\s+/ /g;
s/\\f.//g; # Remove font formatting.
s/\s+/ /g; # One line with single space only.
- if($sh =~ /DESCRIPTION|AVAILABILITY/) {
+ if($sh =~ /DESCRIPTION|DEPRECATED/) {
while($_ =~ /(?:deprecated|obsoleted?)\b\s*(?:in\b|since\b)?\s*(?:version\b|curl\b|libcurl\b)?\s*(\d[0-9.]*\d)?\b\s*(.*)$/i) {
# Flag deprecation status.
if($version ne "X" && $version ne "?") {
--- /dev/null
+#!/usr/bin/env perl
+#***************************************************************************
+# _ _ ____ _
+# Project ___| | | | _ \| |
+# / __| | | | |_) | |
+# | (__| |_| | _ <| |___
+# \___|\___/|_| \_\_____|
+#
+# Copyright (C) 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.
+#
+# SPDX-License-Identifier: curl
+#
+###########################################################################
+#
+# This script grew out of help from Przemyslaw Iskra and Balint Szilakszi
+# a late evening in the #curl IRC channel.
+#
+
+use strict;
+use warnings;
+use vars qw($Cpreprocessor);
+
+#
+# configurehelp perl module is generated by configure script
+#
+my $rc = eval {
+ require configurehelp;
+ configurehelp->import(qw(
+ $Cpreprocessor
+ ));
+ 1;
+};
+# Set default values if configure has not generated a configurehelp.pm file.
+# This is the case with cmake.
+if (!$rc) {
+ $Cpreprocessor = 'cpp';
+}
+
+# we may get the dir root pointed out
+my $root=$ARGV[0] || ".";
+
+# need an include directory when building out-of-tree
+my $i = ($ARGV[1]) ? "-I$ARGV[1] " : '';
+my $error;
+
+
+my @syms;
+my %manpage;
+my %symadded;
+
+sub checkmanpage {
+ my ($m) = @_;
+
+ open(my $mh, "<", "$m");
+ my $line = 1;
+ my $title;
+ my $addedin;
+ while(<$mh>) {
+ if(/^Title: (.*)/i) {
+ $title = $1;
+ }
+ elsif(/^Added-in: (.*)/i) {
+ $addedin = $1;
+ }
+ if($addedin && $title) {
+ if($manpage{$title}) {
+ print "$title is a duplicate symbol in file $m\n";
+ $error++;
+ }
+ $manpage{$title} = $addedin;
+ last;
+ }
+ $line++;
+ }
+ close($mh);
+}
+
+sub scanman_md_dir {
+ my ($d) = @_;
+ opendir(my $dh, $d) ||
+ die "Can't opendir: $!";
+ my @mans = grep { /.md\z/ } readdir($dh);
+ closedir $dh;
+ for my $m (@mans) {
+ checkmanpage("$d/$m");
+ }
+}
+
+scanman_md_dir("$root/docs/libcurl");
+scanman_md_dir("$root/docs/libcurl/opts");
+
+open my $s, "<", "$root/docs/libcurl/symbols-in-versions";
+while(<$s>) {
+ if(/(^[^ \n]+) +(.*)/) {
+ my ($sym, $rest)=($1, $2);
+ my @a=split(/ +/, $rest);
+ push @syms, $sym;
+
+ $symadded{$sym}=$a[0];
+ }
+}
+close $s;
+
+my $ignored=0;
+for my $e (sort @syms) {
+ if( $manpage{$e} ) {
+
+ if( $manpage{$e} ne $symadded{$e} ) {
+ printf "%s.md says version %s, but SIV says %s\n",
+ $e, $manpage{$e}, $symadded{$e};
+ $error++;
+ }
+
+ }
+}
+print "OK\n" if(!$error);
+exit $error;
projects / thirdparty / curl.git / commitdiff
