Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
opts: 8 more CURLINFO* options as stand-alone man pages
- Loading branch information
Showing
9 changed files
with
368 additions
and
28 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,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_CONTENT_LENGTH_DOWNLOAD 3 "1 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options" | ||
| .SH NAME | ||
| CURLINFO_CONTENT_LENGTH_DOWNLOAD \- get content-length of download | ||
| .SH SYNOPSIS | ||
| #include <curl/curl.h> | ||
|
|
||
| CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONTENT_LENGTH_DOWNLOAD, | ||
| double *content_length); | ||
| .SH DESCRIPTION | ||
| Pass a pointer to a double to receive the content-length of the download. This | ||
| is the value read from the Content-Length: field. Since 7.19.4, this returns | ||
| -1 if the size isn't known. | ||
| .SH PROTOCOLS | ||
| HTTP(S) | ||
| .SH EXAMPLE | ||
| TODO | ||
| .SH AVAILABILITY | ||
| Added in 7.6.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), " | ||
| .BR CURLINFO_CONTENT_LENGTH_UPLOAD "(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,43 @@ | ||
| .\" ************************************************************************** | ||
| .\" * _ _ ____ _ | ||
| .\" * 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_CONTENT_LENGTH_UPLOAD 3 "1 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options" | ||
| .SH NAME | ||
| CURLINFO_CONTENT_LENGTH_UPLOAD \- receive the specified size of the upload | ||
| .SH SYNOPSIS | ||
| #include <curl/curl.h> | ||
|
|
||
| CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONTENT_LENGTH_UPLOAD, | ||
| double *content_length); | ||
| .SH DESCRIPTION | ||
| Pass a pointer to a double to receive the specified size of the upload. Since | ||
| 7.19.4, this returns -1 if the size isn't known. | ||
| .SH PROTOCOLS | ||
| All | ||
| .SH EXAMPLE | ||
| TODO | ||
| .SH AVAILABILITY | ||
| Added in 7.6.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,48 @@ | ||
| .\" ************************************************************************** | ||
| .\" * _ _ ____ _ | ||
| .\" * 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_CONTENT_TYPE 3 "1 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options" | ||
| .SH NAME | ||
| CURLINFO_CONTENT_TYPE \- get Content-Type | ||
| .SH SYNOPSIS | ||
| #include <curl/curl.h> | ||
|
|
||
| CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONTENT_TYPE, char **ct); | ||
| .SH DESCRIPTION | ||
| Pass a pointer to a char pointer to receive the content-type of the downloaded | ||
| object. This is the value read from the Content-Type: field. If you get NULL, | ||
| it means that the server didn't send a valid Content-Type header or that the | ||
| protocol used doesn't support this. | ||
|
|
||
| The \fBct\fP pointer will be NULL or pointing to private memory you MUST NOT | ||
| free it - it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the | ||
| corresponding CURL handle. | ||
| .SH PROTOCOLS | ||
| HTTP(S) | ||
| .SH EXAMPLE | ||
| TODO | ||
| .SH AVAILABILITY | ||
| Added in 7.9.4 | ||
| .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,44 @@ | ||
| .\" ************************************************************************** | ||
| .\" * _ _ ____ _ | ||
| .\" * 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_HEADER_SIZE 3 "1 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options" | ||
| .SH NAME | ||
| CURLINFO_HEADER_SIZE \- get size of retrieved headers | ||
| .SH SYNOPSIS | ||
| #include <curl/curl.h> | ||
|
|
||
| CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_HEADER_SIZE, long *sizep); | ||
| .SH DESCRIPTION | ||
| Pass a pointer to a long to receive the total size of all the headers | ||
| received. Measured in number of bytes. | ||
| .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), " | ||
| .BR CURLINFO_REQUEST_SIZE "(3), " | ||
| .BR CURLINFO_SIZE_DOWNLOAD "(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_PRIVATE 3 "1 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options" | ||
| .SH NAME | ||
| CURLINFO_PRIVATE \- get the private pointer | ||
| .SH SYNOPSIS | ||
| #include <curl/curl.h> | ||
|
|
||
| CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PRIVATE, char **private); | ||
| .SH DESCRIPTION | ||
| Pass a pointer to a char pointer to receive the pointer to the private data | ||
| associated with the curl handle (set with the \fICURLOPT_PRIVATE(3)\fP). | ||
| Please note that for internal reasons, the value is returned as a char | ||
| pointer, although effectively being a 'void *'. | ||
| .SH PROTOCOLS | ||
| All | ||
| .SH EXAMPLE | ||
| TODO | ||
| .SH AVAILABILITY | ||
| Added in 7.10.3 | ||
| .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), " | ||
| .BR CURLOPT_PRIVATE "(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_REQUEST_SIZE 3 "1 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options" | ||
| .SH NAME | ||
| CURLINFO_REQUEST_SIZE \- get size of sent request | ||
| .SH SYNOPSIS | ||
| #include <curl/curl.h> | ||
|
|
||
| CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REQUEST_SIZE, long *sizep); | ||
| .SH DESCRIPTION | ||
| Pass a pointer to a long to receive the total size of the issued | ||
| requests. This is so far only for HTTP requests. Note that this may be more | ||
| than one request if \fICURLOPT_FOLLOWLOCATION(3)\fP is enabled. | ||
| .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), " | ||
| .BR CURLINFO_HEADER_SIZE "(3), " | ||
| .BR CURLINFO_SIZE_DOWNLOAD "(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_SSL_ENGINES 3 "1 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options" | ||
| .SH NAME | ||
| CURLINFO_SSL_ENGINES \- [short desc] | ||
| .SH SYNOPSIS | ||
| #include <curl/curl.h> | ||
|
|
||
| CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SSL_ENGINES, | ||
| struct curl_slist **engine_list); | ||
| .SH DESCRIPTION | ||
| Pass the address of a 'struct curl_slist *' to receive a linked-list of | ||
| OpenSSL crypto-engines supported. Note that engines are normally implemented | ||
| in separate dynamic libraries. Hence not all the returned engines may be | ||
| available at run-time. \fBNOTE:\fP you must call \fIcurl_slist_free_all(3)\fP | ||
| on the list pointer once you're done with it, as libcurl will not free the | ||
| data for you. | ||
| .SH PROTOCOLS | ||
| All TLS based ones. | ||
| .SH EXAMPLE | ||
| TODO | ||
| .SH AVAILABILITY | ||
| Added in 7.12.3. Available in OpenSSL builds with "engine" support. | ||
| .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.