bookindex.md

Index

.

• .netrc: Command line leakage, .netrc, The .netrc file format, Enable netrc

/

• /etc/hosts: Host name or address, Edit the hosts file

<

• <curl/curl.h>: include/curl, curl --libcurl, Header files, Get a simple HTML page, Get a HTML page in memory

A

• --anyauth: HTTP authentication
• apt: apt

B

• -b: Cookie engine, Reading cookies from file, Writing cookies to file, New cookie session, curl HTTP cheat sheet
• --basic: HTTP authentication
• BoringSSL: Select TLS backend, Build to use a TLS library, OpenSSL, BoringSSL, libressl, Build curl with boringssl, build boringssl, set up the build tree to get detected by curl's configure, configure curl

C

• -c: Writing cookies to file, curl HTTP cheat sheet
• c-ares: Name resolve tricks with c-ares, c-ares
• C89: Comments, Building and installing
• CA: Verbose mode, MITM-proxies, Available exit codes, Verifying server certificates, CA store, CA store on windows, OCSP stapling
• Chrome: Copy as curl, From Chrome
• clone: Clone the code, git, Pull request, Web site source code, build boringssl
• code of conduct: Code of conduct
• --compressed: Compression, Gzipped transfers, curl HTTP cheat sheet
• configure: root, include/curl, Handling different build options, On Linux and Unix-like systems, Autotools, cross-compiling, Select TLS backend, configure, OpenSSL, BoringSSL, libressl, GnuTLS, NSS, WolfSSL, axTLS, mbedTLS, Secure Transport, Schannel, set up the build tree to get detected by curl's configure, configure curl
• --connect-timeout: Never spend more than this to connect
• --connect-to: Provide a replacement name
• Connection reuse: Connection reuse, Connection reuse
• content-encoding: Compression, Transfer encoding
• contribute: Code of conduct, Contributing, Pull request
• Contributing: docs, Contributing
• Cookie engine: Cookie engine, Writing cookies to file, Cookie engine, Enable cookie engine with reading, Enable cookie engine with writing, Setting custom cookies
• Cookies: docs, Server differences, Change the Host: header, Not perfect, Maintain state with cookies, HTTP authentication, Cookies, Cookie engine, Reading cookies from file, Writing cookies to file, New cookie session, libpsl, Simple by default, more on demand, Available information, Cookies with libcurl, Cookie engine, Enable cookie engine with reading, Enable cookie engine with writing, Setting custom cookies, Import export, Get all cookies from the cookie store, Cookie store commands
• copyright: License, Copyright
• curl-announce: curl-announce, Vulnerability handling
• curl-library: curl-users, curl-library, Make a patch for the mailing list, Vulnerability handling
• curl-users: curl-users, Vulnerability handling
• CURLE_ABORTED_BY_CALLBACK: Progress callback
• CURLMOPT_SOCKETFUNCTION: socket_callback
• CURLMOPT_TIMERFUNCTION: timer_callback
• CURLOPT_CLOSEOCKETFUNCTION: Socket close callback
• CURLOPT_COOKIE: Setting custom cookies
• CURLOPT_COOKIEFILE: Enable cookie engine with reading
• CURLOPT_COOKIEJAR: Enable cookie engine with writing
• CURLOPT_COOKIELIST: Add a cookie to the cookie store, Cookie store commands
• CURLOPT_CUSTOMREQUEST: Request method
• CURLOPT_DEBUGDATA: Debug callback, Trace everything
• CURLOPT_DEBUGFUNCTION: Debug callback, Trace everything
• CURLOPT_ERRORBUFFER: curl --libcurl, CURLcode return code
• CURLOPT_FAILONERROR: About HTTP response code "errors"
• CURLOPT_HEADER: Write callback, Referrer, Download headers too
• CURLOPT_HEADERDATA: Header callback, curl --libcurl, Download headers too
• CURLOPT_HEADERFUNCTION: Header callback, curl --libcurl
• CURLOPT_HTTPGET: libcurl HTTP download
• CURLOPT_HTTPHEADER: Add a header, Change a header, Remove a header, Provide a header without contents
• CURLOPT_HTTPPOST: HTTP multipart formposts
• CURLOPT_MAXFILE_LARGE: Setting numerical options
• CURLOPT_MAXREDIRS: curl --libcurl
• CURLOPT_NOBODY: Request method
• CURLOPT_NOPROGRESS: Progress callback, curl --libcurl
• CURLOPT_OPENSOCKETDATA: Provide a file descriptor
• CURLOPT_OPENSOCKETFUNCTION: Provide a file descriptor
• CURLOPT_POST: HTTP POST
• CURLOPT_POSTFIELDS: Request method, Customize HTTP request headers, HTTP POST
• CURLOPT_POSTFIELDSIZE: HTTP POST
• CURLOPT_POSTREDIR: Decide what method to use in redirects
• CURLOPT_PROGRESSFUNCTION: Progress callback
• CURLOPT_PROXY: Proxy types
• CURLOPT_PROXYPORT: Proxy types
• CURLOPT_PROXYTYPE: Proxy types
• CURLOPT_READDATA: Read callback, curl --libcurl
• CURLOPT_READFUNCTION: Read callback, curl --libcurl, HTTP POST
• CURLOPT_SEEKDATA: curl --libcurl
• CURLOPT_SEEKFUNCTION: curl --libcurl
• CURLOPT_SOCKOPTDATA: sockopt callback
• CURLOPT_SOCKOPTFUNCTION: sockopt callback
• CURLOPT_SSH_KNOWNHOSTS: curl --libcurl
• CURLOPT_STDERR: curl --libcurl, Verbose operations
• CURLOPT_TCP_KEEPALIVE: curl --libcurl
• CURLOPT_TIMEOUT: Setting numerical options
• CURLOPT_UPLOAD: Request method
• CURLOPT_URL: Easy handle, curl --libcurl, Set handle options, Get a simple HTML page, Get a HTML page in memory, Request method, Automatic referrer, libcurl HTTP download, Download headers too
• CURLOPT_USERAGENT: curl --libcurl, Get a HTML page in memory
• CURLOPT_VERBOSE: Verbose operations, Trace everything, Download headers too
• CURLOPT_WRITEDATA: Write callback, curl --libcurl, Get a HTML page in memory
• CURLOPT_WRITEFUNCTION: Write callback, curl --libcurl, Get a HTML page in memory
• CURLOPT_XFERINFODATA: Progress callback
• CURLOPT_XFERINFOFUNCTION: Progress callback
• curl_easy_cleanup: easy handle, curl --libcurl, Get a simple HTML page, Get a HTML page in memory, Enable cookie engine with writing
• curl_easy_init: Easy handle, curl --libcurl, Get a simple HTML page, Get a HTML page in memory, libcurl HTTP download, Download headers too
• curl_easy_perform: Driving with the easy interface, Easy API pool, curl --libcurl, Get a simple HTML page, Get a HTML page in memory, Add a header, Change a header, Remove a header, Provide a header without contents, Referrer, Automatic referrer, libcurl HTTP download, Download headers too
• curl_easy_reset: Easy handle
• curl_easy_setopt: docs/libcurl/opts, Easy handle, Write callback, Read callback, Progress callback, Header callback, Debug callback, sockopt callback, Provide a file descriptor, Socket close callback, curl --libcurl, Set handle options, Setting numerical options, Get handle options, CURLcode return code, Verbose operations, Get a simple HTML page, Get a HTML page in memory, Request method, Add a header, Change a header, Remove a header, Provide a header without contents, Referrer, Automatic referrer, HTTP ranges, Enable cookie engine with reading, Enable cookie engine with writing, Setting custom cookies, Add a cookie to the cookie store, Cookie store commands, libcurl HTTP download, Download headers too, HTTP POST, HTTP multipart formposts
• curl_global_cleanup: Global initialization, Get a HTML page in memory
• curl_global_init: Global initialization, Get a HTML page in memory
• CURL_MAX_WRITE_SIZE: Write callback
• curl_multi_add_handle: Driving with the multi interface, Many easy handles
• curl_multi_cleanup: Multi API
• curl_multi_fdset: Driving with the multi interface
• curl_multi_info_read: When is a single transfer done?, When is it done?, Multi API
• curl_multi_init: Driving with the multi interface
• curl_multi_remove_handle: Driving with the multi interface, Many easy handles, Multi API
• curl_multi_setopt: docs/libcurl/opts, Driving with the multi interface, socket_callback, timer_callback
• curl_multi_socket_action: socket_callback, timer_callback, How to start everything, When is it done?
• curl_multi_timeout: Driving with the multi interface
• curl_multi_wait: Driving with the multi interface
• curl_off_t: Progress callback, Setting numerical options
• CURL_SOCKET_TIMEOUT: timer_callback, How to start everything
• curl_version_info: Which libcurl version runs

D

• -d: Arguments to options, Arguments with spaces, Separate options per URL, POST, HTTP methods, HTTP POST, Content-Type, POSTing binary, Convert that to a GET, Expect 100-continue, Chunked encoded POSTs, Hidden form fields, -d vs -F, HTML web forms, POST outside of HTML, PUT, curl HTTP cheat sheet
• --data: Arguments to options, Separate options per URL, POST, HTTP POST, URL encoding
• --data-binary: Not perfect, POSTing binary, URL encoding
• --data-urlencode: URL encoding
• debian: lib/vtls, apt
• Debug callback: Debug callback, Verbose operations
• development: Project communication, curl-users, curl-library, Reporting bugs, Problems must be known to get fixed, The development team, Future, Development, Source code on github, Who decides what goes in?, SSL and TLS versions, Figure out what a browser sends, apt, yum, Which libcurl version runs

E

• environment variables: Default config file, Proxy environment variables
• etiquette: Mailing list etiquette
• event-driven: Driving with the "multi_socket" interface

F

• -F: multipart formpost, Not perfect, HTTP methods, Sending such a form with curl, Content-Type, -d vs -F, HTML web forms, curl HTTP cheat sheet
• Firefox: lib/vtls, Discover your proxy, Copy as curl, From Firefox, On Firefox, without using the devtools, User-agent
• Fragment: Fragment, Anchors or fragments
• --ftp-method: multicwd, nocwd, singlecwd
• --ftp-pasv: Passive connections
• --ftp-port: Available exit codes, Active connections
• --ftp-skip-pasv-ip: Passive connections
• future: Project communication, Future, docs, [email protected], What other protocols are there?, HTTPS to proxy, "Not used", Cookies, API compatibility

G

• --get: Convert that to a GET
• git: Daily snapshots, Clone the code, root, include/curl, scripts, git, Pull request, Make a patch for the mailing list, git commit style, Who decides what goes in?, Web site source code, Building the web, git vs tarballs, build boringssl
• Globbing: URL globbing, Output variables for globbing
• GnuTLS: OCSP stapling, Build to use a TLS library, GnuTLS, Proxy types
• Gopher: How it started, What protocols does curl support?, GOPHER, Supported protocols

H

• --header: Server differences, Customize headers
• Header callback: Header callback, HTTP responses
• homebrew: homebrew
• Host:: Verbose mode, --trace and --trace-ascii, --trace-time, Change the Host: header, HTTP protocol basics, The URL converted to a request, The HTTP this generates, Customize headers, Customize HTTP request headers, Change a header
• HTTP ranges: HTTP ranges, HTTP ranges
• HTTP redirects: Short options, Long options, Available exit codes, HTTP redirects, Tell curl to follow redirects, Decide what method to use in redirects, Non-HTTP redirects
• HTTP/1.1: HTTP, Verbose mode, --trace and --trace-ascii, --trace-time, HTTP/2, HTTP protocol basics, HTTP versions, The HTTP this generates, GET or POST?, Request method, Customize HTTP request headers, HTTP versions
• HTTP/2: docs, HTTP, HTTP/2, Available exit codes, HTTP versions, GET or POST?, nghttp2, HTTP versions
• HttpGet: How it started

I

• IDN: libidn2
• Indentation: Indentation, Open brace on the same line
• IPv4: Host name or address, Port number, Available --write-out variables
• IPv6: Host name or address, Port number, URL globbing, Available --write-out variables

J

• JavaScript: Client differences, PAC, JavaScript and forms, JavaScript redirects
• json: Arguments with spaces, Content-Type, POST outside of HTML

K

• -K: Command lines, quotes and aliases, Config file
• keep-alive: Keep connections alive
• --keepalive-time: Keep alive, Keep connections alive

L

• -L: Available --write-out variables, Tell curl to follow redirects, Request method, Cookie engine, Reading cookies from file, curl HTTP cheat sheet
• --libcurl: curl --libcurl
• libcurl version: Available exit codes, The latest version?, Which libcurl version, Which libcurl version runs
• libidn2: libidn2
• libmetalink: libmetalink
• libpsl: libpsl
• libressl: Select TLS backend, Build to use a TLS library, OpenSSL, BoringSSL, libressl
• librtmp: librtmp
• libssh2: libssh2
• license: Finding users, Famous users, License, root
• --limit-rate: Rate limiting
• --location: Long options, Separate options per URL, Config file, Tell curl to follow redirects

M

• --max-filesize: Maximum filesize
• --max-time: Retrying failed attempts, Maximum time allowed to spend
• --metalink: Metalink
• Metalink: Metalink
• MIT: License
• MITM-proxies: MITM-proxies
• multi-threading: libcurl multi-threading

N

• --negotiate: Network leakage, HTTP authentication
• --netrc-file: Enable netrc
• --netrc-optional: Enable netrc
• nghttp2: nghttp2
• nix: nix
• --no-eprt: Active connections
• --no-epsv: Passive connections
• NSS: OCSP stapling, yum, Build to use a TLS library, NSS, Proxy types
• --ntlm: Network leakage, HTTP authentication

O

• -O: Many options and URLs, Numerical ranges, Alphabetical ranges, A list, Combinations, Output variables for globbing, Download to a file named by the URL, Get the target file name from the server, Shell redirects, Multiple downloads, Use the URL's file name part for all URLs, Resuming and ranges, curl HTTP cheat sheet
• openldap: openldap
• OpenSSL: lib/vtls, OCSP stapling, Select TLS backend, Build to use a TLS library, configure, OpenSSL, BoringSSL, libressl, Proxy types, Available information

P

• PAC: PAC
• Percent-encoding: URL encoding
• pop3: What protocols does curl support?, POP3, POP3S, Without scheme, Supported protocols, Verbose mode, Available exit codes, Reading email, POP3, Secure mail transfer, Enable TLS
• port number: Connects to "port numbers", Port number, Available --write-out variables, Provide a replacement name, Local port number, HTTP, HTTP proxy tunneling, Available exit codes, The URL converted to a request, Proxies, Proxy types, Post transfer info
• --post301: Decide what method to use in redirects
• --post302: Decide what method to use in redirects
• --post303: Decide what method to use in redirects
• Progress callback: timer_callback, Progress callback
• proxy: How it started, Available --write-out variables, Intermediaries' fiddlings, Proxies, Discover your proxy, PAC, Proxy type, HTTP, HTTPS and proxy, MITM-proxies, Non-HTTP protocols over an HTTP proxy, HTTP proxy tunneling, SOCKS types, Proxy authentication, HTTPS to proxy, Proxy environment variables, Proxy headers, Available exit codes, CONNECT response codes, Pass on transfer encoding, HTTP authentication, Proxies, Proxy types, Local or proxy name lookup, HTTP proxy, HTTPS proxy, Proxy authentication, Available information, HTTP proxy
• --proxy: HTTP, HTTP authentication
• --proxy-user: Proxy authentication, HTTP authentication
• --proxy1.0: HTTP proxy tunneling
• --proxytunnel: HTTP proxy tunneling

R

• ranges: Numerical ranges, Alphabetical ranges, Combinations, Resuming and ranges, HTTP ranges, Provide a file descriptor, HTTP response code, About HTTP response code "errors", HTTP ranges
• Read callback: Read callback, HTTP POST
• redhat: lib/vtls, yum
• redirects: Long options, Separate options per URL, Config file, Available --write-out variables, Download to a file named by the URL, Shell redirects, Provide a custom IP address for a name, Provide a replacement name, Available exit codes, Follow redirects automatically, HTTP redirects, Permanent and temporary, Tell curl to follow redirects, GET or POST?, Decide what method to use in redirects, Non-HTTP redirects, HTML redirects, JavaScript redirects, Request method, Available information, Automatic referrer
• RELEASE-NOTES: scripts
• releases: [1. The cURL project](how.md#1.-the-curl-project), curl-announce, Releases, scripts, Verbose mode, Which libcurl version
• --remote-name-all: Use the URL's file name part for all URLs
• repository: Releases, Daily snapshots, Source code on github, Hosting and download, root, include/curl, scripts, What to add, Pull request, Who decides what goes in?, Web site source code, Building the web, Installing from your package repository, git vs tarballs
• --resolve: Provide a custom IP address for a name, Provide a replacement name
• RTMP: What protocols does curl support?, RTMP, Supported protocols, librtmp
• RTSP: What protocols does curl support?, RTSP, Supported protocols, RTSP interleave callback, Available information

S

• Schannel: CA store on windows, Build to use a TLS library, Schannel
• Scheme: Connects to "port numbers", FILE, Scheme, The scheme separator, Without scheme, Name and password, Proxy type, SOCKS types, Proxy authentication, Available exit codes, librtmp, Proxy types, Available information, Which libcurl version, Bindings
• SCP: What protocols does curl support?, SCP, Supported protocols, Protocols allowing upload, Available exit codes, SCP and SFTP, URLs, Known hosts, libssh2
• security: curl-announce, Security, Past security problems, Trust, docs, Reporting vulnerabilities, Vulnerability handling, TLS, How much do protocols change?, FTPS, TLS, Ciphers, Enable TLS, How to HTTP with curl
• SFTP: What protocols does curl support?, About adhering to standards and who's right, SFTP, Supported protocols, --trace and --trace-ascii, Protocols allowing upload, Available exit codes, SCP and SFTP, URLs, Known hosts, libssh2
• --show-error: Silence
• --silent: The progress meter, Silence, Error message
• SMTP: What protocols does curl support?, SMTP, SMTPS, Without scheme, Supported protocols, Verbose mode, Protocols allowing upload, SMTP uploads, Available exit codes, SMTP, Secure mail transfer, The SMTP URL, Enable TLS
• SMTPS: What protocols does curl support?, SMTPS, Supported protocols, Protocols allowing upload, Enable TLS, Build to use a TLS library
• snapshots: Daily snapshots, root
• SNI: Change the Host: header, Provide a custom IP address for a name
• --socks4: SOCKS types
• --socks4a: SOCKS types
• --socks5: SOCKS types
• --socks5-hostname: SOCKS types
• --speed-limit: Transfer speeds slower than this means exit
• --speed-time: Transfer speeds slower than this means exit
• SSH: SCP, SFTP, Available exit codes, SCP and SFTP, Known hosts, SSH key callback, Trace everything
• SSL context callback: SSL context callback

T

• -T: PUT, FTP uploads, SMTP uploads, Uploading with FTP, HTTP methods, PUT, curl HTTP cheat sheet
• TELNET: What protocols does curl support?, TELNET, Supported protocols, Available exit codes, TELNET
• testing: What does curl do?, Reporting bugs, Testing, Handling different build options, Contributing, About HTTP response code "errors"
• TLS: lib/vtls, docs, Handling different build options, TLS, Transfer data, How much do protocols change?, Connection reuse, Verbose mode, Change the Host: header, MITM-proxies, Available exit codes, SCP and SFTP, Known hosts, TLS, Ciphers, Enable TLS, SSL and TLS versions, Verifying server certificates, CA store, CA store on windows, Certificate pinning, OCSP stapling, Client certificates, TLS auth, Different TLS backends, Multiple TLS backends, How to HTTP with curl, The URL converted to a request, HTTPS, Figure out what a browser sends, apt, yum, Select TLS backend, TLS libraries, Build to use a TLS library, Proxy types, Available information, Trace everything
• TODO: Suggestions
• --tr-encoding: Compression, Transfer encoding
• --trace: --trace and --trace-ascii, --trace-time
• --trace-ascii: --trace and --trace-ascii, --trace-time, Server differences, curl HTTP cheat sheet
• --trace-time: --trace-time
• transfer-encoding: Pass on transfer encoding, Chunked encoded POSTs

U

• -u: Passwords and snooping, Command line leakage, Authentication, URLs, HTTP authentication, curl HTTP cheat sheet
• -U: Proxy authentication
• URL Globbing: URL globbing

V

• --verbose: Long options, Verbose mode, --trace-time
• Vulnerability: Vulnerability handling

W

• Write callback: Write callback, Get a HTML page in memory, HTTP responses
• --write-out: --write-out, Available --write-out variables, HTTP response codes, CONNECT response codes

X

• -X: Request method, Request target, PUT, curl HTTP cheat sheet
• -x: HTTP, HTTPS and proxy, Non-HTTP protocols over an HTTP proxy, HTTP proxy tunneling, SOCKS types, Proxy authentication, Proxy environment variables, curl HTTP cheat sheet

Y

• yum: yum

Z

• zlib: zlib