Commit 58a6265a authored by Daniel Stenberg's avatar Daniel Stenberg
Browse files

docs/opts: 23 more man pages now have examples

parent 22fdb095

docs/libcurl/opts/CURLINFO_ACTIVESOCKET.3

+20 −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
@@ -41,7 +41,25 @@ that one isn't working on all platforms. 
.SH PROTOCOLS

All

.SH EXAMPLE

TODO

.nf

CURL *curl = curl_easy_init();

if(curl) {

  curl_socket_t sockfd;

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



  /* Do not do the transfer - only connect to host */

  curl_easy_setopt(curl, CURLOPT_CONNECT_ONLY, 1L);

  res = curl_easy_perform(curl);



  /* Extract the socket from the curl handle */

  res = curl_easy_getinfo(curl, CURLINFO_ACTIVESOCKET, &sockfd);



  if(res != CURLE_OK) {

    printf("Error: %s\n", curl_easy_strerror(res));

    return 1;

  }

}

.fi

.SH AVAILABILITY

Added in 7.45.0

.SH RETURN VALUE

docs/libcurl/opts/CURLINFO_APPCONNECT_TIME.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
@@ -38,7 +38,22 @@ See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page. 
.SH PROTOCOLS

All

.SH EXAMPLE

TODO

.nf

curl = curl_easy_init();

if(curl) {

  double connect;

  curl_easy_setopt(curl, CURLOPT_URL, url);

  res = curl_easy_perform(curl);

  if(CURLE_OK == res) {

    res = curl_easy_getinfo(curl, CURLINFO_APPCONNECT_TIME, &connect);

    if(CURLE_OK == res) {

      printf("Time: %.1f", connect);

    }

  }

  /* always cleanup */

  curl_easy_cleanup(curl);

}

.fi

.SH AVAILABILITY

Added in 7.19.0

.SH RETURN VALUE

docs/libcurl/opts/CURLINFO_CERTINFO.3

+32 −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
@@ -39,7 +39,37 @@ for the specific named data. See also the certinfo.c example. 
.SH PROTOCOLS

All TLS-based

.SH EXAMPLE

TODO

.nf

curl = curl_easy_init();

if(curl) {

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



  /* connect to any HTTPS site, trusted or not */

  curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L);

  curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L);



  curl_easy_setopt(curl, CURLOPT_CERTINFO, 1L);



  res = curl_easy_perform(curl);



  if (!res) {

    struct curl_certinfo *ci;

    res = curl_easy_getinfo(curl, CURLINFO_CERTINFO, &ci);



    if (!res) {

      printf("%d certs!\n", ci->num_of_certs);



      for(i = 0; i < ci->num_of_certs; i++) {

        struct curl_slist *slist;



        for(slist = ci->certinfo[i]; slist; slist = slist->next)

          printf("%s\n", slist->data);

      }

    }

  }

  curl_easy_cleanup(curl);

}

.fi

.SH AVAILABILITY

This option is only working in libcurl built with OpenSSL, NSS, schannel or

GSKit support. schannel support added in 7.50.0

docs/libcurl/opts/CURLINFO_CONDITION_UNMET.3

+25 −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
@@ -36,7 +36,30 @@ get a zero stored if the condition instead was met. 
.SH PROTOCOLS

HTTP and some

.SH EXAMPLE

TODO

.nf

CURL *curl = curl_easy_init();

if(curl) {

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



  /* January 1, 2020 is 1577833200 */

  curl_easy_setopt(curl, CURLOPT_TIMEVALUE, 1577833200L);



  /* If-Modified-Since the above time stamp */

  curl_easy_setopt(curl, CURLOPT_TIMECONDITION, CURL_TIMECOND_IFMODSINCE);



  /* Perform the request */

  res = curl_easy_perform(curl);



  if(!res) {

    /* check the time condition */

    long unmet;

    res = curl_easy_getinfo(curl, CURLINFO_CONDITION_UNMET, &unmet);

    if(!res) {

      printf("The time condition was %sfulfilled\n", unmet?"NOT":"");

    }

  }

}

.fi

.SH AVAILABILITY

Added in 7.19.4

.SH RETURN VALUE

docs/libcurl/opts/CURLINFO_CONNECT_TIME.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
@@ -35,7 +35,22 @@ See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page. 
.SH PROTOCOLS

All

.SH EXAMPLE

TODO

.nf

curl = curl_easy_init();

if(curl) {

  double connect;

  curl_easy_setopt(curl, CURLOPT_URL, url);

  res = curl_easy_perform(curl);

  if(CURLE_OK == res) {

    res = curl_easy_getinfo(curl, CURLINFO_CONNECT_TIME, &connect);

    if(CURLE_OK == res) {

      printf("Time: %.1f", connect);

    }

  }

  /* always cleanup */

  curl_easy_cleanup(curl);

}

.fi

.SH AVAILABILITY

Added in 7.4.1

.SH RETURN VALUE