| blob | 8ad1facc6d2eae3a9b6efcc0c58bebf0ce645e33 |
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2012, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at http://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .\"
23 .TH libcurl-errors 3 "1 Jan 2010" "libcurl 7.20.0" "libcurl errors"
24 .SH NAME
25 libcurl-errors \- error codes in libcurl
26 .SH DESCRIPTION
27 This man page includes most, if not all, available error codes in libcurl.
28 Why they occur and possibly what you can do to fix the problem are also included.
29 .SH "CURLcode"
30 Almost all "easy" interface functions return a CURLcode error code. No matter
31 what, using the \fIcurl_easy_setopt(3)\fP option \fICURLOPT_ERRORBUFFER\fP is
32 a good idea as it will give you a human readable error string that may offer
33 more details about the cause of the error than just the error code.
34 \fIcurl_easy_strerror(3)\fP can be called to get an error string from a
35 given CURLcode number.
37 CURLcode is one of the following:
38 .IP "CURLE_OK (0)"
39 All fine. Proceed as usual.
40 .IP "CURLE_UNSUPPORTED_PROTOCOL (1)"
41 The URL you passed to libcurl used a protocol that this libcurl does not
42 support. The support might be a compile-time option that you didn't use, it
43 can be a misspelled protocol string or just a protocol libcurl has no code
44 for.
45 .IP "CURLE_FAILED_INIT (2)"
46 Very early initialization code failed. This is likely to be an internal error
47 or problem, or a resource problem where something fundamental couldn't get
48 done at init time.
49 .IP "CURLE_URL_MALFORMAT (3)"
50 The URL was not properly formatted.
51 .IP "CURLE_NOT_BUILT_IN (4)"
52 A requested feature, protocol or option was not found built-in in this libcurl
53 due to a build-time decision. This means that a feature or option was not
54 enabled or explicitly disabled when libcurl was built and in order to get it
55 to function you have to get a rebuilt libcurl.
56 .IP "CURLE_COULDNT_RESOLVE_PROXY (5)"
57 Couldn't resolve proxy. The given proxy host could not be resolved.
58 .IP "CURLE_COULDNT_RESOLVE_HOST (6)"
59 Couldn't resolve host. The given remote host was not resolved.
60 .IP "CURLE_COULDNT_CONNECT (7)"
61 Failed to connect() to host or proxy.
62 .IP "CURLE_FTP_WEIRD_SERVER_REPLY (8)"
63 After connecting to a FTP server, libcurl expects to get a certain reply
64 back. This error code implies that it got a strange or bad reply. The given
65 remote server is probably not an OK FTP server.
66 .IP "CURLE_REMOTE_ACCESS_DENIED (9)"
67 We were denied access to the resource given in the URL. For FTP, this occurs
68 while trying to change to the remote directory.
69 .IP "CURLE_FTP_ACCEPT_FAILED (10)"
70 While waiting for the server to connect back when an active FTP session is
71 used, an error code was sent over the control connection or similar.
72 .IP "CURLE_FTP_WEIRD_PASS_REPLY (11)"
73 After having sent the FTP password to the server, libcurl expects a proper
74 reply. This error code indicates that an unexpected code was returned.
75 .IP "CURLE_FTP_ACCEPT_TIMEOUT (12)"
76 During an active FTP session while waiting for the server to connect, the
77 \fICURLOPT_ACCEPTTIMOUT_MS\fP (or the internal default) timeout expired.
78 .IP "CURLE_FTP_WEIRD_PASV_REPLY (13)"
79 libcurl failed to get a sensible result back from the server as a response to
80 either a PASV or a EPSV command. The server is flawed.
81 .IP "CURLE_FTP_WEIRD_227_FORMAT (14)"
82 FTP servers return a 227-line as a response to a PASV command. If libcurl
83 fails to parse that line, this return code is passed back.
84 .IP "CURLE_FTP_CANT_GET_HOST (15)"
85 An internal failure to lookup the host used for the new connection.
86 .IP "CURLE_FTP_COULDNT_SET_TYPE (17)"
87 Received an error when trying to set the transfer mode to binary or ASCII.
88 .IP "CURLE_PARTIAL_FILE (18)"
89 A file transfer was shorter or larger than expected. This happens when the
90 server first reports an expected transfer size, and then delivers data that
91 doesn't match the previously given size.
92 .IP "CURLE_FTP_COULDNT_RETR_FILE (19)"
93 This was either a weird reply to a 'RETR' command or a zero byte transfer
94 complete.
95 .IP "CURLE_QUOTE_ERROR (21)"
96 When sending custom "QUOTE" commands to the remote server, one of the commands
97 returned an error code that was 400 or higher (for FTP) or otherwise
98 indicated unsuccessful completion of the command.
99 .IP "CURLE_HTTP_RETURNED_ERROR (22)"
100 This is returned if CURLOPT_FAILONERROR is set TRUE and the HTTP server
101 returns an error code that is >= 400.
102 .IP "CURLE_WRITE_ERROR (23)"
103 An error occurred when writing received data to a local file, or an error was
104 returned to libcurl from a write callback.
105 .IP "CURLE_UPLOAD_FAILED (25)"
106 Failed starting the upload. For FTP, the server typically denied the STOR
107 command. The error buffer usually contains the server's explanation for this.
108 .IP "CURLE_READ_ERROR (26)"
109 There was a problem reading a local file or an error returned by the read
110 callback.
111 .IP "CURLE_OUT_OF_MEMORY (27)"
112 A memory allocation request failed. This is serious badness and
113 things are severely screwed up if this ever occurs.
114 .IP "CURLE_OPERATION_TIMEDOUT (28)"
115 Operation timeout. The specified time-out period was reached according to the
116 conditions.
117 .IP "CURLE_FTP_PORT_FAILED (30)"
118 The FTP PORT command returned error. This mostly happens when you haven't
119 specified a good enough address for libcurl to use. See \fICURLOPT_FTPPORT\fP.
120 .IP "CURLE_FTP_COULDNT_USE_REST (31)"
121 The FTP REST command returned error. This should never happen if the server is
122 sane.
123 .IP "CURLE_RANGE_ERROR (33)"
124 The server does not support or accept range requests.
125 .IP "CURLE_HTTP_POST_ERROR (34)"
126 This is an odd error that mainly occurs due to internal confusion.
127 .IP "CURLE_SSL_CONNECT_ERROR (35)"
128 A problem occurred somewhere in the SSL/TLS handshake. You really want the
129 error buffer and read the message there as it pinpoints the problem slightly
130 more. Could be certificates (file formats, paths, permissions), passwords, and
131 others.
132 .IP "CURLE_BAD_DOWNLOAD_RESUME (36)"
133 The download could not be resumed because the specified offset was out of the
134 file boundary.
135 .IP "CURLE_FILE_COULDNT_READ_FILE (37)"
136 A file given with FILE:// couldn't be opened. Most likely because the file
137 path doesn't identify an existing file. Did you check file permissions?
138 .IP "CURLE_LDAP_CANNOT_BIND (38)"
139 LDAP cannot bind. LDAP bind operation failed.
140 .IP "CURLE_LDAP_SEARCH_FAILED (39)"
141 LDAP search failed.
142 .IP "CURLE_FUNCTION_NOT_FOUND (41)"
143 Function not found. A required zlib function was not found.
144 .IP "CURLE_ABORTED_BY_CALLBACK (42)"
145 Aborted by callback. A callback returned "abort" to libcurl.
146 .IP "CURLE_BAD_FUNCTION_ARGUMENT (43)"
147 Internal error. A function was called with a bad parameter.
148 .IP "CURLE_INTERFACE_FAILED (45)"
149 Interface error. A specified outgoing interface could not be used. Set which
150 interface to use for outgoing connections' source IP address with
151 CURLOPT_INTERFACE.
152 .IP "CURLE_TOO_MANY_REDIRECTS (47)"
153 Too many redirects. When following redirects, libcurl hit the maximum amount.
154 Set your limit with CURLOPT_MAXREDIRS.
155 .IP "CURLE_UNKNOWN_OPTION (48)"
156 An option passed to libcurl is not recognized/known. Refer to the appropriate
157 documentation. This is most likely a problem in the program that uses
158 libcurl. The error buffer might contain more specific information about which
159 exact option it concerns.
160 .IP "CURLE_TELNET_OPTION_SYNTAX (49)"
161 A telnet option string was Illegally formatted.
162 .IP "CURLE_PEER_FAILED_VERIFICATION (51)"
163 The remote server's SSL certificate or SSH md5 fingerprint was deemed not OK.
164 .IP "CURLE_GOT_NOTHING (52)"
165 Nothing was returned from the server, and under the circumstances, getting
166 nothing is considered an error.
167 .IP "CURLE_SSL_ENGINE_NOTFOUND (53)"
168 The specified crypto engine wasn't found.
169 .IP "CURLE_SSL_ENGINE_SETFAILED (54)"
170 Failed setting the selected SSL crypto engine as default!
171 .IP "CURLE_SEND_ERROR (55)"
172 Failed sending network data.
173 .IP "CURLE_RECV_ERROR (56)"
174 Failure with receiving network data.
175 .IP "CURLE_SSL_CERTPROBLEM (58)"
176 problem with the local client certificate.
177 .IP "CURLE_SSL_CIPHER (59)"
178 Couldn't use specified cipher.
179 .IP "CURLE_SSL_CACERT (60)"
180 Peer certificate cannot be authenticated with known CA certificates.
181 .IP "CURLE_BAD_CONTENT_ENCODING (61)"
182 Unrecognized transfer encoding.
183 .IP "CURLE_LDAP_INVALID_URL (62)"
184 Invalid LDAP URL.
185 .IP "CURLE_FILESIZE_EXCEEDED (63)"
186 Maximum file size exceeded.
187 .IP "CURLE_USE_SSL_FAILED (64)"
188 Requested FTP SSL level failed.
189 .IP "CURLE_SEND_FAIL_REWIND (65)"
190 When doing a send operation curl had to rewind the data to retransmit, but the
191 rewinding operation failed.
192 .IP "CURLE_SSL_ENGINE_INITFAILED (66)"
193 Initiating the SSL Engine failed.
194 .IP "CURLE_LOGIN_DENIED (67)"
195 The remote server denied curl to login (Added in 7.13.1)
196 .IP "CURLE_TFTP_NOTFOUND (68)"
197 File not found on TFTP server.
198 .IP "CURLE_TFTP_PERM (69)"
199 Permission problem on TFTP server.
200 .IP "CURLE_REMOTE_DISK_FULL (70)"
201 Out of disk space on the server.
202 .IP "CURLE_TFTP_ILLEGAL (71)"
203 Illegal TFTP operation.
204 .IP "CURLE_TFTP_UNKNOWNID (72)"
205 Unknown TFTP transfer ID.
206 .IP "CURLE_REMOTE_FILE_EXISTS (73)"
207 File already exists and will not be overwritten.
208 .IP "CURLE_TFTP_NOSUCHUSER (74)"
209 This error should never be returned by a properly functioning TFTP server.
210 .IP "CURLE_CONV_FAILED (75)"
211 Character conversion failed.
212 .IP "CURLE_CONV_REQD (76)"
213 Caller must register conversion callbacks.
214 .IP "CURLE_SSL_CACERT_BADFILE (77)"
215 Problem with reading the SSL CA cert (path? access rights?)
216 .IP "CURLE_REMOTE_FILE_NOT_FOUND (78)"
217 The resource referenced in the URL does not exist.
218 .IP "CURLE_SSH (79)"
219 An unspecified error occurred during the SSH session.
220 .IP "CURLE_SSL_SHUTDOWN_FAILED (80)"
221 Failed to shut down the SSL connection.
222 .IP "CURLE_AGAIN (81)"
223 Socket is not ready for send/recv wait till it's ready and try again. This
224 return code is only returned from \fIcurl_easy_recv(3)\fP and
225 \fIcurl_easy_send(3)\fP (Added in 7.18.2)
226 .IP "CURLE_SSL_CRL_BADFILE (82)"
227 Failed to load CRL file (Added in 7.19.0)
228 .IP "CURLE_SSL_ISSUER_ERROR (83)"
229 Issuer check failed (Added in 7.19.0)
230 .IP "CURLE_FTP_PRET_FAILED (84)"
231 The FTP server does not understand the PRET command at all or does not support
232 the given argument. Be careful when using \fICURLOPT_CUSTOMREQUEST\fP, a
233 custom LIST command will be sent with PRET CMD before PASV as well. (Added in
234 7.20.0)
235 .IP "CURLE_RTSP_CSEQ_ERROR (85)"
236 Mismatch of RTSP CSeq numbers.
237 .IP "CURLE_RTSP_SESSION_ERROR (86)"
238 Mismatch of RTSP Session Identifiers.
239 .IP "CURLE_FTP_BAD_FILE_LIST (87)"
240 Unable to parse FTP file list (during FTP wildcard downloading).
241 .IP "CURLE_CHUNK_FAILED (88)"
242 Chunk callback reported error.
243 .IP "CURLE_OBSOLETE*"
244 These error codes will never be returned. They were used in an old libcurl
245 version and are currently unused.
246 .SH "CURLMcode"
247 This is the generic return code used by functions in the libcurl multi
248 interface. Also consider \fIcurl_multi_strerror(3)\fP.
249 .IP "CURLM_CALL_MULTI_PERFORM (-1)"
250 This is not really an error. It means you should call
251 \fIcurl_multi_perform(3)\fP again without doing select() or similar in between.
252 .IP "CURLM_OK (0)"
253 Things are fine.
254 .IP "CURLM_BAD_HANDLE (1)"
255 The passed-in handle is not a valid CURLM handle.
256 .IP "CURLM_BAD_EASY_HANDLE (2)"
257 An easy handle was not good/valid. It could mean that it isn't an easy handle
258 at all, or possibly that the handle already is in used by this or another
259 multi handle.
260 .IP "CURLM_OUT_OF_MEMORY (3)"
261 You are doomed.
262 .IP "CURLM_INTERNAL_ERROR (4)"
263 This can only be returned if libcurl bugs. Please report it to us!
264 .IP "CURLM_BAD_SOCKET (5)"
265 The passed-in socket is not a valid one that libcurl already knows about.
266 (Added in 7.15.4)
267 .IP "CURLM_UNKNOWN_OPTION (6)"
268 curl_multi_setopt() with unsupported option
269 (Added in 7.15.4)
270 .SH "CURLSHcode"
271 The "share" interface will return a CURLSHcode to indicate when an error has
272 occurred. Also consider \fIcurl_share_strerror(3)\fP.
273 .IP "CURLSHE_OK (0)"
274 All fine. Proceed as usual.
275 .IP "CURLSHE_BAD_OPTION (1)"
276 An invalid option was passed to the function.
277 .IP "CURLSHE_IN_USE (2)"
278 The share object is currently in use.
279 .IP "CURLSHE_INVALID (3)"
280 An invalid share object was passed to the function.
281 .IP "CURLSHE_NOMEM (4)"
282 Not enough memory was available.
283 (Added in 7.12.0)
284 .IP "CURLSHE_NOT_BUILT_IN (5)"
285 The requsted sharing could not be done because the library you use don't have
286 that particular feature enabled. (Added in 7.23.0)