mirror of
https://github.com/curl/curl.git
synced 2025-09-19 18:42:42 +03:00
docs: Fix some typos
[skip ci]
This commit is contained in:
parent
c29db0303d
commit
2a264d494e
|
@ -162,7 +162,7 @@ used as input to string functions.
|
||||||
# Commit messages
|
# Commit messages
|
||||||
|
|
||||||
Tightly coupled with a code review is making sure that the commit message is
|
Tightly coupled with a code review is making sure that the commit message is
|
||||||
good. It is the responsibilitiy of the person who merges the code to make sure
|
good. It is the responsibility of the person who merges the code to make sure
|
||||||
that the commit message follows our standard (detailed in the
|
that the commit message follows our standard (detailed in the
|
||||||
[CONTRIBUTE.md](CONTRIBUTE.md) document). This includes making sure the PR
|
[CONTRIBUTE.md](CONTRIBUTE.md) document). This includes making sure the PR
|
||||||
identifies related issues and giving credit to reporters and helpers.
|
identifies related issues and giving credit to reporters and helpers.
|
||||||
|
|
6
docs/FAQ
6
docs/FAQ
|
@ -83,7 +83,7 @@ FAQ
|
||||||
5.1 Is libcurl thread-safe?
|
5.1 Is libcurl thread-safe?
|
||||||
5.2 How can I receive all data into a large memory chunk?
|
5.2 How can I receive all data into a large memory chunk?
|
||||||
5.3 How do I fetch multiple files with libcurl?
|
5.3 How do I fetch multiple files with libcurl?
|
||||||
5.4 Does libcurl do Winsock initing on win32 systems?
|
5.4 Does libcurl do Winsock initialization on win32 systems?
|
||||||
5.5 Does CURLOPT_WRITEDATA and CURLOPT_READDATA work on win32 ?
|
5.5 Does CURLOPT_WRITEDATA and CURLOPT_READDATA work on win32 ?
|
||||||
5.6 What about Keep-Alive or persistent connections?
|
5.6 What about Keep-Alive or persistent connections?
|
||||||
5.7 Link errors when building libcurl on Windows!
|
5.7 Link errors when building libcurl on Windows!
|
||||||
|
@ -915,9 +915,9 @@ FAQ
|
||||||
When you invoke curl and get an error 60 error back it means that curl
|
When you invoke curl and get an error 60 error back it means that curl
|
||||||
couldn't verify that the server's certificate was good. curl verifies the
|
couldn't verify that the server's certificate was good. curl verifies the
|
||||||
certificate using the CA cert bundle and verifying for which names the
|
certificate using the CA cert bundle and verifying for which names the
|
||||||
certficiate has been granted.
|
certificate has been granted.
|
||||||
|
|
||||||
To completely disable the certficiate verification, use -k. This does
|
To completely disable the certificate verification, use -k. This does
|
||||||
however enable man-in-the-middle attacks and makes the transfer INSECURE.
|
however enable man-in-the-middle attacks and makes the transfer INSECURE.
|
||||||
We strongly advice against doing this for more than experiments.
|
We strongly advice against doing this for more than experiments.
|
||||||
|
|
||||||
|
|
|
@ -26,7 +26,7 @@ with as an entry-point into the project, perhaps because you are a newcomer or
|
||||||
even maybe not a terribly experienced developer, here's our advice:
|
even maybe not a terribly experienced developer, here's our advice:
|
||||||
|
|
||||||
- Read through this document to get a grasp on a general approach to use
|
- Read through this document to get a grasp on a general approach to use
|
||||||
- Consider adding a test case for something not currentled tested (correctly)
|
- Consider adding a test case for something not currently tested (correctly)
|
||||||
- Consider updating or adding documentation
|
- Consider updating or adding documentation
|
||||||
- One way to get your feet wet gently in the project, is to participate in an
|
- One way to get your feet wet gently in the project, is to participate in an
|
||||||
existing issue/PR and help out by reproducing the issue, review the code in
|
existing issue/PR and help out by reproducing the issue, review the code in
|
||||||
|
|
|
@ -7,7 +7,7 @@ HTTP/2 with curl
|
||||||
Build prerequisites
|
Build prerequisites
|
||||||
-------------------
|
-------------------
|
||||||
- nghttp2
|
- nghttp2
|
||||||
- OpenSSL, libressl, BoringSSL, NSS, GnutTLS, mbedTLS, wolfSSL or Schannel
|
- OpenSSL, libressl, BoringSSL, NSS, GnuTLS, mbedTLS, wolfSSL or Schannel
|
||||||
with a new enough version.
|
with a new enough version.
|
||||||
|
|
||||||
[nghttp2](https://nghttp2.org/)
|
[nghttp2](https://nghttp2.org/)
|
||||||
|
|
|
@ -184,8 +184,9 @@ Library
|
||||||
|
|
||||||
`curl_global_init()` and `curl_global_cleanup()` should be called by the
|
`curl_global_init()` and `curl_global_cleanup()` should be called by the
|
||||||
application to initialize and clean up global stuff in the library. As of
|
application to initialize and clean up global stuff in the library. As of
|
||||||
today, it can handle the global SSL initing if SSL is enabled and it can init
|
today, it can handle the global SSL initialization if SSL is enabled and it
|
||||||
the socket layer on windows machines. libcurl itself has no "global" scope.
|
can initialize the socket layer on Windows machines. libcurl itself has no
|
||||||
|
"global" scope.
|
||||||
|
|
||||||
All printf()-style functions use the supplied clones in `lib/mprintf.c`. This
|
All printf()-style functions use the supplied clones in `lib/mprintf.c`. This
|
||||||
makes sure we stay absolutely platform independent.
|
makes sure we stay absolutely platform independent.
|
||||||
|
@ -226,7 +227,7 @@ Curl_connect()
|
||||||
This function makes sure there's an allocated and initiated `connectdata`
|
This function makes sure there's an allocated and initiated `connectdata`
|
||||||
struct that is used for this particular connection only (although there may
|
struct that is used for this particular connection only (although there may
|
||||||
be several requests performed on the same connect). A bunch of things are
|
be several requests performed on the same connect). A bunch of things are
|
||||||
inited/inherited from the `Curl_easy` struct.
|
initialized/inherited from the `Curl_easy` struct.
|
||||||
|
|
||||||
<a name="multi_do"></a>
|
<a name="multi_do"></a>
|
||||||
multi_do()
|
multi_do()
|
||||||
|
|
10
docs/TODO
10
docs/TODO
|
@ -721,7 +721,7 @@ that doesn't exist on the server, just like --ftp-create-dirs.
|
||||||
You can specify the private and public keys for SSH/SSL as file paths. Some
|
You can specify the private and public keys for SSH/SSL as file paths. Some
|
||||||
programs want to avoid using files and instead just pass them as in-memory
|
programs want to avoid using files and instead just pass them as in-memory
|
||||||
data blobs. There's probably a challenge to make this work across the
|
data blobs. There's probably a challenge to make this work across the
|
||||||
plethory of different TLS and SSH backends that curl supports.
|
plethora of different TLS and SSH backends that curl supports.
|
||||||
https://github.com/curl/curl/issues/2310
|
https://github.com/curl/curl/issues/2310
|
||||||
|
|
||||||
13.4 Cache/share OpenSSL contexts
|
13.4 Cache/share OpenSSL contexts
|
||||||
|
@ -799,7 +799,7 @@ that doesn't exist on the server, just like --ftp-create-dirs.
|
||||||
certificates when comparing the pinned keys. Therefore it is not compatible
|
certificates when comparing the pinned keys. Therefore it is not compatible
|
||||||
with "HTTP Public Key Pinning" as there also intermediate and root
|
with "HTTP Public Key Pinning" as there also intermediate and root
|
||||||
certificates can be pinned. This is very useful as it prevents webadmins from
|
certificates can be pinned. This is very useful as it prevents webadmins from
|
||||||
"locking themself out of their servers".
|
"locking themselves out of their servers".
|
||||||
|
|
||||||
Adding this feature would make curls pinning 100% compatible to HPKP and
|
Adding this feature would make curls pinning 100% compatible to HPKP and
|
||||||
allow more flexible pinning.
|
allow more flexible pinning.
|
||||||
|
@ -824,7 +824,7 @@ that doesn't exist on the server, just like --ftp-create-dirs.
|
||||||
13.14 Support the clienthello extension
|
13.14 Support the clienthello extension
|
||||||
|
|
||||||
Certain stupid networks and middle boxes have a problem with SSL handshake
|
Certain stupid networks and middle boxes have a problem with SSL handshake
|
||||||
pakets that are within a certain size range because how that sets some bits
|
packets that are within a certain size range because how that sets some bits
|
||||||
that previously (in older TLS version) were not set. The clienthello
|
that previously (in older TLS version) were not set. The clienthello
|
||||||
extension adds padding to avoid that size range.
|
extension adds padding to avoid that size range.
|
||||||
|
|
||||||
|
@ -1054,7 +1054,7 @@ that doesn't exist on the server, just like --ftp-create-dirs.
|
||||||
|
|
||||||
Consider a command line option that can make curl do multiple serial requests
|
Consider a command line option that can make curl do multiple serial requests
|
||||||
slow, potentially with a (random) wait between transfers. There's also a
|
slow, potentially with a (random) wait between transfers. There's also a
|
||||||
propsed set of standard HTTP headers to let servers let the client adapt to
|
proposed set of standard HTTP headers to let servers let the client adapt to
|
||||||
its rate limits:
|
its rate limits:
|
||||||
https://www.ietf.org/id/draft-polli-ratelimit-headers-02.html
|
https://www.ietf.org/id/draft-polli-ratelimit-headers-02.html
|
||||||
|
|
||||||
|
@ -1143,7 +1143,7 @@ that doesn't exist on the server, just like --ftp-create-dirs.
|
||||||
|
|
||||||
18.23 Set the modification date on an uploaded file
|
18.23 Set the modification date on an uploaded file
|
||||||
|
|
||||||
For SFTP and posssibly FTP, curl could offer an option to set the
|
For SFTP and possibly FTP, curl could offer an option to set the
|
||||||
modification time for the uploaded file.
|
modification time for the uploaded file.
|
||||||
|
|
||||||
See https://github.com/curl/curl/issues/5768
|
See https://github.com/curl/curl/issues/5768
|
||||||
|
|
|
@ -126,10 +126,10 @@ For example, this could look like:
|
||||||
## Scheme
|
## Scheme
|
||||||
|
|
||||||
The scheme specifies the protocol to use. A curl build can support a few or
|
The scheme specifies the protocol to use. A curl build can support a few or
|
||||||
many different schemes. You can limit what schemes curl should acccept.
|
many different schemes. You can limit what schemes curl should accept.
|
||||||
|
|
||||||
curl supports the following schemes on URLs specified to transfer. They are
|
curl supports the following schemes on URLs specified to transfer. They are
|
||||||
matched case insensitvely:
|
matched case insensitively:
|
||||||
|
|
||||||
`dict`, `file`, `ftp`, `ftps`, `gopher`, `http`, `https`, `imap`, `imaps`,
|
`dict`, `file`, `ftp`, `ftps`, `gopher`, `http`, `https`, `imap`, `imaps`,
|
||||||
`ldap`, `ldaps`, `mqtt`, `pop3`, `pop3s`, `rtmp`, `rtmpe`, `rtmps`, `rtmpt`,
|
`ldap`, `ldaps`, `mqtt`, `pop3`, `pop3s`, `rtmp`, `rtmpe`, `rtmps`, `rtmpt`,
|
||||||
|
@ -267,7 +267,7 @@ the same search but will only return postalAddress attributes:
|
||||||
|
|
||||||
ldap://ldap.example.com/o=My%20Organisation?postalAddress
|
ldap://ldap.example.com/o=My%20Organisation?postalAddress
|
||||||
|
|
||||||
Seearch for an empty DN and request information about the
|
Search for an empty DN and request information about the
|
||||||
`rootDomainNamingContext` attribute for an Active Directory server:
|
`rootDomainNamingContext` attribute for an Active Directory server:
|
||||||
|
|
||||||
ldap://ldap.example.com/?rootDomainNamingContext
|
ldap://ldap.example.com/?rootDomainNamingContext
|
||||||
|
|
Loading…
Reference in New Issue
Block a user