]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
opts: document CURLE_OUT_OF_MEMORY among other return values
authorDan Fandrich <dan@coneharvesters.com>
Fri, 20 Jun 2014 21:43:26 +0000 (23:43 +0200)
committerDan Fandrich <dan@coneharvesters.com>
Fri, 20 Jun 2014 21:43:46 +0000 (23:43 +0200)
20 files changed:
docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3
docs/libcurl/opts/CURLOPT_CRLFILE.3
docs/libcurl/opts/CURLOPT_DNS_INTERFACE.3
docs/libcurl/opts/CURLOPT_DNS_LOCAL_IP4.3
docs/libcurl/opts/CURLOPT_DNS_LOCAL_IP6.3
docs/libcurl/opts/CURLOPT_DNS_SERVERS.3
docs/libcurl/opts/CURLOPT_FTP_ALTERNATIVE_TO_USER.3
docs/libcurl/opts/CURLOPT_FTP_CREATE_MISSING_DIRS.3
docs/libcurl/opts/CURLOPT_HTTPAUTH.3
docs/libcurl/opts/CURLOPT_LOGIN_OPTIONS.3
docs/libcurl/opts/CURLOPT_MAIL_AUTH.3
docs/libcurl/opts/CURLOPT_MAIL_FROM.3
docs/libcurl/opts/CURLOPT_PROXYAUTH.3
docs/libcurl/opts/CURLOPT_PROXY_TRANSFER_MODE.3
docs/libcurl/opts/CURLOPT_SOCKS5_GSSAPI_SERVICE.3
docs/libcurl/opts/CURLOPT_SSH_PRIVATE_KEYFILE.3
docs/libcurl/opts/CURLOPT_SSH_PUBLIC_KEYFILE.3
docs/libcurl/opts/CURLOPT_TLSAUTH_PASSWORD.3
docs/libcurl/opts/CURLOPT_TLSAUTH_USERNAME.3
docs/libcurl/opts/CURLOPT_XOAUTH2_BEARER.3

index b0100ab53f487cdf928497e329518f93caf2c340..eaee975f63abc6a69438c30eabeffc2ab1615d0e 100644 (file)
@@ -56,6 +56,7 @@ TODO
 .SH AVAILABILITY
 This option was called CURLOPT_ENCODING before 7.21.6
 .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_TRANSFER_ENCODING "(3), " CURLOPT_HTTPHEADER "(3), "
index 48395d5c86d5db56b44fc89ad5f3d91fc9950d81..adc0e99d76cbd467fa08f7479f0996da54c0a147 100644 (file)
@@ -54,6 +54,7 @@ TODO
 .SH AVAILABILITY
 Added in 7.19.0
 .SH RETURN VALUE
-Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
+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 d18b2f05d9e06133f8fb62168a2b7bf67ead24a3..c33d79171b172929dc781619e8c432115bdab4cb 100644 (file)
@@ -42,6 +42,7 @@ Added in 7.33.0. This option also requires that libcurl was built with a
 resolver backend that supports this operation. The c-ares backend is the only
 such one.
 .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_NOT_BUILT_IN if support was disabled at compile-time.
 .SH "SEE ALSO"
 .BR CURLOPT_DNS_SERVERS "(3), " CURLOPT_DNS_LOCAL_IP4 "(3), "
index a5e973c1ae4cef05ad8bae7d07cf90055bb6a016..9709ebd01325f7f1f9d54eace8d6b4e9633cbd88 100644 (file)
@@ -44,6 +44,8 @@ supports this operation. The c-ares backend is the only such one.
 
 Added in 7.33.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,
+CURLE_NOT_BUILT_IN if support was disabled at compile-time, or
+CURLE_BAD_FUNCTION_ARGUMENT when given a bad address.
 .SH "SEE ALSO"
 .BR CURLOPT_DNS_INTERFACE "(3), " CURLOPT_DNS_LOCAL_IP4 "(3), "
index fb8456dd69ab1a1b7ddf0cdd6436acf748cc66a7..56865bb528899186ced6dde981033a7fe9c33d1c 100644 (file)
@@ -44,6 +44,8 @@ supports this operation. The c-ares backend is the only such one.
 
 Added in 7.33.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,
+CURLE_NOT_BUILT_IN if support was disabled at compile-time, or
+CURLE_BAD_FUNCTION_ARGUMENT when given a bad address.
 .SH "SEE ALSO"
 .BR CURLOPT_DNS_INTERFACE "(3), " CURLOPT_DNS_LOCAL_IP4 "(3), "
index 94a478b8bedb9cda0483e3f55537c663f5a8d83c..9f5178882784eab26b7455925fc6d465e4b8d467 100644 (file)
@@ -48,6 +48,9 @@ supports this operation. The c-ares backend is the only such one.
 
 Added in 7.24.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,
+CURLE_NOT_BUILT_IN if support was disabled at compile-time,
+CURLE_BAD_FUNCTION_ARGUMENT when given an invalid server list, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_DNS_LOCAL_IP4 "(3), " CURLOPT_DNS_CACHE_TIMEOUT "(3), "
index 7565874d4cd3b2c1d043af279546a189f777817e..b51e4dd1cb0f68aa472b568da9c3984affa85288 100644 (file)
@@ -44,6 +44,7 @@ TODO
 .SH AVAILABILITY
 Added in 7.15.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_SKIP_PASV_IP "(3), " CURLOPT_FTP_RESPONSE_TIMEOUT "(3), "
index d74dcfcfccc22c560ebdc64e62649772ec3fad1d..a52863e8f0446ea59e849e6dc25f81b6ed408f86 100644 (file)
@@ -64,6 +64,7 @@ TODO
 Added in 7.10.7. SFTP support added in 7.16.3. The retry option was added in
 7.19.4.
 .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, and CURLE_UNKNOWN_OPTION if the
+create value is not.
 .SH "SEE ALSO"
 .BR CURLOPT_FTP_FILEMETHOD "(3), " CURLOPT_FTP_USE_EPSV "(3), "
index 9562d65358cd00ca10de1424973219dd66b9c72b..3f0ab12ec327c53460b9aff31c0e5b20129925e9 100644 (file)
@@ -111,6 +111,8 @@ CURLAUTH_ONLY was added in 7.21.3
 
 CURLAUTH_NTLM_WB was added in 7.22.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_NOT_BUILT_IN if the bitmask specified no supported authentication
+methods.
 .SH "SEE ALSO"
 .BR CURLOPT_PROXYAUTH "(3), " CURLOPT_USERPWD "(3), "
index e90e38bb2190acf5fe6407e4c0f071532a2b9523..dde3c6edbccb0cfb7f5c271dda2e213de67732ac 100644 (file)
@@ -47,6 +47,7 @@ TODO
 .SH AVAILABILITY
 Added in 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_USERNAME "(3), " CURLOPT_PASSWORD "(3), "
index 45d997115dc1197070c628b0ae1d6cfe1b1b4fe5..dda088a31316d05bdb04be7fc879dd4e226fe349 100644 (file)
@@ -52,6 +52,7 @@ TODO
 .SH AVAILABILITY
 Added in 7.25.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_MAIL_FROM "(3), " CURLOPT_MAIL_RCPT "(3), "
index a13f42a3433a4ec541ef31f13bf384c1212cd559..f93542964fa64e88a6760fe39e0cc972340e59f6 100644 (file)
@@ -45,6 +45,7 @@ TODO
 .SH AVAILABILITY
 Added in 7.20.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_MAIL_RCPT "(3), " CURLOPT_MAIL_AUTH "(3), "
index c1c095c23ffec8a424fb4983b0c6858609297732..fe742c035ab3d3d77ba3e6c540c2626611388a94 100644 (file)
@@ -47,7 +47,9 @@ TODO
 .SH AVAILABILITY
 Added in 7.10.7
 .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_NOT_BUILT_IN if the bitmask specified no supported authentication
+methods.
 .SH "SEE ALSO"
 .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "
 .BR CURLOPT_PROXYUSERPWD "(3), " CURLOPT_PROXYPORT "(3), "
index c859ab3e6f67b99b295ec4728b8c8eb7e185ba70..ae5ede7717128b78fe45e0fe1e82a5020fdf8a2f 100644 (file)
@@ -42,6 +42,7 @@ TODO
 .SH AVAILABILITY
 Added in 7.18.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, and CURLE_UNKNOWN_OPTION if the
+enabled value is not supported.
 .SH "SEE ALSO"
 .BR CURLOPT_PROXY "(3), " CURLOPT_HTTPPROXYTUNNEL "(3), "
index dbfb1351678f4e868c9e441861900ba4a83dd588..d18ea9f90fa3eedcf28d12f3ff1aaa3781e11c7e 100644 (file)
@@ -40,6 +40,7 @@ TODO
 .SH AVAILABILITY
 Added in 7.19.4
 .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_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "
index 5548412dd0be5b545ef54b4ba9aaf31525f9a373..f357f2c9036ef82eb703caf8ad4e79b32747adcf 100644 (file)
@@ -45,6 +45,7 @@ TODO
 .SH AVAILABILITY
 Added in 7.16.1
 .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_SSH_PUBLIC_KEYFILE "(3), " CURLOPT_SSH_AUTH_TYPES "(3), "
index ec47c01f3a3f2dc5dac5a7fae86f02a48fd33918..35f2a1992919fdd77bb233222d48363a6e44fadb 100644 (file)
@@ -47,6 +47,7 @@ TODO
 .SH AVAILABILITY
 The "" trick was added in 7.26.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_SSH_PRIVATE_KEYFILE "(3), " CURLOPT_SSH_AUTH_TYPES "(3), "
index 99c1701caf9da728ab933e20278afba588785538..39f8cbf515de00cc0c0a3be6ad8baab4cef9868f 100644 (file)
@@ -41,6 +41,7 @@ TODO
 .SH AVAILABILITY
 Added in 7.21.4
 .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_TLSAUTH_TYPE "(3), " CURLOPT_TLSAUTH_USERNAME "(3), "
index 5f31e0d06f3050d62644505fc5cc86316d25fd91..bacf9cc9bcd0cf31b610471a69aefcba8909a546 100644 (file)
@@ -41,6 +41,7 @@ TODO
 .SH AVAILABILITY
 Added in 7.21.4
 .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_TLSAUTH_TYPE "(3), " CURLOPT_TLSAUTH_PASSWORD "(3), "
index 23287144b6ce3ac96816f4c8d71ec379d22e549c..adc5b32697b5b401e2bdcbd320516140bfb0bc6e 100644 (file)
@@ -43,6 +43,7 @@ TODO
 .SH AVAILABILITY
 Added in 7.33.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_MAIL_AUTH "(3), " CURLOPT_USERNAME "(3), "