Merge branch 'bagder:master' into master

.github/scripts/verify-titles.pl

@@ -0,0 +1,37 @@
+#!/usr/bin/perl
+
+my $sum = shift @ARGV;
+
+# Figure out all files in right order
+open(F, "<$sum");
+while(<F>) {
+    if($_  =~ /\[(.*)\]\(([^\)]*)\)/) {
+        my ($title, $file) = ($1, $2);
+        push @files, $file;
+        $title{$file} = $title;
+    }
+}
+close(F);
+
+sub check {
+    my ($f) = @_;
+    open(F, "<$f");
+    while(<F>) {
+        if(/^# (.*)/) {
+            # verify
+            if($1 ne $title{$f}) {
+                printf STDERR "$f says '%s', not '%s' like SUMMARY.md\n",
+                    $1, $title{$f};
+                $errors++;
+            }
+            last;
+        }
+    }
+    close(F);
+};
+
+for my $f (@files) {
+    check($f);
+}
+
+exit $errors;

.github/workflows/verify-titles.yml

@@ -0,0 +1,24 @@
+# Copyright (C) Daniel Stenberg, <[email protected]>, et al.
+
+name: verify-titles
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - '**.md'
+  pull_request:
+    branches:
+      - master
+
+permissions: {}
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: build pdf
+        run: .github/scripts/verify-titles.pl SUMMARY.md
+

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)

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

bookindex.md

@@ -293,7 +293,7 @@
 ## R
  - ranges: [Numerical ranges](cmdline/globbing.md#numerical-ranges), [Downloads](usingcurl/downloads.md#downloads), [Resuming and ranges](usingcurl/downloads/resume.md#resuming-and-ranges), [HTTP with curl](http.md#http-with-curl), [HTTP ranges](http/ranges.md#http-ranges), [Provide a file descriptor](libcurl/callbacks/openclosesocket.md#provide-a-file-descriptor), [Sections](libcurl-http.md#sections), [HTTP response code](libcurl-http/responses.md#http-response-code), [HTTP ranges](libcurl-http/ranges.md#http-ranges)
  - --rate: [Request rate limiting](usingcurl/transfers/request-rate.md#request-rate-limiting)
- - Read callback: [Read callback](libcurl/callbacks/read.md#read-callback), [All easy options](libcurl/options/all.md#all-easy-options)
+ - Read callback: [Read callback](libcurl/callbacks/read.md#read-callback), [All easy options](libcurl/options/all.md#all-easy-options), [HTTP POST](libcurl-http/upload.md#http-post)
  - redhat: [Redhat and CentOS](get/linux.md#redhat-and-centos)
  - redirects: [Long options](cmdline/options.md#long-options), [Separate options per URL](cmdline/urls/options.md#separate-options-per-url), [Config file](cmdline/configfile.md#config-file), [Available --write-out variables](usingcurl/verbose/writeout.md#available---write-out-variables), [Downloads](usingcurl/downloads.md#downloads), [Download to a file named by the URL](usingcurl/downloads/url-named.md#download-to-a-file-named-by-the-url), [Shell redirects](usingcurl/downloads/redirects.md#shell-redirects), [Provide a custom IP address for a name](usingcurl/connections/name.md#provide-a-custom-ip-address-for-a-name), [Available exit codes](usingcurl/returns.md#available-exit-codes), [HTTP with curl](http.md#http-with-curl), [HTTP redirects](http/redirects.md#http-redirects), [Modify the request method](http/modify/method.md#modify-the-request-method), [Redirects](http/browserlike.md#redirects), [Custom addresses for hosts](libcurl/names.md#custom-addresses-for-hosts), [Available information](libcurl/getinfo.md#available-information), [All easy options](libcurl/options/all.md#all-easy-options), [Submit a login form over HTTP](libcurl/examples/login.md#submit-a-login-form-over-http), [Automatic referrer](libcurl-http/requests.md#automatic-referrer), [Request number](libcurl-http/headerapi.md#request-number)
  - RELEASE-NOTES: [scripts](source/layout.md#scripts)
@@ -391,7 +391,7 @@
  - Wireshark: [--trace and --trace-ascii](usingcurl/verbose/trace.md#trace-and---trace-ascii), [Available exit codes](usingcurl/returns.md#available-exit-codes), [SSLKEYLOGFILE](usingcurl/tls/sslkeylogfile.md#sslkeylogfile), [Figure out what a browser sends](http/post/browsersends.md#figure-out-what-a-browser-sends)
  - wolfSSH: [SSH libraries](build/deps.md#ssh-libraries), [SCP and SFTP](usingcurl/scpsftp.md#scp-and-sftp), [`<features>`](internals/tests/file-format.md#less-than-features-greater-than)
  - wolfSSL: [Commercial support](project/support.md#commercial-support), [lib/vtls](source/layout.md#lib-vtls), [Running DLL based configurations](build/windows.md#running-dll-based-configurations), [Build to use a TLS library](build/tls.md#build-to-use-a-tls-library), [Restrictions](usingcurl/tls/sslkeylogfile.md#restrictions), [SSL context callback](libcurl/callbacks/sslcontext.md#ssl-context-callback), [All easy options](libcurl/options/all.md#all-easy-options), [`<features>`](internals/tests/file-format.md#less-than-features-greater-than)
- - Write callback: [Write callback](libcurl/callbacks/write.md#write-callback), [1. The callback approach](libcurl/ws/concept.md#1.-the-callback-approach), [Raw mode](libcurl/ws/options.md#raw-mode), [Write callback](libcurl/ws/read.md#write-callback), [All easy options](libcurl/options/all.md#all-easy-options), [Get a response into memory](libcurl/examples/getinmem.md#get-a-response-into-memory), [Callback considerations](libcurl/cplusplus.md#callback-considerations)
+ - Write callback: [Write callback](libcurl/callbacks/write.md#write-callback), [1. The callback approach](libcurl/ws/concept.md#1.-the-callback-approach), [Raw mode](libcurl/ws/options.md#raw-mode), [Write callback](libcurl/ws/read.md#write-callback), [All easy options](libcurl/options/all.md#all-easy-options), [Get a simple HTML page](libcurl/examples/get.md#get-a-simple-html-page), [Get a response into memory](libcurl/examples/getinmem.md#get-a-response-into-memory), [Callback considerations](libcurl/cplusplus.md#callback-considerations), [Response body](libcurl-http/responses.md#response-body)
  - --write-out: [Write out](usingcurl/verbose/writeout.md#write-out), [Overwriting](usingcurl/downloads/storing.md#overwriting), [HTTP response codes](http/response.md#http-response-codes)
 ## X
  - -X: [Modify the request method](http/modify/method.md#modify-the-request-method), [Modify request target](http/modify/target.md#modify-request-target), [HTTP PUT](http/put.md#http-put), [HTTP cheat sheet](http/cheatsheet.md#http-cheat-sheet)

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

build/boringssl.md

@@ -1,4 +1,4 @@
-# Build curl with boringssl
+# BoringSSL
 
 ## build boringssl
 

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

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

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

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.

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

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

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

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

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
@@ -97,3 +97,14 @@ And to install the libcurl development package:
 This package installs the tool, libcurl, headers and pkg-config files etc
 
     emerge net-misc/curl
+
+## Void Linux
+
+With Void Linux you use `xbps-install` to install packages.
+To install the curl command-line utility:
+
+    xbps-install curl
+
+In order to install the libcurl development package:
+
+    xbps-install libcurl-devel

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

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

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

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.)

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

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`.

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

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

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.

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

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

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

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

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.

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

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

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

libcurl-http/auth.md

@@ -1,4 +1,4 @@
-# HTTP authentication
+# Authentication
 
 libcurl supports a wide variety of HTTP authentication schemes.
 

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,

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

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.

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

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

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

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

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

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,

libcurl/callbacks/debug.md

@@ -1,4 +1,4 @@
-# Debug callback
+# Debug
 
 The debug callback is set with `CURLOPT_DEBUGFUNCTION`:
 

libcurl/callbacks/header.md

@@ -1,4 +1,4 @@
-# Header callback
+# Header data
 
 The header callback is set with `CURLOPT_HEADERFUNCTION`:
 

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

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

libcurl/callbacks/read.md

@@ -1,4 +1,4 @@
-# Read callback
+# Read data
 
 The read callback is set with `CURLOPT_READFUNCTION`: