Commit 4cb7aa06 authored by Daniel Stenberg's avatar Daniel Stenberg
Browse files

opts: provide more and updated examples

parent 41110325

docs/libcurl/opts/CURLOPT_RANGE.3

+1 −1
Original line number Diff line number Diff line
@@ -46,7 +46,7 @@ NULL 
HTTP, FTP, FILE, RTSP and SFTP.

.SH EXAMPLE

.nf

curl = curl_easy_init();

CURL *curl = curl_easy_init();

if(curl) {

  curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");

docs/libcurl/opts/CURLOPT_RESUME_FROM.3

+19 −1
Original line number Diff line number Diff line
@@ -45,10 +45,28 @@ If you need to resume a transfer beyond the 2GB limit, use 
.SH PROTOCOLS

HTTP, FTP, SFTP, FILE

.SH EXAMPLE

TODO

.nf

CURL *curl = curl_easy_init();

if(curl) {

  curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com");



  /* resume upload at byte index 200 */

  curl_easy_setopt(curl, CURLOPT_RESUME_FROM, 200L);



  /* ask for upload */

  curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);



  /* set total data amount to expect */

  curl_easy_setopt(curl, CURLOPT_INFILESIZE, size_of_file);



  /* Perform the request */

  curl_easy_perform(curl);

}

.fi

.SH AVAILABILITY

Always

.SH RETURN VALUE

Returns CURLE_OK

.SH "SEE ALSO"

.BR CURLOPT_RESUME_FROM_LARGE "(3), " CURLOPT_RANGE "(3), "

.BR CURLOPT_INFILESIZE "(3), "

docs/libcurl/opts/CURLOPT_RESUME_FROM_LARGE.3

+22 −1
Original line number Diff line number Diff line
@@ -44,10 +44,31 @@ source file to the remote target file. 
.SH PROTOCOLS

HTTP, FTP, SFTP, FILE

.SH EXAMPLE

TODO

.nf

CURL *curl = curl_easy_init();

if(curl) {

  curl_off_t resume_position = GET_IT_SOMEHOW;

  curl_off_t file_size = GET_IT_SOMEHOW_AS_WELL;



  curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com");



  /* resuming upload at this position, possibly beyond 2GB */

  curl_easy_setopt(curl, CURLOPT_RESUME_FROM_LARGE, resume_position);



  /* ask for upload */

  curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);



  /* set total data amount to expect */

  curl_easy_setopt(curl, CURLOPT_INFILESIZE_LARGE, file_size);



  /* Perform the request */

  curl_easy_perform(curl);

}

.fi

.SH AVAILABILITY

Added in 7.11.0

.SH RETURN VALUE

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.

.SH "SEE ALSO"

.BR CURLOPT_RESUME_FROM "(3), " CURLOPT_RANGE "(3), "

.BR CURLOPT_INFILESIZE_LARGE "(3), "

docs/libcurl/opts/CURLOPT_SSLVERSION.3

+1 −1
Original line number Diff line number Diff line
@@ -55,7 +55,7 @@ CURL_SSLVERSION_DEFAULT 
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3, SMTPS etc.

.SH EXAMPLE

.nf

curl = curl_easy_init();

CURL *curl = curl_easy_init();

if(curl) {

  curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");

docs/libcurl/opts/CURLOPT_UPLOAD.3

+22 −1
Original line number Diff line number Diff line
@@ -47,7 +47,28 @@ must specify the size. 
.SH PROTOCOLS

Most

.SH EXAMPLE

TODO

.nf

CURL *curl = curl_easy_init();

if(curl) {

  /* we want to use our own read function */

  curl_easy_setopt(curl, CURLOPT_READFUNCTION, read_callback);



  /* enable uploading */

  curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);



  /* specify target */

  curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/dir/to/newfile");



  /* now specify which pointer to pass to our callback */

  curl_easy_setopt(curl, CURLOPT_READDATA, hd_src);



  /* Set the size of the file to upload */

  curl_easy_setopt(curl, CURLOPT_INFILESIZE_LARGE, (curl_off_t)fsize);



  /* Now run off and do what you've been told! */

  curl_easy_perform(curl);

}

.fi

.SH AVAILABILITY

Always

.SH RETURN VALUE