docs/CURLDOWN.md+8 -0
| @@ -148,6 +148,14 @@ readable. |
| To make sure curldown documents render correctly as markdown, all literal |
| occurrences of `<` or `>` need to be escaped by a leading backslash. |
| |
| + | ## Generating contents |
| + | |
| + | `# %PROTOCOLS%` - inserts a **PROTOCOLS** section based on the metadata |
| + | provided in the header. |
| + | |
| + | `# %AVAILABILITY%` - inserts an **AVAILABILITY** section based on the metadata |
| + | provided in the header. |
| + | |
| ## Symbols |
| |
| All mentioned curl symbols that have their own man pages, like |
docs/libcurl/curl_easy_cleanup.md+4 -0
| @@ -53,6 +53,8 @@ before it is closed. |
| Passing in a NULL pointer in *handle* makes this function return immediately |
| with no action. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -70,6 +72,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| None |
docs/libcurl/curl_easy_duphandle.md+4 -0
| @@ -47,6 +47,8 @@ data from the main filename to populate the cache. |
| In multi-threaded programs, this function must be called in a synchronous way, |
| the input handle may not be in use when cloned. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| If this function returns NULL, something went wrong and no valid handle was |
docs/libcurl/curl_easy_escape.md+4 -0
| @@ -64,6 +64,8 @@ To create a proper URL from strings that are not already URL encoded, we |
| recommend using libcurl's URL API: set the pieces with curl_url_set(3) and get |
| the final correct URL with curl_url_get(3). |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -81,6 +83,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| A pointer to a null-terminated string or NULL if it failed. |
docs/libcurl/curl_easy_getinfo.md+4 -0
| @@ -385,6 +385,8 @@ An overview of the time values available from curl_easy_getinfo(3) |
| CURLINFO_PRETRANSFER_TIME_T(3), CURLINFO_STARTTRANSFER_TIME_T(3), |
| CURLINFO_TOTAL_TIME_T(3), CURLINFO_REDIRECT_TIME_T(3) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -411,6 +413,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| If the operation was successful, CURLE_OK is returned. Otherwise an |
docs/libcurl/curl_easy_header.md+4 -0
| @@ -137,6 +137,8 @@ response that might happen before the "real" response. |
| |
| The header is an HTTP/2 or HTTP/3 pseudo header |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -154,6 +156,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| This function returns a CURLHcode indicating success or error. |
docs/libcurl/curl_easy_init.md+4 -0
| @@ -51,6 +51,8 @@ You are strongly advised to not allow this automatic behavior, by calling |
| curl_global_init(3) yourself properly. See the description in libcurl(3) of |
| global environment requirements for details of how to use this function. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -66,6 +68,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| If this function returns NULL, something went wrong and you cannot use the |
docs/libcurl/curl_easy_nextheader.md+4 -0
| @@ -61,6 +61,8 @@ The memory for the struct this points to, is owned and managed by libcurl and |
| is associated with the easy handle. Applications must copy the data if they |
| want it to survive subsequent API calls or the life-time of the easy handle. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -90,6 +92,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| This function returns the next header, or NULL when there are no more |
docs/libcurl/curl_easy_option_by_id.md+4 -0
| @@ -36,6 +36,8 @@ well. |
| |
| If libcurl has no option with the given id, this function returns NULL. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -48,6 +50,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| A pointer to the *curl_easyoption* struct for the option or NULL. |
docs/libcurl/curl_easy_option_by_name.md+4 -0
| @@ -35,6 +35,8 @@ insensitive. |
| |
| If libcurl has no option with the given name, this function returns NULL. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -47,6 +49,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| A pointer to the *curl_easyoption* struct for the option or NULL. |
docs/libcurl/curl_easy_option_next.md+4 -0
| @@ -67,6 +67,8 @@ struct curl_easyoption { |
| }; |
| ~~~ |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -82,6 +84,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| A pointer to the *curl_easyoption* struct for the next option or NULL if |
docs/libcurl/curl_easy_pause.md+4 -0
| @@ -98,6 +98,8 @@ buffering 32 megabyte of data for a paused stream. |
| When such a paused stream is unpaused again, any buffered data is delivered |
| first. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -132,6 +134,8 @@ size worth of data that curl cannot stop but instead needs to cache while the |
| 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% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK (zero) means that the option was set properly, and a non-zero return |
docs/libcurl/curl_easy_perform.md+4 -0
| @@ -59,6 +59,8 @@ CURLOPT_POSTFIELDS(3). |
| While the **easy_handle** is added to a multi handle, it cannot be used by |
| curl_easy_perform(3). |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -74,6 +76,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK (0) means everything was OK, non-zero means an error occurred as |
docs/libcurl/curl_easy_recv.md+4 -0
| @@ -58,6 +58,8 @@ Furthermore if you wait on the socket and it tells you there is data to read, |
| curl_easy_recv(3) may return **CURLE_AGAIN** if the only data that was |
| read was for internal SSL processing, and no other data is available. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -86,6 +88,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| On success, returns **CURLE_OK**, stores the received data into |
docs/libcurl/curl_easy_reset.md+4 -0
| @@ -36,6 +36,8 @@ It does not change the following information kept in the handle: live |
| connections, the Session ID cache, the DNS cache, the cookies, the shares or |
| the alt-svc cache. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -50,6 +52,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Nothing |
docs/libcurl/curl_easy_send.md+4 -0
| @@ -53,6 +53,8 @@ Furthermore if you wait on the socket and it tells you it is writable, |
| curl_easy_send(3) may return **CURLE_AGAIN** if the only data that was sent |
| was for internal SSL processing, and no other data could be sent. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -79,6 +81,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| On success, returns **CURLE_OK** and stores the number of bytes actually |
docs/libcurl/curl_easy_setopt.md+4 -0
| @@ -1327,6 +1327,8 @@ Callback for progress meter. See CURLOPT_XFERINFOFUNCTION(3) |
| |
| OAuth2 bearer token. See CURLOPT_XOAUTH2_BEARER(3) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -1342,6 +1344,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| *CURLE_OK* (zero) means that the option was set properly, non-zero means an |
docs/libcurl/curl_easy_strerror.md+4 -0
| @@ -34,6 +34,8 @@ CURLcode error code passed in the argument *errornum*. |
| Typically applications also appreciate CURLOPT_ERRORBUFFER(3) for more |
| specific error descriptions generated at runtime. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -53,6 +55,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| A pointer to a null-terminated string. |
docs/libcurl/curl_easy_unescape.md+4 -0
| @@ -47,6 +47,8 @@ TPF, but it was otherwise ignored. |
| |
| You must curl_free(3) the returned string when you are done with it. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -67,6 +69,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| A pointer to a null-terminated string or NULL if it failed. |
docs/libcurl/curl_easy_upkeep.md+4 -0
| @@ -39,6 +39,8 @@ This function must be explicitly called in order to perform the upkeep work. |
| The connection upkeep interval is set with |
| CURLOPT_UPKEEP_INTERVAL_MS(3). |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -69,6 +71,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| On success, returns **CURLE_OK**. |
docs/libcurl/curl_escape.md+4 -0
| @@ -38,6 +38,8 @@ on **string** to find out the size. |
| |
| You must curl_free(3) the returned string when you are done with it. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -56,6 +58,8 @@ int main(void) |
| Since 7.15.4, curl_easy_escape(3) should be used. This function might be |
| removed in a future release. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| A pointer to a null-terminated string or NULL if it failed. |
docs/libcurl/curl_formadd.md+4 -0
| @@ -203,6 +203,8 @@ for the curl handle. |
| |
| See example below. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -309,6 +311,8 @@ effective data size can then not be automatically determined, resulting in a |
| chunked encoding transfer. Backslashes and double quotes in field and |
| filenames are now escaped before transmission. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| 0 means everything was OK, non-zero means an error occurred corresponding to a |
docs/libcurl/curl_formfree.md+4 -0
| @@ -43,6 +43,8 @@ curl_formadd(3) and may be NULL. |
| Passing in a NULL pointer in *form* makes this function return immediately |
| with no action. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -74,6 +76,8 @@ int main(void) |
| |
| Deprecated in 7.56.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| None |
docs/libcurl/curl_formget.md+4 -0
| @@ -46,6 +46,8 @@ 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! |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -66,6 +68,8 @@ size_t print_httppost(struct curl_httppost *post) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| 0 means everything was OK, non-zero means an error occurred |
docs/libcurl/curl_free.md+4 -0
| @@ -33,6 +33,8 @@ differences in memory management between your application and libcurl. |
| Passing in a NULL pointer in *ptr* makes this function return immediately |
| with no action. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -46,6 +48,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| None |
docs/libcurl/curl_getdate.md+4 -0
| @@ -75,6 +75,8 @@ If a decimal number of the form YYYYMMDD appears, then YYYY is read as the |
| year, MM as the month number and DD as the day of the month, for the specified |
| calendar date. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -114,6 +116,8 @@ RFC 1036) and ANSI C's *asctime()* format. |
| |
| These formats are the only ones RFC 7231 says HTTP applications may use. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| This function returns -1 when it fails to parse the date string. Otherwise it |
docs/libcurl/curl_getenv.md+4 -0
| @@ -31,6 +31,8 @@ systems libcurl builds on (including win32). |
| |
| You must curl_free(3) the returned string when you are done with it. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -44,6 +46,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| A pointer to a null-terminated string or NULL if it failed to find the |
docs/libcurl/curl_global_cleanup.md+4 -0
| @@ -60,6 +60,8 @@ depending on how OpenSSL was built and loaded as a library. It is possible in |
| some rare circumstances a memory leak could occur unless you implement your own |
| OpenSSL thread cleanup. Refer to libcurl-thread(3). |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -73,6 +75,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| None |
docs/libcurl/curl_global_init.md+4 -0
| @@ -110,6 +110,8 @@ Before 7.69.0: when this flag is set, curl acknowledges EINTR condition when |
| connecting or when waiting for data. Otherwise, curl waits until full timeout |
| elapses. (Added in 7.30.0) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -123,6 +125,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| If this function returns non-zero, something went wrong and you cannot use the |
docs/libcurl/curl_global_init_mem.md+4 -0
| @@ -71,6 +71,8 @@ to that man page for documentation. |
| Manipulating these gives considerable powers to the application to severely |
| screw things up for libcurl. Take care! |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -88,6 +90,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK (0) means everything was OK, non-zero means an error occurred as |
docs/libcurl/curl_global_sslset.md+4 -0
| @@ -101,6 +101,8 @@ typedef enum { |
| } curl_sslbackend; |
| ~~~ |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -120,6 +122,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| If this function returns *CURLSSLSET_OK*, the backend was successfully |
docs/libcurl/curl_global_trace.md+4 -0
| @@ -109,6 +109,8 @@ Traces reading of upload data from the application in order to send it to the se |
| |
| Traces writing of download data, received from the server, to the application. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -132,6 +134,8 @@ of an enabled component appears at the beginning in brackets. |
| ... |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| If this function returns non-zero, something went wrong and the configuration |
docs/libcurl/curl_mime_addpart.md+4 -0
| @@ -43,6 +43,8 @@ subsequently be populated using functions from the mime API. |
| *mime* is the handle of the mime structure in which the new part must be |
| appended. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -66,6 +68,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| A mime part structure handle, or NULL upon failure. |
docs/libcurl/curl_mime_data.md+4 -0
| @@ -50,6 +50,8 @@ last call is retained. It is possible to unassign part's contents by setting |
| Setting large data is memory consuming: one might consider using |
| curl_mime_data_cb(3) in such a case. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -72,6 +74,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK or a CURL error code upon failure. |
docs/libcurl/curl_mime_data_cb.md+4 -0
| @@ -98,6 +98,8 @@ the pointed item to be shared between the original and the copied handle. In |
| particular, special attention should be given to the *freefunc* procedure |
| code since it then gets called twice with the same argument. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| Sending a huge data string causes the same amount of memory to be allocated: |
| @@ -164,6 +166,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK or a CURL error code upon failure. |
docs/libcurl/curl_mime_encoder.md+4 -0
| @@ -71,6 +71,8 @@ Encoding should not be applied to multiparts, thus the use of this function on |
| a part with content set with curl_mime_subparts(3) is strongly |
| discouraged. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -96,6 +98,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK or a CURL error code upon failure. |
docs/libcurl/curl_mime_filedata.md+4 -0
| @@ -56,6 +56,8 @@ part is transferred using chunks by HTTP but is rejected by IMAP. |
| Setting a part's contents multiple times is valid: only the value set by the |
| last call is retained. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -81,6 +83,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK or a CURL error code upon failure. CURLE_READ_ERROR is only an |
docs/libcurl/curl_mime_filename.md+4 -0
| @@ -44,6 +44,8 @@ The remote filename string is copied into the part, thus the associated |
| storage may safely be released or reused after call. Setting a part's file |
| name multiple times is valid: only the value set by the last call is retained. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -75,6 +77,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK or a CURL error code upon failure. |
docs/libcurl/curl_mime_free.md+4 -0
| @@ -43,6 +43,8 @@ curl_mime_init(3) and may be NULL. |
| Passing in a NULL pointer in *mime* makes this function return immediately |
| with no action. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,6 +63,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| None |
docs/libcurl/curl_mime_headers.md+4 -0
| @@ -43,6 +43,8 @@ freed explicitly. |
| Setting a part's custom headers list multiple times is valid: only the value |
| set by the last call is retained. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -74,6 +76,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK or a CURL error code upon failure. |
docs/libcurl/curl_mime_init.md+4 -0
| @@ -42,6 +42,8 @@ reporting. Since 7.87.0, it does not need to be the final target handle. |
| Using a mime handle is the recommended way to post an HTTP form, format and |
| send a multi-part email with SMTP or upload such an email to an IMAP server. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -68,6 +70,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| A mime struct handle, or NULL upon failure. |
docs/libcurl/curl_mime_name.md+4 -0
| @@ -41,6 +41,8 @@ safely be released or reused after call. Setting a part's name multiple times |
| is valid: only the value set by the last call is retained. It is possible to |
| reset the name of a part by setting *name* to NULL. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK or a CURL error code upon failure. |
docs/libcurl/curl_mime_subparts.md+4 -0
| @@ -42,6 +42,8 @@ Setting a part's contents multiple times is valid: only the value set by the |
| last call is retained. It is possible to unassign previous part's contents by |
| setting *subparts* to NULL. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -79,6 +81,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK or a CURL error code upon failure. |
docs/libcurl/curl_mime_type.md+4 -0
| @@ -54,6 +54,8 @@ extension, or application/octet-stream by default. |
| |
| - text/plain in other cases. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -82,6 +84,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK or a CURL error code upon failure. |
docs/libcurl/curl_mprintf.md+4 -0
| @@ -264,6 +264,8 @@ by the corresponding argument. |
| |
| A '%' symbol is written. No argument is converted. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -276,6 +278,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| The **curl_maprintf** and **curl_mvaprintf** functions return a pointer to |
docs/libcurl/curl_multi_add_handle.md+4 -0
| @@ -64,6 +64,8 @@ first the easy handle and then the multi handle: |
| |
| 3 - curl_multi_cleanup(3) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -82,6 +84,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLMcode type, general libcurl multi interface error code. |
docs/libcurl/curl_multi_assign.md+4 -0
| @@ -48,6 +48,8 @@ functionality. |
| |
| It is acceptable to call this function from your multi callback functions. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -75,6 +77,8 @@ 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. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| The standard CURLMcode for multi interface error codes. |
docs/libcurl/curl_multi_cleanup.md+4 -0
| @@ -44,6 +44,8 @@ removed |
| Passing in a NULL pointer in *multi_handle* makes this function return |
| CURLM_BAD_HANDLE immediately with no other action. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -58,6 +60,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLMcode type, general libcurl multi interface error code. On success, |
docs/libcurl/curl_multi_fdset.md+4 -0
| @@ -79,6 +79,8 @@ which can cause crashes, or worse. The effect of NOT storing it might possibly |
| save you from the crash, but makes your program NOT wait for sockets it should |
| wait for... |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -113,6 +115,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| **CURLMcode** type, general libcurl multi interface error code. See |
docs/libcurl/curl_multi_get_handles.md+4 -0
| @@ -43,6 +43,8 @@ The order of the easy handles within the array is not guaranteed. |
| |
| The returned array must be freed with a call to curl_free(3) after use. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -71,6 +73,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns NULL on failure. Otherwise it returns a pointer to an allocated array. |
docs/libcurl/curl_multi_info_read.md+4 -0
| @@ -67,6 +67,8 @@ that just completed. |
| |
| At this point, there are no other **msg** types defined. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -94,6 +96,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| A pointer to a filled-in struct, or NULL if it failed or ran out of |
docs/libcurl/curl_multi_init.md+4 -0
| @@ -34,6 +34,8 @@ all the other multi-functions, sometimes referred to as a multi handle in some |
| places in the documentation. This init call MUST have a corresponding call to |
| curl_multi_cleanup(3) when the operation is complete. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -50,6 +52,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| If this function returns NULL, something went wrong and you cannot use the |
docs/libcurl/curl_multi_perform.md+4 -0
| @@ -61,6 +61,8 @@ they cannot be continued. curl_multi_perform(3) should not be called |
| again on the same multi handle after an error has been returned, unless first |
| removing all the handles and adding new ones. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -89,6 +91,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLMcode type, general libcurl multi interface error code. |
docs/libcurl/curl_multi_poll.md+4 -0
| @@ -87,6 +87,8 @@ priority read events such as out of band data. |
| Bit flag to curl_waitfd.events indicating the socket should poll on write |
| events such as the socket being clear to write without blocking. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -133,6 +135,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLMcode type, general libcurl multi interface error code. See |
docs/libcurl/curl_multi_remove_handle.md+4 -0
| @@ -47,6 +47,8 @@ libcurl keeps the connection alive in the connection pool associated with the |
| multi handle, ready to get reused for a future transfer using this multi |
| handle. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -67,6 +69,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLMcode type, general libcurl multi interface error code. |
docs/libcurl/curl_multi_setopt.md+4 -0
| @@ -104,6 +104,8 @@ Custom pointer to pass to timer callback. See CURLMOPT_TIMERDATA(3) |
| |
| Callback to receive timeout values. See CURLMOPT_TIMERFUNCTION(3) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -118,6 +120,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| The standard CURLMcode for multi interface error codes. Note that it returns a |
docs/libcurl/curl_multi_socket.md+4 -0
| @@ -57,6 +57,8 @@ callback is far better than relying on polling the timeout value. |
| Usage of curl_multi_socket(3) is deprecated, whereas the function is |
| equivalent to curl_multi_socket_action(3) with **ev_bitmask** set to 0. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -76,6 +78,8 @@ int main(void) |
| |
| curl_multi_socket(3) is deprecated, use curl_multi_socket_action(3) instead! |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLMcode type, general libcurl multi interface error code. |
docs/libcurl/curl_multi_socket_action.md+4 -0
| @@ -96,6 +96,8 @@ callback has been told. |
| socket(s) that got action. If no activity is detected and the timeout expires, |
| call curl_multi_socket_action(3) with *CURL_SOCKET_TIMEOUT*. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -113,6 +115,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLMcode type, general libcurl multi interface error code. See |
docs/libcurl/curl_multi_socket_all.md+4 -0
| @@ -41,6 +41,8 @@ Force libcurl to (re-)check all its internal sockets and transfers instead of |
| just a single one by calling curl_multi_socket_all(3). Note that there should |
| not be any reason to use this function. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -53,6 +55,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLMcode type, general libcurl multi interface error code. |
docs/libcurl/curl_multi_strerror.md+4 -0
| @@ -31,6 +31,8 @@ const char *curl_multi_strerror(CURLMcode errornum); |
| This function returns a string describing the *CURLMcode* error code |
| passed in the argument *errornum*. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -45,6 +47,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| A pointer to a null-terminated string. |
docs/libcurl/curl_multi_timeout.md+4 -0
| @@ -49,6 +49,8 @@ Note: if libcurl returns a -1 timeout here, it just means that libcurl |
| currently has no stored timeout value. You must not wait too long (more than a |
| few seconds perhaps) before you call curl_multi_perform(3) again. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -83,6 +85,8 @@ out which sockets to wait for by calling curl_multi_fdset(3). |
| When there is activity or timeout, call curl_multi_perform(3) and then |
| loop - until all transfers are complete. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| The standard CURLMcode for multi interface error codes. |
docs/libcurl/curl_multi_wait.md+4 -0
| @@ -80,6 +80,8 @@ priority read events such as out of band data. |
| Bit flag to *curl_waitfd.events* indicating the socket should poll on |
| write events such as the socket being clear to write without blocking. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -114,6 +116,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLMcode type, general libcurl multi interface error code. See |
docs/libcurl/curl_multi_waitfds.md+4 -0
| @@ -52,6 +52,8 @@ The client code can pass *size* equal to zero just to get the number of the |
| descriptors and allocate appropriate storage for them to be used in a |
| subsequent function call. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -100,6 +102,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| **CURLMcode** type, general libcurl multi interface error code. See |
docs/libcurl/curl_multi_wakeup.md+4 -0
| @@ -39,6 +39,8 @@ that multiple calls to this function wake up the same waiting operation. |
| |
| This function has no effect on curl_multi_wait(3) calls. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -85,6 +87,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLMcode type, general libcurl multi interface error code. |
docs/libcurl/curl_pushheader_byname.md+4 -0
| @@ -36,6 +36,8 @@ not have to loop through all headers to find the one it is interested in. The |
| data this function points to is freed when this callback returns. If more than |
| one header field use the same name, this returns only the first one. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -76,6 +78,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns a pointer to the header field content or NULL. |
docs/libcurl/curl_pushheader_bynum.md+4 -0
| @@ -35,6 +35,8 @@ the incoming server push request or NULL. The data pointed to is freed by |
| libcurl when this callback returns. The returned pointer points to a |
| "name:value" string that gets freed when this callback returns. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns a pointer to the header field content or NULL. |
docs/libcurl/curl_share_cleanup.md+4 -0
| @@ -32,6 +32,8 @@ when this function has been called. |
| Passing in a NULL pointer in *share_handle* makes this function return |
| immediately with no action. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -45,6 +47,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLSHE_OK (zero) means that the option was set properly, non-zero means an |
docs/libcurl/curl_share_init.md+4 -0
| @@ -36,6 +36,8 @@ This *share handle* is what you pass to curl using the |
| CURLOPT_SHARE(3) option with curl_easy_setopt(3), to make that |
| specific curl handle use the data in this share. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -49,6 +51,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| If this function returns NULL, something went wrong (out of memory, etc.) |
docs/libcurl/curl_share_setopt.md+4 -0
| @@ -50,6 +50,8 @@ See CURLSHOPT_UNSHARE(3). |
| |
| See CURLSHOPT_USERDATA(3). |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLSHE_OK (zero) means that the option was set properly, non-zero means an |
docs/libcurl/curl_share_strerror.md+4 -0
| @@ -31,6 +31,8 @@ const char *curl_share_strerror(CURLSHcode errornum); |
| The curl_share_strerror(3) function returns a string describing the |
| *CURLSHcode* error code passed in the argument *errornum*. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -44,6 +46,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| A pointer to a null-terminated string. |
docs/libcurl/curl_slist_append.md+4 -0
| @@ -35,6 +35,8 @@ returns. curl_slist_append(3) copies the string. |
| The list should be freed again (after usage) with |
| curl_slist_free_all(3). |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -66,6 +68,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| A null pointer is returned if anything went wrong, otherwise the new list |
docs/libcurl/curl_slist_free_all.md+4 -0
| @@ -31,6 +31,8 @@ linked list. |
| Passing in a NULL pointer in *list* makes this function return immediately |
| with no action. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -52,6 +54,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Nothing. |
docs/libcurl/curl_strequal.md+4 -0
| @@ -39,6 +39,8 @@ This function is provided by libcurl to enable applications to compare strings |
| in a truly portable manner. There are no standard portable case insensitive |
| string comparison functions. This function works on all platforms. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -50,6 +52,8 @@ int main(int argc, char **argv) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Non-zero if the strings are identical. Zero if they are not. |
docs/libcurl/curl_strnequal.md+4 -0
| @@ -42,6 +42,8 @@ This function is provided by libcurl to enable applications to compare strings |
| in a truly portable manner. There are no standard portable case insensitive |
| string comparison functions. This function works on all platforms. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -53,6 +55,8 @@ int main(int argc, char **argv) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Non-zero if the strings are identical. Zero if they are not. |
docs/libcurl/curl_unescape.md+4 -0
| @@ -40,6 +40,8 @@ strlen() on **input** to find out the size. |
| |
| You must curl_free(3) the returned string when you are done with it. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| Since 7.15.4, curl_easy_unescape(3) should be used. This function might |
| be removed in a future release. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| A pointer to a null-terminated string or NULL if it failed. |
docs/libcurl/curl_url.md+4 -0
| @@ -38,6 +38,8 @@ single URL. When the object is first created, there is of course no components |
| stored. They are then set in the object with the curl_url_set(3) |
| function. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -58,6 +60,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns a **CURLU *** if successful, or NULL if out of memory. |
docs/libcurl/curl_url_cleanup.md+4 -0
| @@ -34,6 +34,8 @@ Frees all the resources associated with the given *CURLU* handle! |
| Passing in a NULL pointer in *handle* makes this function return |
| immediately with no action. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -45,6 +47,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| none |
docs/libcurl/curl_url_dup.md+4 -0
| @@ -33,6 +33,8 @@ Duplicates the URL object the input *CURLU* *inhandle* identifies and |
| returns a pointer to the copy as a new *CURLU* handle. The new handle also |
| needs to be freed with curl_url_cleanup(3). |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -50,6 +52,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns a new handle or NULL if out of memory. |
docs/libcurl/curl_url_get.md+4 -0
| @@ -216,6 +216,8 @@ A not-present fragment returns *part* set to NULL. |
| |
| A zero-length fragment returns *part* as NULL unless CURLU_GET_EMPTY is set. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -236,6 +238,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns a CURLUcode error value, which is CURLUE_OK (0) if everything went |
docs/libcurl/curl_url_set.md+4 -0
| @@ -240,6 +240,8 @@ If set, the URL parser does not accept embedded credentials for the |
| **CURLUPART_URL**, and instead returns **CURLUE_USER_NOT_ALLOWED** for |
| such URLs. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -256,6 +258,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns a *CURLUcode* error value, which is CURLUE_OK (0) if everything |
docs/libcurl/curl_url_strerror.md+4 -0
| @@ -33,6 +33,8 @@ const char *curl_url_strerror(CURLUcode errornum); |
| This function returns a string describing the CURLUcode error code passed in |
| the argument *errornum*. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -47,6 +49,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| A pointer to a null-terminated string. |
docs/libcurl/curl_version.md+4 -0
| @@ -30,6 +30,8 @@ its important components (like OpenSSL version). |
| |
| We recommend using curl_version_info(3) instead! |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -39,6 +41,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| A pointer to a null-terminated string. The string resides in a statically |
docs/libcurl/curl_version_info.md+4 -0
| @@ -370,6 +370,8 @@ supports HTTP GSS-Negotiate (added in 7.10.6, deprecated in 7.38.0) |
| |
| supports Kerberos V4 (when using FTP). Legacy bit. Deprecated since 7.33.0. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -383,6 +385,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| A pointer to a curl_version_info_data struct. |
docs/libcurl/curl_ws_meta.md+4 -0
| @@ -98,6 +98,8 @@ This transfer is now closed. |
| |
| This as an incoming ping message, that expects a pong response. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -133,6 +135,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| This function returns a pointer to a *curl_ws_frame* struct with read-only |
docs/libcurl/curl_ws_recv.md+4 -0
| @@ -44,6 +44,8 @@ The *meta* pointer gets set to point to a *const struct curl_ws_frame* |
| that contains information about the received data. See the |
| curl_ws_meta(3) for details on that struct. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,6 +63,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns **CURLE_OK** if everything is okay, and a non-zero number for |
docs/libcurl/curl_ws_send.md+4 -0
| @@ -90,6 +90,8 @@ fragment like this, the *fragsize* must be provided with the total |
| expected fragment size in the first call and it needs to be zero in subsequent |
| calls. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -112,6 +114,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| *CURLE_OK* (zero) means that the data was sent properly, non-zero means an |
docs/libcurl/opts/CURLINFO_ACTIVESOCKET.md+4 -0
| @@ -41,6 +41,8 @@ CURLOPT_CONNECT_ONLY(3), which skips the transfer phase. |
| CURLINFO_ACTIVESOCKET(3) was added as a replacement for |
| CURLINFO_LASTSOCKET(3) since that one is not working on all platforms. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -72,6 +74,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_APPCONNECT_TIME.md+4 -0
| @@ -38,6 +38,8 @@ When a redirect is followed, the time from each request is added together. |
| |
| See also the TIMES overview in the curl_easy_getinfo(3) man page. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,6 +63,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_APPCONNECT_TIME_T.md+4 -0
| @@ -38,6 +38,8 @@ When a redirect is followed, the time from each request is added together. |
| |
| See also the TIMES overview in the curl_easy_getinfo(3) man page. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,6 +64,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_CAINFO.md+4 -0
| @@ -41,6 +41,8 @@ This is a path identifying a single file containing CA certificates. |
| |
| The **path** pointer is set to NULL if there is no default path. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -58,6 +60,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_CAPATH.md+4 -0
| @@ -44,6 +44,8 @@ This is a path identifying a directory. |
| |
| The **path** pointer is set to NULL if there is no default path. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,6 +63,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_CERTINFO.md+5 -1
| @@ -51,6 +51,8 @@ items with textual information in the format "name:content" such as |
| "Subject:Foo", "Issuer:Bar", etc. The items in each list varies depending on |
| the SSL backend and the certificate. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -92,11 +94,13 @@ int main(void) |
| |
| See also the *certinfo.c* example. |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| 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. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_CONDITION_UNMET.md+4 -0
| @@ -37,6 +37,8 @@ gets a zero stored if the condition instead was met. This can also return 1 if |
| the server responded with a 304 HTTP status code, for example after sending a |
| custom "If-Match-*" header. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -70,6 +72,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_CONNECT_TIME.md+4 -0
| @@ -34,6 +34,8 @@ When a redirect is followed, the time from each request is added together. |
| |
| See also the TIMES overview in the curl_easy_getinfo(3) man page. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -57,6 +59,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_CONNECT_TIME_T.md+4 -0
| @@ -36,6 +36,8 @@ When a redirect is followed, the time from each request is added together. |
| |
| See also the TIMES overview in the curl_easy_getinfo(3) man page. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -60,6 +62,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_CONN_ID.md+4 -0
| @@ -35,6 +35,8 @@ The connection id is unique among all connections using the same |
| connection cache. This is implicitly the case for all connections in the |
| same multi handle. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -60,6 +62,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_CONTENT_LENGTH_DOWNLOAD.md+4 -0
| @@ -35,6 +35,8 @@ is the value read from the Content-Length: field. Since 7.19.4, this returns |
| CURLINFO_CONTENT_LENGTH_DOWNLOAD_T(3) is a newer replacement that returns a more |
| sensible variable type. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -64,6 +66,8 @@ int main(void) |
| |
| Deprecated since 7.55.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_CONTENT_LENGTH_DOWNLOAD_T.md+4 -0
| @@ -32,6 +32,8 @@ Pass a pointer to a *curl_off_t* to receive the content-length of the |
| download. This is the value read from the Content-Length: field. Stores -1 if |
| the size is not known. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -57,6 +59,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_CONTENT_LENGTH_UPLOAD.md+4 -0
| @@ -34,6 +34,8 @@ Pass a pointer to a double to receive the specified size of the upload. Since |
| CURLINFO_CONTENT_LENGTH_UPLOAD_T(3) is a newer replacement that returns a |
| more sensible variable type. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| |
| Deprecated since 7.55.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_CONTENT_LENGTH_UPLOAD_T.md+4 -0
| @@ -31,6 +31,8 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONTENT_LENGTH_UPLOAD_T, |
| Pass a pointer to a *curl_off_t* to receive the specified size of the |
| upload. Stores -1 if the size is not known. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -56,6 +58,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_CONTENT_TYPE.md+4 -0
| @@ -40,6 +40,8 @@ corresponding CURL handle. |
| The modern way to get this header from a response is to instead use the |
| curl_easy_header(3) function. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_COOKIELIST.md+4 -0
| @@ -37,6 +37,8 @@ received) the 'struct curl_slist *' is made a NULL pointer. |
| Since 7.43.0 cookies that were imported in the Set-Cookie format without a |
| domain name are not exported by this option. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -72,6 +74,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_EFFECTIVE_METHOD.md+4 -0
| @@ -39,6 +39,8 @@ The **methodp** pointer is NULL or points to private memory. You MUST NOT |
| free - it gets freed when you call curl_easy_cleanup(3) on the |
| corresponding CURL handle. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,6 +64,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_EFFECTIVE_URL.md+4 -0
| @@ -36,6 +36,8 @@ The **urlp** pointer is NULL or points to private memory. You MUST NOT free |
| - it gets freed when you call curl_easy_cleanup(3) on the corresponding |
| CURL handle. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -58,6 +60,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_FILETIME.md+4 -0
| @@ -41,6 +41,8 @@ by using the CURLOPT_FILETIME(3) option or you unconditionally get a -1 back. |
| Consider CURLINFO_FILETIME_T(3) instead to be able to extract dates beyond the |
| year 2038 on systems using 32-bit longs (Windows). |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -67,6 +69,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_FILETIME_T.md+4 -0
| @@ -42,6 +42,8 @@ by using the CURLOPT_FILETIME(3) option or you unconditionally get a -1 back. |
| This option is an alternative to CURLINFO_FILETIME(3) to allow systems with 32 |
| bit long variables to extract dates outside of the 32-bit timestamp range. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -68,6 +70,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_FTP_ENTRY_PATH.md+5 -1
| @@ -35,6 +35,8 @@ The **path** pointer is NULL or points to private memory. You MUST NOT free |
| - it gets freed when you call curl_easy_cleanup(3) on the corresponding |
| CURL handle. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -60,10 +62,12 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| Works for SFTP since 7.21.4 |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_HEADER_SIZE.md+4 -0
| @@ -34,6 +34,8 @@ received. Measured in number of bytes. |
| The total includes the size of any received headers suppressed by |
| CURLOPT_SUPPRESS_CONNECT_HEADERS(3). |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -55,6 +57,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_HTTPAUTH_AVAIL.md+4 -0
| @@ -32,6 +32,8 @@ 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). |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_HTTP_CONNECTCODE.md+4 -0
| @@ -31,6 +31,8 @@ Pass a pointer to a long to receive the last received HTTP proxy response code |
| to a CONNECT request. The returned value is zero if no such response code was |
| available. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -55,6 +57,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_HTTP_VERSION.md+4 -0
| @@ -32,6 +32,8 @@ connection done using this handle. The returned value is |
| CURL_HTTP_VERSION_1_0, CURL_HTTP_VERSION_1_1, CURL_HTTP_VERSION_2_0, |
| CURL_HTTP_VERSION_3 or 0 if the version cannot be determined. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -51,6 +53,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_LASTSOCKET.md+4 -0
| @@ -41,6 +41,8 @@ NOTE: this API is deprecated since it is not working on win64 where the SOCKET |
| type is 64 bits large while its 'long' is 32 bits. Use the |
| CURLINFO_ACTIVESOCKET(3) instead, if possible. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -72,6 +74,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_LOCAL_IP.md+4 -0
| @@ -38,6 +38,8 @@ The **ip** pointer is NULL or points to private memory. You MUST NOT free - |
| it gets freed when you call curl_easy_cleanup(3) on the corresponding |
| CURL handle. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,6 +64,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_LOCAL_PORT.md+4 -0
| @@ -31,6 +31,8 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_LOCAL_PORT, long *portp); |
| Pass a pointer to a long to receive the local port number of the most recent |
| connection done with this **curl** handle. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -58,6 +60,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_NAMELOOKUP_TIME.md+4 -0
| @@ -35,6 +35,8 @@ When a redirect is followed, the time from each request is added together. |
| |
| See also the TIMES overview in the curl_easy_getinfo(3) man page. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -58,6 +60,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_NAMELOOKUP_TIME_T.md+4 -0
| @@ -35,6 +35,8 @@ When a redirect is followed, the time from each request is added together. |
| |
| See also the TIMES overview in the curl_easy_getinfo(3) man page. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -59,6 +61,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_NUM_CONNECTS.md+4 -0
| @@ -33,6 +33,8 @@ many times libcurl successfully reused existing connection(s) or not. See the |
| connection options of curl_easy_setopt(3) to see how libcurl tries to make |
| persistent connections to save time. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -55,6 +57,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_OS_ERRNO.md+4 -0
| @@ -38,6 +38,8 @@ Since 8.8.0 libcurl clears the easy handle's saved errno before performing the |
| transfer. Prior versions did not clear the saved errno, which means if a saved |
| errno is retrieved it could be from a previous transfer on the same handle. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -60,6 +62,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_PRETRANSFER_TIME.md+4 -0
| @@ -40,6 +40,8 @@ When a redirect is followed, the time from each request is added together. |
| |
| See also the TIMES overview in the curl_easy_getinfo(3) man page. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_PRETRANSFER_TIME_T.md+4 -0
| @@ -40,6 +40,8 @@ When a redirect is followed, the time from each request is added together. |
| |
| See also the TIMES overview in the curl_easy_getinfo(3) man page. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_PRIMARY_IP.md+4 -0
| @@ -39,6 +39,8 @@ The **ip** pointer is NULL or points to private memory. You MUST NOT free - |
| it gets freed when you call curl_easy_cleanup(3) on the corresponding |
| CURL handle. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_PRIMARY_PORT.md+4 -0
| @@ -36,6 +36,8 @@ If a proxy was used for the most recent transfer, this is the port number of |
| the proxy, if no proxy was used it is the port number of the most recently |
| accessed URL. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -57,6 +59,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_PRIVATE.md+4 -0
| @@ -32,6 +32,8 @@ associated with the curl handle (set with the CURLOPT_PRIVATE(3)). |
| Please note that for internal reasons, the value is returned as a char |
| pointer, although effectively being a 'void *'. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -58,6 +60,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_PROTOCOL.md+4 -0
| @@ -44,6 +44,8 @@ CURLPROTO_SCP, CURLPROTO_SFTP, CURLPROTO_SMB, CURLPROTO_SMBS, CURLPROTO_SMTP, |
| CURLPROTO_SMTPS, CURLPROTO_TELNET, CURLPROTO_TFTP, CURLPROTO_MQTT |
| ~~~ |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -67,6 +69,8 @@ int main(void) |
| |
| Deprecated since 7.85.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_PROXYAUTH_AVAIL.md+4 -0
| @@ -32,6 +32,8 @@ 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). |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -66,6 +68,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_PROXY_ERROR.md+4 -0
| @@ -72,6 +72,8 @@ transfer returned a **CURLE_PROXY** error. That error code matches the |
| |
| The error code is zero (**CURLPX_OK**) if no response code was available. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -95,6 +97,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_PROXY_SSL_VERIFYRESULT.md+4 -0
| @@ -37,6 +37,8 @@ option. This is only used for HTTPS proxies. |
| |
| 0 is a positive result. Non-zero is an error. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -68,6 +70,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_QUEUE_TIME_T.md+4 -0
| @@ -36,6 +36,8 @@ connection etc due to set conditions and limits imposed by the application. |
| |
| See also the TIMES overview in the curl_easy_getinfo(3) man page. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -60,6 +62,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_REDIRECT_COUNT.md+4 -0
| @@ -32,6 +32,8 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REDIRECT_COUNT, |
| Pass a pointer to a long to receive the total number of redirections that were |
| actually followed. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -52,6 +54,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_REDIRECT_TIME.md+4 -0
| @@ -37,6 +37,8 @@ the complete execution time for multiple redirections. |
| |
| See also the TIMES overview in the curl_easy_getinfo(3) man page. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -60,6 +62,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_REDIRECT_TIME_T.md+4 -0
| @@ -38,6 +38,8 @@ multiple redirections. |
| |
| See also the TIMES overview in the curl_easy_getinfo(3) man page. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,6 +64,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_REDIRECT_URL.md+4 -0
| @@ -38,6 +38,8 @@ the new URL. |
| This URL is also set if the CURLOPT_MAXREDIRS(3) limit prevented a redirect to |
| happen (since 7.54.1). |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -59,6 +61,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_REFERER.md+4 -0
| @@ -35,6 +35,8 @@ The **hdrp** pointer is NULL or points to private memory you MUST NOT free - |
| it gets freed when you call curl_easy_cleanup(3) on the corresponding |
| CURL handle. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -57,6 +59,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_REQUEST_SIZE.md+4 -0
| @@ -32,6 +32,8 @@ Pass a pointer to a long to receive the total size of the issued |
| requests. This is so far only for HTTP requests. Note that this may be more |
| than one request if CURLOPT_FOLLOWLOCATION(3) is enabled. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -53,6 +55,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_RESPONSE_CODE.md+4 -0
| @@ -38,6 +38,8 @@ no server response code has been received. |
| Note that a proxy's CONNECT response should be read with |
| CURLINFO_HTTP_CONNECTCODE(3) and not this. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,6 +64,8 @@ int main(void) |
| 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. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_RETRY_AFTER.md+5 -1
| @@ -38,7 +38,9 @@ or zero if there was no header or the header could not be parsed. |
| |
| # DEFAULT |
| |
| - | Returns zero delay if there was no header. |
| + | Zero if there was no header. |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -61,6 +63,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_RTSP_CLIENT_CSEQ.md+4 -0
| @@ -32,6 +32,8 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_RTSP_CLIENT_CSEQ, |
| Pass a pointer to a long to receive the next CSeq that is expected to be used |
| by the application. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -51,6 +53,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_RTSP_CSEQ_RECV.md+4 -0
| @@ -32,6 +32,8 @@ server. If your application encounters a *CURLE_RTSP_CSEQ_ERROR* then you |
| may wish to troubleshoot and/or fix the CSeq mismatch by peeking at this |
| value. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -51,6 +53,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_RTSP_SERVER_CSEQ.md+4 -0
| @@ -36,6 +36,8 @@ Listening for server initiated requests is not implemented! |
| Applications wishing to resume an RTSP session on another connection should |
| retrieve this info before closing the active connection. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -55,6 +57,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_RTSP_SESSION_ID.md+4 -0
| @@ -37,6 +37,8 @@ The **id** pointer is NULL or points to private memory. You MUST NOT free - |
| it gets freed when you call curl_easy_cleanup(3) on the corresponding |
| CURL handle. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -56,6 +58,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_SCHEME.md+4 -0
| @@ -40,6 +40,8 @@ CURL handle. |
| The returned scheme might be upper or lowercase. Do comparisons case |
| insensitively. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,6 +63,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_SIZE_DOWNLOAD.md+4 -0
| @@ -38,6 +38,8 @@ number. |
| CURLINFO_SIZE_DOWNLOAD_T(3) is a newer replacement that returns a more |
| sensible variable type. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -67,6 +69,8 @@ int main(void) |
| |
| Deprecated since 7.55.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_SIZE_DOWNLOAD_T.md+4 -0
| @@ -35,6 +35,8 @@ were downloaded. The amount is only for the latest transfer and gets reset |
| again for each new transfer. This counts actual payload data, what's also |
| commonly called body. All meta and header data is excluded from this amount. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -60,6 +62,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_SIZE_UPLOAD.md+4 -0
| @@ -35,6 +35,8 @@ uploaded. |
| CURLINFO_SIZE_UPLOAD_T(3) is a newer replacement that returns a more |
| sensible variable type. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| |
| Deprecated since 7.55.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_SIZE_UPLOAD_T.md+4 -0
| @@ -32,6 +32,8 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SIZE_UPLOAD_T, |
| Pass a pointer to a *curl_off_t* to receive the total amount of bytes that |
| were uploaded. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -56,6 +58,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_SPEED_DOWNLOAD.md+4 -0
| @@ -35,6 +35,8 @@ measured for the complete download. Measured in bytes/second. |
| CURLINFO_SPEED_DOWNLOAD_T(3) is a newer replacement that returns a more |
| sensible variable type. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| |
| Deprecated since 7.55.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_SPEED_DOWNLOAD_T.md+4 -0
| @@ -32,6 +32,8 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_DOWNLOAD_T, |
| Pass a pointer to a *curl_off_t* to receive the average download speed |
| that curl measured for the complete download. Measured in bytes/second. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -57,6 +59,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_SPEED_UPLOAD.md+4 -0
| @@ -33,6 +33,8 @@ measured for the complete upload. Measured in bytes/second. |
| CURLINFO_SPEED_UPLOAD_T(3) is a newer replacement that returns a more |
| sensible variable type. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,6 +63,8 @@ int main(void) |
| |
| Deprecated since 7.55.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_SPEED_UPLOAD_T.md+4 -0
| @@ -31,6 +31,8 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_UPLOAD_T, |
| Pass a pointer to a *curl_off_t* to receive the average upload speed that |
| curl measured for the complete upload. Measured in bytes/second. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -55,6 +57,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_SSL_ENGINES.md+4 -0
| @@ -37,6 +37,8 @@ available at runtime. **NOTE:** you must call curl_slist_free_all(3) |
| on the list pointer once you are done with it, as libcurl does not free this |
| data for you. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -57,6 +59,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_SSL_VERIFYRESULT.md+4 -0
| @@ -37,6 +37,8 @@ option). |
| |
| 0 is a positive result. Non-zero is an error. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -67,6 +69,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_STARTTRANSFER_TIME.md+4 -0
| @@ -38,6 +38,8 @@ When a redirect is followed, the time from each request is added together. |
| |
| See also the TIMES overview in the curl_easy_getinfo(3) man page. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,6 +63,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_STARTTRANSFER_TIME_T.md+4 -0
| @@ -39,6 +39,8 @@ When a redirect is followed, the time from each request is added together. |
| |
| See also the TIMES overview in the curl_easy_getinfo(3) man page. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_TLS_SESSION.md+4 -0
| @@ -48,6 +48,8 @@ function *SSL_get_SSL_CTX(3)*. Therefore unless you need compatibility |
| with older versions of libcurl use CURLINFO_TLS_SSL_PTR(3). Refer to |
| that document for more information. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -71,6 +73,8 @@ int main(void) |
| |
| Deprecated since 7.48.0 |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_TLS_SSL_PTR.md+5 -1
| @@ -134,6 +134,8 @@ How are you using this option? Are you affected by any of these limitations? |
| Please let us know by making a comment at |
| https://github.com/curl/curl/issues/685 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -167,11 +169,13 @@ int main(int argc, char **argv) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| 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. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_TOTAL_TIME.md+4 -0
| @@ -36,6 +36,8 @@ When a redirect is followed, the time from each request is added together. |
| |
| See also the TIMES overview in the curl_easy_getinfo(3) man page. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -59,6 +61,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_TOTAL_TIME_T.md+4 -0
| @@ -36,6 +36,8 @@ When a redirect is followed, the time from each request is added together. |
| |
| See also the TIMES overview in the curl_easy_getinfo(3) man page. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -60,6 +62,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_USED_PROXY.md+4 -0
| @@ -32,6 +32,8 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_USED_PROXY, |
| Pass a pointer to a long. It gets set to zero set if no proxy was used in the |
| previous transfer or a non-zero value if a proxy was used. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -59,6 +61,8 @@ int main(int argc, char *argv[]) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLINFO_XFER_ID.md+4 -0
| @@ -36,6 +36,8 @@ The transfer id is unique among all transfers performed using the same |
| connection cache. This is implicitly the case for all transfers in the |
| same multi handle. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -60,6 +62,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE.md+5 -1
| @@ -38,7 +38,9 @@ than CURLMOPT_MAX_PIPELINE_LENGTH(3). |
| |
| # DEFAULT |
| |
| - | The default value is 0, which means that the penalization is inactive. |
| + | 0, which means that penalization is inactive. |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -51,6 +53,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE.md+5 -1
| @@ -37,7 +37,9 @@ CURLMOPT_MAX_PIPELINE_LENGTH(3). |
| |
| # DEFAULT |
| |
| - | The default value is 0, which means that the size penalization is inactive. |
| + | 0, which means that the size penalization is inactive. |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -50,6 +52,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLMOPT_MAXCONNECTS.md+4 -0
| @@ -53,6 +53,8 @@ ones to get made. |
| |
| See DESCRIPTION |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -64,6 +66,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLMOPT_MAX_CONCURRENT_STREAMS.md+4 -0
| @@ -38,6 +38,8 @@ value passed here would be honored based on other system resources properties. |
| |
| 100 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -49,6 +51,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLMOPT_MAX_HOST_CONNECTIONS.md+4 -0
| @@ -56,6 +56,8 @@ ones to get made. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -67,6 +69,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLMOPT_MAX_PIPELINE_LENGTH.md+4 -0
| @@ -43,6 +43,8 @@ CURLMOPT_MAX_PIPELINE_LENGTH(3). |
| |
| 5 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -54,6 +56,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLMOPT_MAX_TOTAL_CONNECTIONS.md+6 -2
| @@ -46,8 +46,10 @@ timeout is however treated as a per-connect timeout. |
| |
| # DEFAULT |
| |
| - | The default value is 0, which means that there is no limit. It is then simply |
| - | controlled by the number of easy handles added. |
| + | 0, which means that there is no limit. It is then simply controlled by the |
| + | number of easy handles added. |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -60,6 +62,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLMOPT_PIPELINING.md+9 -3
| @@ -51,9 +51,9 @@ existing connection if possible. This requires HTTP/2 or HTTP/3. |
| |
| # DEFAULT |
| |
| - | Since 7.62.0, **CURLPIPE_MULTIPLEX** is enabled by default. |
| + | **CURLPIPE_MULTIPLEX** |
| |
| - | Before that, default was **CURLPIPE_NOTHING**. |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -66,11 +66,17 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| The multiplex support bit was added in 7.43.0. HTTP/1 Pipelining support was |
| disabled in 7.62.0. |
| |
| + | Since 7.62.0, **CURLPIPE_MULTIPLEX** is enabled by default. |
| + | |
| + | Before that, default was **CURLPIPE_NOTHING**. |
| + | |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLMOPT_PIPELINING_SERVER_BL.md+5 -1
| @@ -42,7 +42,9 @@ Pass a NULL pointer to clear the block list. |
| |
| # DEFAULT |
| |
| - | The default value is NULL, which means that there is no block list. |
| + | NULL, which means that there is no block list. |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -60,6 +62,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLMOPT_PIPELINING_SITE_BL.md+5 -1
| @@ -37,7 +37,9 @@ Pass a NULL pointer to clear the block list. |
| |
| # DEFAULT |
| |
| - | The default value is NULL, which means that there is no block list. |
| + | NULL, which means that there is no block list. |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -56,6 +58,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLMOPT_PUSHDATA.md+4 -0
| @@ -36,6 +36,8 @@ libcurl itself, only passed on to the callback function. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -77,6 +79,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLMOPT_PUSHFUNCTION.md+4 -0
| @@ -97,6 +97,8 @@ All other return codes are reserved for future use. |
| |
| NULL, no callback |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -138,6 +140,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLMOPT_SOCKETDATA.md+4 -0
| @@ -37,6 +37,8 @@ callback's **clientp** argument. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -72,6 +74,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLM_OK. |
docs/libcurl/opts/CURLMOPT_SOCKETFUNCTION.md+4 -0
| @@ -90,6 +90,8 @@ active transfer. It might soon be added again. |
| |
| NULL (no callback) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -125,6 +127,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLM_OK. |
docs/libcurl/opts/CURLMOPT_TIMERDATA.md+4 -0
| @@ -36,6 +36,8 @@ callback's **clientp** argument. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLMOPT_TIMERFUNCTION.md+4 -0
| @@ -64,6 +64,8 @@ callback with a zero timeout... |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -93,6 +95,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_ABSTRACT_UNIX_SOCKET.md+5 -1
| @@ -43,7 +43,9 @@ share the same storage and therefore only one of them can be set per handle. |
| |
| # DEFAULT |
| |
| - | Default is NULL. |
| + | NULL |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -61,6 +63,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_ACCEPTTIMEOUT_MS.md+4 -0
| @@ -34,6 +34,8 @@ server to connect back to libcurl when an active FTP connection is used. |
| |
| 60000 milliseconds |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -51,6 +53,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.md+7 -1
| @@ -72,10 +72,12 @@ sending the length of the non-compressed content is a common server mistake). |
| The application does not have to keep the string around after setting this |
| option. |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| This option was called CURLOPT_ENCODING before 7.21.6 |
| |
| + | # NOTES |
| + | |
| 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 |
| @@ -85,6 +87,8 @@ responses. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -103,6 +107,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_ADDRESS_SCOPE.md+4 -0
| @@ -32,6 +32,8 @@ Pass a long specifying the scope id value to use when connecting to IPv6 address |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -52,6 +54,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_ALTSVC.md+4 -0
| @@ -39,6 +39,8 @@ Specify a blank filename ("") to make libcurl not load from a file at all. |
| |
| NULL. The alt-svc cache is not read nor written to file. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -101,6 +103,8 @@ Boolean (1 or 0) if "persist" was set for this entry |
| |
| Integer priority value (not currently used) |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_ALTSVC_CTRL.md+10 -4
| @@ -44,6 +44,11 @@ Alternative services are only used when setting up new connections. If there |
| exists an existing connection to the host in the connection pool, then that is |
| preferred. |
| |
| + | If CURLOPT_ALTSVC(3) is set, CURLOPT_ALTSVC_CTRL(3) gets a default value |
| + | corresponding to CURLALTSVC_H1 | CURLALTSVC_H2 | CURLALTSVC_H3 - the HTTP/2 |
| + | and HTTP/3 bits are only set if libcurl was built with support for those |
| + | versions. |
| + | |
| Setting any bit enables the alt-svc engine. |
| |
| ## CURLALTSVC_READONLYFILE |
| @@ -68,10 +73,9 @@ was also built to actually support HTTP/3, otherwise this bit is ignored. |
| |
| # DEFAULT |
| |
| - | Alt-Svc handling is disabled by default. If CURLOPT_ALTSVC(3) is set, |
| - | CURLOPT_ALTSVC_CTRL(3) has a default value corresponding to |
| - | CURLALTSVC_H1 | CURLALTSVC_H2 | CURLALTSVC_H3 - the HTTP/2 and HTTP/3 bits are |
| - | only set if libcurl was built with support for those versions. |
| + | 0 - Alt-Svc handling is disabled |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -87,6 +91,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_APPEND.md+4 -0
| @@ -34,6 +34,8 @@ instead of overwrite it. This is only useful when uploading to an FTP site. |
| |
| 0 (disabled) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -55,6 +57,8 @@ int main(void) |
| |
| This option was known as CURLOPT_FTPAPPEND up to 7.16.4 |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_AUTOREFERER.md+4 -0
| @@ -44,6 +44,8 @@ referer header after the transfer. |
| |
| 0, disabled |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -67,6 +69,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_AWS_SIGV4.md+8 -3
| @@ -65,11 +65,14 @@ for "date", **"test4_request"** for "request type", |
| If you use just "test", instead of "test:try", test is used for every |
| generated string. |
| |
| + | Setting CURLOPT_HTTPAUTH(3) with the CURLAUTH_AWS_SIGV4 bit set is the same as |
| + | setting this option with a **"aws:amz"** parameter. |
| + | |
| # DEFAULT |
| |
| - | By default, the value of this parameter is NULL. |
| - | Calling CURLOPT_HTTPAUTH(3) with CURLAUTH_AWS_SIGV4 is the same |
| - | as calling this with **"aws:amz"** in parameter. |
| + | NULL |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -110,6 +113,8 @@ 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". |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_BUFFERSIZE.md+4 -0
| @@ -54,6 +54,8 @@ allocated as long as there are active transfers. |
| |
| CURL_MAX_WRITE_SIZE (16kB) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -74,6 +76,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_CAINFO.md+5 -1
| @@ -61,6 +61,8 @@ The default value for this can be figured out with CURLINFO_CAINFO(3). |
| Built-in system specific. When curl is built with Secure Transport or |
| Schannel, this option is not set by default. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -76,10 +78,12 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| Schannel support added in libcurl 7.60. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_CAINFO_BLOB.md+5 -1
| @@ -54,6 +54,8 @@ This option overrides CURLOPT_CAINFO(3). |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -77,12 +79,14 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| 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 |
| Transport and Schannel backends. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_CAPATH.md+5 -1
| @@ -49,7 +49,9 @@ The default value for this can be figured out with CURLINFO_CAPATH(3). |
| |
| # DEFAULT |
| |
| - | A default path detected at build time. |
| + | A path detected at build time. |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -67,6 +69,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK if supported; or an error such as: |
docs/libcurl/opts/CURLOPT_CA_CACHE_TIMEOUT.md+5 -1
| @@ -51,6 +51,8 @@ hours. |
| |
| 86400 (24 hours) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -75,11 +77,13 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| 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). |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_CERTINFO.md+5 -1
| @@ -44,6 +44,8 @@ its option CURLINFO_CERTINFO(3). |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -83,11 +85,13 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| Schannel support added in 7.50.0. Secure Transport support added in 7.79.0. |
| mbedTLS support added in 8.9.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_CHUNK_BGN_FUNCTION.md+4 -0
| @@ -84,6 +84,8 @@ Return *CURL_CHUNK_BGN_FUNC_OK* if everything is fine, |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -142,6 +144,8 @@ int main() |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_CHUNK_DATA.md+4 -0
| @@ -34,6 +34,8 @@ CURLOPT_CHUNK_END_FUNCTION(3). |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -92,6 +94,8 @@ int main() |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_CHUNK_END_FUNCTION.md+4 -0
| @@ -42,6 +42,8 @@ Return *CURL_CHUNK_END_FUNC_OK* if everything is fine or |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -72,6 +74,8 @@ int main() |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_CLOSESOCKETDATA.md+5 -1
| @@ -33,7 +33,9 @@ CURLOPT_CLOSESOCKETFUNCTION(3). |
| |
| # DEFAULT |
| |
| - | The default value of this parameter is NULL. |
| + | NULL |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_CLOSESOCKETFUNCTION.md+5 -1
| @@ -44,7 +44,9 @@ closed. |
| |
| # DEFAULT |
| |
| - | By default libcurl uses the standard socket close function. |
| + | Use the standard socket close function. |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -76,6 +78,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_CONNECTTIMEOUT.md+4 -0
| @@ -60,6 +60,8 @@ signals to be used unless CURLOPT_NOSIGNAL(3) is set. |
| |
| 300 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -77,6 +79,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK. Returns CURLE_BAD_FUNCTION_ARGUMENT if set to a negative |
docs/libcurl/opts/CURLOPT_CONNECTTIMEOUT_MS.md+4 -0
| @@ -61,6 +61,8 @@ signals to be used unless CURLOPT_NOSIGNAL(3) is set. |
| |
| 300000 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -78,6 +80,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_CONNECT_ONLY.md+5 -1
| @@ -55,6 +55,8 @@ curl_easy_recv(3) do not function. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -73,10 +75,12 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| WS and WSS support added in 7.86.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_CONNECT_TO.md+4 -0
| @@ -80,6 +80,8 @@ a transfer before you call curl_slist_free_all(3) on the list. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -104,6 +106,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_CONV_FROM_NETWORK_FUNCTION.md+4 -0
| @@ -73,6 +73,8 @@ You need to override these definitions if they are different on your system. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -108,6 +110,8 @@ Not available and deprecated since 7.82.0. |
| Available only if **CURL_DOES_CONVERSIONS** was defined when libcurl was |
| built. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_CONV_FROM_UTF8_FUNCTION.md+4 -0
| @@ -70,6 +70,8 @@ You need to override these definitions if they are different on your system. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -101,6 +103,8 @@ Not available and deprecated since 7.82.0. |
| Available only if **CURL_DOES_CONVERSIONS** was defined when libcurl was |
| built. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_CONV_TO_NETWORK_FUNCTION.md+4 -0
| @@ -72,6 +72,8 @@ You need to override these definitions if they are different on your system. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -104,6 +106,8 @@ Not available and deprecated since 7.82.0. |
| Available only if **CURL_DOES_CONVERSIONS** was defined when libcurl was |
| built. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_COOKIE.md+4 -0
| @@ -70,6 +70,8 @@ ability to stop super cookies. PSL support is identified by the |
| |
| NULL, no cookies |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -86,6 +88,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is enabled, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_COOKIEFILE.md+4 -0
| @@ -68,6 +68,8 @@ run. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -93,6 +95,8 @@ int main(void) |
| The cookie file format and general cookie concepts in curl are described |
| online here: https://curl.se/docs/http-cookies.html |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_COOKIEJAR.md+4 -0
| @@ -54,6 +54,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -75,6 +77,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_COOKIELIST.md+5 -1
| @@ -70,6 +70,8 @@ loads all cookies from the files specified by CURLOPT_COOKIEFILE(3) |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -119,7 +121,7 @@ int main(void) |
| The cookie file format and general cookie concepts in curl are described |
| online here: https://curl.se/docs/http-cookies.html |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| **ALL** was added in 7.14.1 |
| |
| @@ -129,6 +131,8 @@ online here: https://curl.se/docs/http-cookies.html |
| |
| **RELOAD** was added in 7.39.0 |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_COOKIESESSION.md+4 -0
| @@ -42,6 +42,8 @@ the same session. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_COPYPOSTFIELDS.md+4 -0
| @@ -46,6 +46,8 @@ CURLOPT_COPYPOSTFIELDS(3) option is issued. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -67,6 +69,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_CRLF.md+4 -0
| @@ -36,6 +36,8 @@ This is a legacy option of questionable use. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -52,6 +54,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_CRLFILE.md+4 -0
| @@ -59,6 +59,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -75,6 +77,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_CURLU.md+5 -1
| @@ -45,7 +45,9 @@ updated contents is used. |
| |
| # DEFAULT |
| |
| - | The default value of this parameter is NULL. |
| + | NULL |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -69,6 +71,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_CUSTOMREQUEST.md+4 -0
| @@ -100,6 +100,8 @@ issue **NOOP** and **RSET** commands. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -120,6 +122,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_DEBUGDATA.md+4 -0
| @@ -34,6 +34,8 @@ not used by libcurl, it is only passed to the callback. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -76,6 +78,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_DEBUGFUNCTION.md+4 -0
| @@ -104,6 +104,8 @@ CURLOPT_PRIVATE(3) on your handle. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -208,6 +210,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_DEFAULT_PROTOCOL.md+4 -0
| @@ -56,6 +56,8 @@ option. |
| |
| NULL (make a guess based on the host) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -75,6 +77,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK if the option is supported. |
docs/libcurl/opts/CURLOPT_DIRLISTONLY.md+4 -0
| @@ -54,6 +54,8 @@ effectively breaks that feature. |
| |
| 0, disabled |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -79,6 +81,8 @@ int main(void) |
| This option was known as CURLOPT_FTPLISTONLY up to 7.16.4. POP3 is supported |
| since 7.21.5. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_DISALLOW_USERNAME_IN_URL.md+5 -1
| @@ -37,7 +37,9 @@ curl_url_set(3) function. |
| |
| # DEFAULT |
| |
| - | 0 (disabled) - usernames are allowed by default. |
| + | 0 (disabled) |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -55,6 +57,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_DNS_CACHE_TIMEOUT.md+4 -0
| @@ -55,6 +55,8 @@ Since version 8.1.0, libcurl prunes entries from the DNS cache if it exceeds |
| |
| 60 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -79,6 +81,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_DNS_INTERFACE.md+4 -0
| @@ -40,6 +40,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,6 +63,8 @@ int main(void) |
| This option requires that libcurl was built with a resolver backend that |
| supports this operation. The c-ares backend is the only such one. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, |
docs/libcurl/opts/CURLOPT_DNS_LOCAL_IP4.md+4 -0
| @@ -39,6 +39,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -60,6 +62,8 @@ int main(void) |
| This option requires that libcurl was built with a resolver backend that |
| supports this operation. The c-ares backend is the only such one. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, |
docs/libcurl/opts/CURLOPT_DNS_LOCAL_IP6.md+4 -0
| @@ -39,6 +39,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -60,6 +62,8 @@ int main(void) |
| This option requires that libcurl was built with a resolver backend that |
| supports this operation. The c-ares backend is the only such one. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, |
docs/libcurl/opts/CURLOPT_DNS_SERVERS.md+5 -1
| @@ -41,7 +41,9 @@ option. |
| |
| # DEFAULT |
| |
| - | NULL - use system default |
| + | NULL |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -65,6 +67,8 @@ int main(void) |
| This option requires that libcurl was built with a resolver backend that |
| supports this operation. The c-ares backend is the only such one. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, |
docs/libcurl/opts/CURLOPT_DNS_SHUFFLE_ADDRESSES.md+4 -0
| @@ -47,6 +47,8 @@ performance impacts and may cause IPv4 to be used before IPv6 or vice versa. |
| |
| 0 (disabled) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK or an error such as CURLE_UNKNOWN_OPTION. |
docs/libcurl/opts/CURLOPT_DNS_USE_GLOBAL_CACHE.md+4 -0
| @@ -40,6 +40,8 @@ cache between transfers. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,6 +64,8 @@ int main(void) |
| |
| Deprecated since 7.11.1. Functionality removed in 7.62.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_DOH_SSL_VERIFYHOST.md+4 -0
| @@ -60,6 +60,8 @@ of the DoH server certificate. |
| |
| 2 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -80,6 +82,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_DOH_SSL_VERIFYPEER.md+4 -0
| @@ -72,6 +72,8 @@ the correct end-point. |
| |
| 1 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -92,6 +94,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_DOH_SSL_VERIFYSTATUS.md+4 -0
| @@ -47,6 +47,8 @@ the verification fails. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -67,6 +69,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if OCSP stapling is supported by the SSL backend, otherwise |
docs/libcurl/opts/CURLOPT_DOH_URL.md+5 -2
| @@ -64,8 +64,9 @@ CURLOPT_FTPPORT(3), a proxy type set to **CURLPROXY_SOCKS4** or |
| |
| # DEFAULT |
| |
| - | NULL - there is no default DoH URL. If this option is not set, libcurl uses |
| - | the default name resolver. |
| + | NULL |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -81,6 +82,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK on success or CURLE_OUT_OF_MEMORY if there was insufficient |
docs/libcurl/opts/CURLOPT_ECH.md+4 -0
| @@ -74,6 +74,8 @@ ECHConfigList that is used for ECH. |
| |
| NULL, meaning ECH is disabled. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -85,6 +87,8 @@ if(curl) { |
| curl_easy_perform(curl); |
| } |
| ~~~ |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK on success or CURLE_OUT_OF_MEMORY if there was insufficient |
docs/libcurl/opts/CURLOPT_EGDSOCKET.md+2 -0
| @@ -37,6 +37,8 @@ NULL |
| |
| This option was deprecated in 7.84.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_ERRORBUFFER.md+4 -0
| @@ -52,6 +52,8 @@ debug and trace why errors happen. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -91,6 +93,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_EXPECT_100_TIMEOUT_MS.md+4 -0
| @@ -37,6 +37,8 @@ sent anyway. |
| |
| 1000 milliseconds |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -54,6 +56,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_FAILONERROR.md+4 -0
| @@ -46,6 +46,8 @@ get closed and *CURLE_HTTP_RETURNED_ERROR* is returned. |
| |
| 0, do not fail on error |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -64,6 +66,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_FILETIME.md+4 -0
| @@ -40,6 +40,8 @@ transfer to extract the received time (if any). |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -66,6 +68,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_FNMATCH_DATA.md+4 -0
| @@ -34,6 +34,8 @@ the CURLOPT_FNMATCH_FUNCTION(3). |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -70,6 +72,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_FNMATCH_FUNCTION.md+4 -0
| @@ -45,6 +45,8 @@ error occurred. |
| |
| NULL == an internal function for wildcard matching. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -78,6 +80,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_FOLLOWLOCATION.md+4 -0
| @@ -66,6 +66,8 @@ would otherwise select internally. |
| |
| 0, disabled |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -83,6 +85,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_FORBID_REUSE.md+4 -0
| @@ -40,6 +40,8 @@ Set to 0 to have libcurl keep the connection open for possible later reuse |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -59,6 +61,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_FRESH_CONNECT.md+4 -0
| @@ -42,6 +42,8 @@ Set *fresh* to 0 to have libcurl attempt reusing an existing connection |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -58,6 +60,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_FTPPORT.md+4 -0
| @@ -71,6 +71,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -88,6 +90,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_FTPSSLAUTH.md+4 -0
| @@ -48,6 +48,8 @@ Try "AUTH TLS" first, and only if that fails try "AUTH SSL". |
| |
| CURLFTPAUTH_DEFAULT |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -66,6 +68,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_FTP_ACCOUNT.md+4 -0
| @@ -37,6 +37,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -56,6 +58,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_FTP_ALTERNATIVE_TO_USER.md+4 -0
| @@ -42,6 +42,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -59,6 +61,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_FTP_CREATE_MISSING_DIRS.md+4 -0
| @@ -56,6 +56,8 @@ but then another connection does **MKD** before this connection and thus |
| |
| CURLFTP_CREATE_DIR_NONE (0) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -76,6 +78,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if the |
docs/libcurl/opts/CURLOPT_FTP_FILEMETHOD.md+4 -0
| @@ -57,6 +57,8 @@ compliant than 'nocwd' but without the full penalty of 'multicwd'. |
| |
| CURLFTPMETHOD_MULTICWD |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -76,6 +78,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_FTP_SKIP_PASV_IP.md+4 -0
| @@ -43,6 +43,8 @@ This option has no effect if PORT, EPRT or EPSV is used instead of PASV. |
| |
| 1 since 7.74.0, was 0 before then. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,6 +64,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_FTP_SSL_CCC.md+4 -0
| @@ -50,6 +50,8 @@ Initiate the shutdown and wait for a reply. |
| |
| CURLFTPSSL_CCC_NONE |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -68,6 +70,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_FTP_USE_EPRT.md+4 -0
| @@ -42,6 +42,8 @@ then. |
| |
| # DEFAULT |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_FTP_USE_EPSV.md+4 -0
| @@ -42,6 +42,8 @@ If the server is an IPv6 host, this option has no effect. |
| |
| 1 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if FTP is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_FTP_USE_PRET.md+4 -0
| @@ -35,6 +35,8 @@ no effect when using the active FTP transfers mode. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -56,6 +58,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_GSSAPI_DELEGATION.md+4 -0
| @@ -38,6 +38,8 @@ available at compile-time. |
| |
| CURLGSSAPI_DELEGATION_NONE |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -55,6 +57,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS.md+4 -0
| @@ -43,6 +43,8 @@ currently defaults to 200 ms. Firefox and Chrome currently default to 300 ms. |
| |
| CURL_HET_DEFAULT (currently defined as 200L) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,6 +63,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_HAPROXYPROTOCOL.md+4 -0
| @@ -39,6 +39,8 @@ Most applications do not need this option. |
| |
| 0, do not send any HAProxy PROXY protocol header |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -54,6 +56,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_HAPROXY_CLIENT_IP.md+4 -0
| @@ -38,6 +38,8 @@ cannot use a specified address. |
| |
| NULL, no HAProxy header is sent |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -53,6 +55,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_HEADER.md+4 -0
| @@ -54,6 +54,8 @@ custom HTTP headers! |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -70,6 +72,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_HEADERDATA.md+4 -0
| @@ -44,6 +44,8 @@ this option or you might experience crashes. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -79,6 +81,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_HEADERFUNCTION.md+4 -0
| @@ -101,6 +101,8 @@ although strictly they are just continuations of the previous lines. |
| |
| Nothing. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -125,6 +127,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_HEADEROPT.md+4 -0
| @@ -45,6 +45,8 @@ proxy and then CURLOPT_HTTPHEADER(3) headers only to the server. |
| |
| CURLHEADER_SEPARATE (changed in 7.42.1, used CURLHEADER_UNIFIED before then) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -71,6 +73,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_HSTS.md+4 -0
| @@ -60,6 +60,8 @@ currently no length or size limit. |
| |
| NULL, no filename |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -73,6 +75,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_HSTSREADDATA.md+4 -0
| @@ -39,6 +39,8 @@ do that. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,6 +64,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| This returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_HSTSREADFUNCTION.md+4 -0
| @@ -64,6 +64,8 @@ do that. |
| |
| NULL - no callback. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -96,6 +98,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| This returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_HSTSWRITEDATA.md+4 -0
| @@ -39,6 +39,8 @@ do that. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,6 +64,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| This returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_HSTSWRITEFUNCTION.md+4 -0
| @@ -68,6 +68,8 @@ do that. |
| |
| NULL - no callback. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -100,6 +102,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| This returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_HSTS_CTRL.md+5 -1
| @@ -53,7 +53,9 @@ to the file when closing the handle. |
| |
| # DEFAULT |
| |
| - | 0. HSTS is disabled by default. |
| + | 0 |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -68,6 +70,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_HTTP09_ALLOWED.md+11 -3
| @@ -34,10 +34,9 @@ that curl might consider to be HTTP/0.9! |
| |
| # DEFAULT |
| |
| - | curl allowed HTTP/0.9 responses by default before 7.66.0 |
| + | 0 |
| |
| - | Since 7.66.0, libcurl requires this option set to 1L to allow HTTP/0.9 |
| - | responses. |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -54,6 +53,15 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # HISTORY |
| + | |
| + | curl allowed HTTP/0.9 responses by default before 7.66.0 |
| + | |
| + | Since 7.66.0, libcurl requires this option set to 1L to allow HTTP/0.9 |
| + | responses. |
| + | |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_HTTP200ALIASES.md+4 -0
| @@ -45,6 +45,8 @@ assumed to match HTTP 1.0 when an alias match. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_HTTPAUTH.md+5 -1
| @@ -126,6 +126,8 @@ see CURLOPT_AWS_SIGV4(3). |
| |
| CURLAUTH_BASIC |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -143,7 +145,7 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| CURLAUTH_DIGEST_IE was added in 7.19.3 |
| |
| @@ -155,6 +157,8 @@ CURLAUTH_BEARER was added in 7.61.0 |
| |
| CURLAUTH_AWS_SIGV4 was added in 7.74.0 |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_HTTPGET.md+4 -0
| @@ -43,6 +43,8 @@ reset a handle to default method, consider curl_easy_reset(3). |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,6 +63,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_HTTPHEADER.md+5 -1
| @@ -151,6 +151,8 @@ with the CURLOPT_UNRESTRICTED_AUTH(3) option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -175,10 +177,12 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| Use for MIME mail added in 7.56.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_HTTPPOST.md+4 -0
| @@ -50,6 +50,8 @@ CURLOPT_NOBODY(3) to 0. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -94,6 +96,8 @@ int main(void) |
| |
| Deprecated in 7.56.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_HTTPPROXYTUNNEL.md+4 -0
| @@ -50,6 +50,8 @@ rarely works through the proxy anyway). |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_HTTP_CONTENT_DECODING.md+4 -0
| @@ -37,6 +37,8 @@ CURLOPT_ACCEPT_ENCODING(3) for that. |
| |
| 1 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -52,6 +54,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_HTTP_TRANSFER_DECODING.md+4 -0
| @@ -40,6 +40,8 @@ decoding enabled. |
| |
| 1 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -55,6 +57,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_HTTP_VERSION.md+4 -0
| @@ -90,6 +90,8 @@ Since curl 7.62.0: CURL_HTTP_VERSION_2TLS |
| |
| Before that: CURL_HTTP_VERSION_1_1 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -109,6 +111,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_IGNORE_CONTENT_LENGTH.md+10 -2
| @@ -46,6 +46,8 @@ Only use this option if strictly necessary. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,10 +65,16 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # HISTORY |
| + | |
| + | Support for FTP added in 7.46.0. |
| + | |
| # NOTES |
| |
| - | Support for FTP added in 7.46.0. This option is not working for HTTP when |
| - | libcurl is built to use the hyper backend. |
| + | This option is not working for HTTP when libcurl is built to use the hyper |
| + | backend. |
| + | |
| + | # %AVAILABILITY% |
| |
| # RETURN VALUE |
| |
docs/libcurl/opts/CURLOPT_INFILESIZE.md+5 -1
| @@ -51,6 +51,8 @@ and sending a different amount may lead to errors. |
| |
| Unset |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -75,10 +77,12 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| SMTP support added in 7.23.0 |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_INFILESIZE_LARGE.md+5 -1
| @@ -48,6 +48,8 @@ and sending a different amount may lead to errors. |
| |
| Unset |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -71,10 +73,12 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| SMTP support added in 7.23.0 |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_INTERFACE.md+5 -1
| @@ -55,6 +55,8 @@ option. |
| |
| NULL, use whatever the TCP stack finds suitable |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -74,12 +76,14 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| The `if!` and `host!` syntax was added in 7.24.0. |
| |
| The `ifhost!` syntax was added in 8.9.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK on success or |
docs/libcurl/opts/CURLOPT_INTERLEAVEDATA.md+4 -0
| @@ -35,6 +35,8 @@ anywhere. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,6 +64,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_INTERLEAVEFUNCTION.md+4 -0
| @@ -66,6 +66,8 @@ You can also abort the transfer by returning CURL_WRITEFUNC_ERROR. (7.87.0) |
| NULL, the interleave data is then passed to the regular write function: |
| CURLOPT_WRITEFUNCTION(3). |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -92,6 +94,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_IOCTLDATA.md+5 -1
| @@ -31,7 +31,9 @@ argument in the ioctl callback set with CURLOPT_IOCTLFUNCTION(3). |
| |
| # DEFAULT |
| |
| - | By default, the value of this parameter is NULL. |
| + | NULL |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -66,6 +68,8 @@ int main(void) |
| |
| Deprecated since 7.18.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_IOCTLFUNCTION.md+5 -1
| @@ -62,7 +62,9 @@ parameter is ignored when seeking. |
| |
| # DEFAULT |
| |
| - | By default, this parameter is set to NULL. Not used. |
| + | NULL |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -97,6 +99,8 @@ int main(void) |
| |
| Deprecated since 7.18.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_IPRESOLVE.md+4 -0
| @@ -53,6 +53,8 @@ Uses only IPv6 addresses. |
| |
| CURL_IPRESOLVE_WHATEVER |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -73,6 +75,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_ISSUERCERT.md+4 -0
| @@ -53,6 +53,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -69,6 +71,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_ISSUERCERT_BLOB.md+4 -0
| @@ -59,6 +59,8 @@ expects a filename as input. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -83,6 +85,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_KEEP_SENDING_ON_ERROR.md+4 -0
| @@ -42,6 +42,8 @@ Most applications do not need this option. |
| |
| 0, stop sending on error |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -58,6 +60,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_KEYPASSWD.md+5 -1
| @@ -43,6 +43,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,11 +63,13 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| This option was known as CURLOPT_SSLKEYPASSWD up to 7.16.4 and |
| CURLOPT_SSLCERTPASSWD up to 7.9.2. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_KRBLEVEL.md+5 -1
| @@ -39,6 +39,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -55,10 +57,12 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| This option was known as CURLOPT_KRB4LEVEL up to 7.16.3 |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_LOCALPORT.md+4 -0
| @@ -36,6 +36,8 @@ this option is set. Valid port numbers are 1 - 65535. |
| |
| 0, disabled - use whatever the system thinks is fine |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -54,6 +56,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_LOCALPORTRANGE.md+4 -0
| @@ -39,6 +39,8 @@ setup failures. |
| |
| 1 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -57,6 +59,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_LOGIN_OPTIONS.md+5 -1
| @@ -52,6 +52,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -68,10 +70,12 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| Support for OpenLDAP added in 7.82.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_LOW_SPEED_LIMIT.md+4 -0
| @@ -38,6 +38,8 @@ slow and abort. |
| |
| 0, disabled |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -60,6 +62,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_LOW_SPEED_TIME.md+4 -0
| @@ -35,6 +35,8 @@ library to consider it too slow and abort. |
| |
| 0, disabled |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -57,6 +59,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_MAIL_AUTH.md+4 -0
| @@ -49,6 +49,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_MAIL_FROM.md+4 -0
| @@ -42,6 +42,8 @@ option. |
| |
| blank |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -58,6 +60,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_MAIL_RCPT.md+4 -0
| @@ -49,6 +49,8 @@ should be specified using the mailing list name, such as `Friends` or |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -69,6 +71,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_MAIL_RCPT_ALLOWFAILS.md+4 -0
| @@ -45,6 +45,8 @@ RCPT TO command. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -74,6 +76,8 @@ int main(void) |
| This option was called CURLOPT_MAIL_RCPT_ALLLOWFAILS (with three instead of |
| two letter L) before 8.2.0 |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_MAXAGE_CONN.md+5 -1
| @@ -42,7 +42,9 @@ cache that is older than this set *age*, it is closed instead. |
| |
| # DEFAULT |
| |
| - | Default maximum age is set to 118 seconds. |
| + | 118 seconds |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -61,6 +63,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_MAXCONNECTS.md+4 -0
| @@ -49,6 +49,8 @@ CURLMOPT_MAXCONNECTS(3) option. |
| |
| 5 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_MAXFILESIZE.md+4 -0
| @@ -45,6 +45,8 @@ threshold. |
| |
| 0, meaning disabled. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,6 +63,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the size passed is valid or CURLE_BAD_FUNCTION_ARGUMENT if |
docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.md+4 -0
| @@ -46,6 +46,8 @@ threshold. |
| |
| 0, meaning disabled. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_MAXLIFETIME_CONN.md+5 -1
| @@ -44,7 +44,9 @@ If set to 0, this behavior is disabled: all connections are eligible for reuse. |
| |
| # DEFAULT |
| |
| - | Default *maxlifetime* is 0 seconds (i.e., disabled). |
| + | 0 seconds (i.e., disabled) |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -63,6 +65,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_MAXREDIRS.md+4 -0
| @@ -41,6 +41,8 @@ to get stuck in never-ending redirect loops. |
| |
| 30 (since 8.3.0), it was previously unlimited. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,6 +64,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_MAX_RECV_SPEED_LARGE.md+4 -0
| @@ -44,6 +44,8 @@ This option does not affect transfer speeds done with FILE:// URLs. |
| |
| 0, disabled |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -60,6 +62,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_MAX_SEND_SPEED_LARGE.md+4 -0
| @@ -45,6 +45,8 @@ This option does not affect transfer speeds done with FILE:// URLs. |
| |
| 0, disabled |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,6 +64,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_MIMEPOST.md+4 -0
| @@ -44,6 +44,8 @@ When setting CURLOPT_MIMEPOST(3) to NULL, libcurl resets the request |
| type for HTTP to the default to disable the POST. Typically that would mean it |
| is reset to GET. Instead you should set a desired request method explicitly. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -73,6 +75,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| This returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_MIME_OPTIONS.md+4 -0
| @@ -57,6 +57,8 @@ containing multipart form is sent, this is normally transmitted as |
| |
| 0, meaning disabled. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -89,6 +91,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_NETRC.md+4 -0
| @@ -118,6 +118,8 @@ done with "macdef" that it finds. |
| |
| CURL_NETRC_IGNORED |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -133,6 +135,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_NETRC_FILE.md+4 -0
| @@ -39,6 +39,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -55,6 +57,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_NEW_DIRECTORY_PERMS.md+4 -0
| @@ -39,6 +39,8 @@ this are *sftp://*, *scp://*, and *file://*. |
| |
| 0755 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -56,6 +58,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_NEW_FILE_PERMS.md+4 -0
| @@ -37,6 +37,8 @@ The only protocols that can use this are *sftp://*, *scp://*, and *file://*. |
| |
| 0644 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -52,6 +54,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_NOBODY.md+4 -0
| @@ -50,6 +50,8 @@ URL you request). |
| |
| 0, the body is transferred |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -68,6 +70,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_NOPROGRESS.md+4 -0
| @@ -37,6 +37,8 @@ getting called. |
| |
| 1, meaning it normally runs without a progress meter. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -55,6 +57,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_NOPROXY.md+4 -0
| @@ -61,6 +61,8 @@ the same way. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -79,6 +81,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_NOSIGNAL.md+4 -0
| @@ -47,6 +47,8 @@ corner cases when they may still happen, contrary to our desire. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -66,6 +68,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_OPENSOCKETDATA.md+5 -1
| @@ -33,7 +33,9 @@ CURLOPT_OPENSOCKETFUNCTION(3). |
| |
| # DEFAULT |
| |
| - | The default value of this parameter is NULL. |
| + | NULL |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -82,6 +84,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_OPENSOCKETFUNCTION.md+5 -1
| @@ -71,11 +71,13 @@ CURLOPT_SOCKOPTFUNCTION(3) to signal that it already is connected. |
| |
| # DEFAULT |
| |
| - | The default behavior is the equivalent of this: |
| + | The equivalent of this: |
| ~~~c |
| return socket(addr->family, addr->socktype, addr->protocol); |
| ~~~ |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -122,6 +124,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_PASSWORD.md+4 -0
| @@ -41,6 +41,8 @@ option. |
| |
| blank |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -60,6 +62,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PATH_AS_IS.md+4 -0
| @@ -48,6 +48,8 @@ The corresponding flag for the curl_url_set(3) function is called |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_PINNEDPUBLICKEY.md+5 -1
| @@ -58,6 +58,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -117,7 +119,7 @@ footer: |
| -----END PUBLIC KEY----- |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| ## PEM/DER support |
| |
| @@ -143,6 +145,8 @@ footer: |
| |
| Other SSL backends not supported. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PIPEWAIT.md+4 -0
| @@ -53,6 +53,8 @@ and support level. |
| |
| 0 (off) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -68,6 +70,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_PORT.md+6 -2
| @@ -43,8 +43,10 @@ and therefore using a port number lower than zero or over 65535 causes a |
| |
| # DEFAULT |
| |
| - | By default this is 0 which makes it not used. This also makes port number zero |
| - | impossible to set with this API. |
| + | 0 which makes it not used. This also makes port number zero impossible to set |
| + | with this API. |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -62,6 +64,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_POST.md+4 -0
| @@ -72,6 +72,8 @@ you should set a new request type explicitly as described above. |
| |
| 0, disabled |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -92,6 +94,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_POSTFIELDS.md+4 -0
| @@ -74,6 +74,8 @@ CURLOPT_MIMEPOST(3) option combined with curl_mime_init(3). |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -116,6 +118,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_POSTFIELDSIZE.md+4 -0
| @@ -38,6 +38,8 @@ If you post more than 2GB, use CURLOPT_POSTFIELDSIZE_LARGE(3). |
| |
| -1 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,6 +63,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_POSTFIELDSIZE_LARGE.md+4 -0
| @@ -38,6 +38,8 @@ CURLOPT_READFUNCTION(3) (if used) to signal the end of data. |
| |
| -1 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,6 +64,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_POSTQUOTE.md+4 -0
| @@ -39,6 +39,8 @@ Disable this operation again by setting a NULL to this option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_POSTREDIR.md+4 -0
| @@ -49,6 +49,8 @@ when setting CURLOPT_FOLLOWLOCATION(3). |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -75,6 +77,8 @@ int main(void) |
| 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. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_PREQUOTE.md+4 -0
| @@ -43,6 +43,8 @@ this option does not. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -66,6 +68,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_PREREQDATA.md+4 -0
| @@ -34,6 +34,8 @@ argument in the pre-request callback set with CURLOPT_PREREQFUNCTION(3). |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_PREREQFUNCTION.md+5 -1
| @@ -84,7 +84,9 @@ The pointer you set with CURLOPT_PREREQDATA(3). |
| |
| # DEFAULT |
| |
| - | By default, this is NULL and unused. |
| + | NULL |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -115,6 +117,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_PRE_PROXY.md+7 -3
| @@ -48,15 +48,17 @@ be used. Otherwise SOCKS4 is used as default. |
| Setting the pre proxy string to "" (an empty string) explicitly disables the |
| use of a pre proxy. |
| |
| + | When you set a hostname to use, do not assume that there is any particular |
| + | single port number used widely for proxies. Specify it. |
| + | |
| The application does not have to keep the string around after setting this |
| option. |
| |
| # DEFAULT |
| |
| - | Default is NULL, meaning no pre proxy is used. |
| + | NULL |
| |
| - | When you set a hostname to use, do not assume that there is any particular |
| - | single port number used widely for proxies. Specify it! |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -73,6 +75,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if proxies are supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PRIVATE.md+4 -0
| @@ -36,6 +36,8 @@ never does anything with this data. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,6 +64,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_PROGRESSDATA.md+5 -1
| @@ -31,7 +31,9 @@ argument in the progress callback set with CURLOPT_PROGRESSFUNCTION(3). |
| |
| # DEFAULT |
| |
| - | The default value of this parameter is NULL. |
| + | NULL |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -70,6 +72,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_PROGRESSFUNCTION.md+5 -2
| @@ -75,8 +75,9 @@ get called. |
| |
| # DEFAULT |
| |
| - | By default, libcurl has an internal progress meter. That is rarely wanted by |
| - | users. |
| + | NULL. libcurl has an internal progress meter. That is rarely wanted by users. |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -119,6 +120,8 @@ int main(void) |
| |
| Deprecated since 7.32.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_PROTOCOLS.md+4 -0
| @@ -74,6 +74,8 @@ CURLPROTO_TFTP |
| |
| All protocols built-in. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -98,6 +100,8 @@ int main(int argc, char **argv) |
| |
| Deprecated since 7.85.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_PROTOCOLS_STR.md+4 -0
| @@ -57,6 +57,8 @@ way to figure out the protocol used in a previous transfer. |
| |
| All protocols built-in |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -76,6 +78,8 @@ int main(int argc, char **argv) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_UNKNOWN_OPTION if the option is not implemented, |
docs/libcurl/opts/CURLOPT_PROXY.md+8 -4
| @@ -90,6 +90,9 @@ user + password. |
| Unix domain sockets are supported for socks proxies since 7.84.0. Set |
| localhost for the host part. e.g. socks5h://localhost/path/to/socket.sock |
| |
| + | When you set a hostname to use, do not assume that there is any particular |
| + | single port number used widely for proxies. Specify it. |
| + | |
| When a proxy is used, the active FTP mode as set with *CUROPT_FTPPORT(3)*, |
| cannot be used. |
| |
| @@ -108,10 +111,9 @@ variables. |
| |
| # DEFAULT |
| |
| - | Default is NULL, meaning no proxy is used. |
| + | NULL |
| |
| - | When you set a hostname to use, do not assume that there is any particular |
| - | single port number used widely for proxies. Specify it! |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -127,7 +129,7 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| Since 7.14.1 the proxy environment variable names can include the protocol |
| scheme. |
| @@ -137,6 +139,8 @@ Since 7.21.7 the proxy string supports the socks protocols as "schemes". |
| Since 7.50.2, unsupported schemes in proxy strings cause libcurl to return |
| error. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if proxies are supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXYAUTH.md+4 -0
| @@ -44,6 +44,8 @@ CURLOPT_HTTPAUTH(3) man page. |
| |
| CURLAUTH_BASIC |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXYHEADER.md+4 -0
| @@ -45,6 +45,8 @@ Pass a NULL to this to reset back to no custom headers. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -70,6 +72,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_PROXYPASSWORD.md+4 -0
| @@ -41,6 +41,8 @@ option. |
| |
| blank |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -59,6 +61,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXYPORT.md+11 -3
| @@ -31,15 +31,21 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYPORT, long port); |
| We discourage use of this option. |
| |
| Pass a long with this option to set the proxy port to connect to unless it is |
| - | specified in the proxy string CURLOPT_PROXY(3) or uses 443 for https |
| - | proxies and 1080 for all others as default. |
| + | specified in the proxy string CURLOPT_PROXY(3) or uses 443 for https proxies |
| + | and 1080 for all others as default. |
| + | |
| + | Disabling this option, setting it to zero, makes it not specified which makes |
| + | libcurl use the default proxy port number or the port number specified in the |
| + | proxy URL string. |
| |
| While this accepts a 'long', the port number is 16 bit so it cannot be larger |
| than 65535. |
| |
| # DEFAULT |
| |
| - | 0, not specified which makes it use the default port |
| + | 0 |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -58,6 +64,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_PROXYTYPE.md+4 -0
| @@ -73,6 +73,8 @@ the CURLOPT_PROXY(3) string. |
| |
| CURLPROXY_HTTP |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -91,6 +93,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_PROXYUSERNAME.md+4 -0
| @@ -44,6 +44,8 @@ option. |
| |
| blank |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,6 +64,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXYUSERPWD.md+5 -1
| @@ -41,7 +41,9 @@ option. |
| |
| # DEFAULT |
| |
| - | This is NULL by default. |
| + | NULL |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -60,6 +62,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if proxies are supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXY_CAINFO.md+4 -0
| @@ -62,6 +62,8 @@ The default value for this can be figured out with CURLINFO_CAINFO(3). |
| |
| Built-in system specific |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -86,6 +88,8 @@ For TLS backends that do not support certificate files, the |
| CURLOPT_PROXY_CAINFO(3) option is ignored. Refer to |
| https://curl.se/docs/ssl-compared.html |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXY_CAINFO_BLOB.md+4 -0
| @@ -58,6 +58,8 @@ This option overrides CURLOPT_PROXY_CAINFO(3). |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -83,6 +85,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXY_CAPATH.md+4 -0
| @@ -48,6 +48,8 @@ The default value for this can be figured out with CURLINFO_CAPATH(3). |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -66,6 +68,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK if supported; or an error such as: |
docs/libcurl/opts/CURLOPT_PROXY_CRLFILE.md+4 -0
| @@ -59,6 +59,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -76,6 +78,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXY_ISSUERCERT.md+4 -0
| @@ -56,6 +56,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -74,6 +76,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXY_ISSUERCERT_BLOB.md+4 -0
| @@ -60,6 +60,8 @@ instead expects a filename as input. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -86,6 +88,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXY_KEYPASSWD.md+4 -0
| @@ -47,6 +47,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -64,6 +66,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXY_PINNEDPUBLICKEY.md+5 -1
| @@ -54,6 +54,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -110,7 +112,7 @@ footer: |
| -----END PUBLIC KEY----- |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| PEM/DER support: |
| |
| @@ -122,6 +124,8 @@ sha256 support: |
| |
| Other SSL backends not supported. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXY_SERVICE_NAME.md+4 -0
| @@ -39,6 +39,8 @@ option. |
| |
| See above |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -54,6 +56,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXY_SSLCERT.md+4 -0
| @@ -56,6 +56,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -75,6 +77,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXY_SSLCERTTYPE.md+4 -0
| @@ -49,6 +49,8 @@ option. |
| |
| "PEM" |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -69,6 +71,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXY_SSLCERT_BLOB.md+4 -0
| @@ -50,6 +50,8 @@ expects a filename as input. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -77,6 +79,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXY_SSLKEY.md+4 -0
| @@ -50,6 +50,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -69,6 +71,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXY_SSLKEYTYPE.md+4 -0
| @@ -39,6 +39,8 @@ the format of your private key. Supported formats are "PEM", "DER" and "ENG". |
| The application does not have to keep the string around after setting this |
| option. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -59,6 +61,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXY_SSLKEY_BLOB.md+4 -0
| @@ -43,6 +43,8 @@ setting this. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -77,6 +79,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXY_SSLVERSION.md+4 -0
| @@ -104,6 +104,8 @@ inconsistent depending on the TLS library. |
| |
| CURL_SSLVERSION_DEFAULT |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -122,6 +124,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_PROXY_SSL_CIPHER_LIST.md+5 -1
| @@ -68,7 +68,9 @@ option. |
| |
| # DEFAULT |
| |
| - | NULL, use internal default |
| + | NULL, use internal built-in list. |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -87,6 +89,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXY_SSL_OPTIONS.md+4 -0
| @@ -92,6 +92,8 @@ could be a privacy violation and unexpected. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -111,6 +113,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_PROXY_SSL_VERIFYHOST.md+4 -0
| @@ -65,6 +65,8 @@ of the proxy certificate. |
| |
| 2 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -82,6 +84,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_PROXY_SSL_VERIFYPEER.md+4 -0
| @@ -67,6 +67,8 @@ the correct end-point. |
| |
| 1 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -84,6 +86,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_PROXY_TLS13_CIPHERS.md+5 -1
| @@ -51,7 +51,9 @@ option. |
| |
| # DEFAULT |
| |
| - | NULL, use internal default |
| + | NULL, use internal built-in list |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -70,6 +72,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if supported, CURLE_NOT_BUILT_IN otherwise. |
docs/libcurl/opts/CURLOPT_PROXY_TLSAUTH_PASSWORD.md+4 -0
| @@ -44,6 +44,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXY_TLSAUTH_TYPE.md+4 -0
| @@ -48,6 +48,8 @@ options. |
| |
| blank |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -67,6 +69,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_PROXY_TLSAUTH_USERNAME.md+4 -0
| @@ -44,6 +44,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_PROXY_TRANSFER_MODE.md+4 -0
| @@ -39,6 +39,8 @@ doing FTP via a proxy. Beware that not all proxies support this feature. |
| |
| 0, disabled |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -58,6 +60,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if the |
docs/libcurl/opts/CURLOPT_PUT.md+4 -0
| @@ -38,6 +38,8 @@ This option is **deprecated** since version 7.12.1. Use CURLOPT_UPLOAD(3). |
| |
| 0, disabled |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -83,6 +85,8 @@ int main(void) |
| |
| Deprecated since 7.12.1. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_QUICK_EXIT.md+4 -0
| @@ -38,6 +38,8 @@ possible (though short-lived) leak of associated resources. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -52,6 +54,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_QUOTE.md+5 -1
| @@ -128,6 +128,8 @@ See ln. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -152,10 +154,12 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| SFTP support added in 7.16.3. *-prefix for SFTP added in 7.24.0 |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_RANDOM_FILE.md+2 -0
| @@ -37,6 +37,8 @@ NULL, not used |
| |
| Deprecated since 7.84.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_RANGE.md+5 -1
| @@ -59,6 +59,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -77,10 +79,12 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| FILE since 7.18.0, RTSP since 7.20.0 |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK on success or |
docs/libcurl/opts/CURLOPT_READDATA.md+6 -2
| @@ -41,7 +41,9 @@ might experience crashes. |
| |
| # DEFAULT |
| |
| - | By default, this is a FILE * to stdin. |
| + | stdin |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -66,11 +68,13 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| This option was once known by the older name CURLOPT_INFILE, the name |
| CURLOPT_READDATA(3) was introduced in 7.9.7. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| This returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_READFUNCTION.md+6 -2
| @@ -73,7 +73,9 @@ and it allows for better error checking. |
| |
| # DEFAULT |
| |
| - | The default internal read callback is fread(). |
| + | fread(3) |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -112,11 +114,13 @@ int main(int argc, char **argv) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| CURL_READFUNC_PAUSE return code was added in 7.18.0 and CURL_READFUNC_ABORT |
| was added in 7.12.1. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| This returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_REDIR_PROTOCOLS.md+4 -0
| @@ -84,6 +84,8 @@ HTTP, HTTPS, FTP and FTPS (Added in 7.65.2). |
| Older versions defaulted to all protocols except FILE, SCP and since 7.40.0 |
| SMB and SMBS. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -108,6 +110,8 @@ int main(int argc, char **argv) |
| |
| Deprecated since 7.85.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_REDIR_PROTOCOLS_STR.md+4 -0
| @@ -63,6 +63,8 @@ HTTP, HTTPS, FTP and FTPS (Added in 7.65.2). |
| Older versions defaulted to all protocols except FILE, SCP and since 7.40.0 |
| SMB and SMBS. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -82,6 +84,8 @@ int main(int argc, char **argv) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_UNKNOWN_OPTION if the option is not implemented, |
docs/libcurl/opts/CURLOPT_REFERER.md+4 -0
| @@ -39,6 +39,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -56,6 +58,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP support is enabled, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_REQUEST_TARGET.md+4 -0
| @@ -38,6 +38,8 @@ other safe guards. That includes white space and control characters. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -57,6 +59,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_RESOLVE.md+5 -1
| @@ -78,6 +78,8 @@ number must exactly match what was added previously. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -102,7 +104,7 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| Added in 7.21.3. Removal support added in 7.42.0. |
| |
| @@ -113,6 +115,8 @@ Support for providing multiple IP addresses per entry was added in 7.59.0. |
| Support for adding non-permanent entries by using the "+" prefix was added in |
| 7.75.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_RESOLVER_START_DATA.md+4 -0
| @@ -35,6 +35,8 @@ CURLOPT_RESOLVER_START_FUNCTION(3). |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -60,6 +62,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_RESOLVER_START_FUNCTION.md+4 -0
| @@ -53,6 +53,8 @@ resolve to fail. |
| |
| NULL (No callback) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -78,6 +80,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_RESUME_FROM.md+4 -0
| @@ -44,6 +44,8 @@ CURLOPT_RESUME_FROM_LARGE(3) instead. |
| |
| 0, not used |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -70,6 +72,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_RESUME_FROM_LARGE.md+4 -0
| @@ -42,6 +42,8 @@ file to the remote target file. |
| |
| 0, not used |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -69,6 +71,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_RTSP_CLIENT_CSEQ.md+4 -0
| @@ -36,6 +36,8 @@ increments from this new number henceforth. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -52,6 +54,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_RTSP_REQUEST.md+4 -0
| @@ -112,6 +112,8 @@ application a chance to run. |
| |
| # DEFAULT |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -129,6 +131,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_RTSP_SERVER_CSEQ.md+4 -0
| @@ -35,6 +35,8 @@ unimplemented. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -51,6 +53,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_RTSP_SESSION_ID.md+4 -0
| @@ -40,6 +40,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -57,6 +59,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_RTSP_STREAM_URI.md+4 -0
| @@ -44,6 +44,8 @@ option. |
| |
| "*" |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,6 +63,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_RTSP_TRANSPORT.md+4 -0
| @@ -39,6 +39,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -57,6 +59,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_SASL_AUTHZID.md+4 -0
| @@ -44,6 +44,8 @@ access to, or a shared mailbox for example. |
| |
| blank |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,6 +64,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SASL_IR.md+4 -0
| @@ -47,6 +47,8 @@ SASL-IR CAPABILITY. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SEEKDATA.md+4 -0
| @@ -35,6 +35,8 @@ CURLOPT_SEEKFUNCTION(3) option, this is the pointer you get as input. |
| |
| If you do not set this, NULL is passed to the callback. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,4 +64,6 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
docs/libcurl/opts/CURLOPT_SEEKFUNCTION.md+5 -1
| @@ -64,7 +64,9 @@ many systems! |
| |
| # DEFAULT |
| |
| - | By default, this is NULL and unused. |
| + | NULL |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -92,6 +94,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SERVER_RESPONSE_TIMEOUT.md+4 -0
| @@ -47,6 +47,8 @@ This option was formerly known as CURLOPT_FTP_RESPONSE_TIMEOUT. |
| |
| None |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if supported, and CURLE_UNKNOWN_OPTION if not. Returns |
docs/libcurl/opts/CURLOPT_SERVER_RESPONSE_TIMEOUT_MS.md+4 -0
| @@ -49,6 +49,8 @@ This is the millisecond version of CURLOPT_SERVER_RESPONSE_TIMEOUT(3). |
| |
| None |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -67,6 +69,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if supported, and CURLE_UNKNOWN_OPTION if not. Returns |
docs/libcurl/opts/CURLOPT_SERVICE_NAME.md+4 -0
| @@ -44,6 +44,8 @@ option. |
| |
| See above |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -59,6 +61,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_SHARE.md+4 -0
| @@ -48,6 +48,8 @@ Set this option to NULL again to stop using that share object. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -78,6 +80,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_SOCKOPTDATA.md+5 -1
| @@ -31,7 +31,9 @@ argument in the sockopt callback set with CURLOPT_SOCKOPTFUNCTION(3). |
| |
| # DEFAULT |
| |
| - | The default value of this parameter is NULL. |
| + | NULL |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns *CURLE_OK* if the option is supported, and *CURLE_UNKNOWN_OPTION* if not. |
docs/libcurl/opts/CURLOPT_SOCKOPTFUNCTION.md+5 -1
| @@ -73,7 +73,9 @@ not attempt to connect (again). |
| |
| # DEFAULT |
| |
| - | By default, this callback is NULL and unused. |
| + | NULL |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -121,6 +123,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SOCKS5_AUTH.md+4 -0
| @@ -37,6 +37,8 @@ password with the CURLOPT_PROXYUSERPWD(3) option. |
| |
| CURLAUTH_BASIC|CURLAUTH_GSSAPI |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -58,6 +60,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_SOCKS5_GSSAPI_NEC.md+4 -0
| @@ -36,6 +36,8 @@ negotiation. |
| |
| ? |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -53,6 +55,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SOCKS5_GSSAPI_SERVICE.md+4 -0
| @@ -40,6 +40,8 @@ option. |
| |
| See above |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,6 +63,8 @@ int main(void) |
| |
| Deprecated since 7.49.0 |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_SSH_AUTH_TYPES.md+4 -0
| @@ -41,6 +41,8 @@ authentication. |
| |
| CURLSSH_AUTH_ANY (all available) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -58,6 +60,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SSH_COMPRESSION.md+4 -0
| @@ -36,6 +36,8 @@ may or may not do it. |
| |
| 0, disabled |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -54,6 +56,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_SSH_HOSTKEYDATA.md+4 -0
| @@ -33,6 +33,8 @@ the callback set with CURLOPT_SSH_HOSTKEYFUNCTION(3). |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -68,6 +70,8 @@ int main(void) |
| |
| Works only with the libssh2 backend. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SSH_HOSTKEYFUNCTION.md+4 -0
| @@ -59,6 +59,8 @@ the host key is rejected, the connection is canceled. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -93,6 +95,8 @@ int main(void) |
| |
| Work only with the libssh2 backend. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SSH_HOST_PUBLIC_KEY_MD5.md+4 -0
| @@ -44,6 +44,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,6 +63,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256.md+4 -0
| @@ -37,6 +37,8 @@ does not match the hash the remote host provides. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -58,6 +60,8 @@ int main(void) |
| |
| Requires the libssh2 backend. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_SSH_KEYDATA.md+4 -0
| @@ -34,6 +34,8 @@ callback set with CURLOPT_SSH_KEYFUNCTION(3). |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -66,6 +68,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SSH_KEYFUNCTION.md+4 -0
| @@ -110,6 +110,8 @@ up from scratch again. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -143,6 +145,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SSH_KNOWNHOSTS.md+4 -0
| @@ -41,6 +41,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -58,6 +60,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_SSH_PRIVATE_KEYFILE.md+4 -0
| @@ -48,6 +48,8 @@ option. |
| |
| As explained above |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -66,6 +68,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_SSH_PUBLIC_KEYFILE.md+5 -1
| @@ -44,6 +44,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,10 +63,12 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| The "" trick was added in 7.26.0 |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_SSLCERT.md+4 -0
| @@ -66,6 +66,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -84,6 +86,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_SSLCERTTYPE.md+4 -0
| @@ -48,6 +48,8 @@ option. |
| |
| "PEM" |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -67,6 +69,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_SSLCERT_BLOB.md+4 -0
| @@ -50,6 +50,8 @@ expects a filename as input. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -76,6 +78,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_SSLENGINE.md+4 -0
| @@ -39,6 +39,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -55,6 +57,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK - Engine found. |
docs/libcurl/opts/CURLOPT_SSLENGINE_DEFAULT.md+4 -0
| @@ -37,6 +37,8 @@ This option has no effect unless set after CURLOPT_SSLENGINE(3). |
| |
| None |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -54,6 +56,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK - Engine set as default. |
docs/libcurl/opts/CURLOPT_SSLKEY.md+4 -0
| @@ -47,6 +47,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_SSLKEYTYPE.md+4 -0
| @@ -46,6 +46,8 @@ option. |
| |
| "PEM" |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_SSLKEY_BLOB.md+4 -0
| @@ -44,6 +44,8 @@ filename as input. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -78,6 +80,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_SSLVERSION.md+4 -0
| @@ -116,6 +116,8 @@ inconsistent depending on the TLS library. |
| |
| CURL_SSLVERSION_DEFAULT |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -143,6 +145,8 @@ vary depending on which backend libcurl has been built to use. |
| |
| SSLv3 is disabled by default since 7.39.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SSL_CIPHER_LIST.md+6 -2
| @@ -70,7 +70,9 @@ option. |
| |
| # DEFAULT |
| |
| - | NULL, use internal default |
| + | NULL, use built-in list |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -88,10 +90,12 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| Added in 7.9, in 7.83.0 for BearSSL, in 8.8.0 for mbedTLS |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_SSL_CTX_DATA.md+4 -0
| @@ -39,6 +39,8 @@ parameter. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -119,6 +121,8 @@ int main(void) |
| 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. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK if supported; or an error such as: |
docs/libcurl/opts/CURLOPT_SSL_CTX_FUNCTION.md+4 -0
| @@ -83,6 +83,8 @@ completed. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -158,6 +160,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK if supported; or an error such as: |
docs/libcurl/opts/CURLOPT_SSL_EC_CURVES.md+4 -0
| @@ -38,6 +38,8 @@ the SSL backend libcurl is built to use supports it). |
| |
| "", embedded in SSL backend |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -54,6 +56,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SSL_ENABLE_ALPN.md+4 -0
| @@ -36,6 +36,8 @@ is built to use supports it), which can be used to negotiate http2. |
| |
| 1, enabled |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -52,6 +54,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SSL_ENABLE_NPN.md+4 -0
| @@ -38,6 +38,8 @@ is built to use supports it), which can be used to negotiate http2. |
| |
| 1, enabled |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -58,6 +60,8 @@ int main(void) |
| |
| Deprecated since 7.86.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SSL_FALSESTART.md+4 -0
| @@ -38,6 +38,8 @@ when performing a full handshake. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -52,6 +54,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if false start is supported by the SSL backend, otherwise |
docs/libcurl/opts/CURLOPT_SSL_OPTIONS.md+4 -0
| @@ -90,6 +90,8 @@ could be a privacy violation and unexpected. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -108,6 +110,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SSL_SESSIONID_CACHE.md+4 -0
| @@ -41,6 +41,8 @@ wild that may require you to disable this in order for you to succeed. |
| |
| 1 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -58,6 +60,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SSL_VERIFYHOST.md+4 -0
| @@ -87,6 +87,8 @@ may be inaccessible if SNI is not sent. |
| |
| 2 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -104,6 +106,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SSL_VERIFYPEER.md+4 -0
| @@ -73,6 +73,8 @@ malicious servers. |
| |
| 1 - enabled |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -90,6 +92,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SSL_VERIFYSTATUS.md+4 -0
| @@ -42,6 +42,8 @@ extension, the verification fails. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -59,6 +61,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if OCSP stapling is supported by the SSL backend, otherwise |
docs/libcurl/opts/CURLOPT_STDERR.md+4 -0
| @@ -39,6 +39,8 @@ application. A work-around is to instead use CURLOPT_DEBUGFUNCTION(3). |
| |
| stderr |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -55,6 +57,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_STREAM_DEPENDS.md+4 -0
| @@ -48,6 +48,8 @@ option to have an actual effect. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -67,6 +69,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_STREAM_DEPENDS_E.md+4 -0
| @@ -51,6 +51,8 @@ option to have an actual effect. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -70,6 +72,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_STREAM_WEIGHT.md+5 -2
| @@ -48,8 +48,9 @@ streams). |
| |
| # DEFAULT |
| |
| - | If nothing is set, the HTTP/2 protocol itself uses its own default which is |
| - | 16. |
| + | 16 |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -71,6 +72,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_SUPPRESS_CONNECT_HEADERS.md+4 -0
| @@ -71,6 +71,8 @@ Content-Type: application/json |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -93,6 +95,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLE_OK or an error such as CURLE_UNKNOWN_OPTION. |
docs/libcurl/opts/CURLOPT_TCP_FASTOPEN.md+4 -0
| @@ -38,6 +38,8 @@ Fast Open is also known to be problematic on or across certain networks. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -56,6 +58,8 @@ int main(void) |
| |
| This option is only supported on Linux and macOS 10.11 or later. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if fast open is supported by the operating system, otherwise |
docs/libcurl/opts/CURLOPT_TCP_KEEPALIVE.md+4 -0
| @@ -39,6 +39,8 @@ to disable keepalive probes. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_TCP_KEEPCNT.md+4 -0
| @@ -39,6 +39,8 @@ Any larger value is capped to this amount. |
| |
| 9 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_TCP_KEEPIDLE.md+4 -0
| @@ -38,6 +38,8 @@ this amount. |
| |
| 60 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -64,6 +66,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_TCP_KEEPINTVL.md+4 -0
| @@ -37,6 +37,8 @@ this amount. |
| |
| 60 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_TCP_NODELAY.md+4 -0
| @@ -46,6 +46,8 @@ overdone. |
| |
| 1 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| |
| The default was changed to 1 from 0 in 7.50.2. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_TELNETOPTIONS.md+4 -0
| @@ -36,6 +36,8 @@ standard for details. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -56,6 +58,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if TELNET is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_TFTP_BLKSIZE.md+4 -0
| @@ -36,6 +36,8 @@ is used. |
| |
| 512 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -53,6 +55,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_TFTP_NO_OPTIONS.md+4 -0
| @@ -36,6 +36,8 @@ CURLOPT_TFTP_BLKSIZE(3) is ignored. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -68,6 +70,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_TIMECONDITION.md+4 -0
| @@ -40,6 +40,8 @@ option can be used after a transfer to learn if a zero-byte successful |
| |
| CURL_TIMECOND_NONE (0) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,6 +64,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_TIMEOUT.md+5 -1
| @@ -60,7 +60,9 @@ signals to be used unless CURLOPT_NOSIGNAL(3) is set. |
| |
| # DEFAULT |
| |
| - | Default timeout is 0 (zero) which means it never times out during transfer. |
| + | 0 (zero) which means it never times out during transfer. |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -79,6 +81,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK. Returns CURLE_BAD_FUNCTION_ARGUMENT if set to a negative |
docs/libcurl/opts/CURLOPT_TIMEOUT_MS.md+5 -1
| @@ -35,7 +35,9 @@ See CURLOPT_TIMEOUT(3) for details. |
| |
| # DEFAULT |
| |
| - | Default timeout is 0 (zero) which means it never times out during transfer. |
| + | 0 (zero) which means it never times out during transfer. |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -54,6 +56,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_TIMEVALUE.md+4 -0
| @@ -38,6 +38,8 @@ instead. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -59,6 +61,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_TIMEVALUE_LARGE.md+4 -0
| @@ -40,6 +40,8 @@ used to set dates beyond the year 2038. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,6 +63,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_TLS13_CIPHERS.md+6 -2
| @@ -52,7 +52,9 @@ option. |
| |
| # DEFAULT |
| |
| - | NULL, use internal default |
| + | NULL, use internal built-in |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -71,12 +73,14 @@ int main(void) |
| } |
| ~~~ |
| |
| - | # NOTES |
| + | # HISTORY |
| |
| Added in 7.61.0 for OpenSSL. Available when built with OpenSSL \>= 1.1.1. |
| |
| Added in 7.85.0 for Schannel. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if supported, CURLE_NOT_BUILT_IN otherwise. |
docs/libcurl/opts/CURLOPT_TLSAUTH_PASSWORD.md+4 -0
| @@ -44,6 +44,8 @@ This feature relies on TLS SRP which does not work with TLS 1.3. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -62,6 +64,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_TLSAUTH_TYPE.md+4 -0
| @@ -45,6 +45,8 @@ TLS SRP does not work with TLS 1.3. |
| |
| blank |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -63,6 +65,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_TLSAUTH_USERNAME.md+4 -0
| @@ -43,6 +43,8 @@ This feature relies on TLS SRP which does not work with TLS 1.3. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,6 +63,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_TRAILERDATA.md+4 -0
| @@ -32,6 +32,8 @@ Data pointer to be passed to the HTTP trailer callback function. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -49,6 +51,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_TRAILERFUNCTION.md+4 -0
| @@ -60,6 +60,8 @@ without any interruptions. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| ~~~c |
| static int trailer_cb(struct curl_slist **tr, void *data) |
| @@ -101,6 +103,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_TRANSFERTEXT.md+4 -0
| @@ -39,6 +39,8 @@ simply sets the mode to ASCII and performs a standard transfer. |
| |
| 0, disabled |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -55,6 +57,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if FTP is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_TRANSFER_ENCODING.md+4 -0
| @@ -44,6 +44,8 @@ by both HTTP clients and HTTP servers. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -58,6 +60,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_UNIX_SOCKET_PATH.md+5 -1
| @@ -48,7 +48,9 @@ option. |
| |
| # DEFAULT |
| |
| - | Default is NULL, meaning that no Unix domain sockets are used. |
| + | NULL - no Unix domain sockets are used. |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -76,6 +78,8 @@ you can use the proc filesystem to bypass the limitation: |
| /* Be sure to keep dirfd valid until you discard the handle */ |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_UNRESTRICTED_AUTH.md+4 -0
| @@ -53,6 +53,8 @@ again and again as the following hosts can keep redirecting to new hosts. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -68,6 +70,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_UPKEEP_INTERVAL_MS.md+4 -0
| @@ -42,6 +42,8 @@ is called, an HTTP/2 PING frame is sent on the connection. |
| |
| CURL_UPKEEP_INTERVAL_DEFAULT (currently defined as 60000L, which is 60 seconds) |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -72,6 +74,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_UPLOAD.md+11 -7
| @@ -28,23 +28,25 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_UPLOAD, long upload); |
| # DESCRIPTION |
| |
| The long parameter *upload* set to 1 tells the library to prepare for and |
| - | perform an upload. The CURLOPT_READDATA(3) and |
| - | CURLOPT_INFILESIZE(3) or CURLOPT_INFILESIZE_LARGE(3) options are |
| - | also interesting for uploads. If the protocol is HTTP, uploading means using |
| - | the PUT request unless you tell libcurl otherwise. |
| + | perform an upload. The CURLOPT_READDATA(3) and CURLOPT_INFILESIZE(3) or |
| + | CURLOPT_INFILESIZE_LARGE(3) options are also interesting for uploads. If the |
| + | protocol is HTTP, uploading means using the PUT request unless you tell |
| + | libcurl otherwise. |
| |
| Using PUT with HTTP 1.1 implies the use of a "Expect: 100-continue" header. |
| You can disable this header with CURLOPT_HTTPHEADER(3) as usual. |
| |
| If you use PUT to an HTTP 1.1 server, you can upload data without knowing the |
| size before starting the transfer. The library enables this by adding a header |
| - | "Transfer-Encoding: chunked". With HTTP 1.0 or if you prefer not to use chunked |
| - | transfer, you must specify the size of the data with |
| + | "Transfer-Encoding: chunked". With HTTP 1.0 or if you prefer not to use |
| + | chunked transfer, you must specify the size of the data with |
| CURLOPT_INFILESIZE(3) or CURLOPT_INFILESIZE_LARGE(3). |
| |
| # DEFAULT |
| |
| - | 0, default is download |
| + | 0 |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -87,6 +89,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_UPLOAD_BUFFERSIZE.md+4 -0
| @@ -50,6 +50,8 @@ transfer as that may lead to unintended consequences. |
| |
| 65536 bytes |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -70,6 +72,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_URL.md+5 -2
| @@ -88,8 +88,7 @@ specified when passed to the name resolver functions. |
| |
| # DEFAULT |
| |
| - | There is no default URL. If this option is not set, no transfer can be |
| - | performed. |
| + | NULL. If this option is not set, no transfer can be performed. |
| |
| # SECURITY CONCERNS |
| |
| @@ -116,6 +115,8 @@ User provided URLs can also be made to point to sites that redirect further on |
| (possibly to other protocols too). Consider your |
| CURLOPT_FOLLOWLOCATION(3) and CURLOPT_REDIR_PROTOCOLS_STR(3) settings. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -130,6 +131,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK on success or CURLE_OUT_OF_MEMORY if there was insufficient |
docs/libcurl/opts/CURLOPT_USERAGENT.md+5 -1
| @@ -37,7 +37,9 @@ option. |
| |
| # DEFAULT |
| |
| - | NULL, no User-Agent: header is used by default. |
| + | NULL, no User-Agent: header is used. |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -55,6 +57,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if HTTP is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_USERNAME.md+4 -0
| @@ -61,6 +61,8 @@ option. |
| |
| blank |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -80,6 +82,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLOPT_USERPWD.md+4 -0
| @@ -67,6 +67,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -86,6 +88,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK on success or |
docs/libcurl/opts/CURLOPT_USE_SSL.md+4 -0
| @@ -59,6 +59,8 @@ Require SSL for all communication or fail with *CURLE_USE_SSL_FAILED*. |
| |
| CURLUSESSL_NONE |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -83,6 +85,8 @@ 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. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_VERBOSE.md+4 -0
| @@ -43,6 +43,8 @@ CURLOPT_DEBUGFUNCTION(3). |
| |
| 0, meaning disabled. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -61,6 +63,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_WILDCARDMATCH.md+4 -0
| @@ -77,6 +77,8 @@ Using the rules above, a filename pattern can be constructed: |
| |
| ftp://example.com/some/path/[a-z[:upper:]\\].jpg |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -101,6 +103,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_WRITEDATA.md+5 -1
| @@ -42,7 +42,9 @@ crashes. |
| |
| # DEFAULT |
| |
| - | By default, this is a FILE * to stdout. |
| + | stdout |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -57,6 +59,8 @@ https://curl.se/libcurl/c/getinmemory.html |
| This option was formerly known as CURLOPT_FILE, the name CURLOPT_WRITEDATA(3) |
| was added in 7.9.7. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| This returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_WRITEFUNCTION.md+5 -1
| @@ -73,7 +73,9 @@ do that. |
| |
| # DEFAULT |
| |
| - | libcurl uses 'fwrite' as a callback by default. |
| + | fwrite(3) |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -130,6 +132,8 @@ int main(void) |
| |
| Support for the CURL_WRITEFUNC_PAUSE return code was added in version 7.18.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| This returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_WS_OPTIONS.md+4 -0
| @@ -48,6 +48,8 @@ application. |
| |
| 0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
docs/libcurl/opts/CURLOPT_XFERINFODATA.md+5 -1
| @@ -34,7 +34,9 @@ This is an alias for CURLOPT_PROGRESSDATA(3). |
| |
| # DEFAULT |
| |
| - | The default value of this parameter is NULL. |
| + | NULL |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -70,6 +72,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK |
docs/libcurl/opts/CURLOPT_XFERINFOFUNCTION.md+5 -2
| @@ -71,8 +71,9 @@ get called. |
| |
| # DEFAULT |
| |
| - | By default, libcurl has an internal progress meter. That is rarely wanted by |
| - | users. |
| + | NULL - use the internal progress meter. That is rarely wanted by users. |
| + | |
| + | # %PROTOCOLS% |
| |
| # EXAMPLE |
| |
| @@ -113,6 +114,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK. |
docs/libcurl/opts/CURLOPT_XOAUTH2_BEARER.md+4 -0
| @@ -44,6 +44,8 @@ option. |
| |
| NULL |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -64,6 +66,8 @@ int main(void) |
| |
| Support for OpenLDAP added in 7.82.0. |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
docs/libcurl/opts/CURLSHOPT_LOCKFUNC.md+4 -0
| @@ -49,6 +49,8 @@ sure that the callback uses a different lock for each kind of data. |
| *clientp* is the private pointer you set with CURLSHOPT_USERDATA(3). |
| This pointer is not used by libcurl itself. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -65,6 +67,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLSHE_OK (zero) means that the option was set properly, non-zero means an |
docs/libcurl/opts/CURLSHOPT_SHARE.md+4 -0
| @@ -92,6 +92,8 @@ It is not supported to share the HSTS between multiple concurrent threads. |
| |
| Added in 7.88.0 |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -105,6 +107,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLSHE_OK (zero) means that the option was set properly, non-zero means an |
docs/libcurl/opts/CURLSHOPT_UNLOCKFUNC.md+4 -0
| @@ -45,6 +45,8 @@ sure that the callback uses a different lock for each kind of data. |
| *clientp* is the private pointer you set with CURLSHOPT_USERDATA(3). |
| This pointer is not used by libcurl itself. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -60,6 +62,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLSHE_OK (zero) means that the option was set properly, non-zero means an |
docs/libcurl/opts/CURLSHOPT_UNSHARE.md+4 -0
| @@ -59,6 +59,8 @@ The connection cache is no longer shared. |
| |
| The Public Suffix List is no longer shared. |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -72,6 +74,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLSHE_OK (zero) means that the option was set properly, non-zero means an |
docs/libcurl/opts/CURLSHOPT_USERDATA.md+4 -0
| @@ -32,6 +32,8 @@ The *clientp* parameter is held verbatim by libcurl and is passed on as |
| the *clientp* argument to the callbacks set with |
| CURLSHOPT_LOCKFUNC(3) and CURLSHOPT_UNLOCKFUNC(3). |
| |
| + | # %PROTOCOLS% |
| + | |
| # EXAMPLE |
| |
| ~~~c |
| @@ -50,6 +52,8 @@ int main(void) |
| } |
| ~~~ |
| |
| + | # %AVAILABILITY% |
| + | |
| # RETURN VALUE |
| |
| CURLSHE_OK (zero) means that the option was set properly, non-zero means an |
scripts/cd2nroff+21 -7
| @@ -103,15 +103,25 @@ sub outprotocols { |
| push @o, ".SH PROTOCOLS\n"; |
| |
| if($p[0] eq "TLS") { |
| - | push @o, "All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc."; |
| + | push @o, "This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc."; |
| } |
| else { |
| my @s = sort @p; |
| + | push @o, "This functionality affects "; |
| for my $e (sort @s) { |
| - | push @o, sprintf "%s$e", |
| - | $comma ? (($e eq $s[-1]) ? " and " : ", "): ""; |
| + | push @o, sprintf "%s%s", |
| + | $comma ? (($e eq $s[-1]) ? " and " : ", "): "", |
| + | lc($e); |
| $comma = 1; |
| } |
| + | if($#s == 0) { |
| + | if($s[0] eq "All") { |
| + | push @o, " supported protocols"; |
| + | } |
| + | else { |
| + | push @o, " only"; |
| + | } |
| + | } |
| } |
| push @o, "\n"; |
| return @o; |
| @@ -447,20 +457,24 @@ sub single { |
| 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 |
| + | elsif($word eq "%PROTOCOLS%") { |
| + | # insert the generated PROTOCOLS section |
| push @desc, outprotocols(@proto); |
| |
| if($proto[0] eq "TLS") { |
| push @desc, outtls(@tls); |
| } |
| + | $header = 1; |
| + | next; |
| } |
| - | elsif($word eq "RETURN VALUE") { |
| + | elsif($word eq "%AVAILABILITY%") { |
| if($addedin ne "n/a") { |
| - | # insert the generated AVAILABILITY section before RETURN VALUE |
| + | # insert the generated AVAILABILITY section |
| push @desc, ".SH AVAILABILITY\n"; |
| push @desc, "Added in curl $addedin\n"; |
| } |
| + | $header = 1; |
| + | next; |
| } |
| push @desc, ".SH $word\n"; |
| $header = 1; |