opts: document CURLE_OUT_OF_MEMORY as RETURN VALUE
authorDan Fandrich <dan@coneharvesters.com>
Wed, 18 Jun 2014 21:27:24 +0000 (23:27 +0200)
committerDan Fandrich <dan@coneharvesters.com>
Wed, 18 Jun 2014 21:28:13 +0000 (23:28 +0200)
24 files changed:
docs/libcurl/opts/CURLOPT_CAINFO.3
docs/libcurl/opts/CURLOPT_COOKIE.3
docs/libcurl/opts/CURLOPT_COOKIEJAR.3
docs/libcurl/opts/CURLOPT_CUSTOMREQUEST.3
docs/libcurl/opts/CURLOPT_EGDSOCKET.3
docs/libcurl/opts/CURLOPT_FTPPORT.3
docs/libcurl/opts/CURLOPT_INTERFACE.3
docs/libcurl/opts/CURLOPT_KEYPASSWD.3
docs/libcurl/opts/CURLOPT_KRBLEVEL.3
docs/libcurl/opts/CURLOPT_PROXY.3
docs/libcurl/opts/CURLOPT_PROXYUSERPWD.3
docs/libcurl/opts/CURLOPT_RANDOM_FILE.3
docs/libcurl/opts/CURLOPT_RANGE.3
docs/libcurl/opts/CURLOPT_REFERER.3
docs/libcurl/opts/CURLOPT_SSLCERT.3
docs/libcurl/opts/CURLOPT_SSLCERTTYPE.3
docs/libcurl/opts/CURLOPT_SSLENGINE.3
docs/libcurl/opts/CURLOPT_SSLENGINE_DEFAULT.3
docs/libcurl/opts/CURLOPT_SSLKEY.3
docs/libcurl/opts/CURLOPT_SSLKEYTYPE.3
docs/libcurl/opts/CURLOPT_SSL_CIPHER_LIST.3
docs/libcurl/opts/CURLOPT_URL.3
docs/libcurl/opts/CURLOPT_USERAGENT.3
docs/libcurl/opts/CURLOPT_USERPWD.3

index 82411e9..1f2dfc4 100644 (file)
@@ -49,6 +49,7 @@ TODO
 .SH AVAILABILITY
 If built TLS enabled
 .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"
 .BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "
index 7a8ecc1..824e985 100644 (file)
@@ -55,7 +55,8 @@ TODO
 .SH AVAILABILITY
 If HTTP is enabled
 .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"
 .BR CURLOPT_COOKIEFILE "(3), " CURLOPT_COOKIEJAR "(3), "
 .BR CURLOPT_HTTPHEADER "(3), "
index 4d458b0..fd8c0af 100644 (file)
@@ -52,6 +52,7 @@ TODO
 .SH AVAILABILITY
 Along with HTTP
 .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"
 .BR CURLOPT_COOKIEFILE "(3), " CURLOPT_COOKIE "(3), "
index aedf881..2e6ec0c 100644 (file)
@@ -89,6 +89,7 @@ TODO
 .SH AVAILABILITY
 IMAP is supported since 7.30.0, POP3 since 7.26.0 and SMTP since 7.34.0.
 .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"
 .BR CURLOPT_HTTPHEADER "(3), " CURLOPT_NOBODY "(3), "
index cc005d3..2e72ecc 100644 (file)
@@ -39,6 +39,7 @@ TODO
 .SH AVAILABILITY
 If built TLS enabled. Only the OpenSSL and GnuTLS backends will use this.
 .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"
 .BR CURLOPT_RANDOM_FILE "(3), "
index bb1dcf6..fd87bb2 100644 (file)
@@ -66,6 +66,7 @@ TODO
 .SH AVAILABILITY
 Port range support was added in 7.19.5
 .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"
 .BR CURLOPT_FTP_USE_EPRT "(3), " CURLOPT_FTP_USE_EPSV "(3), "
index 61c0aed..0890eb6 100644 (file)
@@ -49,6 +49,7 @@ TODO
 .SH AVAILABILITY
 The "if!" and "host!" syntax was added in 7.24.0.
 .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"
 .BR CURLOPT_SOCKOPTFUNCTION "(3), " CURLOPT_TCP_NODELAY "(3), "
index f4fe277..0ed0c87 100644 (file)
@@ -42,6 +42,7 @@ TODO
 This option was known as CURLOPT_SSLKEYPASSWD up to 7.16.4 and
 CURLOPT_SSLCERTPASSWD up to 7.9.2.
 .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"
 .BR CURLOPT_SSLKEY "(3), " CURLOPT_SSH_PRIVATE_KEYFILE "(3), "
index 62ca08b..571eba3 100644 (file)
@@ -42,6 +42,7 @@ TODO
 .SH AVAILABILITY
 This option was known as CURLOPT_KRB4LEVEL up to 7.16.3
 .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"
 .BR CURLOPT_KRBLEVEL "(3), " CURLOPT_FTP_SSL "(3), "
index 53cf2a9..b419e51 100644 (file)
@@ -78,7 +78,8 @@ scheme.
 
 Since 7.21.7 the proxy string supports the socks protocols as "schemes".
 .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"
 .BR CURLOPT_PROXYPORT "(3), " CURLOPT_HTTPPROXYTUNNEL "(3), "
 .BR CURLOPT_PROXYTYPE "(3)"
index 3f50dbd..1632f0a 100644 (file)
@@ -44,6 +44,7 @@ TODO
 .SH AVAILABILITY
 Always
 .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"
 .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "
index 33c2b31..0c2d688 100644 (file)
@@ -39,6 +39,7 @@ TODO
 .SH AVAILABILITY
 Always
 .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"
 .BR CURLOPT_EGDSOCKET "(3), "
index 88c02bd..48c3ed9 100644 (file)
@@ -49,6 +49,7 @@ TODO
 .SH AVAILABILITY
 FILE since 7.18.0, RTSP since 7.20.0
 .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"
 .BR CURLOPT_RESUME_FROM "(3), " 
index 1461be3..d00019b 100644 (file)
@@ -41,6 +41,7 @@ TODO
 .SH AVAILABILITY
 If built with HTTP support
 .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"
 .BR CURLOPT_USERAGENT "(3), " CURLOPT_HTTPHEADER "(3), "
index aaf1874..7ae54f1 100644 (file)
@@ -49,6 +49,7 @@ TODO
 .SH AVAILABILITY
 If built TLS enabled.
 .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"
 .BR CURLOPT_SSLCERTTYPE "(3), " CURLOPT_SSLKEY "(3), "
index 7197986..b19d517 100644 (file)
@@ -42,6 +42,7 @@ TODO
 .SH AVAILABILITY
 If built TLS enabled. Added in 7.9.3
 .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"
 .BR CURLOPT_SSLCERT "(3), " CURLOPT_SSLKEY "(3), "
index f2fffea..a88a5a7 100644 (file)
@@ -42,6 +42,7 @@ TODO
 .SH AVAILABILITY
 If built TLS enabled.
 .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"
 .BR CURLOPT_SSLENGINE_DEFAULT "(3), " CURLOPT_SSLKEY "(3), "
index 97f2cf3..6570df1 100644 (file)
@@ -42,6 +42,7 @@ TODO
 .SH AVAILABILITY
 If built TLS enabled.
 .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"
 .BR CURLOPT_SSLENGINE "(3), " CURLOPT_SSLCERT "(3), "
index b481190..add69d8 100644 (file)
@@ -44,6 +44,7 @@ TODO
 .SH AVAILABILITY
 If built TLS enabled.
 .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"
 .BR CURLOPT_SSLKEYTYPE "(3), " CURLOPT_SSLCERT "(3), "
index 9ec09aa..d491634 100644 (file)
@@ -44,6 +44,7 @@ TODO
 .SH AVAILABILITY
 If built TLS enabled.
 .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"
 .BR CURLOPT_SSLKEY "(3), " CURLOPT_SSLCERT "(3), "
index c9bb7e2..7e05a59 100644 (file)
@@ -59,6 +59,7 @@ TODO
 .SH AVAILABILITY
 If built TLS enabled.
 .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"
 .BR CURLOPT_SSLVERSION "(3), " CURLOPT_USE_SSL "(3), "
index 7dee395..b465e2e 100644 (file)
@@ -277,7 +277,8 @@ All
 .SH AVAILABILITY
 POP3 and SMTP added in 7.31.0
 .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"
 .BR CURLOPT_VERBOSE "(3), " CURLOPT_PROTOCOLS "(3), "
 .BR curl_easy_perform "(3)"
index ab7995f..13ccbd4 100644 (file)
@@ -41,6 +41,7 @@ TODO
 .SH AVAILABILITY
 As long as HTTP is supported
 .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"
 .BR CURLOPT_REFERER "(3), " CURLOPT_HTTPHEADER "(3), "
index 274c0a0..03d8076 100644 (file)
@@ -59,6 +59,7 @@ TODO
 .SH AVAILABILITY
 Always
 .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"
 .BR CURLOPT_USERNAME "(3), " CURLOPT_PASSWORD "(3), "