Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

curlopt_accept_encoding(3) [mojave man page]

CURLOPT_ACCEPT_ENCODING(3)				     curl_easy_setopt options					CURLOPT_ACCEPT_ENCODING(3)

NAME
CURLOPT_ACCEPT_ENCODING - enables automatic decompression of HTTP downloads SYNOPSIS
#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ACCEPT_ENCODING, char *enc); DESCRIPTION
Pass a char * argument specifying what encoding you'd like. Sets the contents of the Accept-Encoding: header sent in a HTTP request, and enables decoding of a response when a Content-Encoding: header is received. Three encodings are supported: identity, meaning non-compressed, deflate which requests the server to compress its response using the zlib algorithm, and gzip which requests the gzip algorithm. If a zero-length string is set like "", then an Accept-Encoding: header containing all built-in supported encodings is sent. Set this option to NULL to explicitly disable it, which makes libcurl not send an Accept-Encoding: header and not decompress contents auto- matically. You can also opt to just include the Accept-Encoding: header in your request with CURLOPT_HTTPHEADER(3) but then there will be no automatic decompressing when receiving data. This is a request, not an order; the server may or may not do it. This option must be set (to any non-NULL value) or else any unsolicited encoding done by the server is ignored. Servers might respond with Content-Encoding even without getting a Accept-Encoding: in the request. Servers might respond with a different Content-Encoding than what was asked for in the request. The Content-Length: servers send for a compressed response is supposed to indicate the length of the compressed content so when auto decod- ing is enabled it may not match the sum of bytes reported by the write callbacks (although, sending the length of the non-compressed con- tent is a common server mistake). The application does not have to keep the string around after setting this option. DEFAULT
NULL PROTOCOLS
HTTP EXAMPLE
CURL *curl = curl_easy_init(); if(curl) { curl_easy_setopt(curl, CURLOPT_URL, "http://example.com"); /* enable all supported built-in compressions */ curl_easy_setopt(curl, CURLOPT_ACCEPT_ENCODING, ""); /* Perform the request */ curl_easy_perform(curl); } AVAILABILITY
This option was called CURLOPT_ENCODING before 7.21.6 RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space. SEE ALSO
CURLOPT_TRANSFER_ENCODING(3), CURLOPT_HTTPHEADER(3), CURLOPT_HTTP_CONTENT_DECODING(3), libcurl 7.54.0 December 21, 2016 CURLOPT_ACCEPT_ENCODING(3)

Check Out this Related Man Page

CURLOPT_DEFAULT_PROTOCOL(3)				     curl_easy_setopt options				       CURLOPT_DEFAULT_PROTOCOL(3)

NAME
CURLOPT_DEFAULT_PROTOCOL - default protocol to use if the URL is missing a scheme name SYNOPSIS
#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DEFAULT_PROTOCOL, char *protocol); DESCRIPTION
This option tells libcurl to use protocol if the URL is missing a scheme name. Use one of these protocol (scheme) names: dict, file, ftp, ftps, gopher, http, https, imap, imaps, ldap, ldaps, pop3, pop3s, rtsp, scp, sftp, smb, smbs, smtp, smtps, telnet, tftp An unknown or unsupported protocol causes error CURLE_UNSUPPORTED_PROTOCOL when libcurl parses a schemeless URL. Parsing happens when curl_easy_perform(3) or curl_multi_perform(3) is called. The protocols supported by libcurl will vary depending on how it was built. Use curl_version_info(3) if you need a list of protocol names supported by the build of libcurl that you are using. This option does not change the default proxy protocol (http). Without this option libcurl would make a guess based on the host, see CURLOPT_URL(3) for details. The application does not have to keep the string around after setting this option. DEFAULT
NULL (make a guess based on the host) PROTOCOLS
All EXAMPLE
curl = curl_easy_init(); if(curl) { /* set a URL without a scheme */ curl_easy_setopt(curl, CURLOPT_URL, "example.com"); /* set the default protocol (scheme) for schemeless URLs */ curl_easy_setopt(curl, CURLOPT_DEFAULT_PROTOCOL, "https"); /* Perform the request */ curl_easy_perform(curl); } AVAILABILITY
Added in 7.45.0 RETURN VALUE
CURLE_OK if the option is supported. CURLE_OUT_OF_MEMORY if there was insufficient heap space. CURLE_UNKNOWN_OPTION if the option is not supported. SEE ALSO
CURLOPT_URL(3), libcurl 7.54.0 December 21, 2016 CURLOPT_DEFAULT_PROTOCOL(3)
Man Page