mirror of
https://github.com/moparisthebest/curl
synced 2024-11-17 23:15:08 -05:00
curl_easy_setopt.3: mention CURLOPT_PIPEWAIT
This commit is contained in:
Daniel Stenberg
parent
ef0fdb83b8
commit
570076e82c
@ -1,235 +1,3 @@
|
|||||||
.\" **************************************************************************
|
|
||||||
.\" * _ _ ____ _
|
|
||||||
.\" * Project ___| | | | _ \| |
|
|
||||||
.\" * / __| | | | |_) | |
|
|
||||||
.\" * | (__| |_| | _ <| |___
|
|
||||||
.\" * \___|\___/|_| \_\_____|
|
|
||||||
.\" *
|
|
||||||
.\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
||||||
.\" *
|
|
||||||
.\" * This software is licensed as described in the file COPYING, which
|
|
||||||
.\" * you should have received as part of this distribution. The terms
|
|
||||||
.\" * are also available at http://curl.haxx.se/docs/copyright.html.
|
|
||||||
.\" *
|
|
||||||
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
||||||
.\" * copies of the Software, and permit persons to whom the Software is
|
|
||||||
.\" * furnished to do so, under the terms of the COPYING file.
|
|
||||||
.\" *
|
|
||||||
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
||||||
.\" * KIND, either express or implied.
|
|
||||||
.\" *
|
|
||||||
.\" **************************************************************************
|
|
||||||
.\"
|
|
||||||
.TH curl_easy_setopt 3 "25 Jun 2014" "libcurl 7.38.0" "libcurl Manual"
|
|
||||||
.SH NAME
|
|
||||||
curl_easy_setopt \- set options for a curl easy handle
|
|
||||||
.SH SYNOPSIS
|
|
||||||
#include <curl/curl.h>
|
|
||||||
|
|
||||||
CURLcode curl_easy_setopt(CURL *handle, CURLoption option, parameter);
|
|
||||||
.SH DESCRIPTION
|
|
||||||
\fIcurl_easy_setopt(3)\fP is used to tell libcurl how to behave. By setting
|
|
||||||
the appropriate options, the application can change libcurl's behavior. All
|
|
||||||
options are set with an \fIoption\fP followed by a \fIparameter\fP. That
|
|
||||||
parameter can be a \fBlong\fP, a \fBfunction pointer\fP, an \fBobject
|
|
||||||
pointer\fP or a \fBcurl_off_t\fP, depending on what the specific option
|
|
||||||
expects. Read this manual carefully as bad input values may cause libcurl to
|
|
||||||
behave badly! You can only set one option in each function call. A typical
|
|
||||||
application uses many \fIcurl_easy_setopt(3)\fP calls in the setup phase.
|
|
||||||
|
|
||||||
Options set with this function call are valid for all forthcoming transfers
|
|
||||||
performed using this \fIhandle\fP. The options are not in any way reset
|
|
||||||
between transfers, so if you want subsequent transfers with different options,
|
|
||||||
you must change them between the transfers. You can optionally reset all
|
|
||||||
options back to internal default with \fIcurl_easy_reset(3)\fP.
|
|
||||||
|
|
||||||
Strings passed to libcurl as 'char *' arguments, are copied by the library;
|
|
||||||
thus the string storage associated to the pointer argument may be overwritten
|
|
||||||
after \fIcurl_easy_setopt(3)\fP returns. The only exception to this rule is
|
|
||||||
really \fICURLOPT_POSTFIELDS(3)\fP, but the alternative that copies the string
|
|
||||||
\fICURLOPT_COPYPOSTFIELDS(3)\fP has some usage characteristics you need to
|
|
||||||
read up on.
|
|
||||||
|
|
||||||
The order in which the options are set does not matter.
|
|
||||||
|
|
||||||
Before version 7.17.0, strings were not copied. Instead the user was forced
|
|
||||||
keep them available until libcurl no longer needed them.
|
|
||||||
|
|
||||||
The \fIhandle\fP is the return code from a \fIcurl_easy_init(3)\fP or
|
|
||||||
\fIcurl_easy_duphandle(3)\fP call.
|
|
||||||
.SH BEHAVIOR OPTIONS
|
|
||||||
.IP CURLOPT_VERBOSE
|
|
||||||
Display verbose information. See \fICURLOPT_VERBOSE(3)\fP
|
|
||||||
.IP CURLOPT_HEADER
|
|
||||||
Include the header in the body output. See \fICURLOPT_HEADER(3)\fP
|
|
||||||
.IP CURLOPT_NOPROGRESS
|
|
||||||
Shut off the progress meter. See \fICURLOPT_NOPROGRESS(3)\fP
|
|
||||||
.IP CURLOPT_NOSIGNAL
|
|
||||||
Do not install signal handlers. See \fICURLOPT_NOSIGNAL(3)\fP
|
|
||||||
.IP CURLOPT_WILDCARDMATCH
|
|
||||||
Transfer multiple files according to a file name pattern. See \fICURLOPT_WILDCARDMATCH(3)\fP
|
|
||||||
.SH CALLBACK OPTIONS
|
|
||||||
.IP CURLOPT_WRITEFUNCTION
|
|
||||||
Callback for writing data. See \fICURLOPT_WRITEFUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_WRITEDATA
|
|
||||||
Data pointer to pass to the write callback. See \fICURLOPT_WRITEDATA(3)\fP
|
|
||||||
.IP CURLOPT_READFUNCTION
|
|
||||||
Callback for reading data. See \fICURLOPT_READFUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_READDATA
|
|
||||||
Data pointer to pass to the read callback. See \fICURLOPT_READDATA(3)\fP
|
|
||||||
.IP CURLOPT_IOCTLFUNCTION
|
|
||||||
Callback for I/O operations. See \fICURLOPT_IOCTLFUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_IOCTLDATA
|
|
||||||
Data pointer to pass to the I/O callback. See \fICURLOPT_IOCTLDATA(3)\fP
|
|
||||||
.IP CURLOPT_SEEKFUNCTION
|
|
||||||
Callback for seek operations. See \fICURLOPT_SEEKFUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_SEEKDATA
|
|
||||||
Data pointer to pass to the seek callback. See \fICURLOPT_SEEKDATA(3)\fP
|
|
||||||
.IP CURLOPT_SOCKOPTFUNCTION
|
|
||||||
Callback for sockopt operations. See \fICURLOPT_SOCKOPTFUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_SOCKOPTDATA
|
|
||||||
Data pointer to pass to the sockopt callback. See \fICURLOPT_SOCKOPTDATA(3)\fP
|
|
||||||
.IP CURLOPT_OPENSOCKETFUNCTION
|
|
||||||
Callback for socket creation. See \fICURLOPT_OPENSOCKETFUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_OPENSOCKETDATA
|
|
||||||
Data pointer to pass to the open socket callback. See \fICURLOPT_OPENSOCKETDATA(3)\fP
|
|
||||||
.IP CURLOPT_CLOSESOCKETFUNCTION
|
|
||||||
Callback for closing socket. See \fICURLOPT_CLOSESOCKETFUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_CLOSESOCKETDATA
|
|
||||||
Data pointer to pass to the close socket callback. See \fICURLOPT_CLOSESOCKETDATA(3)\fP
|
|
||||||
.IP CURLOPT_PROGRESSFUNCTION
|
|
||||||
OBSOLETE callback for progress meter. See \fICURLOPT_PROGRESSFUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_PROGRESSDATA
|
|
||||||
Data pointer to pass to the progress meter callback. See \fICURLOPT_PROGRESSDATA(3)\fP
|
|
||||||
.IP CURLOPT_XFERINFOFUNCTION
|
|
||||||
Callback for progress meter. See \fICURLOPT_XFERINFOFUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_XFERINFODATA
|
|
||||||
Data pointer to pass to the progress meter callback. See \fICURLOPT_XFERINFODATA(3)\fP
|
|
||||||
.IP CURLOPT_HEADERFUNCTION
|
|
||||||
Callback for writing received headers. See \fICURLOPT_HEADERFUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_HEADERDATA
|
|
||||||
Data pointer to pass to the header callback. See \fICURLOPT_HEADERDATA(3)\fP
|
|
||||||
.IP CURLOPT_DEBUGFUNCTION
|
|
||||||
Callback for debug information. See \fICURLOPT_DEBUGFUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_DEBUGDATA
|
|
||||||
Data pointer to pass to the debug callback. See \fICURLOPT_DEBUGDATA(3)\fP
|
|
||||||
.IP CURLOPT_SSL_CTX_FUNCTION
|
|
||||||
Callback for SSL context logic. See \fICURLOPT_SSL_CTX_FUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_SSL_CTX_DATA
|
|
||||||
Data pointer to pass to the SSL context callback. See \fICURLOPT_SSL_CTX_DATA(3)\fP
|
|
||||||
.IP CURLOPT_CONV_TO_NETWORK_FUNCTION
|
|
||||||
Callback for code base conversion. See \fICURLOPT_CONV_TO_NETWORK_FUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_CONV_FROM_NETWORK_FUNCTION
|
|
||||||
Callback for code base conversion. See \fICURLOPT_CONV_FROM_NETWORK_FUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_CONV_FROM_UTF8_FUNCTION
|
|
||||||
Callback for code base conversion. See \fICURLOPT_CONV_FROM_UTF8_FUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_INTERLEAVEFUNCTION
|
|
||||||
Callback for RTSP interleaved data. See \fICURLOPT_INTERLEAVEFUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_INTERLEAVEDATA
|
|
||||||
Data pointer to pass to the RTSP interleave callback. See \fICURLOPT_INTERLEAVEDATA(3)\fP
|
|
||||||
.IP CURLOPT_CHUNK_BGN_FUNCTION
|
|
||||||
Callback for wildcard download start of chunk. See \fICURLOPT_CHUNK_BGN_FUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_CHUNK_END_FUNCTION
|
|
||||||
Callback for wildcard download end of chunk. See \fICURLOPT_CHUNK_END_FUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_CHUNK_DATA
|
|
||||||
Data pointer to pass to the chunk callbacks. See \fICURLOPT_CHUNK_DATA(3)\fP
|
|
||||||
.IP CURLOPT_FNMATCH_FUNCTION
|
|
||||||
Callback for wildcard matching. See \fICURLOPT_FNMATCH_FUNCTION(3)\fP
|
|
||||||
.IP CURLOPT_FNMATCH_DATA
|
|
||||||
Data pointer to pass to the wildcard matching callback. See \fICURLOPT_FNMATCH_DATA(3)\fP
|
|
||||||
.SH ERROR OPTIONS
|
|
||||||
.IP CURLOPT_ERRORBUFFER
|
|
||||||
Error message buffer. See \fICURLOPT_ERRORBUFFER(3)\fP
|
|
||||||
.IP CURLOPT_STDERR
|
|
||||||
stderr replacement stream. See \fICURLOPT_STDERR(3)\fP
|
|
||||||
.IP CURLOPT_FAILONERROR
|
|
||||||
Fail on HTTP 4xx errors. \fICURLOPT_FAILONERROR(3)\fP
|
|
||||||
.SH NETWORK OPTIONS
|
|
||||||
.IP CURLOPT_URL
|
|
||||||
URL to work on. See \fICURLOPT_URL(3)\fP
|
|
||||||
.IP CURLOPT_PATH_AS_IS
|
|
||||||
Disable squashing /../ and /./ sequences in the path. See \fICURLOPT_PATH_AS_IS(3)\fP
|
|
||||||
.IP CURLOPT_PROTOCOLS
|
|
||||||
Allowed protocols. See \fICURLOPT_PROTOCOLS(3)\fP
|
|
||||||
.IP CURLOPT_REDIR_PROTOCOLS
|
|
||||||
Protocols to allow redirects to. See \fICURLOPT_REDIR_PROTOCOLS(3)\fP
|
|
||||||
.IP CURLOPT_PROXY
|
|
||||||
Proxy to use. See \fICURLOPT_PROXY(3)\fP
|
|
||||||
.IP CURLOPT_PROXYPORT
|
|
||||||
Proxy port to use. See \fICURLOPT_PROXYPORT(3)\fP
|
|
||||||
.IP CURLOPT_PROXYTYPE
|
|
||||||
Proxy type. See \fICURLOPT_PROXYTYPE(3)\fP
|
|
||||||
.IP CURLOPT_NOPROXY
|
|
||||||
Filter out hosts from proxy use. \fICURLOPT_NOPROXY(3)\fP
|
|
||||||
.IP CURLOPT_HTTPPROXYTUNNEL
|
|
||||||
Tunnel through the HTTP proxy. \fICURLOPT_HTTPPROXYTUNNEL(3)\fP
|
|
||||||
.IP CURLOPT_SOCKS5_GSSAPI_SERVICE
|
|
||||||
Socks5 GSSAPI service name. \fICURLOPT_SOCKS5_GSSAPI_SERVICE(3)\fP
|
|
||||||
.IP CURLOPT_SOCKS5_GSSAPI_NEC
|
|
||||||
Socks5 GSSAPI NEC mode. See \fICURLOPT_SOCKS5_GSSAPI_NEC(3)\fP
|
|
||||||
.IP CURLOPT_PROXY_SERVICE_NAME
|
|
||||||
Proxy service name. \fICURLOPT_PROXY_SERVICE_NAME(3)\fP
|
|
||||||
.IP CURLOPT_SERVICE_NAME
|
|
||||||
SPNEGO service name. \fICURLOPT_SERVICE_NAME(3)\fP
|
|
||||||
.IP CURLOPT_INTERFACE
|
|
||||||
Bind connection locally to this. See \fICURLOPT_INTERFACE(3)\fP
|
|
||||||
.IP CURLOPT_LOCALPORT
|
|
||||||
Bind connection locally to this port. See \fICURLOPT_LOCALPORT(3)\fP
|
|
||||||
.IP CURLOPT_LOCALPORTRANGE
|
|
||||||
Bind connection locally to port range. See \fICURLOPT_LOCALPORTRANGE(3)\fP
|
|
||||||
.IP CURLOPT_DNS_CACHE_TIMEOUT
|
|
||||||
Timeout for DNS cache. See \fICURLOPT_DNS_CACHE_TIMEOUT(3)\fP
|
|
||||||
.IP CURLOPT_DNS_USE_GLOBAL_CACHE
|
|
||||||
OBSOLETE Enable global DNS cache. See \fICURLOPT_DNS_USE_GLOBAL_CACHE(3)\fP
|
|
||||||
.IP CURLOPT_BUFFERSIZE
|
|
||||||
Ask for smaller buffer size. See \fICURLOPT_BUFFERSIZE(3)\fP
|
|
||||||
.IP CURLOPT_PORT
|
|
||||||
Port number to connect to. See \fICURLOPT_PORT(3)\fP
|
|
||||||
.IP CURLOPT_TCP_NODELAY
|
|
||||||
Disable the Nagle algorithm. See \fICURLOPT_TCP_NODELAY(3)\fP
|
|
||||||
.IP CURLOPT_ADDRESS_SCOPE
|
|
||||||
IPv6 scope for local addresses. See \fICURLOPT_ADDRESS_SCOPE(3)\fP
|
|
||||||
.IP CURLOPT_TCP_KEEPALIVE
|
|
||||||
Enable TCP keep-alive. See \fICURLOPT_TCP_KEEPALIVE(3)\fP
|
|
||||||
.IP CURLOPT_TCP_KEEPIDLE
|
|
||||||
Idle time before sending keep-alive. See \fICURLOPT_TCP_KEEPIDLE(3)\fP
|
|
||||||
.IP CURLOPT_TCP_KEEPINTVL
|
|
||||||
Interval between keep-alive probes. See \fICURLOPT_TCP_KEEPINTVL(3)\fP
|
|
||||||
.IP CURLOPT_UNIX_SOCKET_PATH
|
|
||||||
Path to a Unix domain socket. See \fICURLOPT_UNIX_SOCKET_PATH(3)\fP
|
|
||||||
.SH NAMES and PASSWORDS OPTIONS (Authentication)
|
|
||||||
.IP CURLOPT_NETRC
|
|
||||||
Enable .netrc parsing. See \fICURLOPT_NETRC(3)\fP
|
|
||||||
.IP CURLOPT_NETRC_FILE
|
|
||||||
\&.netrc file name. See \fICURLOPT_NETRC_FILE(3)\fP
|
|
||||||
.IP CURLOPT_USERPWD
|
|
||||||
User name and password. See \fICURLOPT_USERPWD(3)\fP
|
|
||||||
.IP CURLOPT_PROXYUSERPWD
|
|
||||||
Proxy user name and password. See \fICURLOPT_PROXYUSERPWD(3)\fP
|
|
||||||
.IP CURLOPT_USERNAME
|
|
||||||
User name. See \fICURLOPT_USERNAME(3)\fP
|
|
||||||
.IP CURLOPT_PASSWORD
|
|
||||||
Password. See \fICURLOPT_PASSWORD(3)\fP
|
|
||||||
.IP CURLOPT_LOGIN_OPTIONS
|
|
||||||
Login options. See \fICURLOPT_LOGIN_OPTIONS(3)\fP
|
|
||||||
.IP CURLOPT_PROXYUSERNAME
|
|
||||||
Proxy user name. See \fICURLOPT_PROXYUSERNAME(3)\fP
|
|
||||||
.IP CURLOPT_PROXYPASSWORD
|
|
||||||
Proxy password. See \fICURLOPT_PROXYPASSWORD(3)\fP
|
|
||||||
.IP CURLOPT_HTTPAUTH
|
|
||||||
HTTP server authentication methods. See \fICURLOPT_HTTPAUTH(3)\fP
|
|
||||||
.IP CURLOPT_TLSAUTH_USERNAME
|
|
||||||
TLS authentication user name. See \fICURLOPT_TLSAUTH_USERNAME(3)\fP
|
|
||||||
.IP CURLOPT_TLSAUTH_PASSWORD
|
|
||||||
TLS authentication password. See \fICURLOPT_TLSAUTH_PASSWORD(3)\fP
|
|
||||||
.IP CURLOPT_TLSAUTH_TYPE
|
|
||||||
TLS authentication methods. See \fICURLOPT_TLSAUTH_TYPE(3)\fP
|
|
||||||
.IP CURLOPT_PROXYAUTH
|
|
||||||
HTTP proxy authentication methods. See \fICURLOPT_PROXYAUTH(3)\fP
|
|
||||||
.IP CURLOPT_SASL_IR
|
|
||||||
Enable SASL initial response. See \fICURLOPT_SASL_IR(3)\fP
|
|
||||||
.IP CURLOPT_XOAUTH2_BEARER
|
|
||||||
OAuth2 bearer token. See \fICURLOPT_XOAUTH2_BEARER(3)\fP
|
|
||||||
.SH HTTP OPTIONS
|
.SH HTTP OPTIONS
|
||||||
.IP CURLOPT_AUTOREFERER
|
.IP CURLOPT_AUTOREFERER
|
||||||
Automatically set Referer: header. See \fICURLOPT_AUTOREFERER(3)\fP
|
Automatically set Referer: header. See \fICURLOPT_AUTOREFERER(3)\fP
|
||||||
@ -293,6 +61,8 @@ Disable Content decoding. See \fICURLOPT_HTTP_CONTENT_DECODING(3)\fP
|
|||||||
Disable Transfer decoding. See \fICURLOPT_HTTP_TRANSFER_DECODING(3)\fP
|
Disable Transfer decoding. See \fICURLOPT_HTTP_TRANSFER_DECODING(3)\fP
|
||||||
.IP CURLOPT_EXPECT_100_TIMEOUT_MS
|
.IP CURLOPT_EXPECT_100_TIMEOUT_MS
|
||||||
100-continue timeout. See \fICURLOPT_EXPECT_100_TIMEOUT_MS(3)\fP
|
100-continue timeout. See \fICURLOPT_EXPECT_100_TIMEOUT_MS(3)\fP
|
||||||
|
.IP CURLOPT_PIPEWAIT
|
||||||
|
Wait on connection to pipeline on it. See \fICURLOPT_PIPEWAIT(3)\fP
|
||||||
.SH SMTP OPTIONS
|
.SH SMTP OPTIONS
|
||||||
.IP CURLOPT_MAIL_FROM
|
.IP CURLOPT_MAIL_FROM
|
||||||
Address of the sender. See \fICURLOPT_MAIL_FROM(3)\fP
|
Address of the sender. See \fICURLOPT_MAIL_FROM(3)\fP
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user