docs: misc language polish

- CURLINFO_FILETIME*: improve language
- add '32bit' and '64bit' as bad words, use 32-bit and 64-bit
- mksymbolsmanpage.pl: avoid "will"

Closes #14070
This commit is contained in:
Daniel Stenberg 2024-07-01 10:37:43 +02:00
parent ecd654e12e
commit 816ac2a866
No known key found for this signature in database
GPG key ID: 5CC908FDB71E12C2
22 changed files with 65 additions and 63 deletions

View file

@ -141,13 +141,13 @@ data. Where it comes from and where it goes.
`size_t` is not a fixed size. `time_t` can be signed or unsigned and have
different sizes. Relying on variable sizes is a red flag.
Also remember that endianness and >= 32 bit accesses to unaligned addresses
Also remember that endianness and >= 32-bit accesses to unaligned addresses
are problematic areas.
## Integer overflows
Be careful about integer overflows. Some variable types can be either 32 bit
or 64 bit. Integer overflows must be detected and acted on *before* they
Be careful about integer overflows. Some variable types can be either 32-bit
or 64-bit. Integer overflows must be detected and acted on *before* they
happen.
## Dangerous use of functions

View file

@ -29,7 +29,7 @@ May 2025 are: BearSSL and Secure Transport.
- axTLS
- PolarSSL
- NPN
- Support for systems without 64 bit data types
- Support for systems without 64-bit data types
- NSS
- gskit
- mingw v1

View file

@ -56,7 +56,7 @@ FAQ
4. Running Problems
4.2 Why do I get problems when I use & or % in the URL?
4.3 How can I use {, }, [ or ] to specify multiple URLs?
4.4 Why do I get downloaded data even though the web page does not exist?
4.4 Why do I get downloaded data even though the webpage does not exist?
4.5 Why do I get return code XXX from an HTTP server?
4.5.1 "400 Bad Request"
4.5.2 "401 Unauthorized"
@ -65,7 +65,7 @@ FAQ
4.5.5 "405 Method Not Allowed"
4.5.6 "301 Moved Permanently"
4.6 Can you tell me what error code 142 means?
4.7 How do I keep user names and passwords secret in curl command lines?
4.7 How do I keep usernames and passwords secret in curl command lines?
4.8 I found a bug
4.9 curl cannot authenticate to a server that requires NTLM?
4.10 My HTTP request using HEAD, PUT or DELETE does not work
@ -89,7 +89,7 @@ FAQ
5.6 What about Keep-Alive or persistent connections?
5.7 Link errors when building libcurl on Windows
5.8 libcurl.so.X: open failed: No such file or directory
5.9 How does libcurl resolve host names?
5.9 How does libcurl resolve hostnames?
5.10 How do I prevent libcurl from writing the response to stdout?
5.11 How do I make libcurl not receive the whole HTTP response?
5.12 Can I make libcurl fake or hide my real IP address?
@ -624,7 +624,7 @@ FAQ
3.14 Does curl support JavaScript or PAC (automated proxy config)?
Many web pages do magic stuff using embedded JavaScript. curl and libcurl
Many webpages do magic stuff using embedded JavaScript. curl and libcurl
have no built-in support for that, so it will be treated just like any other
contents.
@ -722,7 +722,7 @@ FAQ
curl --header "Host: www.example.com" http://127.0.0.1/
You can also opt to add faked host name entries to curl with the --resolve
You can also opt to add faked hostname entries to curl with the --resolve
option. That has the added benefit that things like redirects will also work
properly. The above operation would instead be done as:
@ -771,11 +771,10 @@ FAQ
[WHATEVER]. This way you can for example send a DELETE by doing "curl -X
DELETE [URL]".
It is thus pointless to do "curl -XGET [URL]" as GET would be used
anyway. In the same vein it is pointless to do "curl -X POST -d data
[URL]"... But you can make a fun and somewhat rare request that sends a
request-body in a GET request with something like "curl -X GET -d data
[URL]"
It is thus pointless to do "curl -XGET [URL]" as GET would be used anyway.
In the same vein it is pointless to do "curl -X POST -d data [URL]". You can
make a fun and somewhat rare request that sends a request-body in a GET
request with something like "curl -X GET -d data [URL]"
Note that -X does not actually change curl's behavior as it only modifies the
actual string sent in the request, but that may of course trigger a
@ -822,7 +821,7 @@ FAQ
curl -g 'www.example.com/weirdname[].html'
4.4 Why do I get downloaded data even though the web page does not exist?
4.4 Why do I get downloaded data even though the webpage does not exist?
curl asks remote servers for the page you specify. If the page does not exist
at the server, the HTTP protocol defines how the server should respond and
@ -883,7 +882,7 @@ FAQ
appreciate a detailed bug report from you that describes how we could go
ahead and repeat this.
4.7 How do I keep user names and passwords secret in curl command lines?
4.7 How do I keep usernames and passwords secret in curl command lines?
This problem has two sides:
@ -1100,7 +1099,7 @@ FAQ
When doing HTTP transfers, curl will perform exactly what you are asking it
to do and if successful it will not return an error. You can use curl to
test your web server's "file not found" page (that gets 404 back), you can
use it to check your authentication protected web pages (that gets a 401
use it to check your authentication protected webpages (that gets a 401
back) and so on.
The specific HTTP response code does not constitute a problem or error for
@ -1192,7 +1191,7 @@ FAQ
5.6 What about Keep-Alive or persistent connections?
curl and libcurl have excellent support for persistent connections when
transferring several files from the same server. curl will attempt to reuse
transferring several files from the same server. curl will attempt to reuse
connections for all URLs specified on the same command line/config file, and
libcurl will reuse connections for all transfers that are made using the
same libcurl handle.
@ -1252,14 +1251,14 @@ FAQ
'man ld.so' and 'man ld' will tell you more details
5.9 How does libcurl resolve host names?
5.9 How does libcurl resolve hostnames?
libcurl supports a large number of name resolve functions. One of them is
picked at build-time and will be used unconditionally. Thus, if you want to
change name resolver function you must rebuild libcurl and tell it to use a
different function.
- The non-IPv6 resolver that can use one of four different host name resolve
- The non-IPv6 resolver that can use one of four different hostname resolve
calls (depending on what your system supports):
A - gethostbyname()

View file

@ -122,12 +122,12 @@ Always
This function returns -1 when it fails to parse the date string. Otherwise it
returns the number of seconds as described.
On systems with a signed 32 bit time_t: if the year is larger than 2037 or
On systems with a signed 32-bit time_t: if the year is larger than 2037 or
less than 1903, this function returns -1.
On systems with an unsigned 32 bit time_t: if the year is larger than 2106 or
On systems with an unsigned 32-bit time_t: if the year is larger than 2106 or
less than 1970, this function returns -1.
On systems with 64 bit time_t: if the year is less than 1583, this function
On systems with 64-bit time_t: if the year is less than 1583, this function
returns -1. (The Gregorian calendar was first introduced 1582 so no "real"
dates in this way of doing dates existed before then.)

View file

@ -60,7 +60,7 @@ since that version no new code should be written to use the symbol as it is
marked for getting removed in a future.
The last version that featured the specific symbol. Using the symbol in source
code will make it no longer compile error-free after that specified version.
code makes it no longer compile error-free after that specified version.
This man page is automatically generated from the symbols-in-versions file.
HEADER

View file

@ -34,12 +34,11 @@ in number of seconds since January 1 1970 in the GMT/UTC time zone. If you get
hide it or the server does not support the command that tells document time
etc) and the time of the document is unknown.
You must tell libcurl to collect this information before the transfer is made,
by using the CURLOPT_FILETIME(3) option to curl_easy_setopt(3) or
you this unconditionally gets a -1 back.
You must ask libcurl to collect this information before the transfer is made,
by using the CURLOPT_FILETIME(3) option or you unconditionally get a -1 back.
Consider using CURLINFO_FILETIME_T(3) to be able to extract dates beyond
the year 2038 on systems using 32 bit longs (Windows).
Consider CURLINFO_FILETIME_T(3) instead to be able to extract dates beyond the
year 2038 on systems using 32-bit longs (Windows).
# EXAMPLE

View file

@ -30,18 +30,16 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_FILETIME_T,
# DESCRIPTION
Pass a pointer to a curl_off_t to receive the remote time of the retrieved
document in number of seconds since January 1 1970 in the GMT/UTC time
zone. If you get -1, it can be because of many reasons (it might be unknown,
the server might hide it or the server does not support the command that tells
document in number of seconds since January 1 1970 in the GMT/UTC time zone.
If you get -1, it can be because of many reasons (it might be unknown, the
server might hide it or the server does not support the command that tells
document time etc) and the time of the document is unknown.
You must ask libcurl to collect this information before the transfer is made,
by using the CURLOPT_FILETIME(3) option to curl_easy_setopt(3) or
you unconditionally get a -1 back.
by using the CURLOPT_FILETIME(3) option or you unconditionally get a -1 back.
This option is an alternative to CURLINFO_FILETIME(3) to allow systems
with 32 bit long variables to extract dates outside of the 32bit timestamp
range.
This option is an alternative to CURLINFO_FILETIME(3) to allow systems with 32
bit long variables to extract dates outside of the 32-bit timestamp range.
# EXAMPLE

View file

@ -29,7 +29,7 @@ Pass a long *val* as parameter. This should be the time counted as seconds
since 1 Jan 1970, and the time is used in a condition as specified with
CURLOPT_TIMECONDITION(3).
On systems with 32 bit 'long' variables (such as Windows), this option cannot
On systems with 32-bit 'long' variables (such as Windows), this option cannot
set dates beyond the year 2038. Consider CURLOPT_TIMEVALUE_LARGE(3)
instead.

View file

@ -31,9 +31,9 @@ Pass a curl_off_t *val* as parameter. This should be the time counted as
seconds since 1 Jan 1970, and the time is used in a condition as specified
with CURLOPT_TIMECONDITION(3).
The difference between this option and CURLOPT_TIMEVALUE(3) is the type
of the argument. On systems where 'long' is only 32 bit wide, this option has
to be used to set dates beyond the year 2038.
The difference between this option and CURLOPT_TIMEVALUE(3) is the type of the
argument. On systems where 'long' is only 32 bits wide, this option has to be
used to set dates beyond the year 2038.
# DEFAULT