Man Pages in
libcurl4-doc
Carta.tech
Packages
libcurl4-doc
273
Section 3:
Library calls
CURLOPT_ACCEPTTIMEOUT_MS.3
Timeout waiting for ftp server to connect back
CURLOPT_ACCEPT_ENCODING.3
Enables automatic decompression of http downloads
CURLOPT_ADDRESS_SCOPE.3
Set scope for local ipv6 addresses
CURLOPT_APPEND.3
Enable appending to the remote file
CURLOPT_AUTOREFERER.3
Automatically update the referer header
CURLOPT_BUFFERSIZE.3
Set preferred receive buffer size
CURLOPT_CAINFO.3
Path to certificate authority (ca) bundle
CURLOPT_CAPATH.3
Specify directory holding ca certificates
CURLOPT_CERTINFO.3
Request ssl certificate information
CURLOPT_CHUNK_BGN_FUNCTION.3
Callback before a transfer with ftp wildcardmatch
CURLOPT_CHUNK_DATA.3
Custom pointer to the ftp chunk callbacks
CURLOPT_CHUNK_END_FUNCTION.3
Callback after a transfer with ftp wildcardmatch
CURLOPT_CLOSESOCKETDATA.3
Pointer passed to the socket close callback
CURLOPT_CLOSESOCKETFUNCTION.3
Callback to socket close replacement function
CURLOPT_CONNECTTIMEOUT.3
Timeout for the connect phase
CURLOPT_CONNECTTIMEOUT_MS.3
Timeout for the connect phase
CURLOPT_CONNECT_ONLY.3
Stop when connected to target server
CURLOPT_CONV_FROM_NETWORK_FUNCTION.3
Convert data from network to host encoding
CURLOPT_CONV_FROM_UTF8_FUNCTION.3
Convert data from utf8 to host encoding
CURLOPT_CONV_TO_NETWORK_FUNCTION.3
Convert data to network from host encoding
CURLOPT_COOKIE.3
Set contents of http cookie header
CURLOPT_COOKIEFILE.3
File name to read cookies from
CURLOPT_COOKIEJAR.3
File name to store cookies to
CURLOPT_COOKIELIST.3
Add to or manipulate cookies held in memory
CURLOPT_COOKIESESSION.3
Start a new cookie session
CURLOPT_COPYPOSTFIELDS.3
Have libcurl copy data to post
CURLOPT_CRLF.3
Enable/disable crlf conversion
CURLOPT_CRLFILE.3
Specify a certificate revocation list file
CURLOPT_CUSTOMREQUEST.3
Custom string for request
CURLOPT_DEBUGDATA.3
Custom pointer for debug callback
CURLOPT_DEBUGFUNCTION.3
Debug callback
CURLOPT_DIRLISTONLY.3
Ask for names only in a directory listing
CURLOPT_DNS_CACHE_TIMEOUT.3
Set life-time for dns cache entries
CURLOPT_DNS_INTERFACE.3
Set interface to speak dns over
CURLOPT_DNS_LOCAL_IP4.3
Ipv4 address to bind dns resolves to
CURLOPT_DNS_LOCAL_IP6.3
Ipv6 address to bind dns resolves to
CURLOPT_DNS_SERVERS.3
Set preferred dns servers
CURLOPT_DNS_USE_GLOBAL_CACHE.3
Enable/disable global dns cache
CURLOPT_EGDSOCKET.3
Set egd socket path
CURLOPT_ERRORBUFFER.3
Set error buffer for error messages
CURLOPT_EXPECT_100_TIMEOUT_MS.3
Timeout for expect: 100-continue response
CURLOPT_FAILONERROR.3
Request failure on http response = 400
CURLOPT_FILETIME.3
Get the modification time of the remote resource
CURLOPT_FNMATCH_DATA.3
Custom pointer to fnmatch callback
CURLOPT_FNMATCH_FUNCTION.3
Wildcard matching function callback
CURLOPT_FOLLOWLOCATION.3
Follow http 3xx redirects
CURLOPT_FORBID_REUSE.3
Make connection get closed at once after use
CURLOPT_FRESH_CONNECT.3
Force a new connection to be used
CURLOPT_FTPPORT.3
Make ftp transfer active
CURLOPT_FTPSSLAUTH.3
Set order in which to attempt tls vs ssl when using ftp
CURLOPT_FTP_ACCOUNT.3
Set account info for ftp
CURLOPT_FTP_ALTERNATIVE_TO_USER.3
Command to use instead of user with ftp
CURLOPT_FTP_CREATE_MISSING_DIRS.3
Create missing dirs for ftp and sftp
CURLOPT_FTP_FILEMETHOD.3
Select directory traversing method for ftp
CURLOPT_FTP_RESPONSE_TIMEOUT.3
Time allowed to wait for ftp response
CURLOPT_FTP_SKIP_PASV_IP.3
Ignore the ip address in the pasv response
CURLOPT_FTP_SSL_CCC.3
Switch off ssl again with ftp after auth
CURLOPT_FTP_USE_EPRT.3
Enable/disable use of eprt with ftp
CURLOPT_FTP_USE_EPSV.3
Enable/disable use of epsv
CURLOPT_FTP_USE_PRET.3
Enable the pret command
CURLOPT_GSSAPI_DELEGATION.3
Set allowed gss-api delegation
CURLOPT_HEADER.3
Pass headers to the data stream
CURLOPT_HEADERDATA.3
Pointer to pass to header callback
CURLOPT_HEADERFUNCTION.3
Callback that receives header data
CURLOPT_HEADEROPT.3
Set how to send http headers
CURLOPT_HTTP200ALIASES.3
Specify alternative matches for http 200 ok
CURLOPT_HTTPAUTH.3
Set http server authentication methods to try
CURLOPT_HTTPGET.3
Ask for a http get request
CURLOPT_HTTPHEADER.3
Set custom http headers
CURLOPT_HTTPPOST.3
Specify the multipart formpost content
CURLOPT_HTTPPROXYTUNNEL.3
Tunnel through http proxy
CURLOPT_HTTP_CONTENT_DECODING.3
Enable/disable http content decoding
CURLOPT_HTTP_TRANSFER_DECODING.3
Enable/disable http transfer decoding
CURLOPT_HTTP_VERSION.3
Specify http protocol version to use
CURLOPT_IGNORE_CONTENT_LENGTH.3
Ignore content-length in http response
CURLOPT_INFILESIZE.3
Set size of the input file to send off
CURLOPT_INFILESIZE_LARGE.3
Set size of the input file to send off
CURLOPT_INTERFACE.3
Source interface for outgoing traffic
CURLOPT_INTERLEAVEDATA.3
Custom pointer to rtsp interleave callback
CURLOPT_INTERLEAVEFUNCTION.3
Callback function for rtsp interleaved data
CURLOPT_IOCTLDATA.3
Custom pointer passed to i/o callback
CURLOPT_IOCTLFUNCTION.3
Callback for i/o operations
CURLOPT_IPRESOLVE.3
Specify which ip protocol version to use
CURLOPT_ISSUERCERT.3
Issuer ssl certificate filename
CURLOPT_KEYPASSWD.3
Set passphrase to private key
CURLOPT_KRBLEVEL.3
Set ftp kerberos security level
CURLOPT_LOCALPORT.3
Set local port number to use for socket
CURLOPT_LOCALPORTRANGE.3
Number of additional local ports to try
CURLOPT_LOGIN_OPTIONS.3
Set login options
CURLOPT_LOW_SPEED_LIMIT.3
Set low speed limit in bytes per second
CURLOPT_LOW_SPEED_TIME.3
Set low speed limit time period
CURLOPT_MAIL_AUTH.3
Specify smtp authentication address
CURLOPT_MAIL_FROM.3
Smtp mail from address
CURLOPT_MAIL_RCPT.3
Provide list of mail recipients
CURLOPT_MAXCONNECTS.3
Set connection cache size
CURLOPT_MAXFILESIZE.3
Maximum file size allowed to download
CURLOPT_MAXFILESIZE_LARGE.3
Maximum file size allowed to download
CURLOPT_MAXREDIRS.3
Maximum number of redirects allowed
CURLOPT_MAX_RECV_SPEED_LARGE.3
Rate limit data download speed
CURLOPT_MAX_SEND_SPEED_LARGE.3
Rate limit data upload speed
CURLOPT_NETRC.3
Request that .netrc is used
CURLOPT_NETRC_FILE.3
File name to read .netrc info from
CURLOPT_NEW_DIRECTORY_PERMS.3
Permissions for remotely created directories
CURLOPT_NEW_FILE_PERMS.3
Permissions for remotely created files
CURLOPT_NOBODY.3
Do the download request without getting the body
CURLOPT_NOPROGRESS.3
Switch off the progress meter
CURLOPT_NOPROXY.3
Disable proxy use for specific hosts
CURLOPT_NOSIGNAL.3
Skip all signal handling
CURLOPT_OPENSOCKETDATA.3
Custom pointer passed to open socket callback
CURLOPT_OPENSOCKETFUNCTION.3
Set callback for opening sockets
CURLOPT_PASSWORD.3
Password to use in authentication
CURLOPT_PORT.3
Set remote port number to work with
CURLOPT_POST.3
Request a http post
CURLOPT_POSTFIELDS.3
Specify data to post to server
CURLOPT_POSTFIELDSIZE.3
Size of post data pointed to
CURLOPT_POSTFIELDSIZE_LARGE.3
Size of post data pointed to
CURLOPT_POSTQUOTE.3
(s)ftp commands to run after the transfer
CURLOPT_POSTREDIR.3
How to act on a http post redirect
CURLOPT_PREQUOTE.3
Commands to run before ftp or sftp transfer
CURLOPT_PRIVATE.3
Store a private pointer
CURLOPT_PROGRESSDATA.3
Custom pointer passed to the progress callback
CURLOPT_PROGRESSFUNCTION.3
Callback to progress meter function
CURLOPT_PROTOCOLS.3
Set allowed protocols
CURLOPT_PROXY.3
Set proxy to use
CURLOPT_PROXYAUTH.3
Set http proxy authentication methods to try
CURLOPT_PROXYHEADER.3
Custom http headers to pass to proxy
CURLOPT_PROXYPASSWORD.3
Password to use in authentication with proxy
CURLOPT_PROXYPORT.3
Port number the proxy listens on
CURLOPT_PROXYTYPE.3
Proxy protocol type
CURLOPT_PROXYUSERNAME.3
Username to authenticate with a proxy
CURLOPT_PROXYUSERPWD.3
Set user and password to use for the proxy
CURLOPT_PROXY_TRANSFER_MODE.3
Append ftp transfer mode to url for proxy
CURLOPT_PUT.3
Make a http put request
CURLOPT_QUOTE.3
(s)ftp commands to run before transfer
CURLOPT_RANDOM_FILE.3
Specify a source for random data
CURLOPT_RANGE.3
Set byte range to request
CURLOPT_READDATA.3
Custom pointer passed to the read callback
CURLOPT_READFUNCTION.3
Read callback for data uploads
CURLOPT_REDIR_PROTOCOLS.3
Set protocols allowed to redirect to
CURLOPT_REFERER.3
Set the http referer header
CURLOPT_RESOLVE.3
Provide custom host name to ip address resolves
CURLOPT_RESUME_FROM.3
Set a point to resume transfer from
CURLOPT_RESUME_FROM_LARGE.3
Set a point to resume transfer from
CURLOPT_RTSP_CLIENT_CSEQ.3
Set the rtsp client cseq number
CURLOPT_RTSP_REQUEST.3
Specify rtsp request
CURLOPT_RTSP_SERVER_CSEQ.3
Set the rtsp server cseq number
CURLOPT_RTSP_SESSION_ID.3
Set rtsp session id
CURLOPT_RTSP_TRANSPORT.3
Set rtsp transport: header
CURLOPT_SASL_IR.3
Enable sending initial response in first packet
CURLOPT_SEEKDATA.3
Custom pointer passed to the seek callback
CURLOPT_SEEKFUNCTION.3
User callback for seeking in input stream
CURLOPT_SHARE.3
Specify share handle to use
CURLOPT_SOCKOPTDATA.3
Custom pointer to pass to sockopt callback
CURLOPT_SOCKOPTFUNCTION.3
Set callback for setting socket options
CURLOPT_SOCKS5_GSSAPI_NEC.3
Set socks proxy gssapi negotiation protection
CURLOPT_SOCKS5_GSSAPI_SERVICE.3
Proxy socks gssapi service name
CURLOPT_SSH_AUTH_TYPES.3
Set desired auth types for sftp and scp
CURLOPT_SSH_HOST_PUBLIC_KEY_MD5.3
Checksum of ssh server public key
CURLOPT_SSH_KEYDATA.3
Pointer to pass to the ssh key callback
CURLOPT_SSH_KEYFUNCTION.3
Callback for known host matching logic
CURLOPT_SSH_KNOWNHOSTS.3
File name holding the ssh known hosts
CURLOPT_SSH_PRIVATE_KEYFILE.3
Set private key file for ssh auth
CURLOPT_SSH_PUBLIC_KEYFILE.3
Set public key file for ssh auth
CURLOPT_SSLCERT.3
Set ssl client certificate
CURLOPT_SSLCERTTYPE.3
Specify type of the client ssl certificate
CURLOPT_SSLENGINE.3
Set ssl engine identifier
CURLOPT_SSLENGINE_DEFAULT.3
Make ssl engine default
CURLOPT_SSLKEY.3
Specify private keyfile for tls and ssl client cert
CURLOPT_SSLKEYTYPE.3
Set type of the private key file
CURLOPT_SSLVERSION.3
Set preferred tls/ssl version
CURLOPT_SSL_CIPHER_LIST.3
Specify ciphers to use for tls
CURLOPT_SSL_CTX_DATA.3
Custom pointer passed to ssl_ctx callback
CURLOPT_SSL_CTX_FUNCTION.3
Openssl specific callback to do ssl magic
CURLOPT_SSL_ENABLE_ALPN.3
Enable alpn
CURLOPT_SSL_ENABLE_NPN.3
Enable npn
CURLOPT_SSL_OPTIONS.3
Set ssl behavior options
CURLOPT_SSL_SESSIONID_CACHE.3
Enable/disable use of the ssl session-id cache
CURLOPT_SSL_VERIFYHOST.3
Verify the certificate's name against host
CURLOPT_SSL_VERIFYPEER.3
Verify the peer's ssl certificate
CURLOPT_STDERR.3
Redirect stderr to another stream
CURLOPT_TCP_KEEPALIVE.3
Enable tcp keep-alive probing
CURLOPT_TCP_KEEPIDLE.3
Set tcp keep-alive idle time wait
CURLOPT_TCP_KEEPINTVL.3
Set tcp keep-alive interval
CURLOPT_TCP_NODELAY.3
Set the tcp_nodelay option
CURLOPT_TELNETOPTIONS.3
Custom telnet options
CURLOPT_TFTP_BLKSIZE.3
Tftp block size
CURLOPT_TIMECONDITION.3
Select condition for a time request
CURLOPT_TIMEOUT.3
Set maximum time the request is allowed to take
CURLOPT_TIMEOUT_MS.3
Set maximum time the request is allowed to take
CURLOPT_TIMEVALUE.3
Set time value for conditional
CURLOPT_TLSAUTH_PASSWORD.3
Tls authentication password
CURLOPT_TLSAUTH_TYPE.3
Set tls authentication methods
CURLOPT_TLSAUTH_USERNAME.3
User name for tls authentication
CURLOPT_TRANSFERTEXT.3
Request a text based transfer for ftp
CURLOPT_TRANSFER_ENCODING.3
Ask for http transfer encoding
CURLOPT_UNRESTRICTED_AUTH.3
Send credentials to other hosts too
CURLOPT_UPLOAD.3
Enable data upload
CURLOPT_URL.3
Provide the url to use in the request
CURLOPT_USERAGENT.3
Set http user-agent header
CURLOPT_USERNAME.3
Username to authenticate with
CURLOPT_USERPWD.3
Set user + password to work with
CURLOPT_USE_SSL.3
Request using ssl / tls for the transfer
CURLOPT_VERBOSE.3
Set verbose mode on/off
CURLOPT_WILDCARDMATCH.3
Enable directory wildcard transfers
CURLOPT_WRITEDATA.3
Custom pointer passed to the write callback
CURLOPT_WRITEFUNCTION.3
Set callback for writing received data
CURLOPT_XFERINFODATA.3
Custom pointer passed to the progress callback
CURLOPT_XFERINFOFUNCTION.3
Callback to progress meter function
CURLOPT_XOAUTH2_BEARER.3
Specify oauth 2 access token
curl_easy_cleanup.3
End a libcurl easy session
curl_easy_duphandle.3
Clone a libcurl session handle
curl_easy_escape.3
Url encodes the given string
curl_easy_getinfo.3
Extract information from a curl handle
curl_easy_init.3
Start a libcurl easy session
curl_easy_pause.3
Pause and unpause a connection
curl_easy_perform.3
Perform a file transfer
curl_easy_recv.3
Receives raw data on an "easy" connection
curl_easy_reset.3
Reset all options of a libcurl session handle
curl_easy_send.3
Sends raw data over an "easy" connection
curl_easy_setopt.3
Set options for a curl easy handle
curl_easy_strerror.3
Return string describing error code
curl_easy_unescape.3
Url decodes the given string
curl_escape.3
Url encodes the given string
curl_formadd.3
Add a section to a multipart/formdata http post
curl_formfree.3
Free a previously build multipart/formdata http post chain
curl_formget.3
Serialize a previously built multipart/formdata http post chain
curl_free.3
Reclaim memory that has been obtained through a libcurl call
curl_getdate.3
Convert a date string to number of seconds
curl_getenv.3
Return value for environment name
curl_global_cleanup.3
Global libcurl cleanup
curl_global_init.3
Global libcurl initialisation
curl_global_init_mem.3
Global libcurl initialisation with memory callbacks
curl_maprintf.3
Formatted output conversion
curl_mfprintf.3
Formatted output conversion
curl_mprintf.3
Formatted output conversion
curl_msnprintf.3
Formatted output conversion
curl_msprintf.3
Formatted output conversion
curl_multi_add_handle.3
Add an easy handle to a multi session
curl_multi_assign.3
Set data to association with an internal socket
curl_multi_cleanup.3
Close down a multi session
curl_multi_fdset.3
Extracts file descriptor information from a multi handle
curl_multi_info_read.3
Read multi stack informationals
curl_multi_init.3
Create a multi handle
curl_multi_perform.3
Reads/writes available data from each easy handle
curl_multi_remove_handle.3
Remove an easy handle from a multi session
curl_multi_setopt.3
Set options for a curl multi handle
curl_multi_socket.3
Reads/writes available data
curl_multi_socket_action.3
Reads/writes available data given an action
curl_multi_strerror.3
Return string describing error code
curl_multi_timeout.3
How long to wait for action before proceeding
curl_multi_wait.3
Polls on all easy handles in a multi handle
curl_mvaprintf.3
Formatted output conversion
curl_mvfprintf.3
Formatted output conversion
curl_mvprintf.3
Formatted output conversion
curl_mvsnprintf.3
Formatted output conversion
curl_mvsprintf.3
Formatted output conversion
curl_share_cleanup.3
Clean up a shared object
curl_share_init.3
Create a shared object
curl_share_setopt.3
Set options for a shared object
curl_share_strerror.3
Return string describing error code
curl_slist_append.3
Add a string to an slist
curl_slist_free_all.3
Free an entire curl_slist list
curl_strequal.3
Case insensitive string comparisons
curl_strnequal.3
Case insensitive string comparisons
curl_unescape.3
Url decodes the given string
curl_version.3
Returns the libcurl version string
curl_version_info.3
Returns run-time libcurl version info
libcurl.3
Client-side url transfers
libcurl-easy.3
Easy interface overview
libcurl-errors.3
Error codes in libcurl
libcurl-multi.3
How to use the multi interface
libcurl-share.3
How to use the share interface
libcurl-tutorial.3
Libcurl programming tutorial