.\" You can view this file with:
.\" nroff -man [file]
.\" Adapted from libcurl docs by fandom@telefonica.net
-.TH TclCurl n "3 October 2011" "TclCurl 7.22.0 "TclCurl Easy Interface"
+.TH TclCurl 3 "3 October 2011" "TclCurl 7.22.0 "TclCurl Easy Interface"
.SH NAME
TclCurl: - get a URL with FTP, FTPS, HTTP, HTTPS, SCP, SFTP, TFTP, TELNET, DICT, FILE, LDAP,
LDAPS, IMAP, IMAPS, POP, POP3, SMTP, SMTPS and gopher syntax.
.sp
.IB curlhandle " reset"
.sp
-.IB curlHandle " duhandle"
+.IB curlHandle " duphandle"
.sp
.IB curlHandle " pause"
.sp
.I cleanup
when the operation is completed.
You should perform all your sequential file transfers using the same
-curlHandle. This enables TclCurl to use persistant connections when
+curlHandle. This enables TclCurl to use persistent connections when
possible.
.sp
.B RETURN VALUE
specific transfers to only be allowed to use a subset of them.
Accepted protocols are 'http', 'https', 'ftp', 'ftps', 'scp', 'sftp', 'telnet', 'ldap',
-'ldaps','dict', 'file','tftp', 'imap', 'imaps', 'pop', 'pop3', 'smtp', 'smtps', 'gopher'
+\&'ldaps', 'dict', 'file','tftp', 'imap', 'imaps', 'pop', 'pop3', 'smtp', 'smtps', 'gopher'
and 'all'.
.TP
.B -proxyport
Use this option to set the proxy port to use unless it is specified in
the proxy string by \fB-proxy\fP. If not specified, TclCurl will default
--to using port 1080 for proxies.
+to using port 1080 for proxies.
.TP
.B -proxytype
Pass the type of the proxy. Available options are 'http', 'http1.0', 'socks4', 'socks4a',
-'socks5' and 'socks5h', with the HTTP one being the default.
+\&'socks5' and 'socks5h', with the HTTP one being the default.
If you set it to \fIhttp1.0\fP, it will only affect how libcurl speaks to a proxy
when CONNECT is used. The HTTP version used for "regular" HTTP requests is instead
.TP
.B -dnscachetimeout
Pass the timeout in seconds. Name resolves will be kept in memory for this number
-of seconds. Set to '0' to completely disable caching, or '-1' to make the
+of seconds. Set to '0' to completely disable caching, or '\-1' to make the
cached entries remain forever. By default, TclCurl caches this info for 60 seconds.
The name resolve functions of various libc implementations don't re-read name
.TP
.B -buffersize
-Pass your prefered size for the receive buffer in TclCurl. The main point of this
+Pass your preferred size for the receive buffer in TclCurl. The main point of this
would be that the write callback gets called more often and with smaller chunks.
This is just treated as a request, not an order. You cannot be guaranteed to
actually get the given size.
.TP
.B anysafe
-It may use anything but basic, TclCurl will automaticly select the
+It may use anything but basic, TclCurl will automatically select the
one it finds most secure.
.RE
-.TP -tlsauthtype
+.TP
+.B -tlsauthtype
Use it to tell TclCurl which authentication method(s) you want it to use for TLS authentication.
.RS
.TP 5
Sets the redirection limit. If that many redirections have been followed,
the next redirect will cause an error. This option only makes sense if the
\fB-followlocation\fP option is used at the same time. Setting the limit
-to 0 will make libcurl refuse any redirect. Set it to -1 for an infinite
+to 0 will make libcurl refuse any redirect. Set it to \-1 for an infinite
number of redirects (which is the default)
.TP
.TP
.B -cookie
-Pass a string as parameter. It will be used to
-set a cookie in the http request. The format of the string should be
-'[NAME]=[CONTENTS];'. Where NAME is the cookie name and CONTENTS is
-what the cookie should contain.
+Pass a string as parameter.
+It will be used to set a cookie in the http request. The format of
+the string should be '[NAME]=[CONTENTS];'. Where NAME is the cookie
+name and CONTENTS is what the cookie should contain.
If you need to set mulitple cookies, you need to set them all using
a single option and thus you need to concatenate them all in one single string.
Set multiple cookies in one string like this: "name1=content1; name2=content2;"
etc.
-This option sets the cookie header explictly in the outgoing request(s).
+This option sets the cookie header explicitly in the outgoing request(s).
If multiple requests are done due to authentication, followed redirections or similar,
they will all get this cookie passed on.
Set this option to 0 to make the transfer start from the beginning
(effectively disabling resume).
-For FTP, set this option to -1 to make the transfer start from the end of the
+For FTP, set this option to \-1 to make the transfer start from the end of the
target file (useful to continue an interrupted upload).
When doing uploads with FTP, the resume position is where in the local/source
.TP
.B -maxconnects
-Sets the persistant connection cache size in all the protocols that support
+Sets the persistent connection cache size in all the protocols that support
persistent conecctions. The set amount will be the maximum amount of simultaneous
connections that TclCurl may cache in this easy handle. Default is 5, and there
isn't much point in changing this value unless you are perfectly aware of how this
You can remove names from the DNS cache again, to stop providing these fake
resolves, by including a string in the linked list that uses the format
-"-HOST:PORT". The host name must be prefixed with a dash, and the host name
+"\-HOST:PORT". The host name must be prefixed with a dash, and the host name
and port number must exactly match what was already added previously.
.TP
.TP
.B sslv3
Force SSLv3
+.TP
+.B tlsv1_0
+Force TLSv1.0
+.TP
+.B tlsv1_1
+Force TLSv1.1
+.TP
+.B tlsv1_2
+Force TLSv1.2
.RE
.TP
used as operators.
For OpenSSL and GnuTLS valid examples of cipher lists include 'RC4-SHA', 'SHA1+DES',
-'TLSv1' and 'DEFAULT'. The default list is normally set when you compile OpenSSL.
+\&'TLSv1' and 'DEFAULT'. The default list is normally set when you compile OpenSSL.
You will find more details about cipher lists on this URL:
http://www.openssl.org/docs/apps/ciphers.html
ciphers are disabled and only those passed in are enabled.
You'll find more details about the NSS cipher lists on this URL:
- http://directory.fedora.redhat.com/docs/mod_nss.html
+<http://directory.fedora.redhat.com/docs/mod_nss.html>
.TP
.B -sslsessionidcache
you want parallel transfers, you must use several curl handles.
.TP
.B RETURN VALUE
-'0' if all went well, non-zero if it didn't. In case of error, if the
+\&'0' if all went well, non-zero if it didn't. In case of error, if the
.I errorbuffer
was set with
.I configure
Interface error. A specified outgoing interface could not be used.
.IP 47
Too many redirects. When following redirects, TclCurl hit the maximum amount, set
-your limit with --maxredirs
+your limit with \-\-maxredirs
.IP 48
An option passed to TclCurl is not recognized/known. Refer to the appropriate
documentation. This is most likely a problem in the program that uses
.TP
.B filetime
Returns the remote time of the retrieved document (in number of seconds
-since 1 jan 1970 in the GMT/UTC time zone). If you get -1,
+since 1 jan 1970 in the GMT/UTC time zone). If you get \-1,
it can be because of many reasons (unknown, the server hides it or the
server doesn't support the command that tells document time etc) and the time
of the document is unknown.
.TP
.B sslverifyresult
Returns the result of the certification verification that was requested
-(using the -sslverifypeer option to configure).
+(using the \-sslverifypeer option to configure).
.TP
.B sslengines
.B contentlengthdownload
Returns the content-length of the download. This is the value read from the
.B Content-Length:
-field. If the size isn't known, it returns -1.
+field. If the size isn't known, it returns \-1.
.TP
.B contentlengthupload
Resumes a transfer paused with \fBcurlhandle pause\fP
.SH curl::transfer
-In case you do not want to use persistant connections you can use this
+In case you do not want to use persistent connections you can use this
command, it takes the same arguments as the \fIcurlHandle\fP \fBconfigure\fP
and will init, configure, perform and cleanup a connection for you.
projects / sven / tclcurl.git / blobdiff