luo980/curl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

libcurl-easy.md: now *more* than 300 options

Browse Source 
it previously said "almost 300".

Also cleaned up the language somewhat.

Closes #14153
This commit is contained in:
Daniel Stenberg 2024-07-11 13:58:32 +02:00
parent b7f2c66d7d
commit 16f56583e5
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
1 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/libcurl/libcurl-easy.md
View File

@ -27,28 +27,27 @@ interface functions you use. Use curl_easy_init(3) to get the handle.
You continue by setting all the options you want in the upcoming transfer, the You continue by setting all the options you want in the upcoming transfer, the
most important among them is the URL itself (you cannot transfer anything most important among them is the URL itself (you cannot transfer anything
without a specified URL as you may have figured out yourself). You might want without a specified URL). You might want to set some callbacks as well that
to set some callbacks as well that are called from the library when data is are called from the library when data is available etc. For example
available etc. curl_easy_setopt(3) is used for all this. CURLOPT_WRITEFUNCTION(3). curl_easy_setopt(3) is used for all this.
CURLOPT_URL(3) is the only option you really must set, as otherwise CURLOPT_URL(3) is the only option you really must set, as otherwise there can
there can be no transfer. Another commonly used option is be no transfer. Another commonly used option is CURLOPT_VERBOSE(3) that helps
CURLOPT_VERBOSE(3) that helps you see what libcurl is doing under the you see what libcurl is doing under the hood, which is useful when debugging
hood, which is useful when debugging for example. The for example. The curl_easy_setopt(3) man page has a full index of the over 300
curl_easy_setopt(3) man page has a full index of the almost 300
available options. available options.
If you at any point would like to blank all previously set options for a If you at any point would like to blank all previously set options for a
single easy handle, you can call curl_easy_reset(3) and you can also single easy handle, you can call curl_easy_reset(3) and you can also make a
make a clone of an easy handle (with all its set options) using clone of an easy handle (with all its set options) using
curl_easy_duphandle(3). curl_easy_duphandle(3).
When all is setup, you tell libcurl to perform the transfer using When all is setup, you tell libcurl to perform the transfer using
curl_easy_perform(3). It performs the entire transfer operation and does curl_easy_perform(3). It performs the entire transfer operation and does not
not return until it is done (successfully or not). return until it is done (successfully or not).
After the transfer has been made, you can set new options and make another After the transfer has been made, you can set new options and make another
transfer, or if you are done, cleanup the session by calling transfer, or if you are done, cleanup the session by calling
curl_easy_cleanup(3). If you want persistent connections, you do not curl_easy_cleanup(3). If you want persistent connections, you do not cleanup
cleanup immediately, but instead run ahead and perform other transfers using immediately, but instead run ahead and perform other transfers using the same
the same easy handle. easy handle.