Skip to content

Commit

Permalink
Fix a bunch of typos
Browse files Browse the repository at this point in the history
This includes using the correct dashed form of a couple of words.
  • Loading branch information
dfandrich committed Nov 2, 2021
1 parent b5c2567 commit b3f8b0d
Show file tree
Hide file tree
Showing 18 changed files with 48 additions and 48 deletions.
2 changes: 1 addition & 1 deletion get/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ libcurl is then also installed as an individual package.

If you want to build applications against libcurl, you need a development
package installed to get the include headers and some additional
documentation, etc. You can then select a libcurl with the TLS backend you
documentation, etc. You can then select a libcurl with the TLS back-end you
prefer:

apt install libcurl4-openssl-dev
Expand Down
4 changes: 2 additions & 2 deletions http/http3.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ knowledge and awareness that it might change going forward.
## QUIC

HTTP/3 is the HTTP version that is designed to communicate over QUIC. QUIC can
in all practicular purposes to be considered as a TCP+TLS replacement.
for all particular purposes to be considered as a TCP+TLS replacement.

All requests that do HTTP/3 will therefore not use TCP. They will use QUIC.
QUIC is a reliable transport protocol built over UDP. HTTP/3 implies use of
Expand All @@ -21,7 +21,7 @@ QUIC.
## HTTPS only

HTTP/3 is performed over QUIC which is always using TLS, so HTTP/3 is by
defintion always encrypted and secure. Therefore, curl only uses HTTP/3 for
definition always encrypted and secure. Therefore, curl only uses HTTP/3 for
`HTTPS://` URLs.

## Enable
Expand Down
2 changes: 1 addition & 1 deletion http/redirects.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ of these kinds of redirects.
## JavaScript redirects

The modern web is full of JavaScript and as you know, JavaScript is a
language and a full runtime that allows code to execute in the browser when
language and a full run-time that allows code to execute in the browser when
visiting web sites.

JavaScript also provides means for it to instruct the browser to move on to
Expand Down
2 changes: 1 addition & 1 deletion libcurl-http/upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Then you pass that post to libcurl like this:

curl_easy_setopt(easy, CURLOPT_MIMEPOST, form);

(`curl_formadd` is the former API to build multi-part fromposts with but we no
(`curl_formadd` is the former API to build multi-part formposts with but we no
longer recommend using that)


Expand Down
2 changes: 1 addition & 1 deletion libcurl/callbacks/openclosesocket.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ The corresponding callback to the open socket is of course the close
socket. Usually when you provide a custom way to provide a file descriptor you
want to provide your own cleanup version as well:

curl_easy_setopt(handle, CURLOPT_CLOSEOCKETFUNCTION, closesocket_callback);
curl_easy_setopt(handle, CURLOPT_CLOSESOCKETFUNCTION, closesocket_callback);

The `closesocket_callback` function must match this prototype:

Expand Down
2 changes: 1 addition & 1 deletion libcurl/curlcode.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## CURLcode return code

Many libcurl functions return a CURLcode. That's a special libcurl typedefed
Many libcurl functions return a CURLcode. That's a special libcurl typedeffed
variable for error codes. It returns `CURLE_OK` (which has the value zero) if
everything is fine and dandy and it returns a non-zero number if a problem was
detected. There are almost one hundred `CURLcode` errors in use, and you can
Expand Down
8 changes: 4 additions & 4 deletions libcurl/names.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ only use IPv6 addresses:

curl_easy_setopt(easy, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V6);

## Name resolver backends
## Name resolver back-ends

libcurl can be built to do name resolves in one out of these three different
ways and depending on which backend way that is used, it gets a slightly
ways and depending on which back-end way that is used, it gets a slightly
different feature set and sometimes modified behavior.

1. The default backend is invoking the "normal" libc resolver functions in a
1. The default back-end is invoking the "normal" libc resolver functions in a
new helper-thread, so that it can still do fine-grained timeouts if wanted and
there will be no blocking calls involved.

Expand All @@ -44,7 +44,7 @@ compatible with the native name resolver functionality.

### DNS over HTTPS

Independently of what resolver backend that libcurl is built to use, since
Independently of what resolver back-end that libcurl is built to use, since
7.62.0 it also provides a way for the user to ask a specific DoH (DNS over
HTTPS) server for the address of a name. This will avoid using the normal,
native resolver method and server and instead asks a dedicated separate one.
Expand Down
6 changes: 3 additions & 3 deletions libcurl/tlsoptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ protocol versions have been found detect and unsuitable for use over time and
even if curl itself will raise its default lower version over time you might
want to opt for only using the latest and most security protocol versions.

These options take a lowest acceptiable version and optionally a maximum. If
These options take a lowest acceptable version and optionally a maximum. If
the server cannot negotiate a connection with that condition, the transfer
will fail.

Expand Down Expand Up @@ -60,7 +60,7 @@ Here too, a mismatch will cause the transfer to fail.

### TLS Client certificates

When using TLS and the server asks the client to authentice using
When using TLS and the server asks the client to authenticate using
certificates, you typically specify the private key and the corresponding
client certificate using `CURLOPT_SSLKEY` and `CURLOPT_SSLCERT`. The password
for the key is usually also required to be set, with `CURLOPT_SSLKEYPASSWD`.
Expand All @@ -77,7 +77,7 @@ name and password and the options are called `CURLOPT_TLSAUTH_USERNAME` and

## STARTTLS

For protocols that are using the STARTLS method to upgrade the connection to
For protocols that are using the STARTTLS method to upgrade the connection to
TLS (FTP, IMAP, POP3, and SMTP), you usually tell curl to use the non-TLS
version of the protocol when specifying a URL and then ask curl to enable TLS
with the `CURLOPT_USE_SSL` option.
Expand Down
2 changes: 1 addition & 1 deletion project/name.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ word curl. It rhymes with words like girl and earl. Merriam Webster has a
[short WAV file](https://media.merriam-webster.com/soundc11/c/curl0001.wav) to
help.

### Confusions and mixups
### Confusions and mix-ups

Soon after our curl was created another "curl" appeared that created a
programming language. That curl still [exists](http://www.curl.com).
Expand Down
4 changes: 2 additions & 2 deletions project/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ and printers.
A fair number of best-selling games are also using libcurl, on Windows and
game consoles.

### In web site backends
### In web site back-ends

The libcurl binding for PHP was one of, if not the, first bindings for libcurl
to really catch on and get used widely. It quickly got adopted as a default
Expand All @@ -71,7 +71,7 @@ Internet (recent numbers indicated that something like a quarter of all sites on
the Internet uses PHP).

A few really high-demand sites are using PHP and are using libcurl in the
backend. Facebook and Yahoo are two such sites.
back-end. Facebook and Yahoo are two such sites.

## Famous users

Expand Down
2 changes: 1 addition & 1 deletion source/build/deps.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ https://c-ares.haxx.se/

curl can be built with c-ares to be able to do asynchronous name resolution.
Another option to enable asynchronous name resolution is to build curl with the
threaded name resolver backend, which will then instead create a separate
threaded name resolver back-end, which will then instead create a separate
helper thread for each name resolve. c-ares does it all within the
same thread.

Expand Down
10 changes: 5 additions & 5 deletions source/build/fromsource.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ keep up with or know all possible dependencies for all the libraries it can be
made to build with, so users wanting to build with static libs mostly need to
provide that list of libraries to link with.

### Select TLS backend
### Select TLS back-end

The configure based build offers the user to select from a wide variety of
different TLS libraries when building. You select them by using the correct
Expand All @@ -135,7 +135,7 @@ libressl.
All the `--with-*` options also allow you to provide the install prefix so
that configure will search for the specific library where you tell it to.

### Select SSH backend
### Select SSH back-end

The configure based build offers the user to select from a variety of
different SSH libraries when building. You select them by using the
Expand All @@ -145,7 +145,7 @@ correct command line options.
- libssh: `--with-libssh`
- wolfSSH: `--with-wolfssh`

### Select HTTP/3 backend
### Select HTTP/3 back-end

The configure based build offers the user to select different HTTP/3
libraries when building. You select them by using the correct command
Expand All @@ -166,7 +166,7 @@ supports.
On the cmake command line, in the first argument, you specify where to find
the cmake source files. Which is `.` (a single dot) if in the same directory.

To build on Linux using plain make with CmakeLists.txt in the same directory,
To build on Linux using plain make with CMakeLists.txt in the same directory,
you can do:

cmake -G "Unix Makefiles" .
Expand Down Expand Up @@ -200,5 +200,5 @@ Decide what options to enable/disable in your build. The `BUILD.WINDOWS.txt`
file details them all, but an example command line could look like this (split
into several lines for readability):

nname WITH_SSL=dll WITH_NGHTTP2=dll ENABLE_IPV6=yes \
nmake WITH_SSL=dll WITH_NGHTTP2=dll ENABLE_IPV6=yes \
WITH_ZLIB=dll MACHINE=x64
4 changes: 2 additions & 2 deletions source/layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ source files may contain code that is not used in your particular build.

### lib/vtls

The VTLS sub section within libcurl is the home of all the TLS backends
The VTLS sub section within libcurl is the home of all the TLS back-ends
libcurl can be built to support. The "virtual" TLS internal API is a common
API that is used within libcurl to access TLS and crypto functions without the
main code knowing exactly which TLS library that is used. This allows the
Expand All @@ -59,7 +59,7 @@ users.
few features due to lacking some functionality in the library.
- LibreSSL: an OpenSSL fork maintained by the OpenBSD team.
- NSS: a full-blown TLS library perhaps most known for being used by the
Firefox web browser. This was the default TLS backend for curl on Fedora and
Firefox web browser. This was the default TLS back-end for curl on Fedora and
Redhat systems for a while in the past.
- GnuTLS: a full-blown TLS library used by default by the Debian packaged curl.
- mbedTLS: a TLS library targeted towards the embedded market.
Expand Down
2 changes: 1 addition & 1 deletion source/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The project sometimes uses #ifdef protection around entire source files when,
for example, a single file is provided for a specific operating system or
perhaps for a specific feature that is not always present. This is to make it
possible for all platforms to always build all files—it simplifies the build
scripts and makefiles a lot. A file entirely #ifdefed out hardly adds anything
scripts and makefiles a lot. A file entirely #ifdeffed out hardly adds anything
to the build time, anyway.

Rather than sprinkling the code with #ifdefs, to the extent where it is
Expand Down
4 changes: 2 additions & 2 deletions usingcurl/connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@ connect, but in all other ways still assume it is talking to
### Name resolve tricks with c-ares

As should be detailed elsewhere in this book, curl may be built with several
different name resolving backends. One of those backends is powered by the
different name resolving back-ends. One of those back-ends is powered by the
c-ares library and when curl is built to use c-ares, it gets a few extra
superpowers that curl built to use other name resolve backends do not get.
superpowers that curl built to use other name resolve back-ends do not get.
Namely, it gains the ability to more specifically instruct what DNS servers to
use and how that DNS traffic is using the network.

Expand Down
26 changes: 13 additions & 13 deletions usingcurl/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ serious effort.

Having a secure connection to a server is not worth a lot if you cannot also
be certain that you are communicating with the **correct** host. If we do not
know that, we could just as well be talking with an impostor that just
know that, we could just as well be talking with an imposter that just
*appears* to be who we think it is.

To check that it communicates with the right TLS server, curl uses a set of
Expand Down Expand Up @@ -176,7 +176,7 @@ can specify one or more hashes like that, separated with semicolons (;).

curl --pinnedpubkey "sha256//83d34tasd3rt..." https://example.com/

This feature is not supported by all TLS backends.
This feature is not supported by all TLS back-ends.

## OCSP stapling

Expand All @@ -193,7 +193,7 @@ Ask for the handshake to use the status request like this:

curl --cert-status https://example.com/

This feature is only supported by the OpenSSL, GnuTLS and NSS backends.
This feature is only supported by the OpenSSL, GnuTLS and NSS back-ends.

## Client certificates

Expand All @@ -217,7 +217,7 @@ specify the key file independently with `--key`:
curl --cert mycert:mypassword https://example.com
curl --cert mycert:mypassword --key mykey https://example.com

For some TLS backends you can also pass in the key and certificate using
For some TLS back-ends you can also pass in the key and certificate using
different types:

curl --cert mycert:mypassword --cert-type PEM \
Expand All @@ -232,31 +232,31 @@ and `--tlspassword <secret>`. Like this:

curl --tlsuser daniel --tlspassword secret https://example.com

## Different TLS backends
## Different TLS back-ends

When curl is built, it gets told to use a specific TLS library. That TLS
library is the engine that provides curl with the powers to speak TLS over the
wire. We often refer to them as different "backends" as they can be seen as
different plugglable pieces into the curl machine. curl can be built to be
able to use one or more of these backends.
wire. We often refer to them as different "back-ends" as they can be seen as
different pluggable pieces into the curl machine. curl can be built to be
able to use one or more of these back-ends.

Sometimes features and behaviors differ slightly when curl is built with
different TLS backends, but the developers work hard on making those
different TLS back-ends, but the developers work hard on making those
differences as small and unnoticeable as possible.

Showing the curl version information with [curl
--version](usingcurl-version.md) will always include the TLS library and
version in the first line of output.

## Multiple TLS backends
## Multiple TLS back-ends

When curl is built with *multiple* TLS backends, it can be told which one to use
When curl is built with *multiple* TLS back-ends, it can be told which one to use
each time it is started. It is always built to use a specific one by default
unless one is asked for.

If you invoke `curl --version` for a curl with multiple backends it will
If you invoke `curl --version` for a curl with multiple back-ends it will
mention `MultiSSL` as a feature in the last line. The first line will then
include all the supported TLS backends with the non-default ones within
include all the supported TLS back-ends with the non-default ones within
parentheses.

To set a specific one to get used, set the environment variable
Expand Down
2 changes: 1 addition & 1 deletion usingcurl/verbose/writeout.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Some of these variables are not available in really old curl versions.
- `%{num_connects}` the number of new connects made in the recent
transfer.

- `%{num_headers}` number of response headers in the last responsea
- `%{num_headers}` number of response headers in the last response

- `%{num_redirects}` number of redirects that were followed in the request.

Expand Down
12 changes: 6 additions & 6 deletions usingcurl/version.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,17 @@ released and "blessed" version.
The rest of this line contains names of third party components this build of
curl uses, often with their individual version number next to it with a slash
separator. Like `OpenSSL/1.1.1g` and `nghttp2/1.41.0`. This can for example
tell you which TLS backends this curl uses.
tell you which TLS back-ends this curl uses.

### Line 1: TLS versions

Line 1 may contain one or more TLS libraries. curl can be built to support
more than one TLS library which then makes curl - at startup - select which
particular backend to use for this invoke.
more than one TLS library which then makes curl - at start-up - select which
particular back-end to use for this invoke.

If curl supports more than one TLS library like this, the ones that are *not*
selected by default will be listed within parentheses. Thus, if you do not
specify which backend to use use (with the `CURL_SSL_BACKEND` environment
specify which back-end to use use (with the `CURL_SSL_BACKEND` environment
variable) the one listed without parentheses will be used.

## Line 2: Release-Date
Expand Down Expand Up @@ -83,7 +83,7 @@ not enabled.
Features that can be present there:

- alt-svc - Support for the alt-svc: header
- AsynchDNS - This curl uses asynchronous name resolves. Asynchronous name resolves can be done using either the c-ares or the threaded resolver backends.
- AsynchDNS - This curl uses asynchronous name resolves. Asynchronous name resolves can be done using either the c-ares or the threaded resolver back-ends.
- brotli - support for automatic brotli compression over HTTP(S)
- CharConv - curl was built with support for character set conversions (like EBCDIC)
- Debug - This curl uses a libcurl built with Debug. This enables more error-tracking and memory debugging etc. For curl-developers only!
Expand All @@ -97,7 +97,7 @@ Features that can be present there:
- Largefile - This curl supports transfers of large files, files larger than 2GB.
- libz - Automatic gzip decompression of compressed files over HTTP is supported.
- Metalink - This curl supports Metalink
- MultiSSL - This curl supports multiple TLS backends.
- MultiSSL - This curl supports multiple TLS back-ends.
- NTLM - NTLM authentication is supported.
- NTLM_WB - NTLM authentication is supported.
- PSL - PSL is short for Public Suffix List and means that this curl has been built with knowledge about "public suffixes".
Expand Down

0 comments on commit b3f8b0d

Please sign in to comment.