← Back to branch summary

~ubuntu-branches/ubuntu/hardy/curl/hardy-updates

« back to all changes in this revision

Viewing changes to docs/libcurl/curl_easy_setopt.3

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2006-10-30 10:56:48 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20061030105648-uo8q8w9xklb40b4k
Tags: 7.15.5-1ubuntu1
* Merge from debian unstable. Remaining Ubuntu changes:
  - debian/control: Drop libdb4.2 build dependency.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libcurl/curl_easy_setopt.3
18
18
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19
19
.\" * KIND, either express or implied.
20
20
.\" *
21
 
.\" * $Id: curl_easy_setopt.3,v 1.149 2006-05-24 22:46:39 bagder Exp $
 
21
.\" * $Id: curl_easy_setopt.3,v 1.153 2006-08-02 09:33:32 bagder Exp $
22
22
.\" **************************************************************************
23
23
.\"
24
24
.TH curl_easy_setopt 3 "19 Apr 2006" "libcurl 7.15.4" "libcurl Manual"
169
169
.IP CURLOPT_PROGRESSFUNCTION
170
170
Function pointer that should match the \fIcurl_progress_callback\fP prototype
171
171
found in \fI<curl/curl.h>\fP. This function gets called by libcurl instead of
172
 
its internal equivalent with a frequent interval during data transfer (roughly
173
 
once per second).  Unknown/unused argument values pass to the callback will be
174
 
set to zero (like if you only download data, the upload size will remain
175
 
0). Returning a non-zero value from this callback will cause libcurl to abort
176
 
the transfer and return \fICURLE_ABORTED_BY_CALLBACK\fP.
 
172
its internal equivalent with a frequent interval during operation (roughly
 
173
once per second) no matter if data is being transfered or not.  Unknown/unused
 
174
argument values passed to the callback will be set to zero (like if you only
 
175
download data, the upload size will remain 0). Returning a non-zero value from
 
176
this callback will cause libcurl to abort the transfer and return
 
177
\fICURLE_ABORTED_BY_CALLBACK\fP.
177
178
 
178
179
If you transfer data with the multi interface, this function will not be
179
180
called during periods of idleness unless you call the appropriate libcurl
859
860
recommended that if used in conjunction with \fICURLOPT_TIMEOUT\fP, you set
860
861
\fICURLOPT_FTP_RESPONSE_TIMEOUT\fP to a value smaller than
861
862
\fICURLOPT_TIMEOUT\fP.  (Added in 7.10.8)
 
863
.IP CURLOPT_FTP_ALTERNATIVE_TO_USER
 
864
Pass a char * as parameter, pointing to a string which will be used to
 
865
authenticate if the usual FTP "USER user" and "PASS password" negotiation
 
866
fails. This is currently only known to be required when connecting to
 
867
Tumbleweed's Secure Transport FTPS server using client certificates for
 
868
authentication. (Added in 7.15.5)
862
869
.IP CURLOPT_FTP_SKIP_PASV_IP
863
870
Pass a long. If set to a non-zero value, it instructs libcurl to not use the
864
871
IP address the server suggests in its 227-response to libcurl's PASV command
1051
1058
Pass a long as parameter. It contains the time in seconds that the transfer
1052
1059
should be below the \fICURLOPT_LOW_SPEED_LIMIT\fP for the library to consider
1053
1060
it too slow and abort.
 
1061
.IP CURLOPT_MAX_SEND_SPEED_LARGE
 
1062
Pass a curl_off_t as parameter.  If an upload exceeds this speed on cumulative 
 
1063
average during the transfer, the transfer will pause to keep the average rate 
 
1064
less than or equal to the parameter value.  (default: 0, unlimited)
 
1065
.IP CURLOPT_MAX_RECV_SPEED_LARGE
 
1066
Pass a curl_off_t as parameter.  If an upload exceeds this speed on cumulative 
 
1067
average during the transfer, the transfer will pause to keep the average rate 
 
1068
less than or equal to the parameter value.  (default: 0, unlimited)
1054
1069
.IP CURLOPT_MAXCONNECTS
1055
1070
Pass a long. The set number will be the persistent connection cache size. The
1056
1071
set amount will be the maximum amount of simultaneously open connections that
1111
1126
.IP CURL_IPRESOLVE_V6
1112
1127
Resolve to ipv6 addresses.
1113
1128
.RE
1114
 
.SH CURLOPT_CONNECT_ONLY
 
1129
.IP CURLOPT_CONNECT_ONLY
1115
1130
Pass a long. A non-zero parameter tells the library to perform any required
1116
1131
proxy authentication and connection setup, but no data transfer.
1117
1132