-
-
Notifications
You must be signed in to change notification settings - Fork 6.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
opts: more CURLINFO_* options as stand-alone man pages
- Loading branch information
Showing
11 changed files
with
461 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
.\" ************************************************************************** | ||
.\" * _ _ ____ _ | ||
.\" * Project ___| | | | _ \| | | ||
.\" * / __| | | | |_) | | | ||
.\" * | (__| |_| | _ <| |___ | ||
.\" * \___|\___/|_| \_\_____| | ||
.\" * | ||
.\" * Copyright (C) 1998 - 2015, 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 | ||
.\" * are also available at http://curl.haxx.se/docs/copyright.html. | ||
.\" * | ||
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell | ||
.\" * copies of the Software, and permit persons to whom the Software is | ||
.\" * furnished to do so, under the terms of the COPYING file. | ||
.\" * | ||
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY | ||
.\" * KIND, either express or implied. | ||
.\" * | ||
.\" ************************************************************************** | ||
.\" | ||
.TH CURLINFO_APPCONNECT_TIME 3 "28 Aug 2015" "libcurl 7.44.0" "curl_easy_getinfo options" | ||
.SH NAME | ||
CURLINFO_APPCONNECT_TIME \- get the time until the SSL/SSH handshake is completed | ||
.SH SYNOPSIS | ||
#include <curl/curl.h> | ||
|
||
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_APPCONNECT_TIME, double *timep); | ||
.SH DESCRIPTION | ||
Pass a pointer to a double to receive the time, in seconds, it took from the | ||
start until the SSL/SSH connect/handshake to the remote host was completed. | ||
This time is most often very near to the \fICURLINFO_PRETRANSFER_TIME(3)\fP | ||
time, except for cases such as HTTP pipelining where the pretransfer time can | ||
be delayed due to waits in line for the pipeline and more. | ||
|
||
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page. | ||
.SH PROTOCOLS | ||
All | ||
.SH EXAMPLE | ||
TODO | ||
.SH AVAILABILITY | ||
Added in 7.19.0 | ||
.SH RETURN VALUE | ||
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. | ||
.SH "SEE ALSO" | ||
.BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), " |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
.\" ************************************************************************** | ||
.\" * _ _ ____ _ | ||
.\" * Project ___| | | | _ \| | | ||
.\" * / __| | | | |_) | | | ||
.\" * | (__| |_| | _ <| |___ | ||
.\" * \___|\___/|_| \_\_____| | ||
.\" * | ||
.\" * Copyright (C) 1998 - 2015, 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 | ||
.\" * are also available at http://curl.haxx.se/docs/copyright.html. | ||
.\" * | ||
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell | ||
.\" * copies of the Software, and permit persons to whom the Software is | ||
.\" * furnished to do so, under the terms of the COPYING file. | ||
.\" * | ||
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY | ||
.\" * KIND, either express or implied. | ||
.\" * | ||
.\" ************************************************************************** | ||
.\" | ||
.TH CURLINFO_PRETRANSFER_TIME 3 "28 Aug 2015" "libcurl 7.44.0" "curl_easy_getinfo options" | ||
.SH NAME | ||
CURLINFO_PRETRANSFER_TIME \- get the time until the file transfer start | ||
.SH SYNOPSIS | ||
#include <curl/curl.h> | ||
|
||
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRETRANSFER_TIME, double *timep); | ||
.SH DESCRIPTION | ||
Pass a pointer to a double to receive the time, in seconds, it took from the | ||
start until the file transfer is just about to begin. This includes all | ||
pre-transfer commands and negotiations that are specific to the particular | ||
protocol(s) involved. It does \fInot\fP involve the sending of the protocol- | ||
specific request that triggers a transfer. | ||
|
||
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page. | ||
.SH PROTOCOLS | ||
All | ||
.SH EXAMPLE | ||
TODO | ||
.SH AVAILABILITY | ||
Added in 7.4.1 | ||
.SH RETURN VALUE | ||
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. | ||
.SH "SEE ALSO" | ||
.BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), " |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
.\" ************************************************************************** | ||
.\" * _ _ ____ _ | ||
.\" * Project ___| | | | _ \| | | ||
.\" * / __| | | | |_) | | | ||
.\" * | (__| |_| | _ <| |___ | ||
.\" * \___|\___/|_| \_\_____| | ||
.\" * | ||
.\" * Copyright (C) 1998 - 2015, 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 | ||
.\" * are also available at http://curl.haxx.se/docs/copyright.html. | ||
.\" * | ||
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell | ||
.\" * copies of the Software, and permit persons to whom the Software is | ||
.\" * furnished to do so, under the terms of the COPYING file. | ||
.\" * | ||
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY | ||
.\" * KIND, either express or implied. | ||
.\" * | ||
.\" ************************************************************************** | ||
.\" | ||
.TH CURLINFO_REDIRECT_COUNT 3 "28 Aug 2015" "libcurl 7.44.0" "curl_easy_getinfo options" | ||
.SH NAME | ||
CURLINFO_REDIRECT_COUNT \- get the number of redirects | ||
.SH SYNOPSIS | ||
#include <curl/curl.h> | ||
|
||
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REDIRECT_COUNT, long *countp); | ||
.SH DESCRIPTION | ||
Pass a pointer to a long to receive the total number of redirections that were | ||
actually followed. | ||
.SH PROTOCOLS | ||
HTTP(S) | ||
.SH EXAMPLE | ||
TODO | ||
.SH AVAILABILITY | ||
Added in 7.9.7 | ||
.SH RETURN VALUE | ||
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. | ||
.SH "SEE ALSO" | ||
.BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), " |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
!.\" ************************************************************************** | ||
.\" * _ _ ____ _ | ||
.\" * Project ___| | | | _ \| | | ||
.\" * / __| | | | |_) | | | ||
.\" * | (__| |_| | _ <| |___ | ||
.\" * \___|\___/|_| \_\_____| | ||
.\" * | ||
.\" * Copyright (C) 1998 - 2015, 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 | ||
.\" * are also available at http://curl.haxx.se/docs/copyright.html. | ||
.\" * | ||
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell | ||
.\" * copies of the Software, and permit persons to whom the Software is | ||
.\" * furnished to do so, under the terms of the COPYING file. | ||
.\" * | ||
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY | ||
.\" * KIND, either express or implied. | ||
.\" * | ||
.\" ************************************************************************** | ||
.\" | ||
.TH CURLINFO_REDIRECT_TIME 3 "28 Aug 2015" "libcurl 7.44.0" "curl_easy_getinfo options" | ||
.SH NAME | ||
CURLINFO_REDIRECT_TIME \- get the time for all redirection steps | ||
.SH SYNOPSIS | ||
#include <curl/curl.h> | ||
|
||
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REDIRECT_TIME, double *timep); | ||
.SH DESCRIPTION | ||
Pass a pointer to a double to receive the total time, in seconds, it took for | ||
all redirection steps include name lookup, connect, pretransfer and transfer | ||
before final transaction was started. CURLINFO_REDIRECT_TIME contains the | ||
complete execution time for multiple redirections. | ||
|
||
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page. | ||
.SH PROTOCOLS | ||
All | ||
.SH EXAMPLE | ||
TODO | ||
.SH AVAILABILITY | ||
Added in 7.9.7 | ||
.SH RETURN VALUE | ||
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. | ||
.SH "SEE ALSO" | ||
.BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), " |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
.\" ************************************************************************** | ||
.\" * _ _ ____ _ | ||
.\" * Project ___| | | | _ \| | | ||
.\" * / __| | | | |_) | | | ||
.\" * | (__| |_| | _ <| |___ | ||
.\" * \___|\___/|_| \_\_____| | ||
.\" * | ||
.\" * Copyright (C) 1998 - 2015, 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 | ||
.\" * are also available at http://curl.haxx.se/docs/copyright.html. | ||
.\" * | ||
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell | ||
.\" * copies of the Software, and permit persons to whom the Software is | ||
.\" * furnished to do so, under the terms of the COPYING file. | ||
.\" * | ||
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY | ||
.\" * KIND, either express or implied. | ||
.\" * | ||
.\" ************************************************************************** | ||
.\" | ||
.TH CURLINFO_REDIRECT_URL 3 "28 Aug 2015" "libcurl 7.44.0" "curl_easy_getinfo options" | ||
.SH NAME | ||
CURLINFO_REDIRECT_URL \- get the URL a redirect would go to | ||
.SH SYNOPSIS | ||
#include <curl/curl.h> | ||
|
||
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REDIRECT_URL, char **urlp); | ||
.SH DESCRIPTION | ||
Pass a pointer to a char pointer to receive the URL a redirect \fIwould\fP | ||
take you to if you would enable \fICURLOPT_FOLLOWLOCATION(3)\fP. This can come | ||
very handy if you think using the built-in libcurl redirect logic isn't good | ||
enough for you but you would still prefer to avoid implementing all the magic | ||
of figuring out the new URL. | ||
.SH PROTOCOLS | ||
HTTP(S) | ||
.SH EXAMPLE | ||
TODO | ||
.SH AVAILABILITY | ||
Added in 7.18.2 | ||
.SH RETURN VALUE | ||
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. | ||
.SH "SEE ALSO" | ||
.BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), " |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
.\" ************************************************************************** | ||
.\" * _ _ ____ _ | ||
.\" * Project ___| | | | _ \| | | ||
.\" * / __| | | | |_) | | | ||
.\" * | (__| |_| | _ <| |___ | ||
.\" * \___|\___/|_| \_\_____| | ||
.\" * | ||
.\" * Copyright (C) 1998 - 2015, 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 | ||
.\" * are also available at http://curl.haxx.se/docs/copyright.html. | ||
.\" * | ||
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell | ||
.\" * copies of the Software, and permit persons to whom the Software is | ||
.\" * furnished to do so, under the terms of the COPYING file. | ||
.\" * | ||
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY | ||
.\" * KIND, either express or implied. | ||
.\" * | ||
.\" ************************************************************************** | ||
.\" | ||
.TH CURLINFO_SIZE_DOWNLOAD 3 "28 Aug 2015" "libcurl 7.44.0" "curl_easy_getinfo options" | ||
.SH NAME | ||
CURLINFO_SIZE_DOWNLOAD \- get the number of downloaded bytes | ||
.SH SYNOPSIS | ||
#include <curl/curl.h> | ||
|
||
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SIZE_DOWNLOAD, long *dlp); | ||
.SH DESCRIPTION | ||
Pass a pointer to a double to receive the total amount of bytes that were | ||
downloaded. The amount is only for the latest transfer and will be reset | ||
again for each new transfer. This counts actual payload data, what's also | ||
commonly called body. All meta and header data are excluded and will not be | ||
counted in this number. | ||
.SH PROTOCOLS | ||
All | ||
.SH EXAMPLE | ||
TODO | ||
.SH AVAILABILITY | ||
Added in 7.4.1 | ||
.SH RETURN VALUE | ||
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. | ||
.SH "SEE ALSO" | ||
.BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), " |
Oops, something went wrong.