1 .\" You can view this file with:
3 .\" Adapted from libcurl docs by fandom@telefonica.net
4 .TH TclCurl n "3 October 2011" "TclCurl 7.22.0 "TclCurl Easy Interface"
6 TclCurl: - get a URL with FTP, FTPS, HTTP, HTTPS, SCP, SFTP, TFTP, TELNET, DICT, FILE, LDAP,
7 LDAPS, IMAP, IMAPS, POP, POP3, SMTP, SMTPS and gopher syntax.
12 .IB curlHandle " configure " "?options?"
14 .IB curlHandle " perform"
16 .IB curlHandle " getinfo " curlinfo_option
18 .IB curlhandle " cleanup"
20 .IB curlhandle " reset"
22 .IB curlHandle " duhandle"
24 .IB curlHandle " pause"
26 .IB curlHandle " resume"
28 .BI curl::transfer " ?options?"
32 .BI "curl::escape " url
34 .BI "curl::unescape " url
36 .BI "curl::curlConfig " option
38 .BI "curl::versioninfo " option
40 .BI "curl::easystrerror " errorCode
43 The TclCurl extension gives Tcl programmers access to the libcurl
44 library written by \fBDaniel Stenberg\fP, with it you can download urls,
45 upload them and many other neat tricks, for more information check
46 .I http://curl.haxx.se
48 This procedure must be the first one to call, it returns a
50 that you need to use to invoke TclCurl procedures. The init calls intializes
51 curl and this call MUST have a corresponding call to
53 when the operation is completed.
54 You should perform all your sequential file transfers using the same
55 curlHandle. This enables TclCurl to use persistant connections when
62 .SH curlHandle configure ?options?
65 is called to set the options for the transfer. Most operations in TclCurl
66 have default actions, and by using the appropriate options you can
67 make them behave differently (as documented). All options are set with
68 the \fIoption\fP followed by a parameter.
71 the options set with this procedure are valid for the
72 forthcoming data transfers that are performed when you invoke
75 The options are not reset between transfers (except where noted), so if
76 you want subsequent transfers with different options, you must change them
77 between the transfers. You can optionally reset all options back to the internal
78 default with \fBcurlHandle reset\fP.
81 is the return code from the
92 Set the parameter to 1 to get the library to display a lot of verbose
93 information about its operations. Very useful for libcurl and/or protocol
94 debugging and understanding.
96 You hardly ever want this set in production use, you will almost always want
97 this when you debug/report problems. Another neat option for debugging is
102 A 1 tells the extension to include the headers in the body output. This is
103 only relevant for protocols that actually have headers preceding the data (like HTTP).
107 A 1 tells the extension to turn on the progress meter
108 completely. It will also prevent the \fIprogessproc\fP from getting called.
112 A 1 tells TclCurl not use any functions that install signal
113 handlers or any functions that cause signals to be sent to the process. This
114 option is mainly here to allow multi-threaded unix applications to still
115 set/use all timeout options etc, without risking getting signals.
117 If this option is set and libcurl has been built with the standard name resolver,
118 timeouts will not occur while the name resolve takes place. Consider building
119 libcurl with c-ares support to enable asynchronous DNS lookups, which enables
120 nice timeouts for name resolves without signals.
122 Setting \fInosignal\fP to 1 makes libcurl NOT ask the system to ignore
123 SIGPIPE signals, which otherwise are sent by the system when trying to send
124 data to a socket which is closed in the other end. libcurl makes an effort to
125 never cause such SIGPIPEs to trigger, but some operating systems have no way
126 to avoid them and even on those that have there are some corner cases when
127 they may still happen, contrary to our desire. In addition, using
128 \fIntlm_Wb\fP authentication could cause a SIGCHLD signal to be raised.
132 Set this option to 1 if you want to transfer multiple files according to a
133 file name pattern. The pattern can be specified as part of the
134 \fB-url\fP option, using an fnmatch-like pattern (Shell Pattern
135 Matching) in the last part of URL (file name).
137 By default, TClCurl uses its internal wildcard matching implementation. You
138 can provide your own matching function by the \fB-fnmatchproc\fP option.
140 This feature is only supported by the FTP download for now.
142 A brief introduction of its syntax follows:
145 \&ftp://example.com/some/path/\fB*.txt\fP (for all txt's from the root
149 .IP "? - QUESTION MARK"
150 Question mark matches any (exactly one) character.
152 \&ftp://example.com/some/path/\fBphoto?.jpeg\fP
155 .IP "[ - BRACKET EXPRESSION"
156 The left bracket opens a bracket expression. The question mark and asterisk have
157 no special meaning in a bracket expression. Each bracket expression ends by the
158 right bracket and matches exactly one character. Some examples follow:
160 \fB[a-zA-Z0\-9]\fP or \fB[f\-gF\-G]\fP \- character interval
162 \fB[abc]\fP - character enumeration
164 \fB[^abc]\fP or \fB[!abc]\fP - negation
166 \fB[[:\fP\fIname\fP\fB:]]\fP class expression. Supported classes are
167 \fBalnum\fP,\fBlower\fP, \fBspace\fP, \fBalpha\fP, \fBdigit\fP, \fBprint\fP,
168 \fBupper\fP, \fBblank\fP, \fBgraph\fP, \fBxdigit\fP.
170 \fB[][-!^]\fP - special case \- matches only '\-', ']', '[', '!' or '^'. These
171 characters have no special purpose.
173 \fB[\\[\\]\\\\]\fP - escape syntax. Matches '[', ']' or '\\'.
175 Using the rules above, a file name pattern can be constructed:
177 \&ftp://example.com/some/path/\fB[a-z[:upper:]\\\\].jpeg\fP
185 Use it to set a Tcl procedure that will be invoked by TclCurl as soon as
186 there is received data that needs to be saved. The procedure will receive
187 a single parameter with the data to be saved.
189 NOTE: you will be passed as much data as possible in all invokes, but you
190 cannot possibly make any assumptions. It may be nothing if the file is
191 empty or it may be thousands of bytes.
195 File in which the transfered data will be saved.
199 Sets a Tcl procedure to be called by TclCurl as soon as it needs to read
200 data in order to send it to the peer. The procedure has to take one
201 parameter, which will contain the maximun numbers of bytes to read. It
202 should return the actual number of bytes read, or '0' if you want to
205 If you stop the current transfer by returning 0 "pre-maturely" (i.e before
206 the server expected it, like when you've said you will upload N bytes and
207 you upload less than N bytes), you may experience that the server "hangs"
208 waiting for the rest of the data that won't come.
210 Bugs: when doing TFTP uploads, you must return the exact amount of data
211 that the callback wants, or it will be considered the final packet by the
212 server end and the transfer will end there.
216 File from which the data will be transfered.
220 Name of the Tcl procedure that will invoked by TclCurl with a frequent
221 interval during operation (roughly once per second or sooner), no matter if data
222 is being transfered or not. Unknown/unused
223 argument values passed to the callback will be set to zero (like if you
224 only download data, the upload size will remain 0), the prototype of the
227 .B proc ProgressCallback {dltotal dlnow ultotal ulnow}
229 In order to this option to work you have to set the \fBnoprogress\fP
230 option to '0'. Setting this option to the empty string will restore the
231 original progress function.
233 If you transfer data with the multi interface, this procedure will not be
234 called during periods of idleness unless you call the appropriate procedure
235 that performs transfers.
237 You can pause and resume a transfer from within this procedure using the
238 \fBpause\fP and \fBresume\fP commands.
242 Pass a the file name to be used to write the header part of the received data to.
243 The headers are guaranteed to be written one-by-one to this file and
244 only complete lines are written. Parsing headers should be easy enough using
247 See also the \f-headervar\fP option to get the headers into an array.
251 Name of the procedure that will receive the debug data produced by the
253 option, it should match the following prototype:
255 .B debugProc {infoType data}
257 where \fBinfoType\fP specifies what kind of information it is (0 text,
258 1 incoming header, 2 outgoing header, 3 incoming data, 4 outgoing data,
259 5 incoming SSL data, 6 outgoing SSL data).
263 Name of the procedure that will be called before a file will be transfered by
264 ftp, it should match the following prototype:
266 .B ChunkBgnProc {remains}
269 Where remains is the number of files left to be transfered (or skipped)
271 This callback makes sense only when using the \fB-wildcard\fP option.
275 Name of the variable in the global scope that will contain the data of the file about
276 to be transfered. If you don't use this option '::fileData' will be used.
278 The available data is: filename, filetype (file, directory, symlink, device block, device char,
279 named pipe, socket, door or error if it couldn't be identified), time, perm, uid, gid,
280 size, hardlinks and flags.
284 Name of the procedure that will be called after a file is transfered (or skipped)
285 by ftp, it should match the following prototype:
289 It should return '0' if everyhting is fine and '1' if some error occurred.
293 Name of the procedure that will be called instead of the internal wildcard
294 matching function, it should match the following prototype:
296 .B FnMatchProc {pattern string}
298 Returns '0' if it matches, '1' if it doesn't.
304 Pass a variable name where TclCurl may store human readable error
305 messages in. This may be more helpful than just the return code from the
310 Pass a file name as parameter. This is the stream to use internally instead
311 of stderr when reporting errors.
314 A 1 parameter tells the extension to fail silently if the HTTP code
315 returned is equal or larger than 400. The default action would be to return
316 the page normally, ignoring that code.
318 This method is not fail-safe and there are occasions where non-successful response
319 codes will slip through, especially when authentication is involved
320 (response codes 401 and 407).
322 You might get some amounts of headers transferred before this situation is detected,
323 like for when a "100-continue" is received as a response to a POST/PUT and a 401
324 or 407 is received immediately afterwards.
330 The actual URL to deal with.
332 If the given URL lacks the protocol part ("http://" or "ftp://" etc), it will
333 attempt to guess which protocol to use based on the given host name. If the
334 given protocol of the set URL is not supported, TclCurl will return the
335 \fBunsupported protocol\fP error when you call \fBperform\fP. Use
336 \fBcurl::versioninfo\fP for detailed info on which protocols are supported.
338 Starting with version 7.22.0, the fragment part of the URI will not be send as
339 part of the path, which was the case previously.
341 \fBNOTE\fP: this is the one option required to be set before \fBperform\fP is called.
345 Pass a list in lowecase of protocols to limit what protocols TclCurl may use in the transfer. This
346 allows you to have a TclCurl built to support a wide range of protocols but still limit
347 specific transfers to only be allowed to use a subset of them.
349 Accepted protocols are 'http', 'https', 'ftp', 'ftps', 'scp', 'sftp', 'telnet', 'ldap',
350 'ldaps','dict', 'file','tftp', 'imap', 'imaps', 'pop', 'pop3', 'smtp', 'smtps', 'gopher'
355 Pass a list in lowercase of accepted protocols to limit what protocols TclCurl may use in a transfer
356 that it follows to in a redirect when \fB-followlocation\fP is enabled. This allows you
357 to limit specific transfers to only be allowed to use a subset of protocols in redirections.
359 By default TclCurl will allow all protocols except for FILE and SCP. This is a difference
360 compared to pre-7.19.4 versions which unconditionally would follow to all protocols supported.
364 If you need to use a http proxy to access the outside world, set the
365 proxy string with this option. To specify port number in this string,
366 append :[port] to the end of the host name. The proxy string may be
367 prefixed with [protocol]:// since any such prefix will be ignored.
369 When you tell the extension to use a HTTP proxy, TclCurl will
370 transparently convert operations to HTTP even if you specify a FTP
371 URL etc. This may have an impact on what other features of the library
374 and similar FTP specifics that will not work unless you tunnel through
375 the HTTP proxy. Such tunneling is activated with
378 TclCurl respects the environment variables http_proxy, ftp_proxy,
379 all_proxy etc, if any of those are set. The use of this option does
380 however override any possibly set environment variables.
382 Setting the proxy string to "" (an empty string) will explicitly disable
383 the use of a proxy, even if there is an environment variable set for it.
385 The proxy host string can be specified the exact same way as the proxy
386 environment variables, include protocol prefix (http://) and embedded
389 Since 7.22.0, the proxy string may be specified with a protocol:// prefix to
390 specify alternative proxy protocols. Use socks4://, socks4a://, socks5:// or
391 socks5h:// (the last one to enable socks5 and asking the proxy to do the resolving)
392 to request the specific SOCKS version
393 to be used. No protocol specified, http:// and all others will be treated as
398 Use this option to set the proxy port to use unless it is specified in
399 the proxy string by \fB-proxy\fP. If not specified, TclCurl will default
400 -to using port 1080 for proxies.
404 Pass the type of the proxy. Available options are 'http', 'http1.0', 'socks4', 'socks4a',
405 'socks5' and 'socks5h', with the HTTP one being the default.
407 If you set it to \fIhttp1.0\fP, it will only affect how libcurl speaks to a proxy
408 when CONNECT is used. The HTTP version used for "regular" HTTP requests is instead
409 controled with \fIhttpversion\fP.
413 Pass a string, a comma-separated list of hosts which do not use a proxy, if one
414 is specified. The only wildcard is a single * character, which matches all hosts,
415 and effectively disables the proxy. Each name in this list is matched as either
416 a domain which contains the hostname, or the hostname itself. For example, local.com
417 would match local.com, local.com:80, and www.local.com, but not www.notlocal.com.
421 Set the parameter to 1 to get the extension to tunnel all non-HTTP
422 operations through the given HTTP proxy. Do note that there is a big
423 difference between using a proxy and tunneling through it. If you don't know what
424 this means, you probably don't want this tunnel option.
427 .B -socks5gssapiservice
428 Pass thee name of the service. The default service name for a SOCKS5 server is
429 rcmd/server-fqdn. This option allows you to change it.
433 Pass a 1 to enable or 0 to disable. As part of the gssapi negotiation a protection
434 mode is negotiated. The rfc1961 says in section 4.3/4.4 it should be protected, but
435 the NEC reference implementation does not. If enabled, this option allows the
436 unprotected exchange of the protection mode negotiation.
440 Pass the interface name to use as outgoing
441 network interface. The name can be an interface name, an IP address or a host
446 This sets the local port number of the socket used for connection. This can
447 be used in combination with \fB-interface\fP and you are recommended to use
448 \fBlocalportrange\fP as well when this is set. Valid port numbers
453 This is the number of attempts TclCurl should do to find a working local port
454 number. It starts with the given \fB-localport\fP and adds
455 one to the number for each retry. Setting this value to 1 or below will make
456 TclCurl do only one try for each port number. Port numbers by nature
457 are a scarce resource that will be busy at times so setting this value to something
458 too low might cause unnecessary connection setup failures.
462 Pass the timeout in seconds. Name resolves will be kept in memory for this number
463 of seconds. Set to '0' to completely disable caching, or '-1' to make the
464 cached entries remain forever. By default, TclCurl caches this info for 60 seconds.
466 The name resolve functions of various libc implementations don't re-read name
467 server information unless explicitly told so (for example, by calling
468 \fIres_init(3)\fP). This may cause TclCurl to keep using the older server even
469 if DHCP has updated the server info, and this may look like a DNS cache issue.
472 .B -dnsuseglobalcache
473 If the value passed is 1, it tells TclCurl to use a global DNS cache that
474 will survive between curl handles creations and deletions. This is not thread-safe
475 as it uses a global varible.
477 \fBWARNING:\fP this option is considered obsolete. Stop using it. Switch over
478 to using the share interface instead! See \fItclcurl_share\fP.
482 Pass your prefered size for the receive buffer in TclCurl. The main point of this
483 would be that the write callback gets called more often and with smaller chunks.
484 This is just treated as a request, not an order. You cannot be guaranteed to
485 actually get the given size.
490 Pass the number specifying what remote port to connect to, instead of the one specified
491 in the URL or the default port for the used protocol.
496 Pass a number to specify whether the TCP_NODELAY option should be set or cleared (1 = set, 0 = clear).
497 The option is cleared by default. This will have no effect after the connection has been established.
499 Setting this option will disable TCP's Nagle algorithm. The purpose of this algorithm is to try to
500 minimize the number of small packets on the network (where "small packets" means TCP segments less
501 than the Maximum Segment Size (MSS) for the network).
503 Maximizing the amount of data sent per TCP segment is good because it amortizes the overhead of the
504 send. However, in some cases (most notably telnet or rlogin) small segments may need to be sent without
505 delay. This is less efficient than sending larger amounts of data at a time, and can contribute to
506 congestion on the network if overdone.
510 Pass a number specifying the scope_id value to use when connecting to IPv6 link-local or site-local
513 .SH Names and Passwords options
517 A 1 parameter tells the extension to scan your
519 file to find user name and password for the remote site you are about to
520 access. Do note that TclCurl does not verify that the file has the correct
521 properties set (as the standard unix ftp client does), and that only machine
522 name, user name and password is taken into account (init macros and similar
523 things are not supported).
525 You can set it to the following values:
529 The use of your ~/.netrc file is optional, and information in the URL is to
530 be preferred. The file will be scanned with the host and user name (to find
531 the password only) or with the host only, to find the first user name and
532 password after that machine, which ever information is not specified in
535 Undefined values of the option will have this effect.
538 The extension will ignore the file and use only the information in the URL.
542 This value tells the library that use of the file is required, to ignore
543 the information in the URL, and to search the file with the host only.
548 Pass a string containing the full path name to the file you want to use as .netrc
549 file. For the option to work, you have to set the \fBnetrc\fP option to
550 \fBrequired\fP. If this option is omitted, and \fBnetrc\fP is set, TclCurl
551 will attempt to find the a .netrc file in the current user's home directory.
555 Pass a string as parameter, which should be [username]:[password] to use for
556 the connection. Use \fB-httpauth\fP to decide authentication method.
558 When using NTLM, you can set domain by prepending it to the user name and
559 separating the domain and name with a forward (/) or backward slash (\\). Like
560 this: "domain/user:password" or "domain\\user:password". Some HTTP servers (on
561 Windows) support this style even for Basic authentication.
563 When using HTTP and \fB-followlocation\fP, TclCurl might perform several
564 requests to possibly different hosts. TclCurl will only send this user and
565 password information to hosts using the initial host name (unless
566 \fB-unrestrictedauth\fP is set), so if TclCurl follows locations to other
567 hosts it will not send the user and password to those. This is enforced to
568 prevent accidental information leakage.
572 Pass a string as parameter, which should be [username]:[password] to use for
573 the connection to the HTTP proxy.
577 Pass a string with the user name to use for the transfer. It sets the user name
578 to be used in protocol authentication. You should not use this option together
579 with the (older) \fB-userpwd\fP option.
581 In order to specify the password to be used in conjunction with the user name
582 use the \fB-password\fP option.
586 Pass a string with the password to use for the transfer.
588 It should be used in conjunction with the \fB-username\fP option.
592 Pass a string with the user name to use for the transfer while connecting to Proxy.
594 It should be used in same way as the \fB-proxyuserpwd\fP is used, except that it
595 allows the username to contain a colon, like in the following example:
596 "sip:user@example.com".
598 Note the \fB-proxyusername\fP option is an alternative way to set the user name
599 while connecting to Proxy. It doesn't make sense to use them together.
603 Pass a string with the password to use for the transfer while connecting to Proxy. It
604 is meant to use together with \fB-proxyusername\fP.
608 Set to the authentication method you want, the available ones are:
612 HTTP Basic authentication. This is the default choice, and the only
613 method that is in widespread use and supported virtually everywhere.
614 It sends the user name and password over the network in plain text,
615 easily captured by others.
619 HTTP Digest authentication. Digest authentication is a more secure
620 way to do authentication over public networks than the regular
621 old-fashioned Basic method.
625 HTTP Digest authentication with an IE flavor. TclCurl will use a special
626 "quirk" that IE is known to have used before version 7 and that some
627 servers require the client to use.
631 HTTP GSS-Negotiate authentication. The GSS-Negotiate method, also known as
632 plain "Negotiate",was designed by Microsoft and is used in their web
633 applications. It is primarily meant as a support for Kerberos5 authentication
634 but may be also used along with another authentication methods.
638 HTTP NTLM authentication. A proprietary protocol invented and used by Microsoft.
639 It uses a challenge-response and hash concept similar to Digest, to prevent the
640 password from being eavesdropped.
644 NTLM delegating to winbind helper. Authentication is performed by a separate
645 binary application that is executed when needed. The name of the application is
646 specified at libcurl's compile time but is typically /usr/bin/ntlm_auth.
648 Note that libcurl will fork when necessary to run the winbind application and kill
649 it when complete, calling waitpid() to await its exit when done. On POSIX operating
650 systems, killing the process will cause a SIGCHLD signal to be raised
651 (regardless of whether \fB-nosignal\fP is set). This behavior is subject to change
652 in future versions of libcurl.
656 TclCurl will automatically select the one it finds most secure.
660 It may use anything but basic, TclCurl will automaticly select the
661 one it finds most secure.
665 Use it to tell TclCurl which authentication method(s) you want it to use for TLS authentication.
670 TLS-SRP authentication. Secure Remote Password authentication for TLS is
671 defined in RFC 5054 and provides mutual authentication if both sides have a
672 shared secret. To use TLS-SRP, you must also set the
673 \fB-tlsauthusername\fP and \fB-tlsauthpassword\fP options.
675 You need to build libcurl with GnuTLS or OpenSSL with TLS-SRP support for this
681 Pass a string with the username to use for the TLS authentication method specified
682 with the \fB-tlsauthtype\fP option. Requires that the \fB-tlsauthpassword\fP option
687 Pass a string with the password to use for the TLS authentication method specified
688 with the \fB-tlsauthtype\fP option. Requires that the \fB-tlsauthusername\fP option
693 Use it to tell TclCurl which authentication method(s) you want it to use for
694 your proxy authentication. Note that for some methods, this will induce an
695 extra network round-trip. Set the actual name and password with the
696 \fBproxyuserpwd\fP option.
698 The methods are those listed above for the \fBhttpauth\fP option. As of this
699 writing, only Basic and NTLM work.
705 Pass an 1 parameter to enable this. When enabled, TclCurl will
706 automatically set the Referer: field in requests where it follows a Location:
711 Sets the contents of the Accept-Encoding: header sent in an HTTP
712 request, and enables decoding of a response when a Content-Encoding:
713 header is received. Three encodings are supported: \fIidentity\fP,
714 which does nothing, \fIdeflate\fP which requests the server to
715 compress its response using the zlib algorithm, and \fIgzip\fP which
716 requests the gzip algorithm. Use \fIall\fP to send an
717 Accept-Encoding: header containing all supported encodings.
719 This is a request, not an order; the server may or may not do it. This
720 option must be set or else any unsolicited
721 encoding done by the server is ignored. See the special file
722 lib/README.encoding in libcurl docs for details.
726 Adds a request for compressed Transfer Encoding in the outgoing HTTP
727 request. If the server supports this and so desires, it can respond with the
728 HTTP resonse sent using a compressed Transfer-Encoding that will be
729 automatically uncompressed by TclCurl on receival.
731 Transfer-Encoding differs slightly from the Content-Encoding you ask for with
732 \fB-encoding\fP in that a Transfer-Encoding is strictly meant to
733 be for the transfer and thus MUST be decoded before the data arrives in the
734 client. Traditionally, Transfer-Encoding has been much less used and supported
735 by both HTTP clients and HTTP servers.
739 An 1 tells the library to follow any
741 that the server sends as part of a HTTP header.
743 This means that the extension will re-send the same request on the new location
744 and follow new \fBLocation: headers\fP all the way until no more such headers are
745 returned. \fB-maxredirs\fP can be used to limit the number of redirects
748 Since 7.19.4, TclCurl can limit what protocols it will automatically follow.
749 The accepted protocols are set with \fB-redirprotocols\fP and it excludes the FILE
754 An 1 parameter tells the extension it can continue
755 to send authentication (user+password) when following
756 locations, even when hostname changed. Note that this
757 is meaningful only when setting \fB-followlocation\fP.
761 Sets the redirection limit. If that many redirections have been followed,
762 the next redirect will cause an error. This option only makes sense if the
763 \fB-followlocation\fP option is used at the same time. Setting the limit
764 to 0 will make libcurl refuse any redirect. Set it to -1 for an infinite
765 number of redirects (which is the default)
769 Controls how TclCurl acts on redirects after POSTs that get a 301 or 302 response back.
770 A "301" as parameter tells the TclCurl to respect RFC 2616/10.3.2 and not convert POST
771 requests into GET requests when following a 301 redirection. Passing a "302" makes
772 TclCurl maintain the request method after a 302 redirect. "all" is a convenience string
773 that activates both behaviours.
775 The non-RFC behaviour is ubiquitous in web browsers, so the extension does the conversion
776 by default to maintain consistency. However, a server may require a POST to remain a POST
777 after such a redirection.
779 This option is meaningful only when setting \fB-followlocation\fP
781 The option used to be known as \fB-post301\fP, which should still work but is know
786 An 1 parameter tells the extension to use HTTP PUT a file. The file to put
787 must be set with \fB-infile\fP and \fB-infilesize\fP.
789 This option is deprecated starting with version 0.12.1, you should use \fB-upload\fP.
791 This option does not limit how much data TclCurl will actually send, as that is
792 controlled entirely by what the read callback returns.
796 An 1 parameter tells the library to do a regular HTTP post. This is a
797 normal application/x-www-form-urlencoded kind, which is the most commonly used
798 one by HTML forms. See the \fB-postfields\fP option for how to specify the
799 data to post and \fB-postfieldsize\fP about how to set the data size.
801 Use the \fB-postfields\fP option to specify what data to post and \fB-postfieldsize\fP
802 to set the data size. Optionally, you can provide data to POST using the \fB-readproc\fP
805 You can override the default POST Content-Type: header by setting your own with
808 Using POST with HTTP 1.1 implies the use of a "Expect: 100-continue" header.
809 You can disable this header with \fB-httpheader\fP as usual.
811 If you use POST to a HTTP 1.1 server, you can send data without knowing the
812 size before starting the POST if you use chunked encoding. You enable this
813 by adding a header like "Transfer-Encoding: chunked" with \fB-httpheader\fP.
814 With HTTP 1.0 or without chunked transfer, you must specify the size in the
817 When setting \fBpost\fP to an 1 value, it will automatically set
820 NOTE: if you have issued a POST request and want to make a HEAD or GET instead, you must
821 explicitly pick the new request type using \fB-nobody\fP or \fB-httpget\fP or similar.
825 Pass a string as parameter, which should be the full data to post in a HTTP
826 POST operation. You must make sure that the data is formatted the way you
827 want the server to receive it. TclCurl will not convert or encode it for you.
828 Most web servers will assume this data to be url-encoded.
830 This is a normal application/x-www-form-urlencoded kind,
831 which is the most commonly used one by HTML forms.
833 If you want to do a zero-byte POST, you need to set
834 \fB-postfieldsize\fP explicitly to zero, as simply setting
835 \fB-postfields\fP to NULL or "" just effectively disables the sending
836 of the specified string. TclCurl will instead assume that the POST
837 data will be send using the read callback!
839 Using POST with HTTP 1.1 implies the use of a "Expect: 100-continue" header.
840 You can disable this header with \fB-httpheader\fP as usual.
842 \fBNote\fP: to make multipart/formdata posts (aka rfc1867-posts), check out
843 \fB-httppost\fP option.
847 If you want to post data to the server without letting TclCurl do a strlen()
848 to measure the data size, this option must be used. Also, when this option is
849 used, you can post fully binary data which otherwise is likely to fail. If
850 this size is set to zero, the library will use strlen() to get the data
855 Tells TclCurl you want a multipart/formdata HTTP POST to be made and you
856 instruct what data to pass on to the server through a
859 \fBThis is the only case where the data is reset after a transfer.\fP
861 First, there are some basics you need to understand about multipart/formdata
862 posts. Each part consists of at least a \fBNAME\fP and a \fBCONTENTS\fP part. If the part
863 is made for file upload, there are also a stored \fBCONTENT-TYPE\fP and a
864 \fBFILENAME\fP. Below, we'll discuss on what options you use to set these
865 properties in the parts you want to add to your post.
867 The list must contain a \fB'name'\fP tag with the name of the section followed
868 by a string with the name, there are three tags to indicate the value of
869 the section: \fB'value'\fP followed by a string with the data to post, \fB'file'\fP
870 followed by the name of the file to post and \fB'contenttype'\fP with the
871 type of the data (text/plain, image/jpg, ...), you can also indicate a \fIfalse\fP
872 file name with \fB'filename'\fP, this is useful in case the server checks if the given
873 file name is valid, for example, by testing if it starts with 'c:\\' as any real file
874 name does or if you want to include the full path of the file to post. You can also post
875 the content of a variable as if it were a file with the options \fB'bufferName'\fP and
876 \fB'buffer'\fP or use \fB'filecontent'\fP followed by a file name to read that file and
877 use the contents as data.
879 Should you need to specify extra headers for the form POST section, use
880 \fB'contentheader\fP' followed by a list with the headers to post.
882 Please see 'httpPost.tcl' and 'httpBufferPost.tcl' for examples.
884 If TclCurl can't set the data to post an error will be returned:
888 If the memory allocation fails.
891 If one option is given twice for one form.
894 If an empty string was given.
897 If an unknown option was used.
900 If the some form info is not complete (or error)
903 If an illegal option is used in an array.
906 TclCurl has no http support.
911 Pass a string as parameter. It will be used to set the
913 header in the http request sent to the remote server. This can be used to
914 fool servers or scripts. You can also set any custom header with
919 Pass a string as parameter. It will be used to set the
921 header in the http request sent to the remote server. This can be used to fool
922 servers or scripts. You can also set any custom header with
929 with the HTTP headers to pass to the server in your request.
930 If you add a header that is otherwise generated
931 and used by TclCurl internally, your added one will be used instead. If you
932 add a header with no contents as in 'Accept:', the internally used header will
933 just get disabled. Thus, using this option you can add new headers, replace
934 and remove internal headers.
936 The headers included in the linked list must not be CRLF-terminated, because
937 TclCurl adds CRLF after each header item. Failure to comply with this will
938 result in strange bugs because the server will most likely ignore part of the
939 headers you specified.
941 The first line in a request (containing the method, usually a GET or POST) is
942 not a header and cannot be replaced using this option. Only the lines
943 following the request-line are headers. Adding this method line in this list
944 of headers will only cause your request to send an invalid header.
946 \fBNOTE\fP:The most commonly replaced headers have "shortcuts" in the options:
947 .B cookie, useragent,
953 Pass a list of aliases to be treated as valid HTTP 200 responses. Some servers
954 respond with a custom header response line. For example, IceCast servers respond
955 with "ICY 200 OK". By including this string in your list of aliases, the
956 response will be treated as a valid HTTP header line such as "HTTP/1.0 200 OK".
958 \fBNOTE\fP:The alias itself is not parsed for any version strings. Before version
959 7.16.3, TclCurl used the value set by option \fBhttpversion\fP, but starting with
960 7.16.3 the protocol is assumed to match HTTP 1.0 when an alias matched.
964 Pass a string as parameter. It will be used to
965 set a cookie in the http request. The format of the string should be
966 '[NAME]=[CONTENTS];'. Where NAME is the cookie name and CONTENTS is
967 what the cookie should contain.
969 If you need to set mulitple cookies, you need to set them all using
970 a single option and thus you need to concatenate them all in one single string.
971 Set multiple cookies in one string like this: "name1=content1; name2=content2;"
974 This option sets the cookie header explictly in the outgoing request(s).
975 If multiple requests are done due to authentication, followed redirections or similar,
976 they will all get this cookie passed on.
978 Using this option multiple times will only make the latest string override
983 Pass a string as parameter. It should contain the name of your file holding
984 cookie data. The cookie data may be in netscape cookie data format or just
985 regular HTTP-style headers dumped to a file.
987 Given an empty or non-existing file, this option will enable cookies for this
988 curl handle, making it understand and parse received cookies and then use
989 matching cookies in future requests.
991 If you use this option multiple times, you add more files to read.
995 Pass a file name in which TclCurl will dump all internally known cookies
997 .B curlHandle cleanup
998 is called. If no cookies are known, no file will be created.
999 Specify "-" to have the cookies written to stdout.
1001 Using this option also enables cookies for this session, so if you, for
1002 example, follow a location it will make matching cookies get sent accordingly.
1004 TclCurl will not and cannot report an error for this. Using '\fBverbose\fP'
1005 will get a warning to display, but that is the only visible feedback you get
1006 about this possibly lethal situation.
1010 Pass an 1 to mark this as a new cookie "session". It will
1011 force TclCurl to ignore all cookies it is about to load that are "session
1012 cookies" from the previous session. By default, TclCurl always stores and
1013 loads all cookies, independent of whether they are session cookies are not.
1014 Session cookies are cookies without expiry date and they are meant to be
1015 alive and existing for this "session" only.
1019 Pass a string with a cookie. The cookie can be either in Netscape / Mozilla
1020 format or just regular HTTP-style header (Set-Cookie: ...) format. If the
1021 cookie engine was not enabled it will be enabled. Passing a
1022 magic string "ALL" will erase all known cookies while "FLUSH" will write
1023 all cookies known by TclCurl to the file specified by \fB-cookiejar\fP.
1027 If set to 1 forces the HTTP request to get back to GET, usable if
1028 POST, PUT or a custom request have been used previously with the
1031 When setting \fBhttpget\fP to 1, \fBnobody\fP will automatically be set to 0.
1035 Set to one of the values decribed below, they force TclCurl to use the
1036 specific http versions. It should only be used if you really MUST do
1037 that because of a silly remote server.
1041 We do not care about what version the library uses. TclCurl will use whatever
1045 Enforce HTTP 1.0 requests.
1048 Enforce HTTP 1.1 requests.
1052 .B -ignorecontentlength
1053 Ignore the Content-Length header. This is useful for Apache 1.x (and similar
1054 servers) which will report incorrect content length for files over 2
1055 gigabytes. If this option is used, TclCurl will not be able to accurately
1056 report progress, and will simply stop the download when the server ends the
1060 .B -httpcontentdecoding
1061 Set to zero to disable content decoding. If set to 1 it is enabled. Note however
1062 that TclCurl has no default content decoding but requires you to use \fBencoding\fP for that.
1065 .B -httptransferencoding
1066 Set to zero to disable transfer decoding, if set to 1 it is enabled (default). TclCurl does
1067 chunked transfer decoding by default unless this option is set to zero.
1073 Pass a string to specify the sender address in a mail when sending an SMTP mail with TclCurl.
1077 Pass a list of recipients to pass to the server in your SMTP mail request.
1079 Each recipient in SMTP lingo is specified with angle brackets (<>), but should you not use an
1080 angle bracket as first letter, TclCurl will assume you provide a single email address only and
1081 enclose that with angle brackets for you.
1088 Specify the block size to use for TFTP data transmission. Valid range as per RFC 2348 is 8-65464 bytes.
1089 The default of 512 bytes will be used if this option is not specified. The specified block size will
1090 only be used pending support by the remote server. If the server does not return an option acknowledgement
1091 or returns an option acknowledgement with no blksize, the default of 512 bytes will be used.
1097 Pass a string as parameter. It will be used to
1098 get the IP address to use for the ftp PORT instruction. The PORT instruction
1099 tells the remote server to connect to our specified IP address. The string may
1100 be a plain IP address, a host name, a network interface name (under unix) or
1101 just a '-' to let the library use your systems default IP address. Default FTP
1102 operations are passive, and thus will not use PORT.
1104 The address can be followed by a ':' to specify a port, optionally followed by a '-'
1105 o specify a port range. If the port specified is 0, the operating system will pick
1106 a free port. If a range is provided and all ports in the range are not available,
1107 libcurl will report CURLE_FTP_PORT_FAILED for the handle. Invalid port/range settings
1108 are ignored. IPv6 addresses followed by a port or portrange have to be in brackets.
1109 IPv6 addresses without port/range specifier can be in brackets.
1111 Examples with specified ports:
1113 eth0:0 192.168.1.2:32000-33000 curl.se:32123 [::1]:1234-4567
1115 You disable PORT again and go back to using the passive version by setting this option to
1120 Pass a \fBlist\fP list with the FTP or SFTP commands to pass to the server prior to your
1121 ftp request. This will be done before any other FTP commands are issued (even
1122 before the CWD command).If you do not want to transfer any files, set
1123 \fBnobody\fP to '1' and \fBheader\fP to '0'.
1125 Prefix the command with an asterisk (*) to make TclCurl continue even if the command
1126 fails as by default TclCurl will stop.
1128 Disable this operation again by setting an empty string to this option.
1130 Keep in mind the commands to send must be 'raw' ftp commands, for example, to
1131 create a directory you need to send \fBmkd Test\fP, not \fBmkdir Test\fP.
1133 Valid SFTP commands are: chgrp, chmod, chown, ln, mkdir, pwd, rename, rm,
1138 Pass a \fBlist\fP with the FTP commands to pass to the server after your
1139 ftp transfer request. If you do not want to transfer any files, set
1140 \fBnobody\fP to '1' and \fBheader\fP to '0'.
1144 Pass a \fBlist\fP of FTP or SFTP commands to pass to the server after the
1145 transfer type is set.
1149 A 1 tells the library to just list the names of files in a
1150 directory, instead of doing a full directory listing that would include file
1151 sizes, dates etc. It works with both FTP and SFTP urls.
1153 This causes an FTP NLST command to be sent. Beware that some FTP servers list
1154 only files in their response to NLST, they might not include subdirectories
1157 Setting this option to 1 also implies a directory listing even if the URL
1158 doesn't end with a slash, which otherwise is necessary.
1160 Do NOT use this option if you also use \fB-wildcardmatch\fP as it will
1161 effectively break that feature.
1165 A 1 parameter tells the extension to append to the remote file instead of
1166 overwriting it. This is only useful when uploading to a ftp site.
1170 Set to 1 to tell TclCurl to use the EPRT (and LPRT) command when doing
1171 active FTP downloads (which is enabled by '\fBftpport\fP'). Using EPRT means
1172 that it will first attempt to use EPRT and then LPRT before using PORT, if
1173 you pass zero to this option, it will not try using EPRT or LPRT, only plain PORT.
1177 Set to one to tell TclCurl to use the EPSV command when doing passive FTP
1178 downloads (which it always does by default). Using EPSV means that it will
1179 first attempt to use EPSV before using PASV, but if you pass a zero to this
1180 option, it will not try using EPSV, only plain PASV.
1185 Set to one to tell TclCurl to send a PRET command before PASV (and EPSV). Certain
1186 FTP servers, mainly drftpd, require this non-standard command for directory listings
1187 as well as up and downloads in PASV mode. Has no effect when using the active FTP
1191 .B -ftpcreatemissingdirs
1192 If set to 1, TclCurl will attempt to create any remote directory that it
1193 fails to CWD into. CWD is the command that changes working directory.
1195 This setting also applies to SFTP-connections. TclCurl will attempt to create
1196 the remote directory if it can't obtain a handle to the target-location. The
1197 creation will fail if a file of the same name as the directory to create
1198 already exists or lack of permissions prevents creation.
1200 If set to 2, TclCurl will retry the CWD command again if the subsequent MKD
1201 command fails. This is especially useful if you're doing many simultanoeus
1202 connections against the same server and they all have this option enabled,
1203 as then CWD may first fail but then another connection does MKD before this
1204 connection and thus MKD fails but trying CWD works
1207 .B -ftpresponsetimeout
1208 Causes TclCurl to set a timeout period (in seconds) on the amount of time that
1209 the server is allowed to take in order to generate a response message for a
1210 command before the session is considered hung. Note that while TclCurl is waiting
1211 for a response, this value overrides \fBtimeout\fP. It is recommended that if used
1212 in conjunction with \fBtimeout\fP, you set it to a value smaller than \fBtimeout\fP.
1215 .B -ftpalternativetouser
1216 Pass a string which will be used to authenticate if the usual FTP "USER user" and
1217 "PASS password" negotiation fails. This is currently only known to be required when
1218 connecting to Tumbleweed's Secure Transport FTPS server using client certificates for
1223 If set to 1, it instructs TclCurl not to use the IP address the
1224 server suggests in its 227-response to TclCurl's PASV command when TclCurl
1225 connects the data connection. Instead TclCurl will re-use the same IP address
1226 it already uses for the control connection. But it will use the port number
1227 from the 227-response.
1229 This option has no effect if PORT, EPRT or EPSV is used instead of PASV.
1234 Pass TclCurl one of the values from below, to alter how TclCurl issues
1235 "AUTH TLS" or "AUTH SSL" when FTP over SSL is activated (see \fB-ftpssl\fP).
1237 You may need this option because of servers like BSDFTPD-SSL from
1238 http://bsdftpd-ssl.sc.ru/ "which won't work properly when "AUTH SSL" is issued
1239 (although the server responds fine and everything) but requires "AUTH TLS"
1245 Allows TclCurl to decide.
1248 Try "AUTH SSL" first, and only if that fails try "AUTH TLS".
1251 Try "AUTH TLS" first, and only if that fails try "AUTH SSL".
1256 Set it to make TclCurl use CCC (Clear Command Channel). It shuts down the
1257 SSL/TLS layer after authenticating. The rest of the control channel
1258 communication will be unencrypted. This allows NAT routers to follow the
1259 FTP transaction. Possible values are:
1264 Do not attempt to use CCC.
1267 Do not initiate the shutdown, wait for the server to do it. Do not send a reply.
1270 Initiate the shutdown and wait for a reply.
1275 Pass string (or "" to disable). When an FTP server asks for "account data" after
1276 user name and password has been provided, this data is sent off using the ACCT
1281 It allows three values:
1285 The default, TclCurl will do a single CWD operation for each path part in the given
1286 URL. For deep hierarchies this means very many commands. This is how RFC1738 says it
1290 No CWD at all is done, TclCurl will do SIZE, RETR, STOR, etc and give a full path to
1294 Make one CWD with the full target directory and then operate on the file "normally".
1295 This is somewhat more standards compliant than 'nocwd' but without the full penalty of 'multicwd'.
1298 .SH Protocol options
1302 A 1 tells the extension to use ASCII mode for ftp transfers,
1303 instead of the default binary transfer. For win32 systems it does not set the
1304 stdout to binary mode. This option can be usable when transferring text data
1305 between systems with different views on certain characters, such as newlines
1308 \fBNOTE:\fP TclCurl does not do a complete ASCII conversion when doing ASCII
1309 transfers over FTP. This is a known limitation/flaw that nobody has
1310 rectified. TclCurl simply sets the mode to ascii and performs a standard
1314 .B -proxytransfermode
1315 If set to 1, TclCurl sets the transfer mode (binary or ASCII) for FTP transfers
1316 done via an HTTP proxy, by appending ;type=a or ;type=i to the URL.
1317 Without this setting, or it being set to 0, the default, \fB-transfertext\fP has
1318 no effect when doing FTP via a proxy. Beware that not all proxies support this feature.
1322 If set to '1', TclCurl converts Unix newlines to CRLF newlines on transfers. Disable
1323 this option again by setting the value to '0'.
1327 Pass a string as parameter, which should contain the specified range you
1328 want. It should be in the format
1330 , where X or Y may be left out. HTTP
1331 transfers also support several intervals, separated with commas as in
1333 Using this kind of multiple intervals will cause the HTTP server to send the
1334 response document in pieces (using standard MIME separation techniques).
1336 Ranges only work on HTTP, FTP and FILE transfers.
1340 Pass the offset in number of bytes that you want the transfer to start from.
1341 Set this option to 0 to make the transfer start from the beginning
1342 (effectively disabling resume).
1344 For FTP, set this option to -1 to make the transfer start from the end of the
1345 target file (useful to continue an interrupted upload).
1347 When doing uploads with FTP, the resume position is where in the local/source
1348 file TclCurl should try to resume the upload from and it will then append the
1349 source file to the remote target file.
1353 Pass a string as parameter. It will be used instead of GET or HEAD when doing
1354 the HTTP request. This is useful for doing DELETE or other more obscure HTTP
1355 requests. Do not do this at will, make sure your server supports the command first.
1357 Note that TclCurl will still act and assume the keyword it would use if you
1358 do not set your custom and it will act according to that. Thus, changing this
1359 to a HEAD when TclCurl otherwise would do a GET might cause TclCurl to act funny,
1360 and similar. To switch to a proper HEAD, use \fB-nobody\fP, to switch to a proper
1361 POST, use \fB-post\fP or \fB-postfields\fP and so on.
1365 If you pass a 1, TclCurl will attempt to get the
1366 modification date of the remote document in this operation. This requires that
1367 the remote server sends the time or replies to a time querying command. The
1368 getinfo procedure with the
1370 argument can be used after a transfer to extract the received time (if any).
1374 A 1 tells the library not to include the body-part in the
1375 output. This is only relevant for protocols that have a separate header and
1376 body part. On HTTP(S) servers, this will make TclCurl do a HEAD request.
1378 To change request to GET, you should use \fBhttpget\fP. Change request
1379 to POST with \fBpost\fP etc.
1383 When uploading a file to a remote site, this option should be used to tell
1384 TclCurl what the expected size of the infile is.
1386 This option is mandatory for uploading using SCP.
1390 A 1 tells the library to prepare for an upload. The
1391 \fB-infile\fP and \fB-infilesize\fP options are also interesting for uploads.
1392 If the protocol is HTTP, uploading means using the PUT request unless you tell
1395 Using PUT with HTTP 1.1 implies the use of a "Expect: 100-continue" header.
1396 You can disable this header with \fB-httpheader\fP as usual.
1398 If you use PUT to a HTTP 1.1 server, you can upload data without knowing the
1399 size before starting the transfer if you use chunked encoding. You enable this
1400 by adding a header like "Transfer-Encoding: chunked" with \fB-httpheader\fP.
1401 With HTTP 1.0 or without chunked transfer, you must specify the size.
1405 This allows you to specify the maximum size (in bytes) of a file to download.
1406 If the file requested is larger than this value, the transfer will not start
1407 and error 'filesize exceeded' (63) will be returned.
1409 NOTE: The file size is not always known prior to download, and for such files
1410 this option has no effect even if the file transfer ends up being larger than
1411 this given limit. This concerns both FTP and HTTP transfers.
1415 This defines how the \fBtimevalue\fP value is treated. You can set this
1416 parameter to \fBifmodsince\fP or \fBifunmodsince\fP. This feature applies to
1421 This should be the time in seconds since 1 jan 1970, and the time will be
1422 used in a condition as specified with \fBtimecondition\fP.
1425 .SH Connection options
1429 Pass the maximum time in seconds that you allow
1430 the TclCurl transfer operation to take. Do note that normally, name lookups
1431 may take a considerable time and that limiting the operation to less than a
1432 few minutes risks aborting perfectly normal operations. This option will
1433 cause libcurl to use the SIGALRM to enable time-outing system calls.
1435 In unix-like systems, this might cause signals to be used unless
1436 \fB-nosignal\fP is used.
1440 Like \fBtimeout\fP but takes a number of milliseconds instead. If libcurl is
1441 built to use the standard system name resolver, that part will still use
1442 full-second resolution for timeouts.
1446 Pass the speed in bytes per second that the transfer should be below during
1448 seconds for the extension to consider it too slow and abort.
1452 Pass the time in seconds that the transfer should be below the
1454 for the extension to consider it too slow and abort.
1458 Pass a speed in bytes per seconds. If an upload exceeds this speed on cumulative
1459 average during the transfer, the transfer will pause to keep the average rate less
1460 than or equal to the parameter value. Defaults to unlimited speed.
1464 Pass a speed in bytes per second. If a download exceeds this speed on cumulative
1465 average during the transfer, the transfer will pause to keep the average rate less
1466 than or equal to the parameter value. Defaults to unlimited speed.
1470 Sets the persistant connection cache size in all the protocols that support
1471 persistent conecctions. The set amount will be the maximum amount of simultaneous
1472 connections that TclCurl may cache in this easy handle. Default is 5, and there
1473 isn't much point in changing this value unless you are perfectly aware of how this
1474 work and changes TclCurl's behaviour.
1476 When reaching the maximum limit, TclCurl closes the oldest connection in the cache
1477 to prevent the number of open connections to increase.
1479 \fBNote\fP: if you have already performed transfers with this curl handle,
1482 than before may cause open connections to unnecessarily get closed.
1484 If you add this easy handle to a multi handle, this setting is not
1485 being acknowledged, instead you must configure the multi handle its own
1486 \fBmaxconnects\fP option.
1490 Maximum time in seconds that you allow the
1491 connection to the server to take. This only limits the connection phase, once
1492 it has connected, this option is of no more use. Set to zero to disable
1493 connection timeout (it will then only timeout on the internal timeouts).
1495 In unix-like systems, this might cause signals to be used unless
1496 \fB-nosignal\fP is set.
1499 .B -connecttimeoutms
1500 Like \fBconnecttimeout\fP but takes a number of milliseconds instead. If libcurl
1501 is built to use the standard system name resolver, that part will still use
1502 full-second resolution for timeouts.
1506 Allows an application to select what kind of IP addresses to use when
1507 resolving host names. This is only interesting when using host names
1508 that resolve addresses using more than one version of IP. The allowed
1513 Default, resolves addresses to all IP versions that your system allows.
1516 Resolve to ipv4 addresses.
1519 Resolve to ipv6 addresses.
1524 Pass a list of strings with host name resolve information to use for requests with
1527 Each single name resolve string should be written using the format
1528 HOST:PORT:ADDRESS where HOST is the name TclCurl will try to resolve, PORT is
1529 the port number of the service where TclCurl wants to connect to the HOST and
1530 ADDRESS is the numerical IP address. If libcurl is built to support IPv6,
1531 ADDRESS can be either IPv4 or IPv6 style addressing.
1533 This option effectively pre-populates the DNS cache with entries for the
1534 host+port pair so redirects and everything that operations against the
1535 HOST+PORT will instead use your provided ADDRESS.
1537 You can remove names from the DNS cache again, to stop providing these fake
1538 resolves, by including a string in the linked list that uses the format
1539 "-HOST:PORT". The host name must be prefixed with a dash, and the host name
1540 and port number must exactly match what was already added previously.
1544 Pass a one of the values from below to make TclCurl use your desired level of SSL for the transfer.
1545 This is for enabling SSL/TLS when you use FTP, SMTP, POP3, IMAP etc.
1547 You can use ftps:// URLs to explicitly switch on SSL/TSL for the control
1548 connection and the data connection.
1550 Alternatively you can set the option to one of these values:
1555 Do not attempt to use SSL
1558 Try using SSL, proceed anyway otherwise.
1561 Use SSL for the control conecction or fail with "use ssl failed" (64).
1564 Use SSL for all communication or fail with "use ssl failed" (64).
1567 .SH SSL and security options
1571 Pass a string as parameter. The string should be the file name of your certificate.
1572 The default format is "PEM" and can be changed with \fB-sslcerttype\fP.
1574 With NSS this is the nickname of the certificate you wish to authenticate with.
1575 If you want to use a file from the current directory, please precede it with the
1576 "./" prefix, in order to avoid confusion with a nickname.
1580 Pass a string as parameter. The string should be the format of your certificate.
1581 Supported formats are "PEM" and "DER".
1585 Pass a pointer to a zero terminated string as parameter. The string should be
1586 the file name of your private key. The default format is "PEM" and can be
1587 changed with \fB-sslkeytype\fP.
1591 Pass a pointer to a zero terminated string as parameter. The string should be
1592 the format of your private key. Supported formats are "PEM", "DER" and "ENG"
1594 \fBNOTE:\fPThe format "ENG" enables you to load the private key from a crypto
1595 engine. in this case \fB-sslkey\fP is used as an identifier passed to
1596 the engine. You have to set the crypto engine with \fB-sslengine\fP. The "DER"
1597 format key file currently does not work because of a bug in OpenSSL.
1601 Pass a string as parameter. It will be used as the password required to use the
1602 \fB-sslkey\fP or \fB-sshprivatekeyfile\fP private key.
1604 You never need a pass phrase to load a certificate but you need one to load you
1607 This option used to be known as \fB-sslkeypasswd\fP and \fB-sslcertpasswd\fP.
1611 Pass a string as parameter. It will be used as the identifier for the crypto
1612 engine you want to use for your private key.
1614 \fBNOTE:\fPIf the crypto device cannot be loaded, an error will be returned.
1617 .B -sslenginedefault
1618 Pass a 1 to set the actual crypto engine as the default for (asymmetric) crypto operations.
1620 \fBNOTE:\fPIf the crypto device cannot be set, an error will be returned.
1624 Use it to set what version of SSL/TLS to use. The available options are:
1628 The default action. This will attempt to figure out the remote SSL protocol version,
1629 i.e. either SSLv3 or TLSv1 (but not SSLv2, which became disabled by default with 7.18.1).
1643 This option determines whether TclCurl verifies the authenticity of the peer's certificate.
1644 A 1 means it verifies; zero means it doesn't. The default is 1.
1646 When negotiating an SSL connection, the server sends a certificate indicating its identity.
1647 TclCurl verifies whether the certificate is authentic, i.e. that you can trust that the
1648 server is who the certificate says it is. This trust is based on a chain of digital signatures,
1649 rooted in certification authority (CA) certificates you supply.
1651 TclCurl uses a default bundle of CA certificates that comes with libcurl but you can specify
1652 alternate certificates with the \fB-cainfo\fP or the \fB-capath\fP options.
1654 When \fB-sslverifypeer\fP is nonzero, and the verification fails to prove that the certificate
1655 is authentic, the connection fails. When the option is zero, the peer certificate verification
1656 succeeds regardless.
1658 Authenticating the certificate is not by itself very useful. You typically want to ensure
1659 that the server, as authentically identified by its certificate, is the server you mean to
1660 be talking to, use \fB-sslverifyhost\fP to control that. The check that the host name in
1661 the certificate is valid for the host name you're connecting to is done
1662 independently of this option.
1666 Pass a file naming holding the certificate to verify the peer with. This only
1667 makes sense when used in combination with the \fB-sslverifypeer\fP option, if
1668 it is set to zero \fB-cainfo\fP need not even indicate an accessible file.
1670 This option is by default set to the system path where libcurl's cacert bundle
1671 is assumed to be stored, as established at build time.
1673 When built against NSS this is the directory that the NSS certificate database
1678 Pass a string naming a file holding a CA certificate in PEM format. If the option
1679 is set, an additional check against the peer certificate is performed to verify
1680 the issuer is indeed the one associated with the certificate provided by the option.
1681 This additional check is useful in multi-level PKI where one need to enforce the peer
1682 certificate is from a specific branch of the tree.
1684 This option makes sense only when used in combination with the \fB-sslverifypeer\fP
1685 option. Otherwise, the result of the check is not considered as failure.
1689 Pass the directory holding multiple CA certificates to verify the peer with.
1690 If libcurl is built against OpenSSL, the certificate directory must be prepared
1691 using the openssl c_rehash utility.
1692 This only makes sense when used in combination with the \fB-sslverifypeer\fP
1693 option, if it is set to zero, \fB-capath\fP need not even indicate an accessible
1696 This option apparently does not work in Windows due to some limitation in openssl.
1698 This option is OpenSSL-specific and does nothing if libcurl is built to use GnuTLS.
1699 NSS-powered libcurl provides the option only for backward compatibility.
1703 Pass a string naming a file with the concatenation of CRL (in PEM format) to use in
1704 the certificate validation that occurs during the SSL exchange.
1706 When libcurl is built to use NSS or GnuTLS, there is no way to influence the use of
1707 CRL passed to help in the verification process. When built with OpenSSL support,
1708 X509_V_FLAG_CRL_CHECK and X509_V_FLAG_CRL_CHECK_ALL are both set, requiring CRL
1709 check against all the elements of the certificate chain if a CRL file is passed.
1711 This option makes sense only when used in combination with the \fB-sslverifypeer\fP
1714 A specific error code (CURLE_SSL_CRL_BADFILE) is defined with the option. It is returned
1715 when the SSL exchange fails because the CRL file cannot be loaded. A failure in certificate
1716 verification due to a revocation information found in the CRL does not trigger this specific
1721 This option determines whether TclCurl verifies that the server claims to be
1722 who you want it to be.
1724 When negotiating an SSL connection, the server sends a certificate
1725 indicating its identity.
1727 When \fB-sslverifyhost\fP is set to 2, that certificate must indicate
1728 that the server is the server to which you meant to connect, or the
1731 TclCurl considers the server the intended one when the Common Name field
1732 or a Subject Alternate Name field in the certificate matches the host
1733 name in the URL to which you told Curl to connect.
1735 When set to 1, the certificate must contain a Common Name field,
1736 but it does not matter what name it says. (This is not ordinarily a
1739 When the value is 0, the connection succeeds regardless of the names in
1742 The default value for this option is 2.
1744 This option controls the identity that the server \fIclaims\fP. The server
1745 could be lying. To control lying, see \fB-sslverifypeer\fP. If libcurl is built
1746 against NSS and \fB-verifypeer\fP is zero, \fB-verifyhost\fP is ignored.
1750 Set to '1' to enable TclCurl's certificate chain info gatherer. With this enabled, TclCurl
1751 (if built with OpenSSL) will extract lots of information and data about the certificates
1752 in the certificate chain used in the SSL connection. This data can then be to extracted
1753 after a transfer using the \fBgetinfo\fP command and its option \fBcertinfo\fP.
1757 Pass a file name. The file will be used to read from to seed the random engine
1758 for SSL. The more random the specified file is, the more secure the SSL
1763 Pass a path name to the Entropy Gathering Daemon socket. It will be used to seed
1764 the random engine for SSL.
1768 Pass a string holding the ciphers to use for the SSL connection. The list must
1769 consists of one or more cipher strings separated by colons. Commas or spaces
1770 are also acceptable separators but colons are normally used, , - and + can be
1773 For OpenSSL and GnuTLS valid examples of cipher lists include 'RC4-SHA', 'SHA1+DES',
1774 'TLSv1' and 'DEFAULT'. The default list is normally set when you compile OpenSSL.
1776 You will find more details about cipher lists on this URL:
1777 http://www.openssl.org/docs/apps/ciphers.html
1779 For NSS valid examples of cipher lists include 'rsa_rc4_128_md5', 'rsa_aes_128_sha',
1780 etc. With NSS you don't add/remove ciphers. If you use this option then all known
1781 ciphers are disabled and only those passed in are enabled.
1783 You'll find more details about the NSS cipher lists on this URL:
1784 http://directory.fedora.redhat.com/docs/mod_nss.html
1787 .B -sslsessionidcache
1788 Pass a 0 to disable TclCurl's use of SSL session-ID caching or a 1 to enable it.
1789 By default all transfers are done using the cache. While nothing ever
1790 should get hurt by attempting to reuse SSL session-IDs, there seem to be broken SSL
1791 implementations in the wild that may require you to disable this in order for you to
1796 Set the kerberos security level for FTP, this also enables kerberos awareness.
1797 This is a string, 'clear', 'safe', 'confidential' or 'private'. If the string
1798 is set but does not match one of these, 'private' will be used. Set the string
1799 to NULL to disable kerberos4. Set the string to "" to disable kerberos
1803 .B -gssapidelegation
1804 Set the option to 'flag' to allow unconditional GSSAPI credential delegation. The delegation
1805 is disabled by default since 7.21.7. Set the parameter to 'policyflag' to delegate only if
1806 the OK-AS-DELEGATE flag is set in the service ticket in case this feature is supported by the
1807 GSSAPI implementation and the definition of GSS_C_DELEG_POLICY_FLAG was available at compile-time.
1814 The allowed types are:
1827 To let TclCurl pick one
1831 .B -sshhostpublickeymd5
1832 Pass a string containing 32 hexadecimal digits. The string should be the 128
1833 bit MD5 cheksum of the remote host public key, and TclCurl will reject the
1834 connection to the host unless the md5sums match. This option is only for SCP
1839 Pass the file name for your public key. If not used, TclCurl defaults to using \fB$HOME/.ssh/id_dsa.pub\fP.
1840 HOME environment variable is set, and just \fBid_dsa\fP in the current directory if not.
1844 Pass the file name for your private key. If not used, TclCurl defaults to using \fB$HOME/.ssh/id_dsa.pub\fP.
1845 HOME environment variable is set, and just \fBid_dsa\fP in the current directory if not.
1846 If the file is password-protected, set the password with \fB-keypasswd\fP.
1850 Pass a string holding the file name of the known_host file to use. The known_hosts
1851 file should use the OpenSSH file format as supported by libssh2. If this file is
1852 specified, TclCurl will only accept connections with hosts that are known and present
1853 in that file, with a matching public key. Use \fB-sshkeyproc\fP to alter the default
1854 behavior on host and key (mis)matching.
1858 Pass a the name of the procedure that will be called when the known_host matching has
1859 been done, to allow the application to act and decide for TclCurl how to proceed. The
1860 callback will only be called if \fB-knownhosts\fP is also set.
1862 It gets passed a list with three elements, the first one is a list with the type of the
1863 key from the known_hosts file and the key itself, the second is another list with
1864 the type of the key from the remote site and the key itslef, the third tells you
1865 what TclCurl thinks about the matching status.
1867 The known key types are: "rsa", "rsa1" and "dss", in any other case "unknown" is given.
1869 TclCurl opinion about how they match may be: "match", "mismatch", "missing" or "error".
1871 The procedure must return:
1875 The host+key is accepted and TclCurl will append it to the known_hosts file before
1876 continuing with the connection. This will also add the host+key combo to the known_host
1877 pool kept in memory if it wasn't already present there. The adding of data to
1878 the file is done by completely replacing the file with a new copy, so the permissions of
1879 the file must allow this.
1882 The host+key is accepted, TclCurl will continue with the connection. This will also add
1883 the host+key combo to the known_host pool kept in memory if it wasn't already present
1887 The host+key is rejected. TclCurl will close the connection.
1890 The host+key is rejected, but the SSH connection is asked to be kept alive. This feature
1891 could be used when the app wants to somehow return back and act on the host+key situation
1892 and then retry without needing the overhead of setting it up from scratch again.
1895 Any other value will cause the connection to be closed.
1901 Name of the Tcl array variable where TclCurl will store the headers returned
1906 Name of the Tcl variable where TclCurl will store the file requested, the file
1907 may contain text or binary data.
1911 Name of a Tcl variable, in case you have defined a procedure to call with
1912 \fB-progressproc\fP setting this variable to '1' will cancel the transfer.
1916 Executes the given command after the transfer is done, since it only works
1917 with blocking transfers, it is pretty much useless.
1921 Pass a share handle as a parameter. The share handle must have been created by
1922 a previous call to \fBcurl::shareinit\fP. Setting this option, will make this
1923 handle use the data from the shared handle instead of keeping the data to itself.
1924 See \fItclcurl_share\fP for details.
1928 Pass a number as a parameter, containing the value of the permissions that will
1929 be assigned to newly created files on the remote server. The default value is 0644,
1930 but any valid value can be used. The only protocols that can use this are sftp://,
1934 .B -newdirectoryperms
1935 Pass a number as a parameter, containing the value of the permissions that will be
1936 assigned to newly created directories on the remote server. The default value is 0755,
1937 but any valid value can be used. The only protocols that can use this are sftp://, scp://
1944 Pass a list with variables to pass to the telnet negotiations. The variables should be in
1945 the format <option=value>. TclCurl supports the options 'TTYPE', 'XDISPLOC' and 'NEW_ENV'.
1946 See the TELNET standard for details.
1949 Some of the options libcurl offers are not supported, I don't think them
1950 worth supporting in TclCurl but if you need one of them don't forget to
1953 .B CURLOPT_FRESH_CONNECT, CURLOPT_FORBID_REUSE, CURLOPT_PRIVATE,
1954 .B CURLOPT_SSL_CTX_FUNCTION, CURLOPT_SSL_CTX_DATA, CURLOPT_SSL_CTX_FUNCTION and
1955 .B CURLOPT_CONNECT_ONLY, CURLOPT_OPENSOCKETFUNCTION, CURLOPT_OPENSOCKETDATA.
1957 .SH curlHandle perform
1958 This procedure is called after the
1962 calls are made, and will perform the transfer as described in the options.
1964 It must be called with the same
1965 \fIcurlHandle\fP \fBcurl::init\fP call returned.
1966 You can do any amount of calls to perform while using the same handle. If you
1967 intend to transfer more than one file, you are even encouraged to do
1968 so. TclCurl will then attempt to re-use the same connection for the following
1969 transfers, thus making the operations faster, less CPU intense and using less
1970 network resources. Just note that you will have to use
1972 between the invokes to set options for the following perform.
1974 You must never call this procedure simultaneously from two places using the
1975 same handle. Let it return first before invoking it another time. If
1976 you want parallel transfers, you must use several curl handles.
1979 '0' if all went well, non-zero if it didn't. In case of error, if the
1983 there will be a readable error message.
1984 The error codes are:
1986 Unsupported protocol. This build of TclCurl has no support for this protocol.
1988 Very early initialization code failed. This is likely to be and internal error
1989 or a resource problem where something fundamental couldn't get done at init time.
1991 URL malformat. The syntax was not correct.
1993 A requested feature, protocol or option was not found built-in in this libcurl
1994 due to a build-time decision. This means that a feature or option was not
1995 enabled or explicitly disabled when libcurl was built and in order to get it
1996 to function you have to get a rebuilt libcurl.
1998 Couldn't resolve proxy. The given proxy host could not be resolved.
2000 Couldn't resolve host. The given remote host was not resolved.
2002 Failed to connect to host or proxy.
2004 FTP weird server reply. The server sent data TclCurl couldn't parse.
2005 The given remote server is probably not an OK FTP server.
2007 We were denied access to the resource given in the URL. For FTP, this occurs
2008 while trying to change to the remote directory.
2010 FTP weird PASS reply. TclCurl couldn't parse the reply sent to the PASS request.
2012 FTP weird PASV reply, TclCurl couldn't parse the reply sent to the PASV or EPSV
2015 FTP weird 227 format. TclCurl couldn't parse the 227-line the server sent.
2017 FTP can't get host. Couldn't resolve the host IP we got in the 227-line.
2019 FTP couldn't set type. Couldn't change transfer method to either binary or
2022 Partial file. Only a part of the file was transfered, this happens when
2023 the server first reports an expected transfer size and then delivers data
2024 that doesn't match the given size.
2026 FTP couldn't RETR file, we either got a weird reply to a 'RETR' command or
2027 a zero byte transfer.
2029 Quote error. A custom 'QUOTE' returned error code 400 or higher (for FTP) or
2030 otherwise indicated unsuccessful completion of the command.
2032 HTTP returned error. This return code only appears if \fB-failonerror\fP is
2033 used and the HTTP server returns an error code that is 400 or higher.
2035 Write error. TclCurl couldn't write data to a local filesystem or an error
2036 was returned from a write callback.
2038 Failed upload failed. For FTP, the server typcially denied the STOR
2039 command. The error buffer usually contains the server's explanation to this.
2041 Read error. There was a problem reading from a local file or an error was returned
2042 from the read callback.
2044 Out of memory. A memory allocation request failed. This should never happen unless
2045 something weird is going on in your computer.
2047 Operation timeout. The specified time-out period was reached according to the
2050 The FTP PORT command failed, not all FTP servers support the PORT command,
2051 try doing a transfer using PASV instead!.
2053 FTP couldn't use REST. This command is used for resumed FTP transfers.
2055 Range error. The server doesn't support or accept range requests.
2057 HTTP post error. Internal post-request generation error.
2059 SSL connect error. The SSL handshaking failed, the error buffer may have
2060 a clue to the reason, could be certificates, passwords, ...
2062 The download could not be resumed because the specified offset was out of the
2065 A file given with FILE:// couldn't be read. Did you checked the permissions?
2067 LDAP cannot bind. LDAP bind operation failed.
2071 A required zlib function was not found.
2073 Aborted by callback. An application told TclCurl to abort the operation.
2075 Internal error. A function was called with a bad parameter.
2077 Interface error. A specified outgoing interface could not be used.
2079 Too many redirects. When following redirects, TclCurl hit the maximum amount, set
2080 your limit with --maxredirs
2082 An option passed to TclCurl is not recognized/known. Refer to the appropriate
2083 documentation. This is most likely a problem in the program that uses
2084 TclCurl. The error buffer might contain more specific information about which
2085 exact option it concerns.
2087 A telnet option string was illegally formatted.
2089 The remote peer's SSL certificate or SSH md5 fingerprint wasn't ok
2091 The server didn't reply anything, which here is considered an error.
2093 The specified crypto engine wasn't found.
2095 Failed setting the selected SSL crypto engine as default!
2097 Failed sending network data.
2099 Failure with receiving network data.
2101 Problem with the local client certificate.
2103 Couldn't use specified SSL cipher.
2105 Peer certificate cannot be authenticated with known CA certificates.
2107 Unrecognized transfer encoding.
2111 Maximum file size exceeded.
2115 Sending the data requires a rewind that failed, since TclCurl should
2116 take care of it for you, it means you found a bug.
2118 Failed to initialise ssl engine.
2120 Failed to login, user password or similar was not accepted.
2122 File not found on TFTP server.
2124 There is a permission problem with the TFTP request.
2126 The remote server has run out of space.
2128 Illegal TFTP operation.
2130 Unknown transfer ID.
2132 TFTP file already exists and will not be overwritten.
2134 No such user in the TFTP server and good behaving TFTP servers
2135 should never return this.
2137 Character conversion failed.
2139 Problem with reading the SSL CA cert (path? access rights?).
2141 Remote file not found
2143 Error from the SSH layer
2145 Failed to shut down the SSL connection
2147 Failed to load CRL file
2151 The FTP server does not understand the PRET command at all or does not support
2152 the given argument. Be careful when using \fB-customrequest\fP, a
2153 custom LIST command will be sent with PRET CMD before PASV as well.
2155 Mismatch of RTSP CSeq numbers.
2157 Mismatch of RTSP Session Identifiers.
2159 Unable to parse FTP file list (during FTP wildcard downloading).
2161 Chunk callback reported error.
2163 .SH curlHandle getinfo option
2164 Request internal information from the curl session with this procedure.
2165 This procedure is intended to get used *AFTER* a performed transfer,
2166 and can be relied upon only if the \fBperform\fP returns 0. Use
2167 this function AFTER a performed transfer if you want to get
2168 transfer-oriented data.
2170 The following information can be extracted:
2174 Returns the last used effective URL.
2178 Returns the last received HTTP or FTP code. This will be zero if no server
2179 response code has been received. Note that a proxy's CONNECT response should
2180 be read with \fBhttpconnectcode\fP and not this.
2184 Returns the last received proxy response code to a CONNECT request.
2188 Returns the remote time of the retrieved document (in number of seconds
2189 since 1 jan 1970 in the GMT/UTC time zone). If you get -1,
2190 it can be because of many reasons (unknown, the server hides it or the
2191 server doesn't support the command that tells document time etc) and the time
2192 of the document is unknown.
2194 In order for this to work you have to set the \fB-filetime\fP option before
2199 Returns the time, in seconds, it took from the start until the name resolving
2204 Returns the time, in seconds, it took from the start until the connect to the
2205 remote host (or proxy) was completed.
2209 Returns the time, in seconds, it took from the start until the SSL/SSH
2210 connect/handshake to the remote host was completed. This time is most often very
2211 near to the PRETRANSFER time, except for cases such as HTTP pippelining where the
2212 pretransfer time can be delayed due to waits in line for the pipeline and more.
2216 Returns the time, in seconds, it took from the start until the file transfer
2217 is just about to begin. This includes all pre-transfer commands and
2218 negotiations that are specific to the particular protocol(s) involved.
2221 .B starttransfertime
2222 Returns the time, in seconds, it took from the start until the first byte
2223 is just about to be transfered. This includes the \fBpretransfertime\fP,
2224 and also the time the server needs to calculate the result.
2228 Returns the total transaction time, in seconds, for the previous transfer,
2229 including name resolving, TCP connect etc.
2233 Returns the URL a redirect would take you to if you enable \fBfollowlocation\fP.
2234 This can come very handy if you think using the built-in libcurl redirect logic
2235 isn't good enough for you but you would still prefer to avoid implementing all
2236 the magic of figuring out the new URL.
2240 Returns the total time, in seconds, it took for all redirection steps
2241 including name lookup, connect, pretransfer and transfer before
2242 the final transaction was started, it returns the complete execution
2243 time for multiple redirections, so it returns zero if no redirections
2248 Returns the total number of redirections that were actually followed.
2252 Returns how many new connections TclCurl had to create to achieve the
2253 previous transfer (only the successful connects are counted). Combined
2254 with \fBredirectcount\fP you are able to know how many times TclCurl
2255 successfully reused existing connection(s) or not. See the Connection
2256 Options of \fBsetopt\fP to see how TclCurl tries to make persistent
2257 connections to save time.
2261 Returns the IP address of the most recent connection done with this handle.
2262 This string may be IPv6 if that's enabled.
2266 Returns the destination port of the most recent connection done with this handle.
2270 Returns the local (source) IP address of the most recent connection done
2271 with this handle. This string may be IPv6 if that's enabled.
2275 Returns the local (source) port of the most recent connection done with this handle.
2279 Returns the total amount of bytes that were uploaded.
2283 Returns the total amount of bytes that were downloaded. The amount is only
2284 for the latest transfer and will be reset again for each new transfer.
2288 Returns the average download speed, measured in bytes/second, for the complete download.
2292 Returns the average upload speed, measured in bytes/second, for the complete upload.
2296 Returns the total size in bytes of all the headers received.
2300 Returns the total size of the issued requests. This is so far only for HTTP
2301 requests. Note that this may be more than one request if followLocation is true.
2305 Returns the result of the certification verification that was requested
2306 (using the -sslverifypeer option to configure).
2310 Returns a \fBlist\fP of the OpenSSL crypto-engines supported. Note that engines are
2311 normally implemented in separate dynamic libraries. Hence not all the returned
2312 engines may be available at run-time.
2315 .B contentlengthdownload
2316 Returns the content-length of the download. This is the value read from the
2318 field. If the size isn't known, it returns -1.
2321 .B contentlengthupload
2322 Returns the specified size of the upload.
2326 Returns the content-type of the downloaded object. This is the value
2327 read from the Content-Type: field. If you get an empty string, it means
2328 the server didn't send a valid Content-Type header or that the protocol
2329 used doesn't support this.
2333 Returns a list with the authentication method(s) available.
2337 Returns a list with the authentication method(s) available for your
2338 proxy athentication.
2342 Returns the errno value from a connect failure. This value is only set on
2343 failure, it is no reset after a successfull operation.
2347 Returns a list of all cookies TclCurl knows (expired ones, too). If there
2348 are no cookies (cookies for the handle have not been enabled or simply
2349 none have been received) the list will be empty.
2353 Returns a string holding the path of the entry path. That is the initial path
2354 TclCurl ended up in when logging on to the remote FTP server. Returns an empty
2355 string if something is wrong.
2359 Returns list with information about the certificate chain, assuming you had the
2360 \fB-certinfo\fP option enabled when the previous request was done. The list
2361 first item reports how many certs it found and then you can extract info for each
2362 of those certs by following the list. The info chain is provided in a series of data
2363 in the format "name:content" where the content is for the specific named data.
2365 NOTE: this option is only available in libcurl built with OpenSSL support.
2369 Returns the number 1 if the condition provided in the previous request
2370 didn't match (see \fItimecondition\fP), you will get a zero if the condition
2373 .SH curlHandle cleanup
2374 This procedure must be the last one to call for a curl session. It is the
2377 procedure and must be called with the same
2379 as input as the curl::init call returned.
2380 This will effectively close all connections TclCurl has used and possibly
2381 has kept open until now. Don't call this procedure if you intend to transfer
2384 .SH curlHandle reset
2386 Re-initializes all options previously set on a specified handle to the
2389 This puts back the handle to the same state as it was in when it was just
2390 created with curl::init.
2392 It does not change the following information kept in the handle: live
2393 connections, the Session ID cache, the DNS cache, the cookies and shares.
2395 .SH curlHandle duphandle
2396 This procedure will return a new curl handle, a duplicate,
2397 using all the options previously set in the input curl handle.
2398 Both handles can subsequently be used independently and
2399 they must both be freed with
2401 The new handle will not inherit any state information,
2402 connections, SSL sessions or cookies.
2405 A new curl handle or an error message if the copy fails.
2407 .SH curlHandle pause
2408 You can use this command from within a progress callback procedure
2409 to pause the transfer.
2411 .SH curlHandle resume
2412 Resumes a transfer paused with \fBcurlhandle pause\fP
2415 In case you do not want to use persistant connections you can use this
2416 command, it takes the same arguments as the \fIcurlHandle\fP \fBconfigure\fP
2417 and will init, configure, perform and cleanup a connection for you.
2419 You can also get the \fIgetinfo\fP information by using \fI-infooption variable\fP
2420 pairs, after the transfer \fIvariable\fP will contain the value that would have
2421 been returned by \fI$curlHandle getinfo option\fP.
2424 The same error code \fBperform\fP would return.
2427 Returns a string with the version number of tclcurl, libcurl and some of
2428 its important components (like OpenSSL version).
2431 The string with the version info.
2433 .SH curl::escape url
2434 This procedure will convert the given input string to an URL encoded string and
2435 return that. All input characters that are not a-z,
2436 A-Z or 0-9 will be converted to their "URL escaped" version (%NN where NN is a
2437 two-digit hexadecimal number)
2440 The converted string.
2441 .SH curl::unescape url
2442 This procedure will convert the given URL encoded input string to a "plain
2443 string" and return that. All input characters that
2444 are URL encoded (%XX where XX is a two-digit hexadecimal number) will be
2445 converted to their plain text versions.
2448 The string unencoded.
2450 .SH curl::curlConfig option
2451 Returns some information about how you have
2457 Returns the directory root where you installed
2461 Returns a list containing particular main features the installed
2463 was built with. The list may include SSL, KRB4 or IPv6, do not
2464 assume any particular order.
2467 Outputs version information about the installed libcurl, in
2468 numerical mode. This outputs the version number, in hexadecimal,
2469 with 8 bits for each part; major, minor, patch. So that libcurl
2470 7.7.4 would appear as 070704 and libcurl 12.13.14 would appear as
2473 .SH curl::versioninfo option
2474 Returns information about various run-time features in TclCurl.
2476 Applications should use this information to judge if things are possible to do
2477 or not, instead of using compile-time checks, as dynamic/DLL libraries can be
2478 changed independent of applications.
2482 Returns the version of libcurl we are using.
2486 Retuns the version of libcurl we are using in hexadecimal with 8 bits for each
2487 part; major, minor, patch. So that libcurl 7.7.4 would appear as 070704 and
2488 libcurl 12.13.14 would appear as 0c0d0e... Note that the initial zero might be
2493 Returns a string with the host information as discovered by a configure
2494 script or set by the build environment.
2498 Returns a list with the features compiled into libcurl, the possible elements are:
2502 Libcurl was built with support for asynchronous name lookups, which allows
2503 more exact timeouts (even on Windows) and less blocking when using the multi
2507 Libcurl was built with support for character conversions.
2510 Libcurl was built with extra debug capabilities built-in. This is mainly of
2511 interest for libcurl hackers.
2514 Supports HTTP GSS-Negotiate.
2517 Supports IDNA, domain names with international letters.
2523 Supports kerberos4 (when using FTP).
2526 Libcurl was built with support for large files.
2529 Supports HTTP deflate using libz.
2535 Libcurl was built with support for SPNEGO authentication (Simple and Protected
2536 GSS-API Negotiation Mechanism, defined in RFC 2478)
2539 Supports SSL (HTTPS/FTPS)
2542 Libcurl was built with support for SSPI. This is only available on Windows and
2543 makes libcurl use Windows-provided functions for NTLM authentication. It also
2544 allows libcurl to use the current user and the current user's password without
2545 the app having to pass them on.
2548 Libcurl was built with support for TLS-SRP.
2550 Libcurl was built with support for NTLM delegation to a winbind helper.
2552 Do not assume any particular order.
2556 Returns a string with the OpenSSL version used, like OpenSSL/0.9.6b.
2560 Returns the numerical OpenSSL version value as defined by the OpenSSL project.
2561 If libcurl has no SSL support, this is 0.
2565 Returns a string, there is no numerical version, for example: 1.1.3.
2569 Lists what particular protocols the installed TclCurl was built to support.
2570 At the time of writing, this list may include HTTP, HTTPS, FTP, FTPS,
2571 FILE, TELNET, LDAP, DICT. Do not assume any particular order. The protocols
2572 will be listed using uppercase. There may be none, one or several protocols
2575 .SH curl::easystrerror errorCode
2576 This procedure returns a string describing the error code passed in the argument.
2579 .I curl, The art of HTTP scripting (at http://curl.haxx.se), RFC 2396,
projects / sven / tclcurl.git / blob