opts: document CURLE_OUT_OF_MEMORY as RETURN VALUE

This commit is contained in:
Dan Fandrich 2014-06-18 23:27:24 +02:00
parent 479675f23e
commit efbffa2fb7
24 changed files with 48 additions and 24 deletions

View File

@ -49,6 +49,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
If built TLS enabled If built TLS enabled
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), " .BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "

View File

@ -55,7 +55,8 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
If HTTP is enabled If HTTP is enabled
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if HTTP is enabled, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_COOKIEFILE "(3), " CURLOPT_COOKIEJAR "(3), " .BR CURLOPT_COOKIEFILE "(3), " CURLOPT_COOKIEJAR "(3), "
.BR CURLOPT_HTTPHEADER "(3), " .BR CURLOPT_HTTPHEADER "(3), "

View File

@ -52,6 +52,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
Along with HTTP Along with HTTP
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if HTTP is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_COOKIEFILE "(3), " CURLOPT_COOKIE "(3), " .BR CURLOPT_COOKIEFILE "(3), " CURLOPT_COOKIE "(3), "

View File

@ -89,6 +89,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
IMAP is supported since 7.30.0, POP3 since 7.26.0 and SMTP since 7.34.0. IMAP is supported since 7.30.0, POP3 since 7.26.0 and SMTP since 7.34.0.
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_HTTPHEADER "(3), " CURLOPT_NOBODY "(3), " .BR CURLOPT_HTTPHEADER "(3), " CURLOPT_NOBODY "(3), "

View File

@ -39,6 +39,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
If built TLS enabled. Only the OpenSSL and GnuTLS backends will use this. If built TLS enabled. Only the OpenSSL and GnuTLS backends will use this.
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_RANDOM_FILE "(3), " .BR CURLOPT_RANDOM_FILE "(3), "

View File

@ -66,6 +66,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
Port range support was added in 7.19.5 Port range support was added in 7.19.5
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_FTP_USE_EPRT "(3), " CURLOPT_FTP_USE_EPSV "(3), " .BR CURLOPT_FTP_USE_EPRT "(3), " CURLOPT_FTP_USE_EPSV "(3), "

View File

@ -49,6 +49,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
The "if!" and "host!" syntax was added in 7.24.0. The "if!" and "host!" syntax was added in 7.24.0.
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK Returns CURLE_OK on success or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_SOCKOPTFUNCTION "(3), " CURLOPT_TCP_NODELAY "(3), " .BR CURLOPT_SOCKOPTFUNCTION "(3), " CURLOPT_TCP_NODELAY "(3), "

View File

@ -42,6 +42,7 @@ TODO
This option was known as CURLOPT_SSLKEYPASSWD up to 7.16.4 and This option was known as CURLOPT_SSLKEYPASSWD up to 7.16.4 and
CURLOPT_SSLCERTPASSWD up to 7.9.2. CURLOPT_SSLCERTPASSWD up to 7.9.2.
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if TLS enabled, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_SSLKEY "(3), " CURLOPT_SSH_PRIVATE_KEYFILE "(3), " .BR CURLOPT_SSLKEY "(3), " CURLOPT_SSH_PRIVATE_KEYFILE "(3), "

View File

@ -42,6 +42,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
This option was known as CURLOPT_KRB4LEVEL up to 7.16.3 This option was known as CURLOPT_KRB4LEVEL up to 7.16.3
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_KRBLEVEL "(3), " CURLOPT_FTP_SSL "(3), " .BR CURLOPT_KRBLEVEL "(3), " CURLOPT_FTP_SSL "(3), "

View File

@ -78,7 +78,8 @@ scheme.
Since 7.21.7 the proxy string supports the socks protocols as "schemes". Since 7.21.7 the proxy string supports the socks protocols as "schemes".
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK. Returns CURLE_OK if proxies are supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_PROXYPORT "(3), " CURLOPT_HTTPPROXYTUNNEL "(3), " .BR CURLOPT_PROXYPORT "(3), " CURLOPT_HTTPPROXYTUNNEL "(3), "
.BR CURLOPT_PROXYTYPE "(3)" .BR CURLOPT_PROXYTYPE "(3)"

View File

@ -44,6 +44,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
Always Always
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK Returns CURLE_OK if proxies are supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), " .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "

View File

@ -39,6 +39,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
Always Always
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK Returns CURLE_OK on success or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_EGDSOCKET "(3), " .BR CURLOPT_EGDSOCKET "(3), "

View File

@ -49,6 +49,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
FILE since 7.18.0, RTSP since 7.20.0 FILE since 7.18.0, RTSP since 7.20.0
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK Returns CURLE_OK on success or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_RESUME_FROM "(3), " .BR CURLOPT_RESUME_FROM "(3), "

View File

@ -41,6 +41,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
If built with HTTP support If built with HTTP support
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if HTTP support is enabled, CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if HTTP support is enabled, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_USERAGENT "(3), " CURLOPT_HTTPHEADER "(3), " .BR CURLOPT_USERAGENT "(3), " CURLOPT_HTTPHEADER "(3), "

View File

@ -49,6 +49,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
If built TLS enabled. If built TLS enabled.
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if TLS enabled, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_SSLCERTTYPE "(3), " CURLOPT_SSLKEY "(3), " .BR CURLOPT_SSLCERTTYPE "(3), " CURLOPT_SSLKEY "(3), "

View File

@ -42,6 +42,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
If built TLS enabled. Added in 7.9.3 If built TLS enabled. Added in 7.9.3
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_SSLCERT "(3), " CURLOPT_SSLKEY "(3), " .BR CURLOPT_SSLCERT "(3), " CURLOPT_SSLKEY "(3), "

View File

@ -42,6 +42,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
If built TLS enabled. If built TLS enabled.
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_SSLENGINE_DEFAULT "(3), " CURLOPT_SSLKEY "(3), " .BR CURLOPT_SSLENGINE_DEFAULT "(3), " CURLOPT_SSLKEY "(3), "

View File

@ -42,6 +42,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
If built TLS enabled. If built TLS enabled.
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_SSLENGINE "(3), " CURLOPT_SSLCERT "(3), " .BR CURLOPT_SSLENGINE "(3), " CURLOPT_SSLCERT "(3), "

View File

@ -44,6 +44,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
If built TLS enabled. If built TLS enabled.
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_SSLKEYTYPE "(3), " CURLOPT_SSLCERT "(3), " .BR CURLOPT_SSLKEYTYPE "(3), " CURLOPT_SSLCERT "(3), "

View File

@ -44,6 +44,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
If built TLS enabled. If built TLS enabled.
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_SSLKEY "(3), " CURLOPT_SSLCERT "(3), " .BR CURLOPT_SSLKEY "(3), " CURLOPT_SSLCERT "(3), "

View File

@ -59,6 +59,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
If built TLS enabled. If built TLS enabled.
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_SSLVERSION "(3), " CURLOPT_USE_SSL "(3), " .BR CURLOPT_SSLVERSION "(3), " CURLOPT_USE_SSL "(3), "

View File

@ -277,7 +277,8 @@ All
.SH AVAILABILITY .SH AVAILABILITY
POP3 and SMTP added in 7.31.0 POP3 and SMTP added in 7.31.0
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK Returns CURLE_OK on success or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_VERBOSE "(3), " CURLOPT_PROTOCOLS "(3), " .BR CURLOPT_VERBOSE "(3), " CURLOPT_PROTOCOLS "(3), "
.BR curl_easy_perform "(3)" .BR curl_easy_perform "(3)"

View File

@ -41,6 +41,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
As long as HTTP is supported As long as HTTP is supported
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if HTTP is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_REFERER "(3), " CURLOPT_HTTPHEADER "(3), " .BR CURLOPT_REFERER "(3), " CURLOPT_HTTPHEADER "(3), "

View File

@ -59,6 +59,7 @@ TODO
.SH AVAILABILITY .SH AVAILABILITY
Always Always
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK Returns CURLE_OK on success or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_USERNAME "(3), " CURLOPT_PASSWORD "(3), " .BR CURLOPT_USERNAME "(3), " CURLOPT_PASSWORD "(3), "