diff options
Diffstat (limited to 'docs/libcurl')
27 files changed, 111 insertions, 114 deletions
diff --git a/docs/libcurl/curl_easy_pause.3 b/docs/libcurl/curl_easy_pause.3 index 0558b9c64..265db6ec4 100644 --- a/docs/libcurl/curl_easy_pause.3 +++ b/docs/libcurl/curl_easy_pause.3 @@ -99,9 +99,9 @@ If the downloaded data is compressed and is asked to get uncompressed automatically on download, libcurl will continue to uncompress the entire downloaded chunk and it will cache the data uncompressed. This has the side- effect that if you download something that is compressed a lot, it can result -in a very large data amount needing to be allocated to save the data during -the pause. This said, you should probably consider not using paused receiving -if you allow libcurl to uncompress data automatically. +in a large data amount needing to be allocated to save the data during the +pause. This said, you should probably consider not using paused receiving if +you allow libcurl to uncompress data automatically. .SH AVAILABILITY Added in 7.18.0. .SH RETURN VALUE diff --git a/docs/libcurl/curl_easy_send.3 b/docs/libcurl/curl_easy_send.3 index 6430c54e0..292a3e3d3 100644 --- a/docs/libcurl/curl_easy_send.3 +++ b/docs/libcurl/curl_easy_send.3 @@ -73,8 +73,8 @@ sent was for internal SSL processing, and no other data could be sent. Added in 7.18.2. .SH RETURN VALUE On success, returns \fBCURLE_OK\fP and stores the number of bytes actually -sent into \fB*n\fP. Note that this may very well be less than the amount you -wanted to send. +sent into \fB*n\fP. Note that this may be less than the amount you wanted to +send. On failure, returns the appropriate error code. diff --git a/docs/libcurl/curl_mime_data.3 b/docs/libcurl/curl_mime_data.3 index e482555ac..abb84789c 100644 --- a/docs/libcurl/curl_mime_data.3 +++ b/docs/libcurl/curl_mime_data.3 @@ -42,7 +42,7 @@ Setting a part's contents twice is valid: only the value set by the last call is retained. It is possible to unassign part's contents by setting \fIdata\fP to NULL. -Setting very large data is memory consuming: one might consider using +Setting large data is memory consuming: one might consider using \fIcurl_mime_data_cb(3)\fP in such a case. .SH EXAMPLE .nf diff --git a/docs/libcurl/curl_multi_info_read.3 b/docs/libcurl/curl_multi_info_read.3 index 6a3d9f748..cd4c725e9 100644 --- a/docs/libcurl/curl_multi_info_read.3 +++ b/docs/libcurl/curl_multi_info_read.3 @@ -48,10 +48,10 @@ is emptied. calling \fIcurl_multi_cleanup(3)\fP, \fIcurl_multi_remove_handle(3)\fP or \fIcurl_easy_cleanup(3)\fP. -The 'CURLMsg' struct is very simple and only contains very basic information. -If more involved information is wanted, the particular "easy handle" is -present in that struct and can be used in subsequent regular -\fIcurl_easy_getinfo(3)\fP calls (or similar): +The 'CURLMsg' struct is simple and only contains basic information. If more +involved information is wanted, the particular "easy handle" is present in +that struct and can be used in subsequent regular \fIcurl_easy_getinfo(3)\fP +calls (or similar): .nf struct CURLMsg { diff --git a/docs/libcurl/curl_multi_perform.3 b/docs/libcurl/curl_multi_perform.3 index 90ccf2b60..aeb346eb1 100644 --- a/docs/libcurl/curl_multi_perform.3 +++ b/docs/libcurl/curl_multi_perform.3 @@ -46,9 +46,9 @@ is less than the amount of easy handles you've added to the multi handle), you know that there is one or more transfers less "running". You can then call \fIcurl_multi_info_read(3)\fP to get information about each individual completed transfer, and that returned info includes CURLcode and more. If an -added handle fails very quickly, it may never be counted as a running_handle. -You could use \fIcurl_multi_info_read(3)\fP to track actual status of the -added handles in that case. +added handle fails quickly, it may never be counted as a running_handle. You +could use \fIcurl_multi_info_read(3)\fP to track actual status of the added +handles in that case. When \fIrunning_handles\fP is set to zero (0) on the return of this function, there is no longer any transfers in progress. diff --git a/docs/libcurl/curl_multi_timeout.3 b/docs/libcurl/curl_multi_timeout.3 index 4f169332c..125738783 100644 --- a/docs/libcurl/curl_multi_timeout.3 +++ b/docs/libcurl/curl_multi_timeout.3 @@ -38,9 +38,8 @@ to CURL_SOCKET_TIMEOUT, or call \fIcurl_multi_perform(3)\fP if you're using the simpler and older multi interface approach. The timeout value returned in the long \fBtimeout\fP points to, is in number -of milliseconds at this very moment. If 0, it means you should proceed -immediately without waiting for anything. If it returns -1, there's no timeout -at all set. +of milliseconds at this moment. If 0, it means you should proceed immediately +without waiting for anything. If it returns -1, there's no timeout at all set. An application that uses the multi_socket API SHOULD NOT use this function, but SHOULD instead use \fIcurl_multi_setopt(3)\fP and its diff --git a/docs/libcurl/libcurl-easy.3 b/docs/libcurl/libcurl-easy.3 index 0fe58159a..efa78fd08 100644 --- a/docs/libcurl/libcurl-easy.3 +++ b/docs/libcurl/libcurl-easy.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -35,9 +35,9 @@ is available etc. \fIcurl_easy_setopt(3)\fP is used for all this. \fICURLOPT_URL(3)\fP is only option you really must set, as otherwise there can be no transfer. Another commonly used option is \fICURLOPT_VERBOSE(3)\fP -that will help you see what libcurl is doing under the hood, very useful when -debugging for example. The \fIcurl_easy_setopt(3)\fP man page has a full index -of the over 200 available options. +that will help you see what libcurl is doing under the hood, which is useful +when debugging for example. The \fIcurl_easy_setopt(3)\fP man page has a full +index of the over 200 available options. If you at any point would like to blank all previously set options for a single easy handle, you can call \fIcurl_easy_reset(3)\fP and you can also diff --git a/docs/libcurl/libcurl-security.3 b/docs/libcurl/libcurl-security.3 index b83112f2a..5e9db9152 100644 --- a/docs/libcurl/libcurl-security.3 +++ b/docs/libcurl/libcurl-security.3 @@ -42,9 +42,9 @@ many of these and similar types of weaknesses of which application writers should be aware. .SH "Command Lines" If you use a command line tool (such as curl) that uses libcurl, and you give -options to the tool on the command line those options can very likely get read -by other users of your system when they use 'ps' or other tools to list -currently running processes. +options to the tool on the command line those options can get read by other +users of your system when they use 'ps' or other tools to list currently +running processes. To avoid these problems, never feed sensitive things to programs using command line options. Write them to a protected file and use the \-K option to avoid @@ -64,11 +64,11 @@ To avoid these problems, don't use .netrc files and never store passwords in plain text anywhere. .SH "Clear Text Passwords" Many of the protocols libcurl supports send name and password unencrypted as -clear text (HTTP Basic authentication, FTP, TELNET etc). It is very easy for -anyone on your network or a network nearby yours to just fire up a network -analyzer tool and eavesdrop on your passwords. Don't let the fact that HTTP -Basic uses base64 encoded passwords fool you. They may not look readable at a -first glance, but they very easily "deciphered" by anyone within seconds. +clear text (HTTP Basic authentication, FTP, TELNET etc). It is easy for anyone +on your network or a network nearby yours to just fire up a network analyzer +tool and eavesdrop on your passwords. Don't let the fact that HTTP Basic uses +base64 encoded passwords fool you. They may not look readable at a first +glance, but they are easily "deciphered" by anyone within seconds. To avoid this problem, use an authentication mechanism or other protocol that doesn't let snoopers see your password: Digest, CRAM-MD5, Kerberos, SPNEGO or @@ -370,7 +370,7 @@ information with faked data. .SH "Setuid applications using libcurl" libcurl-using applications that set the 'setuid' bit to run with elevated or modified rights also implicitly give that extra power to libcurl and this -should only be done after very careful considerations. +should only be done after careful considerations. Giving setuid powers to the application means that libcurl can save files using those new rights (if for example the `SSLKEYLOGFILE` environment variable is diff --git a/docs/libcurl/libcurl-thread.3 b/docs/libcurl/libcurl-thread.3 index ff9c2304f..387e407f9 100644 --- a/docs/libcurl/libcurl-thread.3 +++ b/docs/libcurl/libcurl-thread.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 2015 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 2015 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -84,9 +84,9 @@ threaded situation as there will be race where libcurl risks restoring the former signal handler while another thread should still ignore it. .IP "Name resolving" \fBgethostby* functions and other system calls.\fP These functions, provided -by your operating system, must be thread safe. It is very important that -libcurl can find and use thread safe versions of these and other system calls, -as otherwise it can't function fully thread safe. Some operating systems are +by your operating system, must be thread safe. It is important that libcurl +can find and use thread safe versions of these and other system calls, as +otherwise it can't function fully thread safe. Some operating systems are known to have faulty thread implementations. We have previously received problem reports on *BSD (at least in the past, they may be working fine these days). Some operating systems that are known to have solid and working thread diff --git a/docs/libcurl/libcurl-tutorial.3 b/docs/libcurl/libcurl-tutorial.3 index 3aafcb853..6c053ec17 100644 --- a/docs/libcurl/libcurl-tutorial.3 +++ b/docs/libcurl/libcurl-tutorial.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -86,9 +86,9 @@ The people behind libcurl have put a considerable effort to make libcurl work on a large amount of different operating systems and environments. You program libcurl the same way on all platforms that libcurl runs on. There -are only very few minor considerations that differ. If you just make sure to -write your code portable enough, you may very well create yourself a very -portable program. libcurl shouldn't stop you from that. +are only a few minor details that differ. If you just make sure to write your +code portable enough, you can create a portable program. libcurl shouldn't +stop you from that. .SH "Global Preparation" The program must initialize some of the libcurl functionality globally. That @@ -120,7 +120,7 @@ libcurl has a default protection mechanism that detects if \fIcurl_global_init(3)\fP hasn't been called by the time \fIcurl_easy_perform(3)\fP is called and if that is the case, libcurl runs the function itself with a guessed bit pattern. Please note that depending solely -on this is not considered nice nor very good. +on this is not considered nice nor good. When the program no longer uses libcurl, it should call \fIcurl_global_cleanup(3)\fP, which is the opposite of the init call. It will @@ -284,14 +284,13 @@ If \fICURLOPT_VERBOSE(3)\fP is not enough, you increase the level of debug data your application receive by using the \fICURLOPT_DEBUGFUNCTION(3)\fP. Getting some in-depth knowledge about the protocols involved is never wrong, -and if you're trying to do funny things, you might very well understand -libcurl and how to use it better if you study the appropriate RFC documents -at least briefly. +and if you're trying to do funny things, you might understand libcurl and how +to use it better if you study the appropriate RFC documents at least briefly. .SH "Upload Data to a Remote Site" libcurl tries to keep a protocol independent approach to most transfers, thus -uploading to a remote FTP site is very similar to uploading data to an HTTP -server with a PUT request. +uploading to a remote FTP site is similar to uploading data to an HTTP server +with a PUT request. Of course, first you either create an easy handle or you re-use one existing one. Then you set the URL to operate on just like before. This is the remote @@ -373,7 +372,7 @@ curl use this file, use the \fICURLOPT_NETRC(3)\fP option: curl_easy_setopt(easyhandle, CURLOPT_NETRC, 1L); -And a very basic example of how such a .netrc file may look like: +And a basic example of how such a .netrc file may look like: .nf machine myhost.mydomain.com @@ -795,10 +794,9 @@ For HTTP proxies: the fact that the proxy is an HTTP proxy puts certain restrictions on what can actually happen. A requested URL that might not be a HTTP URL will be still be passed to the HTTP proxy to deliver back to libcurl. This happens transparently, and an application may not need to -know. I say "may", because at times it is very important to understand that -all operations over an HTTP proxy use the HTTP protocol. For example, you -can't invoke your own custom FTP commands or even proper FTP directory -listings. +know. I say "may", because at times it is important to understand that all +operations over an HTTP proxy use the HTTP protocol. For example, you can't +invoke your own custom FTP commands or even proper FTP directory listings. .IP "Proxy Options" @@ -942,9 +940,9 @@ may also be added in the future. Each easy handle will attempt to keep the last few connections alive for a while in case they are to be used again. You can set the size of this "cache" -with the \fICURLOPT_MAXCONNECTS(3)\fP option. Default is 5. There is very -seldom any point in changing this value, and if you think of changing this it -is often just a matter of thinking again. +with the \fICURLOPT_MAXCONNECTS(3)\fP option. Default is 5. There is rarely +any point in changing this value, and if you think of changing this it is +often just a matter of thinking again. To force your upcoming request to not use an already existing connection (it will even close one first if there happens to be one alive to the same host @@ -986,7 +984,7 @@ libcurl is your friend here too. .IP CUSTOMREQUEST If just changing the actual HTTP request keyword is what you want, like when GET, HEAD or POST is not good enough for you, \fICURLOPT_CUSTOMREQUEST(3)\fP -is there for you. It is very simple to use: +is there for you. It is simple to use: curl_easy_setopt(easyhandle, CURLOPT_CUSTOMREQUEST, "MYOWNREQUEST"); @@ -1045,9 +1043,9 @@ data size is unknown. .IP "HTTP Version" All HTTP requests includes the version number to tell the server which version -we support. libcurl speaks HTTP 1.1 by default. Some very old servers don't -like getting 1.1-requests and when dealing with stubborn old things like that, -you can tell libcurl to use 1.0 instead by doing something like this: +we support. libcurl speaks HTTP 1.1 by default. Some old servers don't like +getting 1.1-requests and when dealing with stubborn old things like that, you +can tell libcurl to use 1.0 instead by doing something like this: curl_easy_setopt(easyhandle, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0); @@ -1057,14 +1055,14 @@ Not all protocols are HTTP-like, and thus the above may not help you when you want to make, for example, your FTP transfers to behave differently. Sending custom commands to an FTP server means that you need to send the -commands exactly as the FTP server expects them (RFC959 is a good guide -here), and you can only use commands that work on the control-connection -alone. All kinds of commands that require data interchange and thus need -a data-connection must be left to libcurl's own judgement. Also be aware -that libcurl will do its very best to change directory to the target -directory before doing any transfer, so if you change directory (with CWD -or similar) you might confuse libcurl and then it might not attempt to -transfer the file in the correct remote directory. +commands exactly as the FTP server expects them (RFC959 is a good guide here), +and you can only use commands that work on the control-connection alone. All +kinds of commands that require data interchange and thus need a +data-connection must be left to libcurl's own judgement. Also be aware that +libcurl will do its best to change directory to the target directory before +doing any transfer, so if you change directory (with CWD or similar) you might +confuse libcurl and then it might not attempt to transfer the file in the +correct remote directory. A little example that deletes a given file before an operation: @@ -1336,9 +1334,9 @@ with the particular file descriptors libcurl uses for the moment. When you then call select(), it'll return when one of the file handles signal action and you then call \fIcurl_multi_perform(3)\fP to allow libcurl to do what it wants to do. Take note that libcurl does also feature some time-out -code so we advise you to never use very long timeouts on select() before you -call \fIcurl_multi_perform(3)\fP again. \fIcurl_multi_timeout(3)\fP is -provided to help you get a suitable timeout period. +code so we advise you to never use long timeouts on select() before you call +\fIcurl_multi_perform(3)\fP again. \fIcurl_multi_timeout(3)\fP is provided to +help you get a suitable timeout period. Another precaution you should use: always call \fIcurl_multi_fdset(3)\fP immediately before the select() call since the current set of file descriptors diff --git a/docs/libcurl/opts/CURLINFO_APPCONNECT_TIME.3 b/docs/libcurl/opts/CURLINFO_APPCONNECT_TIME.3 index d3a93bb22..94e73e78c 100644 --- a/docs/libcurl/opts/CURLINFO_APPCONNECT_TIME.3 +++ b/docs/libcurl/opts/CURLINFO_APPCONNECT_TIME.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -30,9 +30,9 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_APPCONNECT_TIME, double *timep .SH DESCRIPTION Pass a pointer to a double to receive the time, in seconds, it took from the start until the SSL/SSH connect/handshake to the remote host was completed. -This time is most often very near to the \fICURLINFO_PRETRANSFER_TIME(3)\fP -time, except for cases such as HTTP pipelining where the pretransfer time can -be delayed due to waits in line for the pipeline and more. +This time is most often close to the \fICURLINFO_PRETRANSFER_TIME(3)\fP time, +except for cases such as HTTP pipelining where the pretransfer time can be +delayed due to waits in line for the pipeline and more. When a redirect is followed, the time from each request is added together. diff --git a/docs/libcurl/opts/CURLINFO_APPCONNECT_TIME_T.3 b/docs/libcurl/opts/CURLINFO_APPCONNECT_TIME_T.3 index 37f18c938..753356227 100644 --- a/docs/libcurl/opts/CURLINFO_APPCONNECT_TIME_T.3 +++ b/docs/libcurl/opts/CURLINFO_APPCONNECT_TIME_T.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 2018 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 2018 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -28,12 +28,12 @@ CURLINFO_APPCONNECT_TIME_T \- get the time until the SSL/SSH handshake is comple CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_APPCONNECT_TIME_T, curl_off_t *timep); .SH DESCRIPTION -Pass a pointer to a curl_off_t to receive the time, in microseconds, -it took from the -start until the SSL/SSH connect/handshake to the remote host was completed. -This time is most often very near to the \fICURLINFO_PRETRANSFER_TIME_T(3)\fP -time, except for cases such as HTTP pipelining where the pretransfer time can -be delayed due to waits in line for the pipeline and more. +Pass a pointer to a curl_off_t to receive the time, in microseconds, it took +from the start until the SSL/SSH connect/handshake to the remote host was +completed. This time is most often close to the +\fICURLINFO_PRETRANSFER_TIME_T(3)\fP time, except for cases such as HTTP +pipelining where the pretransfer time can be delayed due to waits in line for +the pipeline and more. When a redirect is followed, the time from each request is added together. diff --git a/docs/libcurl/opts/CURLINFO_EFFECTIVE_METHOD.3 b/docs/libcurl/opts/CURLINFO_EFFECTIVE_METHOD.3 index 66c1bec2d..b9b111ad1 100644 --- a/docs/libcurl/opts/CURLINFO_EFFECTIVE_METHOD.3 +++ b/docs/libcurl/opts/CURLINFO_EFFECTIVE_METHOD.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -34,8 +34,8 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_EFFECTIVE_METHOD, Pass in a pointer to a char pointer and get the last used effective HTTP method. -In cases when you've asked libcurl to follow redirects, the method may very -well not be the same method the first request would use. +In cases when you've asked libcurl to follow redirects, the method may not be +the same method the first request would use. The \fBmethodp\fP pointer will be NULL or pointing to private memory you MUST NOT free - it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the diff --git a/docs/libcurl/opts/CURLINFO_EFFECTIVE_URL.3 b/docs/libcurl/opts/CURLINFO_EFFECTIVE_URL.3 index 47b1c9802..0a89836e6 100644 --- a/docs/libcurl/opts/CURLINFO_EFFECTIVE_URL.3 +++ b/docs/libcurl/opts/CURLINFO_EFFECTIVE_URL.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -30,8 +30,8 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_EFFECTIVE_URL, char **urlp); .SH DESCRIPTION Pass in a pointer to a char pointer and get the last used effective URL. -In cases when you've asked libcurl to follow redirects, it may very well not -be the same value you set with \fICURLOPT_URL(3)\fP. +In cases when you've asked libcurl to follow redirects, it may not be the same +value you set with \fICURLOPT_URL(3)\fP. The \fBurlp\fP pointer will be NULL or pointing to private memory you MUST NOT free - it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the diff --git a/docs/libcurl/opts/CURLOPT_CURLU.3 b/docs/libcurl/opts/CURLOPT_CURLU.3 index 5f6d4af76..364ead7c4 100644 --- a/docs/libcurl/opts/CURLOPT_CURLU.3 +++ b/docs/libcurl/opts/CURLOPT_CURLU.3 @@ -36,9 +36,9 @@ CURLU *. Setting \fICURLOPT_CURLU(3)\fP will explicitly override transfer is started. libcurl will use this handle and its contents read-only and will not change -its contents. An application can very well update the contents of the URL -handle after a transfer is done and if the same handle is then used in a -subsequent request the updated contents will then be used. +its contents. An application can update the contents of the URL handle after a +transfer is done and if the same handle is then used in a subsequent request +the updated contents will then be used. .SH DEFAULT The default value of this parameter is NULL. .SH PROTOCOLS diff --git a/docs/libcurl/opts/CURLOPT_DNS_CACHE_TIMEOUT.3 b/docs/libcurl/opts/CURLOPT_DNS_CACHE_TIMEOUT.3 index a85e9f7ca..7b2e37242 100644 --- a/docs/libcurl/opts/CURLOPT_DNS_CACHE_TIMEOUT.3 +++ b/docs/libcurl/opts/CURLOPT_DNS_CACHE_TIMEOUT.3 @@ -52,7 +52,7 @@ CURL *curl = curl_easy_init(); if(curl) { curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin"); - /* only reuse addresses for a very short time */ + /* only reuse addresses for a short time */ curl_easy_setopt(curl, CURLOPT_DNS_CACHE_TIMEOUT, 2L); ret = curl_easy_perform(curl); diff --git a/docs/libcurl/opts/CURLOPT_ERRORBUFFER.3 b/docs/libcurl/opts/CURLOPT_ERRORBUFFER.3 index 55fe53d67..bb999c6c0 100644 --- a/docs/libcurl/opts/CURLOPT_ERRORBUFFER.3 +++ b/docs/libcurl/opts/CURLOPT_ERRORBUFFER.3 @@ -34,9 +34,9 @@ return code from \fIcurl_easy_perform(3)\fP and related functions. The buffer \fBmust be at least CURL_ERROR_SIZE bytes big\fP. You must keep the associated buffer available until libcurl no longer needs -it. Failing to do so will cause very odd behavior or even crashes. libcurl -will need it until you call \fIcurl_easy_cleanup(3)\fP or you set the same -option again to use a different pointer. +it. Failing to do so will cause odd behavior or even crashes. libcurl will +need it until you call \fIcurl_easy_cleanup(3)\fP or you set the same option +again to use a different pointer. Do not rely on the contents of the buffer unless an error code was returned. Since 7.60.0 libcurl will initialize the contents of the error buffer to an diff --git a/docs/libcurl/opts/CURLOPT_FOLLOWLOCATION.3 b/docs/libcurl/opts/CURLOPT_FOLLOWLOCATION.3 index 0d0ab00c8..505c106dc 100644 --- a/docs/libcurl/opts/CURLOPT_FOLLOWLOCATION.3 +++ b/docs/libcurl/opts/CURLOPT_FOLLOWLOCATION.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -51,7 +51,7 @@ dictates which request method it will use in the subsequent request: For 301, will make libcurl send the same method again. For users who think the existing location following is too naive, too simple -or just lacks features, it is very easy to instead implement your own redirect +or just lacks features, it is easy to instead implement your own redirect follow logic with the use of \fIcurl_easy_getinfo(3)\fP's \fICURLINFO_REDIRECT_URL(3)\fP option instead of using \fICURLOPT_FOLLOWLOCATION(3)\fP. diff --git a/docs/libcurl/opts/CURLOPT_HEADERFUNCTION.3 b/docs/libcurl/opts/CURLOPT_HEADERFUNCTION.3 index 229bf356e..33ac8cfd7 100644 --- a/docs/libcurl/opts/CURLOPT_HEADERFUNCTION.3 +++ b/docs/libcurl/opts/CURLOPT_HEADERFUNCTION.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -38,10 +38,10 @@ shown above. This function gets called by libcurl as soon as it has received header data. The header callback will be called once for each header and only -complete header lines are passed on to the callback. Parsing headers is very -easy using this. \fIbuffer\fP points to the delivered data, and the size of -that data is \fInitems\fP; \fIsize\fP is always 1. Do not assume that the -header line is null-terminated! +complete header lines are passed on to the callback. Parsing headers is easy +to do using this callback. \fIbuffer\fP points to the delivered data, and the +size of that data is \fInitems\fP; \fIsize\fP is always 1. Do not assume that +the header line is null-terminated! The pointer named \fIuserdata\fP is the one you set with the \fICURLOPT_HEADERDATA(3)\fP option. diff --git a/docs/libcurl/opts/CURLOPT_HTTP200ALIASES.3 b/docs/libcurl/opts/CURLOPT_HTTP200ALIASES.3 index 1009c66fd..66ac89ad9 100644 --- a/docs/libcurl/opts/CURLOPT_HTTP200ALIASES.3 +++ b/docs/libcurl/opts/CURLOPT_HTTP200ALIASES.3 @@ -32,11 +32,11 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTP200ALIASES, .SH DESCRIPTION Pass a pointer to a linked list of \fIaliases\fP to be treated as valid HTTP 200 responses. Some servers respond with a custom header response line. For -example, SHOUTcast servers respond with "ICY 200 OK". Also some very old -Icecast 1.3.x servers will respond like that for certain user agent headers or -in absence of such. By including this string in your list of aliases, -the response will be treated as a valid HTTP header line such as -"HTTP/1.0 200 OK". +example, SHOUTcast servers respond with "ICY 200 OK". Also some old Icecast +1.3.x servers will respond like that for certain user agent headers or in +absence of such. By including this string in your list of aliases, the +response will be treated as a valid HTTP header line such as "HTTP/1.0 200 +OK". The linked list should be a fully valid list of struct curl_slist structs, and be properly filled in. Use \fIcurl_slist_append(3)\fP to create the list and diff --git a/docs/libcurl/opts/CURLOPT_MAXLIFETIME_CONN.3 b/docs/libcurl/opts/CURLOPT_MAXLIFETIME_CONN.3 index 8f8ec33c8..18329d9cd 100644 --- a/docs/libcurl/opts/CURLOPT_MAXLIFETIME_CONN.3 +++ b/docs/libcurl/opts/CURLOPT_MAXLIFETIME_CONN.3 @@ -35,7 +35,7 @@ connection to have to be considered for reuse for this request. libcurl features a connection cache that holds previously used connections. When a new request is to be done, it will consider any connection that matches for reuse. The \fICURLOPT_MAXLIFETIME_CONN(3)\fP limit prevents libcurl from -trying very old connections for reuse. This can be used for client-side load +trying too old connections for reuse. This can be used for client-side load balancing. If a connection is found in the cache that is older than this set \fImaxlifetime\fP, it will instead be closed once any in-progress transfers complete. diff --git a/docs/libcurl/opts/CURLOPT_PRE_PROXY.3 b/docs/libcurl/opts/CURLOPT_PRE_PROXY.3 index 4d979ce55..5adc43a89 100644 --- a/docs/libcurl/opts/CURLOPT_PRE_PROXY.3 +++ b/docs/libcurl/opts/CURLOPT_PRE_PROXY.3 @@ -59,7 +59,7 @@ Default is NULL, meaning no pre proxy is used. When you set a host name to use, do not assume that there's any particular single port number used widely for proxies. Specify it! .SH PROTOCOLS -All except file://. Note that some protocols don't do very well over proxy. +All except file://. Note that some protocols don't work well over proxy. .SH EXAMPLE .nf CURL *curl = curl_easy_init(); diff --git a/docs/libcurl/opts/CURLOPT_PROGRESSFUNCTION.3 b/docs/libcurl/opts/CURLOPT_PROGRESSFUNCTION.3 index dc2f8439a..35a37de6b 100644 --- a/docs/libcurl/opts/CURLOPT_PROGRESSFUNCTION.3 +++ b/docs/libcurl/opts/CURLOPT_PROGRESSFUNCTION.3 @@ -41,7 +41,7 @@ We encourage users to use the newer \fICURLOPT_XFERINFOFUNCTION(3)\fP instead, if you can. This function gets called by libcurl instead of its internal equivalent with a -frequent interval. While data is being transferred it will be called very +frequent interval. While data is being transferred it will be called frequently, and during slow periods like when nothing is being transferred it can slow down to about one call per second. diff --git a/docs/libcurl/opts/CURLOPT_PROXY.3 b/docs/libcurl/opts/CURLOPT_PROXY.3 index 8913771c8..6c570fb20 100644 --- a/docs/libcurl/opts/CURLOPT_PROXY.3 +++ b/docs/libcurl/opts/CURLOPT_PROXY.3 @@ -90,7 +90,7 @@ Default is NULL, meaning no proxy is used. When you set a host name to use, do not assume that there's any particular single port number used widely for proxies. Specify it! .SH PROTOCOLS -All except file://. Note that some protocols don't do very well over proxy. +All except file://. Note that some protocols don't work well over proxy. .SH EXAMPLE .nf CURL *curl = curl_easy_init(); diff --git a/docs/libcurl/opts/CURLOPT_PROXYTYPE.3 b/docs/libcurl/opts/CURLOPT_PROXYTYPE.3 index abdd96457..2cdcb3307 100644 --- a/docs/libcurl/opts/CURLOPT_PROXYTYPE.3 +++ b/docs/libcurl/opts/CURLOPT_PROXYTYPE.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -36,9 +36,9 @@ HTTP Proxy. Default. .IP CURLPROXY_HTTPS HTTPS Proxy. (Added in 7.52.0 for OpenSSL, GnuTLS and NSS) .IP CURLPROXY_HTTP_1_0 -HTTP 1.0 Proxy. This is very similar to CURLPROXY_HTTP except it uses HTTP/1.0 -for any CONNECT tunnelling. It does not change the HTTP version of the actual -HTTP requests, controlled by \fICURLOPT_HTTP_VERSION(3)\fP. +HTTP 1.0 Proxy. This is similar to CURLPROXY_HTTP except it uses HTTP/1.0 for +any CONNECT tunnelling. It does not change the HTTP version of the actual HTTP +requests, controlled by \fICURLOPT_HTTP_VERSION(3)\fP. .IP CURLPROXY_SOCKS4 SOCKS4 Proxy. .IP CURLPROXY_SOCKS4A diff --git a/docs/libcurl/opts/CURLOPT_URL.3 b/docs/libcurl/opts/CURLOPT_URL.3 index e33d866bf..aaac06119 100644 --- a/docs/libcurl/opts/CURLOPT_URL.3 +++ b/docs/libcurl/opts/CURLOPT_URL.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -88,8 +88,8 @@ security concerns: If you have an application that runs as or in a server application, getting an unfiltered URL can easily trick your application to access a local resource -instead of a remote. Protecting yourself against localhost accesses is very -hard when accepting user provided URLs. +instead of a remote. Protecting yourself against localhost accesses is hard +when accepting user provided URLs. Such custom URLs can also access other ports than you planned as port numbers are part of the regular URL format. The combination of a local host and a diff --git a/docs/libcurl/opts/CURLOPT_XFERINFOFUNCTION.3 b/docs/libcurl/opts/CURLOPT_XFERINFOFUNCTION.3 index fba1930dc..29367a6b7 100644 --- a/docs/libcurl/opts/CURLOPT_XFERINFOFUNCTION.3 +++ b/docs/libcurl/opts/CURLOPT_XFERINFOFUNCTION.3 @@ -38,7 +38,7 @@ Pass a pointer to your callback function, which should match the prototype shown above. This function gets called by libcurl instead of its internal equivalent with a -frequent interval. While data is being transferred it will be called very +frequent interval. While data is being transferred it will be called frequently, and during slow periods like when nothing is being transferred it can slow down to about one call per second. |