Commit bb1a8c17 authored by Daniel Stenberg's avatar Daniel Stenberg
Browse files

opts: more examples added to man pages

parent 2d5fa35e

docs/libcurl/opts/CURLOPT_FAILONERROR.3

+15 −4
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ 
.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" * Copyright (C) 1998 - 2017, 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
@@ -41,15 +41,26 @@ detected, like when a "100-continue" is received as a response to a POST/PUT 
and a 401 or 407 is received immediately afterwards.



When this option is used and an error is detected, it will cause the

connection to get closed.

connection to get closed and \fICURLE_HTTP_RETURNED_ERROR\fP is returned.

.SH DEFAULT

0, do not fail on error

.SH PROTOCOLS

HTTP

.SH EXAMPLE

TODO

.nf

CURL *curl = curl_easy_init();

if(curl) {

  CURLcode ret;

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

  curl_easy_setopt(curl, CURLOPT_FAILONERROR, 1L);

  ret = curl_easy_perform(curl);

  if(ret == CURLE_HTTP_RETURNED_ERROR) {

    /* a HTTP response error problem */

  }

}

.fi

.SH AVAILABILITY

Along with HTTP 

Along with HTTP.

.SH RETURN VALUE

Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.

.SH "SEE ALSO"

docs/libcurl/opts/CURLOPT_FTPPORT.3

+10 −2
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ 
.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" * Copyright (C) 1998 - 2017, 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
@@ -65,7 +65,15 @@ NULL 
.SH PROTOCOLS

FTP

.SH EXAMPLE

TODO

.nf

CURL *curl = curl_easy_init();

if(curl) {

  curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/old-server/file.txt");

  curl_easy_setopt(curl, CURLOPT_FTPPORT, "-");

  ret = curl_easy_perform(curl);

  curl_easy_cleanup(curl);

}

.fi

.SH AVAILABILITY

Port range support was added in 7.19.5

.SH RETURN VALUE

docs/libcurl/opts/CURLOPT_HEADEROPT.3

+19 −2
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ 
.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" * Copyright (C) 1998 - 2017, 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
@@ -48,7 +48,24 @@ CURLHEADER_SEPARATE (changed in 7.42.1, ased CURLHEADER_UNIFIED before then) 
.SH PROTOCOLS

HTTP

.SH EXAMPLE

TODO

.nf

CURL *curl = curl_easy_init();

if(curl) {

  CURLcode ret;

  struct curl_slist *list;

  list = curl_slist_append(NULL, "Shoesize: 10");

  list = curl_slist_append(list, "Accept:");

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

  curl_easy_setopt(curl, CURLOPT_PROXY, "http://localhost:8080");



  /* HTTPS over a proxy makes a separate CONNECT to the proxy, so tell

     libcurl to not send the custom headers to the proxy. Keep them

     separate! */

  curl_easy_setopt(curl, CURLOPT_HEADEROPT, CURLHEADER_SEPARATE);

  ret = curl_easy_perform(curl);

  curl_easy_cleanup(curl);

}

.fi

.SH AVAILABILITY

Added in 7.37.0

.SH RETURN VALUE

docs/libcurl/opts/CURLOPT_HTTPAUTH.3

+12 −2
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ 
.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" * Copyright (C) 1998 - 2017, 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
@@ -99,7 +99,17 @@ CURLAUTH_BASIC 
.SH PROTOCOLS

HTTP

.SH EXAMPLE

TODO

.nf

CURL *curl = curl_easy_init();

if(curl) {

  CURLcode ret;

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

  /* allow whatever auth the server speaks */

  curl_easy_setopt(curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);

  curl_easy_setopt(curl, CURLOPT_USERPWD, "james:bond");

  ret = curl_easy_perform(curl);

}

.fi

.SH AVAILABILITY

Option Added in 7.10.6.

docs/libcurl/opts/CURLOPT_HTTP_VERSION.3

+13 −2
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ 
.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" * Copyright (C) 1998 - 2017, 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
@@ -64,7 +64,18 @@ CURL_HTTP_VERSION_NONE 
.SH PROTOCOLS

HTTP

.SH EXAMPLE

TODO

.nf

CURL *curl = curl_easy_init();

if(curl) {

  CURLcode ret;

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

  curl_easy_setopt(curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_2TLS);

  ret = curl_easy_perform(curl);

  if(ret == CURLE_HTTP_RETURNED_ERROR) {

    /* a HTTP response error problem */

  }

}

.fi

.SH AVAILABILITY

Along with HTTP

.SH RETURN VALUE