Skip to content

Commit

Permalink
fix bad words
Browse files Browse the repository at this point in the history
  • Loading branch information
bagder committed Feb 6, 2024
1 parent 2451dbc commit d857700
Show file tree
Hide file tree
Showing 23 changed files with 68 additions and 63 deletions.
2 changes: 1 addition & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@
* [Memory debugging](internals/memory-debugging.md)
* [Content Encoding](internals/content-encoding.md)
* [Structs](internals/structs.md)
* [Resolving host names](internals/resolving.md)
* [Resolving hostnames](internals/resolving.md)
* [Tests](internals/tests/README.md)
* [Test file format](internals/tests/file-format.md)
* [Build tests](internals/tests/build.md)
Expand Down
2 changes: 1 addition & 1 deletion cmdline/exitcode.md
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ A basic Unix shell script could look like something like this:
66. Failed to initialize the OpenSSL SSL Engine. This can only happen when
OpenSSL is used and would signify a serious internal problem.

67. The user name, password, or similar was not accepted and curl failed to
67. The username, password, or similar was not accepted and curl failed to
log in. Verify that the credentials are provided correctly and that they are
encoded the right way.

Expand Down
2 changes: 1 addition & 1 deletion cmdline/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ and asking for HTTP redirects as well using the long format looks like:
## Arguments to options

Not all options are just simple boolean flags that enable or disable
features. For some of them you need to pass on data, like perhaps a user name
features. For some of them you need to pass on data, like perhaps a username
or a path to a file. You do this by writing first the option and then the
argument, separated with a space. Like, for example, if you want to send an
arbitrary string of data in an HTTP POST to a server:
Expand Down
8 changes: 4 additions & 4 deletions cmdline/passwords.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ curl offers several ways to receive passwords from the user and then
subsequently pass them on or use them to something else.

The most basic curl authentication option is `-u / --user`. It accepts an
argument that is the user name and password, colon separated. Like when
`alice` wants to request a page requiring HTTP authentication and her password
is `12345`:
argument that is the username and password, colon separated. Like when `alice`
wants to request a page requiring HTTP authentication and her password is
`12345`:

$ curl -u alice:12345 http://example.com/

Expand All @@ -20,7 +20,7 @@ password on the command line and the command line might be readable for other
users on the same system (assuming you have a multi-user system). curl helps
minimize that risk by trying to blank out passwords from process listings.

One way to avoid passing the user name and password on the command line is to
One way to avoid passing the username and password on the command line is to
instead use a [.netrc file](../usingcurl/netrc.md) or a [config file](configfile.md).
You can also use the `-u` option without specifying the password, and then
curl instead prompts the user for it when it runs.
Expand Down
6 changes: 3 additions & 3 deletions cmdline/urls/auth.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Name and password

Following the scheme in a URL, there can be a possible user name and password
Following the scheme in a URL, there can be a possible username and password
field embedded. The use of this syntax is usually frowned upon these days
since you easily leak this information in scripts or otherwise. For example,
listing the directory of an FTP server using a given name and password:

curl ftp://user:[email protected]/

The presence of user name and password in the URL is completely optional. curl
The presence of username and password in the URL is completely optional. curl
also allows that information to be provided with normal command-line options,
outside of the URL.

If you want a non-ASCII letter or maybe a `:` or `@` as part of the user name
If you want a non-ASCII letter or maybe a `:` or `@` as part of the username
and/or password, remember to URL encode that letter: write it as `%HH` where
`HH` is the hexadecimal byte value. `:` is `%3a` and `@` is `%40`.
2 changes: 1 addition & 1 deletion helpers/sharing.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ easy handle still needs to get its cookie "engine" started properly to start
using cookies.

`CURL_LOCK_DATA_DNS` - the DNS cache is where libcurl stores addresses for
resolved host names for a while to make subsequent lookups faster.
resolved hostnames for a while to make subsequent lookups faster.

`CURL_LOCK_DATA_SSL_SESSION` - the SSL session ID cache is where libcurl store
resume information for SSL connections to be able to resume a previous
Expand Down
6 changes: 3 additions & 3 deletions helpers/url/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ include the port number.
## `CURLU_URLENCODE`

This flag makes `curl_url_get()` URL encode the hostname part when a full URL
is retrieved. If not set (default), libcurl returns the URL with the host name
"raw" to support IDN names to appear as-is. IDN host names are typically using
is retrieved. If not set (default), libcurl returns the URL with the hostname
"raw" to support IDN names to appear as-is. IDN hostnames are typically using
non-ASCII bytes that otherwise are percent-encoded.

Note that even when not asking for URL encoding, the `%` (byte 37) is URL
encoded in host names to make sure the hostname remains valid.
encoded in hostnames to make sure the hostname remains valid.

## `CURLU_URLDECODE`

Expand Down
4 changes: 2 additions & 2 deletions how-to-read.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ A closer look at doing and controlling HTTP specific transfers with libcurl.
## 13. [libcurl helpers](helpers/README.md)

libcurl provides a set of additional APIs, helpers, that go a little beyond
just transfers. These are APIs and subsystems that can make your libcurl
using application excel. Manage URLs, extract HTTP headers and more.
just transfers. These are APIs and subsystems that can make your libcurl using
application excel. Manage URLs, extract HTTP headers and more.

## 14. [libcurl examples](examples/README.md)

Expand Down
4 changes: 2 additions & 2 deletions http/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ and then the browser issues a POST with the user and password etc, and then
subsequently maintain cookies for the session.

To tell curl to do an authenticated HTTP request, you use the `-u, --user`
option to provide user name and password (separated with a colon). Like this:
option to provide username and password (separated with a colon). Like this:

curl --user daniel:secret http://example.com/

This makes curl use the default *Basic* HTTP authentication method. Yes, it is
actually called Basic and it is truly basic. To explicitly ask for the basic
method, use `--basic`.

The Basic authentication method sends the user name and password in clear text
The Basic authentication method sends the username and password in clear text
over the network (base64 encoded) and should be avoided for HTTP transport.

When asking to do an HTTP transfer using a single (specified or implied),
Expand Down
2 changes: 1 addition & 1 deletion http/browserlike.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ the verbatim request.

## Cookies

A lot of the web today works with a user name and password login prompt
A lot of the web today works with a username and password login prompt
somewhere. In many cases you even logged in a while ago with your browser but
it has kept the state and keeps you logged in.

Expand Down
12 changes: 6 additions & 6 deletions http/redirects.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,17 +100,17 @@ response by using the dedicated options for that: `--post301`, `--post302` and
`--post303`. If you are instead writing a libcurl based application, you
control that behavior with the `CURLOPT_POSTREDIR` option.

## Redirecting to other host names
## Redirecting to other hostnames

When you use curl you may provide credentials like user name and password for
When you use curl you may provide credentials like username and password for
a particular site, but since an HTTP redirect might move away to a different
host curl limits what it sends away to other hosts than the original within
the same transfer.

So if you want the credentials to also get sent to the following host names
even though they are not the same as the original—presumably because you
trust them and know that there is no harm in doing that—you can tell curl that
it is fine to do so by using the `--location-trusted` option.
So if you want the credentials to also get sent to the following hostnames
even though they are not the same as the original—presumably because you trust
them and know that there is no harm in doing that—you can tell curl that it is
fine to do so by using the `--location-trusted` option.

# Non-HTTP redirects

Expand Down
2 changes: 1 addition & 1 deletion internals/caches.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ disk as well.
## Alt-Svc

`Alt-Svc:` is an HTTP response header that informs the client about
alternative host names, port numbers and protocol versions where the same
alternative hostnames, port numbers and protocol versions where the same
service is also available. curl keeps this alternative service information in
memory and can be told to load it from and save it to disk as well.

Expand Down
2 changes: 1 addition & 1 deletion internals/resolving.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Resolving host names
# Resolving hostnames

Aka `hostip.c` explained

Expand Down
10 changes: 5 additions & 5 deletions libcurl-http/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ used scheme on the web today where authentication is performed by an HTTP POST
and then keeping state in cookies. See [Cookies with libcurl](cookies.md)
for details on how to do that.

## User name and password
## Username and password

libcurl does not try any HTTP authentication without a given user name. Set
libcurl does not try any HTTP authentication without a given username. Set
one like:

curl_easy_setopt(curl, CURLOPT_USERNAME, "joe");
Expand Down Expand Up @@ -58,7 +58,7 @@ plain text. This is however an authentication method that is rarely spoken by
browsers and consequently is not a frequently used one.

You can explicitly tell libcurl to use the Digest method for a specific
transfer like this (it still needs user name and password set as well):
transfer like this (it still needs username and password set as well):

curl_easy_setopt(curl, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);

Expand All @@ -67,7 +67,7 @@ transfer like this (it still needs user name and password set as well):
Another HTTP authentication method is called NTLM.

You can explicitly tell libcurl to use the NTLM method for a specific transfer
like this (it still needs user name and password set as well):
like this (it still needs username and password set as well):

curl_easy_setopt(curl, CURLOPT_HTTPAUTH, CURLAUTH_NTLM);

Expand All @@ -76,7 +76,7 @@ like this (it still needs user name and password set as well):
Another HTTP authentication method is called Negotiate.

You can explicitly tell libcurl to use the Negotiate method for a specific
transfer like this (it still needs user name and password set as well):
transfer like this (it still needs username and password set as well):

curl_easy_setopt(curl, CURLOPT_HTTPAUTH, CURLAUTH_NEGOTIATE);

Expand Down
6 changes: 3 additions & 3 deletions libcurl/caches.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ A reused connection usually saves having to a DNS lookup, setting up a TCP
connection, do a TLS handshake and more.

Connections are only reused if the name is identical. Even if two different
host names resolve to the same IP addresses, they still always use two
separate connections with libcurl.
hostnames resolve to the same IP addresses, they still always use two separate
connections with libcurl.

Since the connection reuse is based on the hostname and the DNS resolve phase
is entirely skipped when a connection is reused for a transfer, libcurl does
Expand All @@ -58,7 +58,7 @@ TLS session IDs and tickets are special TLS mechanisms that a client can pass
to a server to shortcut subsequent TLS handshakes to a server it previously
established a connection to.

libcurl caches session IDs and tickets associated with host names and port
libcurl caches session IDs and tickets associated with hostnames and port
numbers, so if a subsequent connection attempt is made to a host for which
libcurl has a cached ID or ticket, using that can greatly decrease the TLS
handshake process and therefore the time needed until completion.
Expand Down
2 changes: 1 addition & 1 deletion transfers/conn/names.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ made shared between multiple easy handles using the

## Custom addresses for hosts

Sometimes it is handy to provide fake, custom addresses for real host names so
Sometimes it is handy to provide fake, custom addresses for real hostnames so
that libcurl connects to a different address instead of one an actual name
resolve would suggest.

Expand Down
8 changes: 4 additions & 4 deletions transfers/conn/proxies.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,11 @@ exists. If a specific protocol variable one exists, such a one takes
precedence.

When using environment variables to set a proxy, you could easily end up in a
situation where one or a few host names should be excluded from going through
situation where one or a few hostnames should be excluded from going through
the proxy. This can be done with the `NO_PROXY` variable - or the
corresponding `CURLOPT_NOPROXY` libcurl option. Set that to a comma-separated
list of host names that should not use a proxy when being accessed. You can
set NO_PROXY to be a single asterisk ('\*') to match all hosts.
list of hostnames that should not use a proxy when being accessed. You can set
NO_PROXY to be a single asterisk ('\*') to match all hosts.

## HTTP proxy

Expand Down Expand Up @@ -144,7 +144,7 @@ is then in addition to and separate of the possible authentication or lack of
authentication with the remote host.

libcurl supports authentication with HTTP, HTTPS and SOCKS5 proxies. The key
option is then `CURLOPT_PROXYUSERPWD` which sets the user name and password to
option is then `CURLOPT_PROXYUSERPWD` which sets the username and password to
use - unless you set it within the `CURLOPT_PROXY` string.

## HTTP Proxy headers
Expand Down
8 changes: 4 additions & 4 deletions transfers/conn/reuse.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ benefits in speed and required resources.
When libcurl is about to make a new connection for the purposes of doing a
transfer, it first checks to see if there is an existing connection in the
pool that it can reuse instead. The connection re-use check is done before any
DNS or other name resolving mechanism is used, so it is purely host name
based. If there is an existing live connection to the right hostname, a lot
of other properties (port number, protocol, etc) are also checked to see that
it can be used.
DNS or other name resolving mechanism is used, so it is purely hostname
based. If there is an existing live connection to the right hostname, a lot of
other properties (port number, protocol, etc) are also checked to see that it
can be used.

## Easy API pool

Expand Down
Loading

0 comments on commit d857700

Please sign in to comment.