diff --git a/SUMMARY.md b/SUMMARY.md index ab699f54f0..8af285a217 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,6 +1,6 @@ # Table of contents -* [README](README.md) +* [Introduction](README.md) * [How to read this book](how-to-read.md) * [The cURL project](project.md) * [How it started](project/started.md) @@ -33,7 +33,7 @@ * [Source code](source.md) * [Open Source](source/opensource.md) * [License](source/opensource/license.md) - * [Copyright and Legal](source/opensource/copyright.md) + * [Copyright](source/opensource/copyright.md) * [Code layout](source/layout.md) * [Handling build options](source/options.md) * [Code style](source/style.md) @@ -87,7 +87,7 @@ * [Shell redirects](usingcurl/downloads/redirects.md) * [Multiple downloads](usingcurl/downloads/multiple.md) * [My browser shows something else](usingcurl/downloads/browsers.md) - * [Maximum file size](usingcurl/downloads/max-filesize.md) + * [Maximum filesize](usingcurl/downloads/max-filesize.md) * [Storing metadata in file system](usingcurl/downloads/metadata-fs.md) * [Raw](usingcurl/downloads/raw.md) * [Retry](usingcurl/downloads/retry.md) @@ -113,7 +113,7 @@ * [HTTP proxy](usingcurl/proxies/http.md) * [SOCKS proxy](usingcurl/proxies/socks.md) * [MITM proxy](usingcurl/proxies/mitm.md) - * [Authentication](usingcurl/proxies/auth.md) + * [Proxy authentication](usingcurl/proxies/auth.md) * [HTTPS proxy](usingcurl/proxies/https.md) * [Proxy environment variables](usingcurl/proxies/env.md) * [Proxy headers](usingcurl/proxies/headers.md) diff --git a/bindings.md b/bindings.md index 0377a83417..3cc265baad 100644 --- a/bindings.md +++ b/bindings.md @@ -1,4 +1,4 @@ -# Bindings for libcurl +# Bindings Creative people have written bindings or interfaces for various environments and programming languages. Using one of these allows you to take advantage of diff --git a/build.md b/build.md index cbabe857a3..08c7d0d0d8 100644 --- a/build.md +++ b/build.md @@ -1,4 +1,4 @@ -# Build +# Build curl The source code for this project is written in a way that allows it to get compiled and built on just about any operating system and platform, with as diff --git a/build/boringssl.md b/build/boringssl.md index 13c36a082c..d7c1d9719b 100644 --- a/build/boringssl.md +++ b/build/boringssl.md @@ -1,4 +1,4 @@ -# Build curl with boringssl +# BoringSSL ## build boringssl diff --git a/build/tls.md b/build/tls.md index 077d43632e..fd579954a9 100644 --- a/build/tls.md +++ b/build/tls.md @@ -1,4 +1,4 @@ -# Build to use a TLS library +# TLS libraries To make curl support TLS based protocols, such as HTTPS, FTPS, SMTPS, POP3S, IMAPS and more, you need to build with a third-party TLS library since curl diff --git a/build/windows.md b/build/windows.md index 80c8942706..a937fb8775 100644 --- a/build/windows.md +++ b/build/windows.md @@ -1,4 +1,4 @@ -# On Windows +# Windows You can build curl on Windows in several different ways. We recommend using the MSVC compiler from Microsoft or the free and open source mingw diff --git a/cmdline/listopts.md b/cmdline/listopts.md index 0516862507..3e1e2a1d33 100644 --- a/cmdline/listopts.md +++ b/cmdline/listopts.md @@ -1,4 +1,4 @@ -# List all command-line options +# List options curl has more than two hundred command-line options and the number of options keep increasing over time. Chances are the number of options will reach 250 diff --git a/cmdline/passwords.md b/cmdline/passwords.md index ea1465628d..c01aa67812 100644 --- a/cmdline/passwords.md +++ b/cmdline/passwords.md @@ -1,4 +1,4 @@ -# Passwords and snooping +# Passwords Passwords are tricky and sensitive. Leaking a password can make someone other than you access the resources and the data otherwise protected. diff --git a/cmdline/progressmeter.md b/cmdline/progressmeter.md index 3b8d47da79..0b7650fe24 100644 --- a/cmdline/progressmeter.md +++ b/cmdline/progressmeter.md @@ -1,4 +1,4 @@ -# The progress meter +# Progress meter curl has a built-in progress meter. When curl is invoked to transfer data (either uploading or downloading) it can show that meter in the terminal diff --git a/ftp/traversedir.md b/ftp/traversedir.md index 2f65a3a109..028e7bd367 100644 --- a/ftp/traversedir.md +++ b/ftp/traversedir.md @@ -1,4 +1,4 @@ -# How to traverse directories +# Directory traversing When doing FTP commands to traverse the remote file system, there are a few different ways curl can proceed to reach the target file, the file the user diff --git a/ftp/twoconnections.md b/ftp/twoconnections.md index da1650e9d8..5a29c73752 100644 --- a/ftp/twoconnections.md +++ b/ftp/twoconnections.md @@ -1,4 +1,4 @@ -# FTP uses two connections +# Two connections FTP uses two TCP connections! The first connection is setup by the client when it connects to an FTP server, and is called the *control connection*. As the diff --git a/get.md b/get.md index 02abbc2413..972d4a674b 100644 --- a/get.md +++ b/get.md @@ -1,4 +1,4 @@ -# Get curl +# Install curl curl is totally free, open and available. There are numerous ways to get it and install it for most operating systems and architecture. This section will diff --git a/get/linux.md b/get/linux.md index 15b1fa6e15..3380a74fa5 100644 --- a/get/linux.md +++ b/get/linux.md @@ -1,4 +1,4 @@ -# Get curl for Linux +# Linux Linux distributions come with "packager managers" that let you install software that they offer. Most Linux distributions offer curl and libcurl to diff --git a/get/macos.md b/get/macos.md index b97b2157c0..3e4dadcb0b 100644 --- a/get/macos.md +++ b/get/macos.md @@ -1,4 +1,4 @@ -# Get curl for macOS +# macOS macOS comes with the curl tool bundled with the operating system since many years. If you want to upgrade to the latest version shipped by the curl diff --git a/get/windows.md b/get/windows.md index b3b99531ef..097596b52e 100644 --- a/get/windows.md +++ b/get/windows.md @@ -1,4 +1,4 @@ -# Get curl for Windows +# Windows Windows 10 comes with the curl tool bundled with the operating system since version 1804. If you have an older Windows version or just want to upgrade to diff --git a/http/auth.md b/http/auth.md index e9e2cda27a..3e4fb19895 100644 --- a/http/auth.md +++ b/http/auth.md @@ -1,4 +1,4 @@ -# HTTP authentication +# Authentication Each HTTP request can be made authenticated. If a server or a proxy want the user to provide proof that they have the correct credentials to access a URL diff --git a/http/basics.md b/http/basics.md index bd922916d6..4db3e1d5d4 100644 --- a/http/basics.md +++ b/http/basics.md @@ -1,4 +1,4 @@ -# HTTP protocol basics +# Protocol basics (This assumes you have read the [Network and protocols](../protocols.md) section or are otherwise already familiar with protocols.) diff --git a/http/hsts.md b/http/hsts.md index 775ac345bd..f452d91df7 100644 --- a/http/hsts.md +++ b/http/hsts.md @@ -1,4 +1,4 @@ -# HTTP Strict Transport Security +# HSTS HTTP Strict Transport Security, HSTS, is a protocol mechanism that helps to protect HTTPS servers against man-in-the-middle attacks such as protocol diff --git a/http/method.md b/http/method.md index 3e39685f37..cc520e0e55 100644 --- a/http/method.md +++ b/http/method.md @@ -1,4 +1,4 @@ -# HTTP method +# Method In every HTTP request, there is a method. Sometimes called a verb. The most commonly used ones are `GET`, `POST`, `HEAD` and `PUT`. diff --git a/http/modify/fragment.md b/http/modify/fragment.md index 424b10c036..fc57057c28 100644 --- a/http/modify/fragment.md +++ b/http/modify/fragment.md @@ -1,4 +1,4 @@ -# Anchors or fragments +# Fragment A URL may contain an "anchor", also known as a fragment, which is written with a pound sign and string at the end of the URL. Like for example diff --git a/http/modify/method.md b/http/modify/method.md index ce0bbf1110..a0be3b7556 100644 --- a/http/modify/method.md +++ b/http/modify/method.md @@ -1,4 +1,4 @@ -# Modify the request method +# Request method The first line of an HTTP request includes the *method* - sometimes also referred to as the verb. When doing a simple GET request as this command line diff --git a/http/modify/target.md b/http/modify/target.md index 0fec8859bf..e078a9d52d 100644 --- a/http/modify/target.md +++ b/http/modify/target.md @@ -1,4 +1,4 @@ -# Modify request target +# Request target When given an input URL such as `http://example.com/file`, the path section of the URL gets extracted and is turned into `/file` in the HTTP request line. diff --git a/http/multipart.md b/http/multipart.md index 358fee242d..7e56be6366 100644 --- a/http/multipart.md +++ b/http/multipart.md @@ -1,4 +1,4 @@ -# HTTP multipart formposts +# Multipart formposts A multipart formpost is what an HTTP client sends when an HTML form is submitted with *enctype* set to "multipart/form-data". It is an HTTP POST diff --git a/http/ranges.md b/http/ranges.md index 956ee7f665..dc73a83985 100644 --- a/http/ranges.md +++ b/http/ranges.md @@ -1,4 +1,4 @@ -# HTTP ranges +# Ranges What if the client only wants the first 200 bytes out of a remote resource or perhaps 300 bytes somewhere in the middle? The HTTP protocol allows a client diff --git a/http/redirects.md b/http/redirects.md index 01c29e82ef..550353a53a 100644 --- a/http/redirects.md +++ b/http/redirects.md @@ -1,4 +1,4 @@ -# HTTP redirects +# Redirects The “redirect” is a fundamental part of the HTTP protocol. The concept was present and is documented already in the first spec (RFC 1945), published in diff --git a/http/response.md b/http/response.md index 5948f0f748..14d309bc66 100644 --- a/http/response.md +++ b/http/response.md @@ -1,4 +1,4 @@ -# HTTP responses +# Responses When an HTTP client talks HTTP to a server, the server *will* respond with an HTTP response message or curl will consider it an error and returns 52 with diff --git a/internals/caches.md b/internals/caches.md index 40f2e3102b..e479f76fc6 100644 --- a/internals/caches.md +++ b/internals/caches.md @@ -1,4 +1,4 @@ -# Caches and state in libcurl +# Caches and state When libcurl is used for Internet transfers, it stores data in caches and state storage in order to do subsequent transfers faster and better. diff --git a/internals/memory-debugging.md b/internals/memory-debugging.md index eca86377b1..24d6e6b7a4 100644 --- a/internals/memory-debugging.md +++ b/internals/memory-debugging.md @@ -1,4 +1,4 @@ -# Memory Debugging +# Memory debugging The file `lib/memdebug.c` contains debug-versions of a few functions. Functions such as `malloc()`, `free()`, `fopen()`, `fclose()`, etc that diff --git a/internals/tests/ci.md b/internals/tests/ci.md index 597b72e3cd..bad9e43b7c 100644 --- a/internals/tests/ci.md +++ b/internals/tests/ci.md @@ -1,4 +1,4 @@ -# Continuous Integration (CI) +# Continuous Integration For every pull request submitted to the curl project on GitHub and for every commit pushed to the master branch in the git repository, a vast amount of diff --git a/internals/tests/torture.md b/internals/tests/torture.md index b2ed643551..cf0a627310 100644 --- a/internals/tests/torture.md +++ b/internals/tests/torture.md @@ -1,4 +1,4 @@ -# Torture tests +# Torture When curl is built [debug enabled](debug.md), it offers a special kind of testing. The tests we call **torture** tests. Do not worry, it is not quite as diff --git a/libcurl-http/auth.md b/libcurl-http/auth.md index 3bd698d18e..438a7a8362 100644 --- a/libcurl-http/auth.md +++ b/libcurl-http/auth.md @@ -1,4 +1,4 @@ -# HTTP authentication +# Authentication libcurl supports a wide variety of HTTP authentication schemes. diff --git a/libcurl-http/cookies.md b/libcurl-http/cookies.md index d8ad7eef14..b1ed9d026d 100644 --- a/libcurl-http/cookies.md +++ b/libcurl-http/cookies.md @@ -1,4 +1,4 @@ -# Cookies with libcurl +# Cookies By default and by design, libcurl makes transfers as basic as possible and features need to be enabled to get used. One such feature is HTTP cookies, diff --git a/libcurl-http/download.md b/libcurl-http/download.md index b69bdefaee..6fa2afbd04 100644 --- a/libcurl-http/download.md +++ b/libcurl-http/download.md @@ -1,4 +1,4 @@ -# libcurl HTTP download +# Download The GET method is the default method libcurl uses when an HTTP URL is requested and no particular other method is asked for. It asks the server for a diff --git a/libcurl-http/headerapi.md b/libcurl-http/headerapi.md index a4ce42bd0e..65e921d845 100644 --- a/libcurl-http/headerapi.md +++ b/libcurl-http/headerapi.md @@ -1,4 +1,4 @@ -# Header API +# Headers API libcurl offers an API for iterating over all received HTTP headers and for extracting the contents from specific ones. diff --git a/libcurl-http/ranges.md b/libcurl-http/ranges.md index 7cd1645289..a3f19b8ed9 100644 --- a/libcurl-http/ranges.md +++ b/libcurl-http/ranges.md @@ -1,4 +1,4 @@ -# HTTP ranges +# Ranges What if the client only wants the first 200 bytes out of a remote resource or perhaps 300 bytes somewhere in the middle? The HTTP protocol diff --git a/libcurl-http/requests.md b/libcurl-http/requests.md index b5f1bdbeac..2d05a01d75 100644 --- a/libcurl-http/requests.md +++ b/libcurl-http/requests.md @@ -1,4 +1,4 @@ -# HTTP Requests +# Requests An HTTP request is what curl sends to the server when it tells the server what to do. When it wants to get data or send data. All transfers involving HTTP diff --git a/libcurl-http/responses.md b/libcurl-http/responses.md index 4e2d1f3aed..c366942d91 100644 --- a/libcurl-http/responses.md +++ b/libcurl-http/responses.md @@ -1,4 +1,4 @@ -# HTTP responses +# Responses Every HTTP request includes an HTTP response. An HTTP response is a set of metadata and a response body, where the body can occasionally be zero bytes diff --git a/libcurl-http/upload.md b/libcurl-http/upload.md index 50569cdf74..2484678f38 100644 --- a/libcurl-http/upload.md +++ b/libcurl-http/upload.md @@ -1,4 +1,4 @@ -# HTTP upload +# Upload Uploads over HTTP can be done in many different ways and it is important to notice the differences. They can use different methods, like POST or PUT, and diff --git a/libcurl-http/versions.md b/libcurl-http/versions.md index 8cb25c4389..432cb72122 100644 --- a/libcurl-http/versions.md +++ b/libcurl-http/versions.md @@ -1,4 +1,4 @@ -# HTTP versions +# Versions Like all Internet protocols, the HTTP protocol has kept evolving over the years and now there are clients and servers distributed over the world and diff --git a/libcurl/--libcurl.md b/libcurl/--libcurl.md index 49e6737c46..1d7b8fef57 100644 --- a/libcurl/--libcurl.md +++ b/libcurl/--libcurl.md @@ -1,4 +1,4 @@ -# curl --libcurl +# --libcurl We actively encourage users to first try out the transfer they want to do with the curl command-line tool, and once it works roughly the way you want it to, diff --git a/libcurl/callbacks/debug.md b/libcurl/callbacks/debug.md index 542fb9ca71..b58fc2bcc1 100644 --- a/libcurl/callbacks/debug.md +++ b/libcurl/callbacks/debug.md @@ -1,4 +1,4 @@ -# Debug callback +# Debug The debug callback is set with `CURLOPT_DEBUGFUNCTION`: diff --git a/libcurl/callbacks/header.md b/libcurl/callbacks/header.md index fe944ab384..f2b146cb3c 100644 --- a/libcurl/callbacks/header.md +++ b/libcurl/callbacks/header.md @@ -1,4 +1,4 @@ -# Header callback +# Header data The header callback is set with `CURLOPT_HEADERFUNCTION`: diff --git a/libcurl/callbacks/openclosesocket.md b/libcurl/callbacks/openclosesocket.md index 3610d27259..b4c8d11256 100644 --- a/libcurl/callbacks/openclosesocket.md +++ b/libcurl/callbacks/openclosesocket.md @@ -1,4 +1,4 @@ -# Opensocket and closesocket callbacks +# Opensocket and closesocket Occasionally you end up in a situation where you want your application to control with more precision exactly what socket libcurl will use for its diff --git a/libcurl/callbacks/progress.md b/libcurl/callbacks/progress.md index 5bf03468bc..95b7bde9c0 100644 --- a/libcurl/callbacks/progress.md +++ b/libcurl/callbacks/progress.md @@ -1,4 +1,4 @@ -# Progress callback +# Progress information The progress callback is what gets called regularly and repeatedly for each transfer during the entire lifetime of the transfer. The old callback was set diff --git a/libcurl/callbacks/read.md b/libcurl/callbacks/read.md index fc8c33e739..ac7091aece 100644 --- a/libcurl/callbacks/read.md +++ b/libcurl/callbacks/read.md @@ -1,4 +1,4 @@ -# Read callback +# Read data The read callback is set with `CURLOPT_READFUNCTION`: diff --git a/libcurl/callbacks/rtsp.md b/libcurl/callbacks/rtsp.md index fac1153719..51d73b62ac 100644 --- a/libcurl/callbacks/rtsp.md +++ b/libcurl/callbacks/rtsp.md @@ -1,4 +1,4 @@ -# RTSP interleave callback +# RTSP interleaved data The callback with the `CURLOPT_INTERLEAVEFUNCTION` option. diff --git a/libcurl/callbacks/seek.md b/libcurl/callbacks/seek.md index 6129e7f737..77afa83ac0 100644 --- a/libcurl/callbacks/seek.md +++ b/libcurl/callbacks/seek.md @@ -1,4 +1,4 @@ -# seek callback +# Seek and ioctl This callback is set with `CURLOPT_SEEKFUNCTION`. diff --git a/libcurl/callbacks/sockopt.md b/libcurl/callbacks/sockopt.md index a83f1ffbcc..81952fa00f 100644 --- a/libcurl/callbacks/sockopt.md +++ b/libcurl/callbacks/sockopt.md @@ -1,4 +1,4 @@ -# sockopt callback +# sockopt The sockopt callback is set with `CURLOPT_SOCKOPTFUNCTION`: diff --git a/libcurl/callbacks/sshkey.md b/libcurl/callbacks/sshkey.md index 5f4559391d..b728365724 100644 --- a/libcurl/callbacks/sshkey.md +++ b/libcurl/callbacks/sshkey.md @@ -1,4 +1,4 @@ -# SSH key callback +# SSH key This callback is set with `CURLOPT_SSH_KEYFUNCTION`. diff --git a/libcurl/callbacks/sslcontext.md b/libcurl/callbacks/sslcontext.md index abf3503fb1..201ab51c98 100644 --- a/libcurl/callbacks/sslcontext.md +++ b/libcurl/callbacks/sslcontext.md @@ -1,4 +1,4 @@ -# SSL context callback +# SSL context libcurl offers a special TLS related callback called `CURLOPT_SSL_CTX_FUNCTION`. This option only works for libcurl powered by diff --git a/libcurl/callbacks/write.md b/libcurl/callbacks/write.md index b8e5aef8b3..7617a7bfcf 100644 --- a/libcurl/callbacks/write.md +++ b/libcurl/callbacks/write.md @@ -1,4 +1,4 @@ -# Write callback +# Write data The write callback is set with `CURLOPT_WRITEFUNCTION`: diff --git a/libcurl/cplusplus.md b/libcurl/cplusplus.md index 8cef1cb869..879186d9eb 100644 --- a/libcurl/cplusplus.md +++ b/libcurl/cplusplus.md @@ -1,4 +1,4 @@ -# libcurl for C++ programmers +# for C++ programmers libcurl provides a C API. C and C++ are similar but not the same. There are a few things to keep in mind when using libcurl in C++. diff --git a/libcurl/curlcode.md b/libcurl/curlcode.md index 3c5cf0e3e8..fcfbc3c80d 100644 --- a/libcurl/curlcode.md +++ b/libcurl/curlcode.md @@ -1,4 +1,4 @@ -# CURLcode return code +# CURLcode return codes Many libcurl functions return a CURLcode. That is a special libcurl typedefed variable for error codes. It returns `CURLE_OK` (which has the value zero) if diff --git a/libcurl/drive.md b/libcurl/drive.md index 9a3cf78442..e19a42f87b 100644 --- a/libcurl/drive.md +++ b/libcurl/drive.md @@ -1,4 +1,4 @@ -# "Drive" transfers +# Drive transfers libcurl provides three different ways to perform the transfer. Which way to use in your case is entirely up to you and what you need. diff --git a/libcurl/drive/easy.md b/libcurl/drive/easy.md index 75880e6ee3..8f2a129c17 100644 --- a/libcurl/drive/easy.md +++ b/libcurl/drive/easy.md @@ -1,4 +1,4 @@ -# Driving with the easy interface +# Drive with easy The name 'easy' was picked simply because this is really the easy way to use libcurl, and with easy, of course, comes a few limitations. Like, for example, diff --git a/libcurl/drive/multi-socket.md b/libcurl/drive/multi-socket.md index fbaa2a0167..ee88b9b6a2 100644 --- a/libcurl/drive/multi-socket.md +++ b/libcurl/drive/multi-socket.md @@ -1,4 +1,4 @@ -# Driving with the "multi_socket" interface +# Drive with multi\_socket multi_socket is the extra spicy version of the regular multi interface and is designed for event-driven applications. Make sure you read the diff --git a/libcurl/drive/multi.md b/libcurl/drive/multi.md index 9229a78195..4ae076611b 100644 --- a/libcurl/drive/multi.md +++ b/libcurl/drive/multi.md @@ -1,4 +1,4 @@ -# Driving with the multi interface +# Drive with multi The name 'multi' is for multiple, as in multiple parallel transfers, all done in the same single thread. The multi API is non-blocking so it can also make diff --git a/libcurl/examples/get.md b/libcurl/examples/get.md index 3725fc3516..2ba6f0fcff 100644 --- a/libcurl/examples/get.md +++ b/libcurl/examples/get.md @@ -1,4 +1,4 @@ -# Get a simple HTML page +# Get a simple HTTP page This example just fetches the HTML from a given URL and sends it to stdout. Possibly the simplest libcurl program you can write. diff --git a/libcurl/options.md b/libcurl/options.md index 227cd2d0b9..c9eedc4c41 100644 --- a/libcurl/options.md +++ b/libcurl/options.md @@ -1,4 +1,4 @@ -# Set handle options +# curl easy options You set options in the easy handle to control how that transfer is going to be done, or in some cases you can actually set options and modify the transfer's diff --git a/libcurl/options/all.md b/libcurl/options/all.md index aaee054ea0..1f54aa41bf 100644 --- a/libcurl/options/all.md +++ b/libcurl/options/all.md @@ -1,4 +1,4 @@ -# All easy options +# All options This is a table of a complete list of all available options for `curl_easy_setopt()` as of what will be present in the 7.83.0 release, April diff --git a/libcurl/options/tls.md b/libcurl/options/tls.md index a9f115da21..e3e32482f1 100644 --- a/libcurl/options/tls.md +++ b/libcurl/options/tls.md @@ -1,4 +1,4 @@ -# libcurl TLS options +# TLS options At the time of writing this, there are no less than **forty** different options for curl_easy_setopt that are dedicated for controlling how libcurl diff --git a/libcurl/threading.md b/libcurl/threading.md index cedee793cd..0e5f77515e 100644 --- a/libcurl/threading.md +++ b/libcurl/threading.md @@ -1,4 +1,4 @@ -# libcurl multi-threading +# multi-threading libcurl is thread safe but has no internal thread synchronization. You may have to provide your own locking or change options to properly use libcurl threaded. diff --git a/libcurl/url/setopt.md b/libcurl/url/setopt.md index 2a134da157..153d52ff7e 100644 --- a/libcurl/url/setopt.md +++ b/libcurl/url/setopt.md @@ -1,4 +1,4 @@ -# CURLOPT_CURLU +# CURLOPT\_CURLU As a convenience to applications, they can pass in an already parsed URL to libcurl to work with, as an alternative to `CURLOPT_URL`. diff --git a/libcurl/ws/urls.md b/libcurl/ws/urls.md index 2e691db1cd..e980eed7ad 100644 --- a/libcurl/ws/urls.md +++ b/libcurl/ws/urls.md @@ -1,4 +1,4 @@ -# WebSocket URLs +# URLs A client starts a WebSocket communication with libcurl by using a URL with the scheme `ws` or `wss`. Like in `wss://websocket.example.com/traffic-lights`. diff --git a/project/coc.md b/project/coc.md index 79b2ad0b1c..255c8ae387 100644 --- a/project/coc.md +++ b/project/coc.md @@ -1,4 +1,4 @@ -# Code of conduct +# Code of Conduct As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, diff --git a/protocols/curl.md b/protocols/curl.md index 24877c2da8..592a860010 100644 --- a/protocols/curl.md +++ b/protocols/curl.md @@ -1,4 +1,4 @@ -# The protocols curl supports +# curl protocols curl supports about 26 protocols. We say "about" because it depends on how you count and what you consider to be distinctly different protocols. diff --git a/protocols/protocols.md b/protocols/protocols.md index 37a990e20a..029f714836 100644 --- a/protocols/protocols.md +++ b/protocols/protocols.md @@ -1,4 +1,4 @@ -# Protocol +# Protocols The language used to ask for data to get sent—in either direction—is called **the protocol**. The protocol describes exactly how to ask the server diff --git a/source.md b/source.md index affc11f49f..cd78c22550 100644 --- a/source.md +++ b/source.md @@ -1,4 +1,4 @@ -# The source code +# Source code The source code is, of course, the actual engine parts of this project. After all, it is a software project. diff --git a/source/options.md b/source/options.md index 7338513382..c1540beed2 100644 --- a/source/options.md +++ b/source/options.md @@ -1,4 +1,4 @@ -# Handling different build options +# Handling build options The curl and libcurl source code has been carefully written to build and run on virtually every computer platform in existence. This can only be done diff --git a/source/style.md b/source/style.md index 789dff2784..aac871d63c 100644 --- a/source/style.md +++ b/source/style.md @@ -1,4 +1,4 @@ -# Style and code requirements +# Code style Source code that has a common style is easier to read than code that uses different styles in different places. It helps making the code feel like one diff --git a/source/web.md b/source/web.md index f50bed01bc..b1d6022c5f 100644 --- a/source/web.md +++ b/source/web.md @@ -1,4 +1,4 @@ -# Web site source code +# Website Most of the curl website is also available in a public git repository, although separate from the source code repository since it generally is not diff --git a/usingcurl/downloads/browsers.md b/usingcurl/downloads/browsers.md index 5daba09cae..3db97012ea 100644 --- a/usingcurl/downloads/browsers.md +++ b/usingcurl/downloads/browsers.md @@ -1,4 +1,4 @@ -# "My browser shows something else" +# My browser shows something else A common use case is using curl to get a URL that you can get in your browser when you paste the URL in the browser's address bar. diff --git a/usingcurl/downloads/retry.md b/usingcurl/downloads/retry.md index 44b28a4b27..15b7dde811 100644 --- a/usingcurl/downloads/retry.md +++ b/usingcurl/downloads/retry.md @@ -1,4 +1,4 @@ -# Retrying failed attempts +# Retry Normally curl will only make a single attempt to perform a transfer and return an error if not successful. Using the `--retry` option you can tell curl to diff --git a/usingcurl/tls/ciphers.md b/usingcurl/tls/ciphers.md index 5ac963569c..fe04bfa350 100644 --- a/usingcurl/tls/ciphers.md +++ b/usingcurl/tls/ciphers.md @@ -1,4 +1,4 @@ -# TLS ciphers +# Ciphers When curl connects to a TLS server, it negotiates how to speak the protocol and that negotiation involves several parameters and variables that both diff --git a/usingcurl/verbose.md b/usingcurl/verbose.md index 1c6b17c154..5822c2fb37 100644 --- a/usingcurl/verbose.md +++ b/usingcurl/verbose.md @@ -1,4 +1,4 @@ -# Verbose mode +# Verbose If your curl command does not execute or return what you expected it to, your first gut reaction should always be to run the command with the `-v / diff --git a/usingcurl/verbose/trace.md b/usingcurl/verbose/trace.md index 2968943acd..d7d1246e98 100644 --- a/usingcurl/verbose/trace.md +++ b/usingcurl/verbose/trace.md @@ -1,4 +1,4 @@ -# --trace and --trace-ascii +# Trace options There are times when `-v` is not enough. In particular, when you want to store the complete stream including the actual transferred data.