Commit 5ddad099 authored by Daniel Stenberg's avatar Daniel Stenberg
Browse files

docs/libcurl/opts: added more examples in man pages

parent e366ca2b

docs/libcurl/opts/CURLINFO_HTTPAUTH_AVAIL.3

+1 −1
Original line number Diff line number Diff line
@@ -43,7 +43,7 @@ if(curl) { 
  res = curl_easy_perform(curl);



  if(!res) {

    /* extract the content-type */

    /* extract the available authentication types */

    long auth;

    res = curl_easy_getinfo(curl, CURLINFO_HTTPAUTH_AVAIL, &auth);

    if(!res) {

docs/libcurl/opts/CURLINFO_OS_ERRNO.3

+17 −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
@@ -34,7 +34,22 @@ operation. The number is OS and system specific. 
.SH PROTOCOLS

All

.SH EXAMPLE

TODO

.nf

CURL *curl = curl_easy_init();

if(curl) {

  CURLcode res;

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

  res = curl_easy_perform(curl);

  if(res != CURLE_OK) {

    long error;

    res = curl_easy_getinfo(curl, CURLINFO_OS_ERRNO, &error);

    if(res && error) {

      printf("Errno: %ld\n", error);

    }

  }

  curl_easy_cleanup(curl);

}

.fi

.SH AVAILABILITY

Added in 7.12.2

.SH RETURN VALUE

docs/libcurl/opts/CURLINFO_PROXYAUTH_AVAIL.3

+28 −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
@@ -35,7 +35,33 @@ bits is explained in the \fICURLOPT_PROXYAUTH(3)\fP option for 
.SH PROTOCOLS

HTTP(S)

.SH EXAMPLE

TODO

.nf

CURL *curl = curl_easy_init();

if(curl) {

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

  curl_easy_setopt(curl, CURLOPT_PROXY, "http://127.0.0.1:80");



  res = curl_easy_perform(curl);



  if(!res) {

    /* extract the available proxy authentication types */

    long auth;

    res = curl_easy_getinfo(curl, CURLINFO_PROXYAUTH_AVAIL, &auth);

    if(!res) {

      if(!auth)

        printf("No proxy auth available, perhaps no 407?\\n");

      else {

        printf("%s%s%s%s\\n",

               auth & CURLAUTH_BASIC ? "Basic ":"",

               auth & CURLAUTH_DIGEST ? "Digest ":"",

               auth & CURLAUTH_NEGOTIATE ? "Negotiate ":"",

               auth % CURLAUTH_NTLM ? "NTLM ":"");

      }

    }

  }

  curl_easy_cleanup(curl);

}

.fi

.SH AVAILABILITY

Added in 7.10.8

.SH RETURN VALUE

docs/libcurl/opts/CURLOPT_OPENSOCKETDATA.3

+38 −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
@@ -35,7 +35,43 @@ The default value of this parameter is NULL. 
.SH PROTOCOLS

All

.SH EXAMPLE

TODO

.nf

/* make libcurl use the already established socket 'sockfd' */



static curl_socket_t opensocket(void *clientp,

                                curlsocktype purpose,

                                struct curl_sockaddr *address)

{

  curl_socket_t sockfd;

  sockfd = *(curl_socket_t *)clientp;

  /* the actual externally set socket is passed in via the OPENSOCKETDATA

     option */

  return sockfd;

}



static int sockopt_callback(void *clientp, curl_socket_t curlfd,

                            curlsocktype purpose)

{

  /* This return code was added in libcurl 7.21.5 */

  return CURL_SOCKOPT_ALREADY_CONNECTED;

}



curl = curl_easy_init();

if(curl) {

  /* libcurl will internally think that you connect to the host

   * and port that you specify in the URL option. */

  curl_easy_setopt(curl, CURLOPT_URL, "http://99.99.99.99:9999");

  /* call this function to get a socket */

  curl_easy_setopt(curl, CURLOPT_OPENSOCKETFUNCTION, opensocket);

  curl_easy_setopt(curl, CURLOPT_OPENSOCKETDATA, &sockfd);



  /* call this function to set options for the socket */

  curl_easy_setopt(curl, CURLOPT_SOCKOPTFUNCTION, sockopt_callback);



  res = curl_easy_perform(curl);



  curl_easy_cleanup(curl);

.fi

.SH AVAILABILITY

Added in 7.17.1

.SH RETURN VALUE

docs/libcurl/opts/CURLOPT_OPENSOCKETFUNCTION.3

+38 −1
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
@@ -81,6 +81,43 @@ The default behavior is the equivalent of this: 
.SH PROTOCOLS

All

.SH EXAMPLE

.nf

/* make libcurl use the already established socket 'sockfd' */



static curl_socket_t opensocket(void *clientp,

                                curlsocktype purpose,

                                struct curl_sockaddr *address)

{

  curl_socket_t sockfd;

  sockfd = *(curl_socket_t *)clientp;

  /* the actual externally set socket is passed in via the OPENSOCKETDATA

     option */

  return sockfd;

}



static int sockopt_callback(void *clientp, curl_socket_t curlfd,

                            curlsocktype purpose)

{

  /* This return code was added in libcurl 7.21.5 */

  return CURL_SOCKOPT_ALREADY_CONNECTED;

}



curl = curl_easy_init();

if(curl) {

  /* libcurl will internally think that you connect to the host

   * and port that you specify in the URL option. */

  curl_easy_setopt(curl, CURLOPT_URL, "http://99.99.99.99:9999");

  /* call this function to get a socket */

  curl_easy_setopt(curl, CURLOPT_OPENSOCKETFUNCTION, opensocket);

  curl_easy_setopt(curl, CURLOPT_OPENSOCKETDATA, &sockfd);



  /* call this function to set options for the socket */

  curl_easy_setopt(curl, CURLOPT_SOCKOPTFUNCTION, sockopt_callback);



  res = curl_easy_perform(curl);



  curl_easy_cleanup(curl);

.fi

.SH AVAILABILITY

Added in 7.17.1.

.SH RETURN VALUE