2
0
mirror of https://codeberg.org/kiss-community/repo synced 2024-12-21 23:00:06 -07:00

curl: 8.9.0

This commit is contained in:
Owen Rafferty 2024-07-29 19:00:04 -05:00
parent eff68db9e4
commit eaf15b1797
No known key found for this signature in database
505 changed files with 3545 additions and 9539 deletions

File diff suppressed because it is too large Load Diff

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_ACTIVESOCKET.md
.TH CURLINFO_ACTIVESOCKET 3 "2024-06-01" libcurl
.TH CURLINFO_ACTIVESOCKET 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_ACTIVESOCKET \- get the active socket
.SH SYNOPSIS
@ -22,7 +22,7 @@ is complete, and is typically used in combination with
\fICURLINFO_ACTIVESOCKET(3)\fP was added as a replacement for
\fICURLINFO_LASTSOCKET(3)\fP since that one is not working on all platforms.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -53,7 +53,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.45.0
Added in curl 7.45.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_APPCONNECT_TIME.md
.TH CURLINFO_APPCONNECT_TIME 3 "2024-06-01" libcurl
.TH CURLINFO_APPCONNECT_TIME 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_APPCONNECT_TIME \- get the time until the SSL/SSH handshake is completed
.SH SYNOPSIS
@ -20,7 +20,7 @@ When a redirect is followed, the time from each request is added together.
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -43,7 +43,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.19.0
Added in curl 7.19.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_APPCONNECT_TIME_T.md
.TH CURLINFO_APPCONNECT_TIME_T 3 "2024-06-01" libcurl
.TH CURLINFO_APPCONNECT_TIME_T 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_APPCONNECT_TIME_T \- time until the SSL/SSH handshake completed
.SH SYNOPSIS
@ -20,7 +20,7 @@ When a redirect is followed, the time from each request is added together.
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -44,7 +44,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.61.0
Added in curl 7.61.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_CAINFO.md
.TH CURLINFO_CAINFO 3 "2024-06-01" libcurl
.TH CURLINFO_CAINFO 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_CAINFO \- get the default built\-in CA certificate path
.SH SYNOPSIS
@ -21,7 +21,7 @@ This is a path identifying a single file containing CA certificates.
The \fBpath\fP pointer is set to NULL if there is no default path.
.SH PROTOCOLS
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
All TLS backends support this option.
.SH EXAMPLE
@ -40,7 +40,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.84.0
Added in curl 7.84.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_CAPATH.md
.TH CURLINFO_CAPATH 3 "2024-06-01" libcurl
.TH CURLINFO_CAPATH 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_CAPATH \- get the default built\-in CA path string
.SH SYNOPSIS
@ -21,7 +21,7 @@ This is a path identifying a directory.
The \fBpath\fP pointer is set to NULL if there is no default path.
.SH PROTOCOLS
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
This option works only with the following TLS backends:
GnuTLS, OpenSSL, mbedTLS and wolfSSL
@ -41,7 +41,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.84.0
Added in curl 7.84.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_CERTINFO.md
.TH CURLINFO_CERTINFO 3 "2024-06-01" libcurl
.TH CURLINFO_CERTINFO 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_CERTINFO \- get the TLS certificate chain
.SH SYNOPSIS
@ -28,7 +28,7 @@ items with textual information in the format "name:content" such as
\&"Subject:Foo", "Issuer:Bar", etc. The items in each list varies depending on
the SSL backend and the certificate.
.SH PROTOCOLS
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
This option works only with the following TLS backends:
GnuTLS, OpenSSL, Schannel and Secure Transport
@ -71,12 +71,11 @@ int main(void)
.fi
See also the \fIcertinfo.c\fP example.
.SH HISTORY
GnuTLS support added in 7.42.0. Schannel support added in 7.50.0. Secure
Transport support added in 7.79.0. mbedTLS support added in 8.9.0.
.SH AVAILABILITY
This option is only working in libcurl built with OpenSSL, GnuTLS, Schannel or
Secure Transport. GnuTLS support added in 7.42.0. Schannel support added in
7.50.0. Secure Transport support added in 7.79.0.
Added in 7.19.1
Added in curl 7.19.1
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_CONDITION_UNMET.md
.TH CURLINFO_CONDITION_UNMET 3 "2024-06-01" libcurl
.TH CURLINFO_CONDITION_UNMET 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_CONDITION_UNMET \- get info on unmet time conditional or 304 HTTP response.
.SH SYNOPSIS
@ -18,7 +18,7 @@ gets a zero stored if the condition instead was met. This can also return 1 if
the server responded with a 304 HTTP status code, for example after sending a
custom "If\-Match\-*" header.
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -51,7 +51,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.19.4
Added in curl 7.19.4
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_CONNECT_TIME.md
.TH CURLINFO_CONNECT_TIME 3 "2024-06-01" libcurl
.TH CURLINFO_CONNECT_TIME 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_CONNECT_TIME \- get the time until connect
.SH SYNOPSIS
@ -16,7 +16,7 @@ When a redirect is followed, the time from each request is added together.
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -39,7 +39,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.4.1
Added in curl 7.4.1
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_CONNECT_TIME_T.md
.TH CURLINFO_CONNECT_TIME_T 3 "2024-06-01" libcurl
.TH CURLINFO_CONNECT_TIME_T 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_CONNECT_TIME_T \- get the time until connect
.SH SYNOPSIS
@ -17,7 +17,7 @@ When a redirect is followed, the time from each request is added together.
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -41,7 +41,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.61.0
Added in curl 7.61.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_CONN_ID.md
.TH CURLINFO_CONN_ID 3 "2024-06-01" libcurl
.TH CURLINFO_CONN_ID 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_CONN_ID \- get the ID of the last connection used by the handle
.SH SYNOPSIS
@ -17,7 +17,7 @@ The connection id is unique among all connections using the same
connection cache. This is implicitly the case for all connections in the
same multi handle.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -42,7 +42,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 8.2.0
Added in curl 8.2.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_CONTENT_LENGTH_DOWNLOAD.md
.TH CURLINFO_CONTENT_LENGTH_DOWNLOAD 3 "2024-06-01" libcurl
.TH CURLINFO_CONTENT_LENGTH_DOWNLOAD 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_CONTENT_LENGTH_DOWNLOAD \- get content\-length of download
.SH SYNOPSIS
@ -17,7 +17,7 @@ is the value read from the Content\-Length: field. Since 7.19.4, this returns
\fICURLINFO_CONTENT_LENGTH_DOWNLOAD_T(3)\fP is a newer replacement that returns a more
sensible variable type.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -41,8 +41,10 @@ int main(void)
}
}
.fi
.SH DEPRECATED
Deprecated since 7.55.0.
.SH AVAILABILITY
Added in 7.6.1. Deprecated since 7.55.0.
Added in curl 7.6.1
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_CONTENT_LENGTH_DOWNLOAD_T.md
.TH CURLINFO_CONTENT_LENGTH_DOWNLOAD_T 3 "2024-06-01" libcurl
.TH CURLINFO_CONTENT_LENGTH_DOWNLOAD_T 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_CONTENT_LENGTH_DOWNLOAD_T \- get content\-length of download
.SH SYNOPSIS
@ -14,7 +14,7 @@ Pass a pointer to a \fIcurl_off_t\fP to receive the content\-length of the
download. This is the value read from the Content\-Length: field. Stores \-1 if
the size is not known.
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -39,7 +39,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.55.0
Added in curl 7.55.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_CONTENT_LENGTH_UPLOAD.md
.TH CURLINFO_CONTENT_LENGTH_UPLOAD 3 "2024-06-01" libcurl
.TH CURLINFO_CONTENT_LENGTH_UPLOAD 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_CONTENT_LENGTH_UPLOAD \- get the specified size of the upload
.SH SYNOPSIS
@ -16,7 +16,7 @@ Pass a pointer to a double to receive the specified size of the upload. Since
\fICURLINFO_CONTENT_LENGTH_UPLOAD_T(3)\fP is a newer replacement that returns a
more sensible variable type.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -40,8 +40,10 @@ int main(void)
}
}
.fi
.SH DEPRECATED
Deprecated since 7.55.0.
.SH AVAILABILITY
Added in 7.6.1. Deprecated since 7.55.0.
Added in curl 7.6.1
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_CONTENT_LENGTH_UPLOAD_T.md
.TH CURLINFO_CONTENT_LENGTH_UPLOAD_T 3 "2024-06-01" libcurl
.TH CURLINFO_CONTENT_LENGTH_UPLOAD_T 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_CONTENT_LENGTH_UPLOAD_T \- get the specified size of the upload
.SH SYNOPSIS
@ -13,7 +13,7 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONTENT_LENGTH_UPLOAD_T,
Pass a pointer to a \fIcurl_off_t\fP to receive the specified size of the
upload. Stores \-1 if the size is not known.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -38,7 +38,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.55.0
Added in curl 7.55.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_CONTENT_TYPE.md
.TH CURLINFO_CONTENT_TYPE 3 "2024-06-01" libcurl
.TH CURLINFO_CONTENT_TYPE 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_CONTENT_TYPE \- get Content\-Type
.SH SYNOPSIS
@ -21,7 +21,7 @@ corresponding CURL handle.
The modern way to get this header from a response is to instead use the
\fIcurl_easy_header(3)\fP function.
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -46,7 +46,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.9.4
Added in curl 7.9.4
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_COOKIELIST.md
.TH CURLINFO_COOKIELIST 3 "2024-06-01" libcurl
.TH CURLINFO_COOKIELIST 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_COOKIELIST \- get all known cookies
.SH SYNOPSIS
@ -19,7 +19,7 @@ received) the \(aqstruct curl_slist *\(aq is made a NULL pointer.
Since 7.43.0 cookies that were imported in the Set\-Cookie format without a
domain name are not exported by this option.
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -54,7 +54,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.14.1
Added in curl 7.14.1
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_EFFECTIVE_METHOD.md
.TH CURLINFO_EFFECTIVE_METHOD 3 "2024-06-01" libcurl
.TH CURLINFO_EFFECTIVE_METHOD 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_EFFECTIVE_METHOD \- get the last used HTTP method
.SH SYNOPSIS
@ -20,7 +20,7 @@ The \fBmethodp\fP pointer is NULL or points to private memory. You MUST NOT
free \- it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the
corresponding CURL handle.
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -43,7 +43,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.72.0
Added in curl 7.72.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_EFFECTIVE_URL.md
.TH CURLINFO_EFFECTIVE_URL 3 "2024-06-01" libcurl
.TH CURLINFO_EFFECTIVE_URL 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_EFFECTIVE_URL \- get the last used URL
.SH SYNOPSIS
@ -18,7 +18,7 @@ The \fBurlp\fP pointer is NULL or points to private memory. You MUST NOT free
- it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the corresponding
CURL handle.
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -40,7 +40,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.4
Added in curl 7.4
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_FILETIME.md
.TH CURLINFO_FILETIME 3 "2024-06-01" libcurl
.TH CURLINFO_FILETIME 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_FILETIME \- get the remote time of the retrieved document
.SH SYNOPSIS
@ -15,14 +15,13 @@ in number of seconds since January 1 1970 in the GMT/UTC time zone. If you get
hide it or the server does not support the command that tells document time
etc) and the time of the document is unknown.
You must tell libcurl to collect this information before the transfer is made,
by using the \fICURLOPT_FILETIME(3)\fP option to \fIcurl_easy_setopt(3)\fP or
you this unconditionally gets a \-1 back.
You must ask libcurl to collect this information before the transfer is made,
by using the \fICURLOPT_FILETIME(3)\fP option or you unconditionally get a \-1 back.
Consider using \fICURLINFO_FILETIME_T(3)\fP to be able to extract dates beyond
the year 2038 on systems using 32 bit longs (Windows).
Consider \fICURLINFO_FILETIME_T(3)\fP instead to be able to extract dates beyond the
year 2038 on systems using 32\-bit longs (Windows).
.SH PROTOCOLS
FTP, HTTP and SFTP
This functionality affects ftp, http and sftp
.SH EXAMPLE
.nf
int main(void)
@ -48,7 +47,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.5
Added in curl 7.5
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_FILETIME_T.md
.TH CURLINFO_FILETIME 3 "2024-06-01" libcurl
.TH CURLINFO_FILETIME_T 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_FILETIME_T \- get the remote time of the retrieved document
.SH SYNOPSIS
@ -11,20 +11,18 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_FILETIME_T,
.fi
.SH DESCRIPTION
Pass a pointer to a curl_off_t to receive the remote time of the retrieved
document in number of seconds since January 1 1970 in the GMT/UTC time
zone. If you get \-1, it can be because of many reasons (it might be unknown,
the server might hide it or the server does not support the command that tells
document in number of seconds since January 1 1970 in the GMT/UTC time zone.
If you get \-1, it can be because of many reasons (it might be unknown, the
server might hide it or the server does not support the command that tells
document time etc) and the time of the document is unknown.
You must ask libcurl to collect this information before the transfer is made,
by using the \fICURLOPT_FILETIME(3)\fP option to \fIcurl_easy_setopt(3)\fP or
you unconditionally get a \-1 back.
by using the \fICURLOPT_FILETIME(3)\fP option or you unconditionally get a \-1 back.
This option is an alternative to \fICURLINFO_FILETIME(3)\fP to allow systems
with 32 bit long variables to extract dates outside of the 32bit timestamp
range.
This option is an alternative to \fICURLINFO_FILETIME(3)\fP to allow systems with 32
bit long variables to extract dates outside of the 32\-bit timestamp range.
.SH PROTOCOLS
FTP, HTTP and SFTP
This functionality affects ftp, http and sftp
.SH EXAMPLE
.nf
int main(void)
@ -50,7 +48,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.59.0
Added in curl 7.59.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_FTP_ENTRY_PATH.md
.TH CURLINFO_FTP_ENTRY_PATH 3 "2024-06-01" libcurl
.TH CURLINFO_FTP_ENTRY_PATH 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_FTP_ENTRY_PATH \- get entry path in FTP server
.SH SYNOPSIS
@ -18,7 +18,7 @@ The \fBpath\fP pointer is NULL or points to private memory. You MUST NOT free
- it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the corresponding
CURL handle.
.SH PROTOCOLS
FTP
This functionality affects ftp only
.SH EXAMPLE
.nf
int main(void)
@ -42,8 +42,10 @@ int main(void)
}
}
.fi
.SH HISTORY
Works for SFTP since 7.21.4
.SH AVAILABILITY
Added in 7.15.4. Works for SFTP since 7.21.4
Added in curl 7.15.4
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_HEADER_SIZE.md
.TH CURLINFO_HEADER_SIZE 3 "2024-06-01" libcurl
.TH CURLINFO_HEADER_SIZE 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_HEADER_SIZE \- get size of retrieved headers
.SH SYNOPSIS
@ -15,7 +15,7 @@ received. Measured in number of bytes.
The total includes the size of any received headers suppressed by
\fICURLOPT_SUPPRESS_CONNECT_HEADERS(3)\fP.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -36,7 +36,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.4.1
Added in curl 7.4.1
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_HTTPAUTH_AVAIL.md
.TH CURLINFO_HTTPAUTH_AVAIL 3 "2024-06-01" libcurl
.TH CURLINFO_HTTPAUTH_AVAIL 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_HTTPAUTH_AVAIL \- get available HTTP authentication methods
.SH SYNOPSIS
@ -11,10 +11,9 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_HTTPAUTH_AVAIL, long *authp);
.SH DESCRIPTION
Pass a pointer to a long to receive a bitmask indicating the authentication
method(s) available according to the previous response. The meaning of the
bits is explained in the \fICURLOPT_HTTPAUTH(3)\fP option for
\fIcurl_easy_setopt(3)\fP.
bits is explained in the \fICURLOPT_HTTPAUTH(3)\fP option for \fIcurl_easy_setopt(3)\fP.
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -47,8 +46,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added RFC 2617 in 7.10.8
Added RFC 7616 in 7.57.0
Added in curl 7.10.8
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_HTTP_CONNECTCODE.md
.TH CURLINFO_HTTP_CONNECTCODE 3 "2024-06-01" libcurl
.TH CURLINFO_HTTP_CONNECTCODE 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_HTTP_CONNECTCODE \- get the CONNECT response code
.SH SYNOPSIS
@ -13,7 +13,7 @@ Pass a pointer to a long to receive the last received HTTP proxy response code
to a CONNECT request. The returned value is zero if no such response code was
available.
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -37,7 +37,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.10.7
Added in curl 7.10.7
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_HTTP_VERSION.md
.TH CURLINFO_HTTP_VERSION 3 "2024-06-01" libcurl
.TH CURLINFO_HTTP_VERSION 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_HTTP_VERSION \- get the http version used in the connection
.SH SYNOPSIS
@ -14,7 +14,7 @@ connection done using this handle. The returned value is
CURL_HTTP_VERSION_1_0, CURL_HTTP_VERSION_1_1, CURL_HTTP_VERSION_2_0,
CURL_HTTP_VERSION_3 or 0 if the version cannot be determined.
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -33,7 +33,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.50.0
Added in curl 7.50.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_LASTSOCKET.md
.TH CURLINFO_LASTSOCKET 3 "2024-06-01" libcurl
.TH CURLINFO_LASTSOCKET 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_LASTSOCKET \- get the last socket used
.SH SYNOPSIS
@ -22,7 +22,7 @@ NOTE: this API is deprecated since it is not working on win64 where the SOCKET
type is 64 bits large while its \(aqlong\(aq is 32 bits. Use the
\fICURLINFO_ACTIVESOCKET(3)\fP instead, if possible.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -53,7 +53,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.15.2
Added in curl 7.15.2
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_LOCAL_IP.md
.TH CURLINFO_LOCAL_IP 3 "2024-06-01" libcurl
.TH CURLINFO_LOCAL_IP 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_LOCAL_IP \- get local IP address of last connection
.SH SYNOPSIS
@ -19,7 +19,7 @@ The \fBip\fP pointer is NULL or points to private memory. You MUST NOT free \-
it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the corresponding
CURL handle.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -43,7 +43,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.21.0
Added in curl 7.21.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_LOCAL_PORT.md
.TH CURLINFO_LOCAL_PORT 3 "2024-06-01" libcurl
.TH CURLINFO_LOCAL_PORT 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_LOCAL_PORT \- get the latest local port number
.SH SYNOPSIS
@ -12,7 +12,7 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_LOCAL_PORT, long *portp);
Pass a pointer to a long to receive the local port number of the most recent
connection done with this \fBcurl\fP handle.
.SH PROTOCOLS
TCP
This functionality affects tcp only
.SH EXAMPLE
.nf
int main(void)
@ -39,7 +39,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.21.0
Added in curl 7.21.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_NAMELOOKUP_TIME.md
.TH CURLINFO_NAMELOOKUP_TIME 3 "2024-06-01" libcurl
.TH CURLINFO_NAMELOOKUP_TIME 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_NAMELOOKUP_TIME \- get the name lookup time
.SH SYNOPSIS
@ -17,7 +17,7 @@ When a redirect is followed, the time from each request is added together.
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -40,7 +40,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.4.1
Added in curl 7.4.1
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_NAMELOOKUP_TIME_T.md
.TH CURLINFO_NAMELOOKUP_TIME_T 3 "2024-06-01" libcurl
.TH CURLINFO_NAMELOOKUP_TIME_T 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_NAMELOOKUP_TIME_T \- get the name lookup time in microseconds
.SH SYNOPSIS
@ -17,7 +17,7 @@ When a redirect is followed, the time from each request is added together.
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -41,7 +41,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.61.0
Added in curl 7.61.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_NUM_CONNECTS.md
.TH CURLINFO_NUM_CONNECTS 3 "2024-06-01" libcurl
.TH CURLINFO_NUM_CONNECTS 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_NUM_CONNECTS \- get number of created connections
.SH SYNOPSIS
@ -16,7 +16,7 @@ many times libcurl successfully reused existing connection(s) or not. See the
connection options of \fIcurl_easy_setopt(3)\fP to see how libcurl tries to make
persistent connections to save time.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -38,7 +38,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.12.3
Added in curl 7.12.3
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_OS_ERRNO.md
.TH CURLINFO_OS_ERRNO 3 "2024-06-01" libcurl
.TH CURLINFO_OS_ERRNO 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_OS_ERRNO \- get errno number from last connect failure
.SH SYNOPSIS
@ -21,7 +21,7 @@ Since 8.8.0 libcurl clears the easy handle\(aqs saved errno before performing th
transfer. Prior versions did not clear the saved errno, which means if a saved
errno is retrieved it could be from a previous transfer on the same handle.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -43,7 +43,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.12.2
Added in curl 7.12.2
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_PRETRANSFER_TIME.md
.TH CURLINFO_PRETRANSFER_TIME 3 "2024-06-01" libcurl
.TH CURLINFO_PRETRANSFER_TIME 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_PRETRANSFER_TIME \- get the time until the file transfer start
.SH SYNOPSIS
@ -21,7 +21,7 @@ When a redirect is followed, the time from each request is added together.
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -44,7 +44,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.4.1
Added in curl 7.4.1
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_PRETRANSFER_TIME_T.md
.TH CURLINFO_PRETRANSFER_TIME_T 3 "2024-06-01" libcurl
.TH CURLINFO_PRETRANSFER_TIME_T 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_PRETRANSFER_TIME_T \- get the time until the file transfer start
.SH SYNOPSIS
@ -21,7 +21,7 @@ When a redirect is followed, the time from each request is added together.
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -46,7 +46,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.61.0
Added in curl 7.61.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_PRIMARY_IP.md
.TH CURLINFO_PRIMARY_IP 3 "2024-06-01" libcurl
.TH CURLINFO_PRIMARY_IP 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_PRIMARY_IP \- get IP address of last connection
.SH SYNOPSIS
@ -19,7 +19,7 @@ The \fBip\fP pointer is NULL or points to private memory. You MUST NOT free \-
it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the corresponding
CURL handle.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -43,7 +43,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.19.0
Added in curl 7.19.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_PRIMARY_PORT.md
.TH CURLINFO_PRIMARY_PORT 3 "2024-06-01" libcurl
.TH CURLINFO_PRIMARY_PORT 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_PRIMARY_PORT \- get the latest destination port number
.SH SYNOPSIS
@ -17,7 +17,7 @@ If a proxy was used for the most recent transfer, this is the port number of
the proxy, if no proxy was used it is the port number of the most recently
accessed URL.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -38,7 +38,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.21.0
Added in curl 7.21.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_PRIVATE.md
.TH CURLINFO_PRIVATE 3 "2024-06-01" libcurl
.TH CURLINFO_PRIVATE 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_PRIVATE \- get the private pointer
.SH SYNOPSIS
@ -14,7 +14,7 @@ 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 \(aqvoid *\(aq.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -40,7 +40,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.10.3
Added in curl 7.10.3
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_PROTOCOL.md
.TH CURLINFO_PROTOCOL 3 "2024-06-01" libcurl
.TH CURLINFO_PROTOCOL 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_PROTOCOL \- get the protocol used in the connection
.SH SYNOPSIS
@ -26,7 +26,7 @@ CURLPROTO_SCP, CURLPROTO_SFTP, CURLPROTO_SMB, CURLPROTO_SMBS, CURLPROTO_SMTP,
CURLPROTO_SMTPS, CURLPROTO_TELNET, CURLPROTO_TFTP, CURLPROTO_MQTT
.fi
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -44,8 +44,10 @@ int main(void)
}
}
.fi
.SH DEPRECATED
Deprecated since 7.85.0.
.SH AVAILABILITY
Added in 7.52.0. Deprecated since 7.85.0.
Added in curl 7.52.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_PROXYAUTH_AVAIL.md
.TH CURLINFO_PROXYAUTH_AVAIL 3 "2024-06-01" libcurl
.TH CURLINFO_PROXYAUTH_AVAIL 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_PROXYAUTH_AVAIL \- get available HTTP proxy authentication methods
.SH SYNOPSIS
@ -12,10 +12,9 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PROXYAUTH_AVAIL,
.SH DESCRIPTION
Pass a pointer to a long to receive a bitmask indicating the authentication
method(s) available according to the previous response. The meaning of the
bits is explained in the \fICURLOPT_PROXYAUTH(3)\fP option for
\fIcurl_easy_setopt(3)\fP.
bits is explained in the \fICURLOPT_PROXYAUTH(3)\fP option for \fIcurl_easy_setopt(3)\fP.
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -49,8 +48,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added RFC 2617 in 7.10.8
Added RFC 7616 in 7.57.0
Added in curl 7.10.8
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_PROXY_ERROR.md
.TH CURLINFO_PROXY_ERROR 3 "2024-06-01" libcurl
.TH CURLINFO_PROXY_ERROR 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_PROXY_ERROR \- get the detailed (SOCKS) proxy error
.SH SYNOPSIS
@ -53,7 +53,7 @@ transfer returned a \fBCURLE_PROXY\fP error. That error code matches the
The error code is zero (\fBCURLPX_OK\fP) if no response code was available.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -76,7 +76,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.73.0
Added in curl 7.73.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_PROXY_SSL_VERIFYRESULT.md
.TH CURLINFO_PROXY_SSL_VERIFYRESULT 3 "2024-06-01" libcurl
.TH CURLINFO_PROXY_SSL_VERIFYRESULT 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_PROXY_SSL_VERIFYRESULT \- get the result of the proxy certificate verification
.SH SYNOPSIS
@ -16,7 +16,7 @@ option. This is only used for HTTPS proxies.
0 is a positive result. Non\-zero is an error.
.SH PROTOCOLS
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
This option works only with the following TLS backends:
GnuTLS and OpenSSL
@ -50,7 +50,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.52.0
Added in curl 7.52.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_QUEUE_TIME_T.md
.TH CURLINFO_QUEUE_TIME_T 3 "2024-06-01" libcurl
.TH CURLINFO_QUEUE_TIME_T 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_QUEUE_TIME_T \- time this transfer was queued
.SH SYNOPSIS
@ -17,7 +17,7 @@ connection etc due to set conditions and limits imposed by the application.
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -41,7 +41,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 8.6.0
Added in curl 8.6.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_REDIRECT_COUNT.md
.TH CURLINFO_REDIRECT_COUNT 3 "2024-06-01" libcurl
.TH CURLINFO_REDIRECT_COUNT 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_REDIRECT_COUNT \- get the number of redirects
.SH SYNOPSIS
@ -13,7 +13,7 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REDIRECT_COUNT,
Pass a pointer to a long to receive the total number of redirections that were
actually followed.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -33,7 +33,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.9.7
Added in curl 7.9.7
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_REDIRECT_TIME.md
.TH CURLINFO_REDIRECT_TIME 3 "2024-06-01" libcurl
.TH CURLINFO_REDIRECT_TIME 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_REDIRECT_TIME \- get the time for all redirection steps
.SH SYNOPSIS
@ -17,7 +17,7 @@ the complete execution time for multiple redirections.
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -40,7 +40,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.9.7
Added in curl 7.9.7
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_REDIRECT_TIME_T.md
.TH CURLINFO_REDIRECT_TIME_T 3 "2024-06-01" libcurl
.TH CURLINFO_REDIRECT_TIME_T 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_REDIRECT_TIME_T \- get the time for all redirection steps
.SH SYNOPSIS
@ -18,7 +18,7 @@ multiple redirections.
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -42,7 +42,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.61.0
Added in curl 7.61.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_REDIRECT_URL.md
.TH CURLINFO_REDIRECT_URL 3 "2024-06-01" libcurl
.TH CURLINFO_REDIRECT_URL 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_REDIRECT_URL \- get the URL a redirect would go to
.SH SYNOPSIS
@ -9,16 +9,16 @@ CURLINFO_REDIRECT_URL \- get the URL a redirect would go to
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REDIRECT_URL, char **urlp);
.fi
.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
handy if you think using the built\-in libcurl redirect logic is not good enough
for you but you would still prefer to avoid implementing all the magic of
figuring out the new URL.
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 handy if
you think using the built\-in libcurl redirect logic is not good enough for you
but you would still prefer to avoid implementing all the magic of figuring out
the new URL.
This URL is also set if the \fICURLOPT_MAXREDIRS(3)\fP limit prevented a
redirect to happen (since 7.54.1).
This URL is also set if the \fICURLOPT_MAXREDIRS(3)\fP limit prevented a redirect to
happen (since 7.54.1).
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -39,7 +39,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.18.2
Added in curl 7.18.2
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_REFERER.md
.TH CURLINFO_REFERER 3 "2024-06-01" libcurl
.TH CURLINFO_REFERER 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_REFERER \- get the used referrer request header
.SH SYNOPSIS
@ -16,7 +16,7 @@ The \fBhdrp\fP pointer is NULL or points to private memory you MUST NOT free \-
it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the corresponding
CURL handle.
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -38,7 +38,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.76.0
Added in curl 7.76.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_REQUEST_SIZE.md
.TH CURLINFO_REQUEST_SIZE 3 "2024-06-01" libcurl
.TH CURLINFO_REQUEST_SIZE 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_REQUEST_SIZE \- get size of sent request
.SH SYNOPSIS
@ -13,7 +13,7 @@ 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
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -34,7 +34,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.4.1
Added in curl 7.4.1
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_RESPONSE_CODE.md
.TH CURLINFO_RESPONSE_CODE 3 "2024-06-01" libcurl
.TH CURLINFO_RESPONSE_CODE 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_RESPONSE_CODE \- get the last response code
.SH SYNOPSIS
@ -17,7 +17,7 @@ no server response code has been received.
Note that a proxy\(aqs CONNECT response should be read with
\fICURLINFO_HTTP_CONNECTCODE(3)\fP and not this.
.SH PROTOCOLS
FTP, HTTP, LDAP and SMTP
This functionality affects ftp, http, ldap and smtp
.SH EXAMPLE
.nf
int main(void)
@ -35,9 +35,11 @@ int main(void)
}
}
.fi
.SH NOTES
The former name, CURLINFO_HTTP_CODE, was added in 7.4.1. Support for SMTP
responses added in 7.25.0, for OpenLDAP in 7.81.0.
.SH AVAILABILITY
Added in 7.10.8. CURLINFO_HTTP_CODE was added in 7.4.1.
Support for SMTP responses added in 7.25.0, for OpenLDAP in 7.81.0.
Added in curl 7.10.8
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_RETRY_AFTER.md
.TH CURLINFO_RETRY_AFTER 3 "2024-06-01" libcurl
.TH CURLINFO_RETRY_AFTER 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_RETRY_AFTER \- returns the Retry\-After retry delay
.SH SYNOPSIS
@ -18,9 +18,9 @@ While the HTTP header might contain a fixed date string, the
\fICURLINFO_RETRY_AFTER(3)\fP always returns the number of seconds to wait \-
or zero if there was no header or the header could not be parsed.
.SH DEFAULT
Returns zero delay if there was no header.
Zero if there was no header.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -41,7 +41,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.66.0
Added in curl 7.66.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_RTSP_CLIENT_CSEQ.md
.TH CURLINFO_RTSP_CLIENT_CSEQ 3 "2024-06-01" libcurl
.TH CURLINFO_RTSP_CLIENT_CSEQ 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_RTSP_CLIENT_CSEQ \- get the next RTSP client CSeq
.SH SYNOPSIS
@ -13,7 +13,7 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_RTSP_CLIENT_CSEQ,
Pass a pointer to a long to receive the next CSeq that is expected to be used
by the application.
.SH PROTOCOLS
RTSP
This functionality affects rtsp only
.SH EXAMPLE
.nf
int main(void)
@ -32,7 +32,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.20.0
Added in curl 7.20.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_RTSP_CSEQ_RECV.md
.TH CURLINFO_RTSP_CSEQ_RECV 3 "2024-06-01" libcurl
.TH CURLINFO_RTSP_CSEQ_RECV 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_RTSP_CSEQ_RECV \- get the recently received CSeq
.SH SYNOPSIS
@ -14,7 +14,7 @@ server. If your application encounters a \fICURLE_RTSP_CSEQ_ERROR\fP then you
may wish to troubleshoot and/or fix the CSeq mismatch by peeking at this
value.
.SH PROTOCOLS
RTSP
This functionality affects rtsp only
.SH EXAMPLE
.nf
int main(void)
@ -33,7 +33,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.20.0
Added in curl 7.20.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_RTSP_SERVER_CSEQ.md
.TH CURLINFO_RTSP_SERVER_CSEQ 3 "2024-06-01" libcurl
.TH CURLINFO_RTSP_SERVER_CSEQ 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_RTSP_SERVER_CSEQ \- get the next RTSP server CSeq
.SH SYNOPSIS
@ -18,7 +18,7 @@ Listening for server initiated requests is not implemented!
Applications wishing to resume an RTSP session on another connection should
retrieve this info before closing the active connection.
.SH PROTOCOLS
RTSP
This functionality affects rtsp only
.SH EXAMPLE
.nf
int main(void)
@ -37,7 +37,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.20.0
Added in curl 7.20.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_RTSP_SESSION_ID.md
.TH CURLINFO_RTSP_SESSION_ID 3 "2024-06-01" libcurl
.TH CURLINFO_RTSP_SESSION_ID 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_RTSP_SESSION_ID \- get RTSP session ID
.SH SYNOPSIS
@ -19,7 +19,7 @@ The \fBid\fP pointer is NULL or points to private memory. You MUST NOT free \-
it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the corresponding
CURL handle.
.SH PROTOCOLS
RTSP
This functionality affects rtsp only
.SH EXAMPLE
.nf
int main(void)
@ -38,7 +38,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.20.0
Added in curl 7.20.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_SCHEME.md
.TH CURLINFO_SCHEME 3 "2024-06-01" libcurl
.TH CURLINFO_SCHEME 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_SCHEME \- get the URL scheme (sometimes called protocol) used in the connection
.SH SYNOPSIS
@ -20,7 +20,7 @@ CURL handle.
The returned scheme might be upper or lowercase. Do comparisons case
insensitively.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -41,7 +41,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.52.0
Added in curl 7.52.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_SIZE_DOWNLOAD.md
.TH CURLINFO_SIZE_DOWNLOAD 3 "2024-06-01" libcurl
.TH CURLINFO_SIZE_DOWNLOAD 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_SIZE_DOWNLOAD \- get the number of downloaded bytes
.SH SYNOPSIS
@ -18,7 +18,7 @@ number.
\fICURLINFO_SIZE_DOWNLOAD_T(3)\fP is a newer replacement that returns a more
sensible variable type.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -42,8 +42,10 @@ int main(void)
}
}
.fi
.SH DEPRECATED
Deprecated since 7.55.0.
.SH AVAILABILITY
Added in 7.4.1. Deprecated since 7.55.0.
Added in curl 7.4.1
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_SIZE_DOWNLOAD_T.md
.TH CURLINFO_SIZE_DOWNLOAD_T 3 "2024-06-01" libcurl
.TH CURLINFO_SIZE_DOWNLOAD_T 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_SIZE_DOWNLOAD_T \- get the number of downloaded bytes
.SH SYNOPSIS
@ -15,7 +15,7 @@ were downloaded. The amount is only for the latest transfer and gets reset
again for each new transfer. This counts actual payload data, what\(aqs also
commonly called body. All meta and header data is excluded from this amount.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -40,7 +40,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.55.0
Added in curl 7.55.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_SIZE_UPLOAD.md
.TH CURLINFO_SIZE_UPLOAD 3 "2024-06-01" libcurl
.TH CURLINFO_SIZE_UPLOAD 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_SIZE_UPLOAD \- get the number of uploaded bytes
.SH SYNOPSIS
@ -16,7 +16,7 @@ uploaded.
\fICURLINFO_SIZE_UPLOAD_T(3)\fP is a newer replacement that returns a more
sensible variable type.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -39,8 +39,10 @@ int main(void)
}
}
.fi
.SH DEPRECATED
Deprecated since 7.55.0.
.SH AVAILABILITY
Added in 7.4.1. Deprecated since 7.55.0.
Added in curl 7.4.1
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_SIZE_UPLOAD_T.md
.TH CURLINFO_SIZE_UPLOAD_T 3 "2024-06-01" libcurl
.TH CURLINFO_SIZE_UPLOAD_T 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_SIZE_UPLOAD_T \- get the number of uploaded bytes
.SH SYNOPSIS
@ -13,7 +13,7 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SIZE_UPLOAD_T,
Pass a pointer to a \fIcurl_off_t\fP to receive the total amount of bytes that
were uploaded.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -37,7 +37,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.55.0
Added in curl 7.55.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_SPEED_DOWNLOAD.md
.TH CURLINFO_SPEED_DOWNLOAD 3 "2024-06-01" libcurl
.TH CURLINFO_SPEED_DOWNLOAD 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_SPEED_DOWNLOAD \- get download speed
.SH SYNOPSIS
@ -16,7 +16,7 @@ measured for the complete download. Measured in bytes/second.
\fICURLINFO_SPEED_DOWNLOAD_T(3)\fP is a newer replacement that returns a more
sensible variable type.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -39,8 +39,10 @@ int main(void)
}
}
.fi
.SH DEPRECATED
Deprecated since 7.55.0.
.SH AVAILABILITY
Added in 7.4.1. Deprecated since 7.55.0.
Added in curl 7.4.1
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_SPEED_DOWNLOAD_T.md
.TH CURLINFO_SPEED_DOWNLOAD_T 3 "2024-06-01" libcurl
.TH CURLINFO_SPEED_DOWNLOAD_T 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_SPEED_DOWNLOAD_T \- get download speed
.SH SYNOPSIS
@ -13,7 +13,7 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_DOWNLOAD_T,
Pass a pointer to a \fIcurl_off_t\fP to receive the average download speed
that curl measured for the complete download. Measured in bytes/second.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -38,7 +38,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.55.0
Added in curl 7.55.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_SPEED_UPLOAD.md
.TH CURLINFO_SPEED_UPLOAD 3 "2024-06-01" libcurl
.TH CURLINFO_SPEED_UPLOAD 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_SPEED_UPLOAD \- get upload speed
.SH SYNOPSIS
@ -15,7 +15,7 @@ measured for the complete upload. Measured in bytes/second.
\fICURLINFO_SPEED_UPLOAD_T(3)\fP is a newer replacement that returns a more
sensible variable type.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -38,8 +38,10 @@ int main(void)
}
}
.fi
.SH DEPRECATED
Deprecated since 7.55.0.
.SH AVAILABILITY
Added in 7.4.1. Deprecated since 7.55.0.
Added in curl 7.4.1
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_SPEED_UPLOAD_T.md
.TH CURLINFO_SPEED_UPLOAD_T 3 "2024-06-01" libcurl
.TH CURLINFO_SPEED_UPLOAD_T 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_SPEED_UPLOAD_T \- get upload speed
.SH SYNOPSIS
@ -13,7 +13,7 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_UPLOAD_T,
Pass a pointer to a \fIcurl_off_t\fP to receive the average upload speed that
curl measured for the complete upload. Measured in bytes/second.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -37,7 +37,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.55.0
Added in curl 7.55.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_SSL_ENGINES.md
.TH CURLINFO_SSL_ENGINES 3 "2024-06-01" libcurl
.TH CURLINFO_SSL_ENGINES 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_SSL_ENGINES \- get an slist of OpenSSL crypto\-engines
.SH SYNOPSIS
@ -17,7 +17,7 @@ available at runtime. \fBNOTE:\fP you must call \fIcurl_slist_free_all(3)\fP
on the list pointer once you are done with it, as libcurl does not free this
data for you.
.SH PROTOCOLS
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
This option works only with the following TLS backends:
OpenSSL
@ -40,7 +40,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.12.3. Available in OpenSSL builds with "engine" support.
Added in curl 7.12.3
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_SSL_VERIFYRESULT.md
.TH CURLINFO_SSL_VERIFYRESULT 3 "2024-06-01" libcurl
.TH CURLINFO_SSL_VERIFYRESULT 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_SSL_VERIFYRESULT \- get the result of the certificate verification
.SH SYNOPSIS
@ -16,7 +16,7 @@ option).
0 is a positive result. Non\-zero is an error.
.SH PROTOCOLS
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
This option works only with the following TLS backends:
GnuTLS and OpenSSL
@ -49,7 +49,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.5. Only set by the OpenSSL/libressl/boringssl and GnuTLS backends.
Added in curl 7.5
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_STARTTRANSFER_TIME.md
.TH CURLINFO_STARTTRANSFER_TIME 3 "2024-06-01" libcurl
.TH CURLINFO_STARTTRANSFER_TIME 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_STARTTRANSFER_TIME \- get the time until the first byte is received
.SH SYNOPSIS
@ -19,7 +19,7 @@ When a redirect is followed, the time from each request is added together.
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -42,7 +42,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.9.2
Added in curl 7.9.2
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_STARTTRANSFER_TIME_T.md
.TH CURLINFO_STARTTRANSFER_TIME_T 3 "2024-06-01" libcurl
.TH CURLINFO_STARTTRANSFER_TIME_T 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_STARTTRANSFER_TIME_T \- get the time until the first byte is received
.SH SYNOPSIS
@ -20,7 +20,7 @@ When a redirect is followed, the time from each request is added together.
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -44,7 +44,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.61.0
Added in curl 7.61.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_TLS_SESSION.md
.TH CURLINFO_TLS_SESSION 3 "2024-06-01" libcurl
.TH CURLINFO_TLS_SESSION 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_TLS_SESSION \- get TLS session info
.SH SYNOPSIS
@ -27,7 +27,7 @@ function \fISSL_get_SSL_CTX(3)\fP. Therefore unless you need compatibility
with older versions of libcurl use \fICURLINFO_TLS_SSL_PTR(3)\fP. Refer to
that document for more information.
.SH PROTOCOLS
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
This option works only with the following TLS backends:
GnuTLS and OpenSSL
@ -48,9 +48,10 @@ int main(void)
}
}
.fi
.SH DEPRECATED
Deprecated since 7.48.0
.SH AVAILABILITY
Added in 7.34.0. Deprecated since 7.48.0 and supported by OpenSSL and GnuTLS
only up until this version was released.
Added in curl 7.34.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_TLS_SSL_PTR.md
.TH CURLINFO_TLS_SSL_PTR 3 "2024-06-01" libcurl
.TH CURLINFO_TLS_SSL_PTR 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_TLS_SESSION, CURLINFO_TLS_SSL_PTR \- get TLS session info
.SH SYNOPSIS
@ -35,8 +35,8 @@ struct curl_tlssessioninfo {
The \fIbackend\fP struct member is one of the defines in the CURLSSLBACKEND_*
series: CURLSSLBACKEND_NONE (when built without TLS support),
CURLSSLBACKEND_WOLFSSL, CURLSSLBACKEND_SECURETRANSPORT, CURLSSLBACKEND_GNUTLS,
CURLSSLBACKEND_MBEDTLS, CURLSSLBACKEND_NSS, CURLSSLBACKEND_OPENSSL,
CURLSSLBACKEND_SCHANNEL or CURLSSLBACKEND_MESALINK. (Note that the OpenSSL
CURLSSLBACKEND_MBEDTLS, CURLSSLBACKEND_NSS, CURLSSLBACKEND_OPENSSL or
CURLSSLBACKEND_SCHANNEL. (Note that the OpenSSL
forks are all reported as just OpenSSL here.)
The \fIinternals\fP struct member points to a TLS library specific pointer for
@ -57,7 +57,7 @@ as well:
\fBSSLContext \fP*
.IP wolfSSL
\fBSSL \fP*
.PP
If the \fIinternals\fP pointer is NULL then either the SSL backend is not
supported, an SSL session has not yet been established or the connection is no
longer associated with the easy handle (e.g. \fIcurl_easy_perform(3)\fP has
@ -92,7 +92,7 @@ How are you using this option? Are you affected by any of these limitations?
Please let us know by making a comment at
https://github.com/curl/curl/issues/685
.SH PROTOCOLS
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
This option works only with the following TLS backends:
BearSSL, GnuTLS, OpenSSL, Schannel, Secure Transport, mbedTLS and wolfSSL
@ -127,11 +127,11 @@ int main(int argc, char **argv)
return res;
}
.fi
.SH AVAILABILITY
Added in 7.48.0.
.SH HISTORY
This option supersedes \fICURLINFO_TLS_SESSION(3)\fP which was added in 7.34.0.
This option is exactly the same as that option except in the case of OpenSSL.
.SH AVAILABILITY
Added in curl 7.48.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_TOTAL_TIME.md
.TH CURLINFO_TOTAL_TIME 3 "2024-06-01" libcurl
.TH CURLINFO_TOTAL_TIME 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_TOTAL_TIME \- get total time of previous transfer
.SH SYNOPSIS
@ -17,7 +17,7 @@ When a redirect is followed, the time from each request is added together.
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -40,7 +40,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.4.1
Added in curl 7.4.1
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_TOTAL_TIME_T.md
.TH CURLINFO_TOTAL_TIME_T 3 "2024-06-01" libcurl
.TH CURLINFO_TOTAL_TIME_T 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_TOTAL_TIME_T \- get total time of previous transfer in microseconds
.SH SYNOPSIS
@ -18,7 +18,7 @@ When a redirect is followed, the time from each request is added together.
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -42,7 +42,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.61.0
Added in curl 7.61.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_USED_PROXY.md
.TH CURLINFO_USED_PROXY 3 "2024-06-01" libcurl
.TH CURLINFO_USED_PROXY 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_USED_PROXY \- whether the transfer used a proxy
.SH SYNOPSIS
@ -13,7 +13,7 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_USED_PROXY,
Pass a pointer to a long. It gets set to zero set if no proxy was used in the
previous transfer or a non\-zero value if a proxy was used.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(int argc, char *argv[])
@ -40,7 +40,7 @@ int main(int argc, char *argv[])
}
.fi
.SH AVAILABILITY
Added in 8.7.0
Added in curl 8.7.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLINFO_XFER_ID.md
.TH CURLINFO_XFER_ID 3 "2024-06-01" libcurl
.TH CURLINFO_XFER_ID 3 "2024-07-29" libcurl
.SH NAME
CURLINFO_XFER_ID \- get the ID of a transfer
.SH SYNOPSIS
@ -18,7 +18,7 @@ The transfer id is unique among all transfers performed using the same
connection cache. This is implicitly the case for all transfers in the
same multi handle.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -42,7 +42,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 8.2.0
Added in curl 8.2.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE.md
.TH CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE 3 "2024-06-01" libcurl
.TH CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE 3 "2024-07-29" libcurl
.SH NAME
CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE \- chunk length threshold for pipelining
.SH SYNOPSIS
@ -18,9 +18,9 @@ current chunk length larger than \fICURLMOPT_CHUNK_LENGTH_PENALTY_SIZE(3)\fP,
that pipeline is not considered for additional requests, even if it is shorter
than \fICURLMOPT_MAX_PIPELINE_LENGTH(3)\fP.
.SH DEFAULT
The default value is 0, which means that the penalization is inactive.
0, which means that penalization is inactive.
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -31,7 +31,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.30.0
Added in curl 7.30.0
.SH RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE.md
.TH CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE 3 "2024-06-01" libcurl
.TH CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE 3 "2024-07-29" libcurl
.SH NAME
CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE \- size threshold for pipelining penalty
.SH SYNOPSIS
@ -18,9 +18,9 @@ currently processing a request with a Content\-Length larger than this
for additional requests, even if it is shorter than
\fICURLMOPT_MAX_PIPELINE_LENGTH(3)\fP.
.SH DEFAULT
The default value is 0, which means that the size penalization is inactive.
0, which means that the size penalization is inactive.
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -31,7 +31,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.30.0
Added in curl 7.30.0
.SH RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLMOPT_MAXCONNECTS.md
.TH CURLMOPT_MAXCONNECTS 3 "2024-06-01" libcurl
.TH CURLMOPT_MAXCONNECTS 3 "2024-07-29" libcurl
.SH NAME
CURLMOPT_MAXCONNECTS \- size of connection cache
.SH SYNOPSIS
@ -34,7 +34,7 @@ ones to get made.
.SH DEFAULT
See DESCRIPTION
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -45,7 +45,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.16.3
Added in curl 7.16.3
.SH RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLMOPT_MAX_CONCURRENT_STREAMS.md
.TH CURLMOPT_MAX_CONCURRENT_STREAMS 3 "2024-06-01" libcurl
.TH CURLMOPT_MAX_CONCURRENT_STREAMS 3 "2024-07-29" libcurl
.SH NAME
CURLMOPT_MAX_CONCURRENT_STREAMS \- max concurrent streams for http2
.SH SYNOPSIS
@ -19,7 +19,7 @@ value passed here would be honored based on other system resources properties.
.SH DEFAULT
100
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -30,7 +30,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.67.0
Added in curl 7.67.0
.SH RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLMOPT_MAX_HOST_CONNECTIONS.md
.TH CURLMOPT_MAX_HOST_CONNECTIONS 3 "2024-06-01" libcurl
.TH CURLMOPT_MAX_HOST_CONNECTIONS 3 "2024-07-29" libcurl
.SH NAME
CURLMOPT_MAX_HOST_CONNECTIONS \- max number of connections to a single host
.SH SYNOPSIS
@ -37,7 +37,7 @@ ones to get made.
.SH DEFAULT
0
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -48,7 +48,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.30.0
Added in curl 7.30.0
.SH RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLMOPT_MAX_PIPELINE_LENGTH.md
.TH CURLMOPT_MAX_PIPELINE_LENGTH 3 "2024-06-01" libcurl
.TH CURLMOPT_MAX_PIPELINE_LENGTH 3 "2024-07-29" libcurl
.SH NAME
CURLMOPT_MAX_PIPELINE_LENGTH \- maximum number of requests in a pipeline
.SH SYNOPSIS
@ -25,7 +25,7 @@ of the pipelines to the host is ready to accept a request. Thus, the total
.SH DEFAULT
5
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -36,7 +36,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.30.0
Added in curl 7.30.0
.SH RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLMOPT_MAX_TOTAL_CONNECTIONS.md
.TH CURLMOPT_MAX_TOTAL_CONNECTIONS 3 "2024-06-01" libcurl
.TH CURLMOPT_MAX_TOTAL_CONNECTIONS 3 "2024-07-29" libcurl
.SH NAME
CURLMOPT_MAX_TOTAL_CONNECTIONS \- max simultaneously open connections
.SH SYNOPSIS
@ -27,10 +27,10 @@ transfer might never even start before it times out.
Even in the queued up situation, the \fICURLOPT_CONNECTTIMEOUT_MS(3)\fP
timeout is however treated as a per\-connect timeout.
.SH DEFAULT
The default value is 0, which means that there is no limit. It is then simply
controlled by the number of easy handles added.
0, which means that there is no limit. It is then simply controlled by the
number of easy handles added.
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -41,7 +41,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.30.0
Added in curl 7.30.0
.SH RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLMOPT_PIPELINING.md
.TH CURLMOPT_PIPELINING 3 "2024-06-01" libcurl
.TH CURLMOPT_PIPELINING 3 "2024-07-29" libcurl
.SH NAME
CURLMOPT_PIPELINING \- enable HTTP multiplexing
.SH SYNOPSIS
@ -22,11 +22,9 @@ This bit is deprecated and has no effect since version 7.62.0.
If this bit is set, libcurl tries to multiplex the new transfer over an
existing connection if possible. This requires HTTP/2 or HTTP/3.
.SH DEFAULT
Since 7.62.0, \fBCURLPIPE_MULTIPLEX\fP is enabled by default.
Before that, default was \fBCURLPIPE_NOTHING\fP.
\fBCURLPIPE_MULTIPLEX\fP
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -36,9 +34,15 @@ int main(void)
curl_multi_setopt(m, CURLMOPT_PIPELINING, CURLPIPE_MULTIPLEX);
}
.fi
.SH HISTORY
The multiplex support bit was added in 7.43.0. HTTP/1 Pipelining support was
disabled in 7.62.0.
Since 7.62.0, \fBCURLPIPE_MULTIPLEX\fP is enabled by default.
Before that, default was \fBCURLPIPE_NOTHING\fP.
.SH AVAILABILITY
Added in 7.16.0. Multiplex support bit added in 7.43.0. HTTP/1 Pipelining
support was disabled in 7.62.0.
Added in curl 7.16.0
.SH RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLMOPT_PIPELINING_SERVER_BL.md
.TH CURLMOPT_PIPELINING_SERVER_BL 3 "2024-06-01" libcurl
.TH CURLMOPT_PIPELINING_SERVER_BL 3 "2024-07-29" libcurl
.SH NAME
CURLMOPT_PIPELINING_SERVER_BL \- pipelining server block list
.SH SYNOPSIS
@ -23,9 +23,9 @@ both be blocked by having "Ninja" in the list.
Pass a NULL pointer to clear the block list.
.SH DEFAULT
The default value is NULL, which means that there is no block list.
NULL, which means that there is no block list.
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
static char *server_block_list[] =
@ -41,7 +41,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.30.0
Added in curl 7.30.0
.SH RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLMOPT_PIPELINING_SITE_BL.md
.TH CURLMOPT_PIPELINING_SITE_BL 3 "2024-06-01" libcurl
.TH CURLMOPT_PIPELINING_SITE_BL 3 "2024-07-29" libcurl
.SH NAME
CURLMOPT_PIPELINING_SITE_BL \- pipelining host block list
.SH SYNOPSIS
@ -18,9 +18,9 @@ support HTTP pipelining. The array is copied by libcurl.
Pass a NULL pointer to clear the block list.
.SH DEFAULT
The default value is NULL, which means that there is no block list.
NULL, which means that there is no block list.
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
static char *site_block_list[] =
@ -37,7 +37,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.30.0
Added in curl 7.30.0
.SH RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLMOPT_PUSHDATA.md
.TH CURLMOPT_PUSHDATA 3 "2024-06-01" libcurl
.TH CURLMOPT_PUSHDATA 3 "2024-07-29" libcurl
.SH NAME
CURLMOPT_PUSHDATA \- pointer to pass to push callback
.SH SYNOPSIS
@ -15,7 +15,7 @@ libcurl itself, only passed on to the callback function.
.SH DEFAULT
NULL
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
#include <string.h>
@ -56,7 +56,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.44.0
Added in curl 7.44.0
.SH RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLMOPT_PUSHFUNCTION.md
.TH CURLMOPT_PUSHFUNCTION 3 "2024-06-01" libcurl
.TH CURLMOPT_PUSHFUNCTION 3 "2024-07-29" libcurl
.SH NAME
CURLMOPT_PUSHFUNCTION \- callback that approves or denies server pushes
.SH SYNOPSIS
@ -65,7 +65,7 @@ All other return codes are reserved for future use.
.SH DEFAULT
NULL, no callback
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
#include <string.h>
@ -106,7 +106,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.44.0
Added in curl 7.44.0
.SH RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLMOPT_SOCKETDATA.md
.TH CURLMOPT_SOCKETDATA 3 "2024-06-01" libcurl
.TH CURLMOPT_SOCKETDATA 3 "2024-07-29" libcurl
.SH NAME
CURLMOPT_SOCKETDATA \- custom pointer passed to the socket callback
.SH SYNOPSIS
@ -17,7 +17,7 @@ callback\(aqs \fBclientp\fP argument.
.SH DEFAULT
NULL
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
struct priv {
@ -52,7 +52,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.15.4
Added in curl 7.15.4
.SH RETURN VALUE
Returns CURLM_OK.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLMOPT_SOCKETFUNCTION.md
.TH CURLMOPT_SOCKETFUNCTION 3 "2024-06-01" libcurl
.TH CURLMOPT_SOCKETFUNCTION 3 "2024-07-29" libcurl
.SH NAME
CURLMOPT_SOCKETFUNCTION \- callback informed about what to wait for
.SH SYNOPSIS
@ -60,7 +60,7 @@ active transfer. It might soon be added again.
.SH DEFAULT
NULL (no callback)
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
struct priv {
@ -95,7 +95,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.15.4
Added in curl 7.15.4
.SH RETURN VALUE
Returns CURLM_OK.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLMOPT_TIMERDATA.md
.TH CURLMOPT_TIMERDATA 3 "2024-06-01" libcurl
.TH CURLMOPT_TIMERDATA 3 "2024-07-29" libcurl
.SH NAME
CURLMOPT_TIMERDATA \- custom pointer to pass to timer callback
.SH SYNOPSIS
@ -17,7 +17,7 @@ callback\(aqs \fBclientp\fP argument.
.SH DEFAULT
NULL
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
struct priv {
@ -46,7 +46,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.16.0
Added in curl 7.16.0
.SH RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLMOPT_TIMERFUNCTION.md
.TH CURLMOPT_TIMERFUNCTION 3 "2024-06-01" libcurl
.TH CURLMOPT_TIMERFUNCTION 3 "2024-07-29" libcurl
.SH NAME
CURLMOPT_TIMERFUNCTION \- callback to receive timeout values
.SH SYNOPSIS
@ -45,7 +45,7 @@ callback with a zero timeout...
.SH DEFAULT
NULL
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
struct priv {
@ -74,7 +74,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.16.0
Added in curl 7.16.0
.SH RETURN VALUE
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLOPT_ABSTRACT_UNIX_SOCKET.md
.TH CURLOPT_ABSTRACT_UNIX_SOCKET 3 "2024-06-01" libcurl
.TH CURLOPT_ABSTRACT_UNIX_SOCKET 3 "2024-07-29" libcurl
.SH NAME
CURLOPT_ABSTRACT_UNIX_SOCKET \- abstract Unix domain socket
.SH SYNOPSIS
@ -24,9 +24,9 @@ This option shares the same semantics as \fICURLOPT_UNIX_SOCKET_PATH(3)\fP in
which documentation more details can be found. Internally, these two options
share the same storage and therefore only one of them can be set per handle.
.SH DEFAULT
Default is NULL.
NULL
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -42,7 +42,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.53.0.
Added in curl 7.53.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLOPT_ACCEPTTIMEOUT_MS.md
.TH CURLOPT_ACCEPTTIMEOUT_MS 3 "2024-06-01" libcurl
.TH CURLOPT_ACCEPTTIMEOUT_MS 3 "2024-07-29" libcurl
.SH NAME
CURLOPT_ACCEPTTIMEOUT_MS \- timeout waiting for FTP server to connect back
.SH SYNOPSIS
@ -14,7 +14,7 @@ server to connect back to libcurl when an active FTP connection is used.
.SH DEFAULT
60000 milliseconds
.SH PROTOCOLS
FTP
This functionality affects ftp only
.SH EXAMPLE
.nf
int main(void)
@ -31,7 +31,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.24.0
Added in curl 7.24.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLOPT_ACCEPT_ENCODING.md
.TH CURLOPT_ACCEPT_ENCODING 3 "2024-06-01" libcurl
.TH CURLOPT_ACCEPT_ENCODING 3 "2024-07-29" libcurl
.SH NAME
CURLOPT_ACCEPT_ENCODING \- automatic decompression of HTTP downloads
.SH SYNOPSIS
@ -53,10 +53,17 @@ sending the length of the non\-compressed content is a common server mistake).
The application does not have to keep the string around after setting this
option.
.SH HISTORY
This option was called CURLOPT_ENCODING before 7.21.6
.SH NOTES
The specific libcurl you are using must have been built with zlib to be able to
decompress gzip and deflate responses, with the brotli library to
decompress brotli responses and with the zstd library to decompress zstd
responses.
.SH DEFAULT
NULL
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -74,12 +81,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
This option was called CURLOPT_ENCODING before 7.21.6
The specific libcurl you are using must have been built with zlib to be able to
decompress gzip and deflate responses, with the brotli library to
decompress brotli responses and with the zstd library to decompress zstd
responses.
Added in curl 7.21.6
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLOPT_ADDRESS_SCOPE.md
.TH CURLOPT_ADDRESS_SCOPE 3 "2024-06-01" libcurl
.TH CURLOPT_ADDRESS_SCOPE 3 "2024-07-29" libcurl
.SH NAME
CURLOPT_ADDRESS_SCOPE \- scope id for IPv6 addresses
.SH SYNOPSIS
@ -13,7 +13,7 @@ Pass a long specifying the scope id value to use when connecting to IPv6 address
.SH DEFAULT
0
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
#include <net/if.h> /* for if_nametoindex() */
@ -33,7 +33,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.19.0
Added in curl 7.19.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
Returns CURLE_BAD_FUNCTION_ARGUMENT if set to a negative value.

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLOPT_ALTSVC.md
.TH CURLOPT_ALTSVC 3 "2024-06-01" libcurl
.TH CURLOPT_ALTSVC 3 "2024-07-29" libcurl
.SH NAME
CURLOPT_ALTSVC \- alt\-svc cache filename
.SH SYNOPSIS
@ -18,7 +18,7 @@ Specify a blank filename ("") to make libcurl not load from a file at all.
.SH DEFAULT
NULL. The alt\-svc cache is not read nor written to file.
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -62,7 +62,7 @@ Boolean (1 or 0) if "persist" was set for this entry
.IP 0
Integer priority value (not currently used)
.SH AVAILABILITY
Added in 7.64.1
Added in curl 7.64.1
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLOPT_ALTSVC_CTRL.md
.TH CURLOPT_ALTSVC_CTRL 3 "2024-06-01" libcurl
.TH CURLOPT_ALTSVC_CTRL 3 "2024-07-29" libcurl
.SH NAME
CURLOPT_ALTSVC_CTRL \- control alt\-svc behavior
.SH SYNOPSIS
@ -26,6 +26,11 @@ Alternative services are only used when setting up new connections. If there
exists an existing connection to the host in the connection pool, then that is
preferred.
If \fICURLOPT_ALTSVC(3)\fP is set, \fICURLOPT_ALTSVC_CTRL(3)\fP gets a default value
corresponding to CURLALTSVC_H1 | CURLALTSVC_H2 | CURLALTSVC_H3 \- the HTTP/2
and HTTP/3 bits are only set if libcurl was built with support for those
versions.
Setting any bit enables the alt\-svc engine.
.IP CURLALTSVC_READONLYFILE
Do not write the alt\-svc cache back to the file specified with
@ -40,12 +45,9 @@ was also built to actually support HTTP/2, otherwise this bit is ignored.
Accept alternative services offered over HTTP/3. This is only used if libcurl
was also built to actually support HTTP/3, otherwise this bit is ignored.
.SH DEFAULT
Alt\-Svc handling is disabled by default. If \fICURLOPT_ALTSVC(3)\fP is set,
\fICURLOPT_ALTSVC_CTRL(3)\fP has a default value corresponding to
CURLALTSVC_H1 | CURLALTSVC_H2 | CURLALTSVC_H3 \- the HTTP/2 and HTTP/3 bits are
only set if libcurl was built with support for those versions.
0 \- Alt\-Svc handling is disabled
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -59,7 +61,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.64.1
Added in curl 7.64.1
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLOPT_APPEND.md
.TH CURLOPT_APPEND 3 "2024-06-01" libcurl
.TH CURLOPT_APPEND 3 "2024-07-29" libcurl
.SH NAME
CURLOPT_APPEND \- append to the remote file
.SH SYNOPSIS
@ -14,7 +14,7 @@ instead of overwrite it. This is only useful when uploading to an FTP site.
.SH DEFAULT
0 (disabled)
.SH PROTOCOLS
FTP
This functionality affects ftp only
.SH EXAMPLE
.nf
int main(void)
@ -30,8 +30,10 @@ int main(void)
}
}
.fi
.SH AVAILABILITY
.SH HISTORY
This option was known as CURLOPT_FTPAPPEND up to 7.16.4
.SH AVAILABILITY
Added in curl 7.17.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLOPT_AUTOREFERER.md
.TH CURLOPT_AUTOREFERER 3 "2024-06-01" libcurl
.TH CURLOPT_AUTOREFERER 3 "2024-07-29" libcurl
.SH NAME
CURLOPT_AUTOREFERER \- automatically update the referer header
.SH SYNOPSIS
@ -22,7 +22,7 @@ referer header after the transfer.
.SH DEFAULT
0, disabled
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -45,7 +45,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Along with HTTP
Added in curl 7.1
.SH RETURN VALUE
Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLOPT_AWS_SIGV4.md
.TH CURLOPT_AWS_SIGV4 3 "2024-06-01" libcurl
.TH CURLOPT_AWS_SIGV4 3 "2024-07-29" libcurl
.SH NAME
CURLOPT_AWS_SIGV4 \- V4 signature
.SH SYNOPSIS
@ -24,24 +24,25 @@ It is extracted from the hostname specified in the URL if omitted.
.IP service
The argument is a function provided by a cloud. It is extracted from the
hostname specified in the URL if omitted.
NOTE: This call set \fICURLOPT_HTTPAUTH(3)\fP to CURLAUTH_AWS_SIGV4.
Calling \fICURLOPT_HTTPAUTH(3)\fP with CURLAUTH_AWS_SIGV4 is the same
as calling this with \fB"aws:amz"\fP in parameter.
.PP
NOTE: This call set \fICURLOPT_HTTPAUTH(3)\fP to CURLAUTH_AWS_SIGV4. Calling
\fICURLOPT_HTTPAUTH(3)\fP with CURLAUTH_AWS_SIGV4 is the same as calling this with
\fB"aws:amz"\fP in parameter.
Example with "Test:Try", when curl uses the algorithm, it generates
\fB"TEST\-HMAC\-SHA256"\fP for "Algorithm", \fB"x\-try\-date"\fP and
\fB"X\-Try\-Date"\fP for "date", \fB"test4_request"\fP for "request type",
\fB"TEST\-HMAC\-SHA256"\fP for "Algorithm", \fB"x\-try\-date"\fP and \fB"X\-Try\-Date"\fP
for "date", \fB"test4_request"\fP for "request type",
\fB"SignedHeaders=content\-type;host;x\-try\-date"\fP for "signed headers"
If you use just "test", instead of "test:try", test is used for every
generated string.
Setting \fICURLOPT_HTTPAUTH(3)\fP with the CURLAUTH_AWS_SIGV4 bit set is the same as
setting this option with a \fB"aws:amz"\fP parameter.
.SH DEFAULT
By default, the value of this parameter is NULL.
Calling \fICURLOPT_HTTPAUTH(3)\fP with CURLAUTH_AWS_SIGV4 is the same
as calling this with \fB"aws:amz"\fP in parameter.
NULL
.SH PROTOCOLS
HTTP
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
@ -63,14 +64,10 @@ int main(void)
}
}
.fi
.SH AVAILABILITY
Added in 7.75.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH NOTES
This option overrides the other auth types you might have set in
\fICURLOPT_HTTPAUTH(3)\fP which should be highlighted as this makes this auth
method special. This method cannot be combined with other auth types.
\fICURLOPT_HTTPAUTH(3)\fP which should be highlighted as this makes this auth method
special. This method cannot be combined with other auth types.
A sha256 checksum of the request payload is used as input to the signature
calculation. For POST requests, this is a checksum of the provided
@ -78,9 +75,13 @@ calculation. For POST requests, this is a checksum of the provided
requests like PUT, you can provide your own checksum in an HTTP header named
\fBx\-provider2\-content\-sha256\fP.
For \fBaws:s3\fP, a \fBx\-amz\-content\-sha256\fP header is added to every request
if not already present. For s3 requests with unknown payload, this header takes
For \fBaws:s3\fP, a \fBx\-amz\-content\-sha256\fP header is added to every request if
not already present. For s3 requests with unknown payload, this header takes
the special value "UNSIGNED\-PAYLOAD".
.SH AVAILABILITY
Added in curl 7.75.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO
.BR CURLOPT_HEADEROPT (3),
.BR CURLOPT_HTTPAUTH (3),

View File

@ -1,5 +1,5 @@
.\" generated by cd2nroff 0.1 from CURLOPT_BUFFERSIZE.md
.TH CURLOPT_BUFFERSIZE 3 "2024-06-01" libcurl
.TH CURLOPT_BUFFERSIZE 3 "2024-07-29" libcurl
.SH NAME
CURLOPT_BUFFERSIZE \- receive buffer size
.SH SYNOPSIS
@ -33,7 +33,7 @@ allocated as long as there are active transfers.
.SH DEFAULT
CURL_MAX_WRITE_SIZE (16kB)
.SH PROTOCOLS
All
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
@ -53,7 +53,7 @@ int main(void)
}
.fi
.SH AVAILABILITY
Added in 7.10. Growing the buffer was added in 7.53.0.
Added in curl 7.10
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO

Some files were not shown because too many files have changed in this diff Show More