generic-library/curl
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
cd6c13c2b3
curl/docs/libcurl/curl_easy_setopt.3

517 lines
22 KiB
Groff
Raw Normal View History

mention that the _LARGE options are added in 7.11.0, added a header to the file with the standard curl blurb
2004-01-07 08:20:08 +01:00
.\" **************************************************************************
.\" * _ _ ____ _
.\" * Project ___| | | | _ \| |
.\" * / __| | | | |_) | |
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
Updated copyright year for recent changes
2014-01-03 00:35:29 +01:00
.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
mention that the _LARGE options are added in 7.11.0, added a header to the file with the standard curl blurb
2004-01-07 08:20:08 +01:00
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
.\" * are also available at http://curl.haxx.se/docs/copyright.html.
.\" *
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
.\" * copies of the Software, and permit persons to whom the Software is
.\" * furnished to do so, under the terms of the COPYING file.
.\" *
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
.\" * KIND, either express or implied.
.\" *
.\" **************************************************************************
ripped out from ../ and put in its own directory now
2002-03-04 11:09:48 +01:00
.\"
curl_easy_setopt.3: fixed the error code for an unsupported option
2014-06-25 22:30:36 +02:00
.TH curl_easy_setopt 3 "25 Jun 2014" "libcurl 7.38.0" "libcurl Manual"
ripped out from ../ and put in its own directory now
2002-03-04 11:09:48 +01:00
.SH NAME
use the proper dash
2006-01-08 23:55:13 +01:00
curl_easy_setopt \- set options for a curl easy handle
ripped out from ../ and put in its own directory now
2002-03-04 11:09:48 +01:00
.SH SYNOPSIS
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLoption option, parameter);
.SH DESCRIPTION
docs: edited lots of libcurl docs for clarity
2014-10-21 10:26:40 +02:00
\fIcurl_easy_setopt(3)\fP is used to tell libcurl how to behave. By setting
the appropriate options, the application can change libcurl's behavior. All
options are set with an \fIoption\fP followed by a \fIparameter\fP. That
parameter can be a \fBlong\fP, a \fBfunction pointer\fP, an \fBobject
pointer\fP or a \fBcurl_off_t\fP, depending on what the specific option
expects. Read this manual carefully as bad input values may cause libcurl to
behave badly! You can only set one option in each function call. A typical
application uses many \fIcurl_easy_setopt(3)\fP calls in the setup phase.
ripped out from ../ and put in its own directory now
2002-03-04 11:09:48 +01:00
Peter Sylvester's CURLOPT_SSL_CTX_FUNCTION docs I reworded some of the intial paragraphs to avoid 'NOTE2'
2004-01-15 11:38:08 +01:00
Options set with this function call are valid for all forthcoming transfers
performed using this \fIhandle\fP. The options are not in any way reset
between transfers, so if you want subsequent transfers with different options,
mention the reset function
2004-08-17 14:37:35 +02:00
you must change them between the transfers. You can optionally reset all
options back to internal default with \fIcurl_easy_reset(3)\fP.
Peter Sylvester's CURLOPT_SSL_CTX_FUNCTION docs I reworded some of the intial paragraphs to avoid 'NOTE2'
2004-01-15 11:38:08 +01:00
Patrick Monnerat and I modified libcurl so that now it *copies* all strings passed to it with curl_easy_setopt()! Previously it has always just refered to the data, forcing the user to keep the data around until libcurl is done with it. That is now history and libcurl will instead clone the given strings and keep private copies.
2007-08-01 23:20:01 +02:00
Strings passed to libcurl as 'char *' arguments, are copied by the library;
thus the string storage associated to the pointer argument may be overwritten
docs: edited lots of libcurl docs for clarity
2014-10-21 10:26:40 +02:00
after \fIcurl_easy_setopt(3)\fP returns. The only exception to this rule is
really \fICURLOPT_POSTFIELDS(3)\fP, but the alternative that copies the string
lib man pages: update easy setopt option references ... by using the "\fIopt(3)\fP" syntax they will be linked properly when the web version of the page is generated.
2014-06-21 20:21:47 +02:00
\fICURLOPT_COPYPOSTFIELDS(3)\fP has some usage characteristics you need to
read up on.
Patrick Monnerat and I modified libcurl so that now it *copies* all strings passed to it with curl_easy_setopt()! Previously it has always just refered to the data, forcing the user to keep the data around until libcurl is done with it. That is now history and libcurl will instead clone the given strings and keep private copies.
2007-08-01 23:20:01 +02:00
keep lines shorter than 80 columns, and reduce/remove the use of the word 'note' in most description as it is mostly useless.
2010-01-22 10:19:10 +01:00
Before version 7.17.0, strings were not copied. Instead the user was forced
keep them available until libcurl no longer needed them.
ripped out from ../ and put in its own directory now
2002-03-04 11:09:48 +01:00
The \fIhandle\fP is the return code from a \fIcurl_easy_init(3)\fP or
\fIcurl_easy_duphandle(3)\fP call.
Re-ordered all the options to be more logically structured. Hopefully this will make this page more readable and easy to find things in!
2002-09-18 17:26:42 +02:00
.SH BEHAVIOR OPTIONS
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_VERBOSE
curl_easy_setopt.3: shorten shorten descriptions, mostly refer to the separate descriptions
2014-06-21 00:03:45 +02:00
Display verbose information. See \fICURLOPT_VERBOSE(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_HEADER
curl_easy_setopt.3: shorten shorten descriptions, mostly refer to the separate descriptions
2014-06-21 00:03:45 +02:00
Include the header in the body output. See \fICURLOPT_HEADER(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_NOPROGRESS
curl_easy_setopt.3: shorten shorten descriptions, mostly refer to the separate descriptions
2014-06-21 00:03:45 +02:00
Shut off the progress meter. See \fICURLOPT_NOPROGRESS(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_NOSIGNAL
curl_easy_setopt.3: shorten shorten descriptions, mostly refer to the separate descriptions
2014-06-21 00:03:45 +02:00
Do not install signal handlers. See \fICURLOPT_NOSIGNAL(3)\fP
FTP: WILDCARDMATCH/CHUNKING/FNMATCH added
2010-05-12 15:33:22 +02:00
.IP CURLOPT_WILDCARDMATCH
curl_easy_setopt.3: shorten shorten descriptions, mostly refer to the separate descriptions
2014-06-21 00:03:45 +02:00
Transfer multiple files according to a file name pattern. See \fICURLOPT_WILDCARDMATCH(3)\fP
Re-ordered all the options to be more logically structured. Hopefully this will make this page more readable and easy to find things in!
2002-09-18 17:26:42 +02:00
.SH CALLBACK OPTIONS
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_WRITEFUNCTION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Callback for writing data. See \fICURLOPT_WRITEFUNCTION(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_WRITEDATA
curl_easy_setopt.3: fixed some typos
2014-06-21 20:43:04 +02:00
Data pointer to pass to the write callback. See \fICURLOPT_WRITEDATA(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_READFUNCTION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Callback for reading data. See \fICURLOPT_READFUNCTION(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_READDATA
curl_easy_setopt.3: fixed some typos
2014-06-21 20:43:04 +02:00
Data pointer to pass to the read callback. See \fICURLOPT_READDATA(3)\fP
HTTP "auth done right". See lib/README.httpauth
2004-11-24 17:11:35 +01:00
.IP CURLOPT_IOCTLFUNCTION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Callback for I/O operations. See \fICURLOPT_IOCTLFUNCTION(3)\fP
HTTP "auth done right". See lib/README.httpauth
2004-11-24 17:11:35 +01:00
.IP CURLOPT_IOCTLDATA
curl_easy_setopt.3: Fixed lots of typos
2014-10-30 23:40:05 +01:00
Data pointer to pass to the I/O callback. See \fICURLOPT_IOCTLDATA(3)\fP
Georg Lippitsch brought CURLOPT_SEEKFUNCTION and CURLOPT_SEEKDATA to allow libcurl to seek in a given input stream. This is particularly important when doing upload resumes when there's already a huge part of the file present remotely. Before, and still if this callback isn't used, libcurl will read and through away the entire file up to the point to where the resuming begins (which of course can be a slow opereration depending on file size, I/O bandwidth and more). This new function will also be preferred to get used instead of the CURLOPT_IOCTLFUNCTION for seeking back in a stream when doing multi-stage HTTP auth with POST/PUT.
2008-01-10 11:30:19 +01:00
.IP CURLOPT_SEEKFUNCTION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Callback for seek operations. See \fICURLOPT_SEEKFUNCTION(3)\fP
Georg Lippitsch brought CURLOPT_SEEKFUNCTION and CURLOPT_SEEKDATA to allow libcurl to seek in a given input stream. This is particularly important when doing upload resumes when there's already a huge part of the file present remotely. Before, and still if this callback isn't used, libcurl will read and through away the entire file up to the point to where the resuming begins (which of course can be a slow opereration depending on file size, I/O bandwidth and more). This new function will also be preferred to get used instead of the CURLOPT_IOCTLFUNCTION for seeking back in a stream when doing multi-stage HTTP auth with POST/PUT.
2008-01-10 11:30:19 +01:00
.IP CURLOPT_SEEKDATA
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Data pointer to pass to the seek callback. See \fICURLOPT_SEEKDATA(3)\fP
David McCreedy added CURLOPT_SOCKOPTFUNCTION and CURLOPT_SOCKOPTDATA to allow applications to set their own socket options.
2006-08-29 16:39:33 +02:00
.IP CURLOPT_SOCKOPTFUNCTION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Callback for sockopt operations. See \fICURLOPT_SOCKOPTFUNCTION(3)\fP
David McCreedy added CURLOPT_SOCKOPTFUNCTION and CURLOPT_SOCKOPTDATA to allow applications to set their own socket options.
2006-08-29 16:39:33 +02:00
.IP CURLOPT_SOCKOPTDATA
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Data pointer to pass to the sockopt callback. See \fICURLOPT_SOCKOPTDATA(3)\fP
Alexey Pesternikov documented CURLOPT_OPENSOCKETDATA and CURLOPT_OPENSOCKETFUNCTION
2007-10-05 17:16:18 +02:00
.IP CURLOPT_OPENSOCKETFUNCTION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Callback for socket creation. See \fICURLOPT_OPENSOCKETFUNCTION(3)\fP
Alexey Pesternikov documented CURLOPT_OPENSOCKETDATA and CURLOPT_OPENSOCKETFUNCTION
2007-10-05 17:16:18 +02:00
.IP CURLOPT_OPENSOCKETDATA
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Data pointer to pass to the open socket callback. See \fICURLOPT_OPENSOCKETDATA(3)\fP
curl_easy_setopt.3: document CLOSESOCKET* options
2011-05-18 22:30:10 +02:00
.IP CURLOPT_CLOSESOCKETFUNCTION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Callback for closing socket. See \fICURLOPT_CLOSESOCKETFUNCTION(3)\fP
curl_easy_setopt.3: document CLOSESOCKET* options
2011-05-18 22:30:10 +02:00
.IP CURLOPT_CLOSESOCKETDATA
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Data pointer to pass to the close socket callback. See \fICURLOPT_CLOSESOCKETDATA(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_PROGRESSFUNCTION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
OBSOLETE callback for progress meter. See \fICURLOPT_PROGRESSFUNCTION(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_PROGRESSDATA
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Data pointer to pass to the progress meter callback. See \fICURLOPT_PROGRESSDATA(3)\fP
.IP CURLOPT_XFERINFOFUNCTION
Callback for progress meter. See \fICURLOPT_XFERINFOFUNCTION(3)\fP
CURLOPT_XFERINFOFUNCTION: introducing a new progress callback CURLOPT_XFERINFOFUNCTION is now the preferred progress callback function and CURLOPT_PROGRESSFUNCTION is considered deprecated. This new callback uses pure 'curl_off_t' arguments to pass on full resolution sizes. It otherwise retains the same characteristics: the same call rate, the same meanings for the arguments and the return code is used the same way. The progressfunc.c example is updated to show how to use the new callback for newer libcurls while supporting the older one if built with an older libcurl or even built with a newer libcurl while running with an older.
2013-06-15 14:57:01 +02:00
.IP CURLOPT_XFERINFODATA
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Data pointer to pass to the progress meter callback. See \fICURLOPT_XFERINFODATA(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_HEADERFUNCTION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Callback for writing received headers. See \fICURLOPT_HEADERFUNCTION(3)\fP
.IP CURLOPT_HEADERDATA
Data pointer to pass to the header callback. See \fICURLOPT_HEADERDATA(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_DEBUGFUNCTION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Callback for debug information. See \fICURLOPT_DEBUGFUNCTION(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_DEBUGDATA
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Data pointer to pass to the debug callback. See \fICURLOPT_DEBUGDATA(3)\fP
Peter Sylvester's CURLOPT_SSL_CTX_FUNCTION docs I reworded some of the intial paragraphs to avoid 'NOTE2'
2004-01-15 11:38:08 +01:00
.IP CURLOPT_SSL_CTX_FUNCTION
curl_easy_setopt.3: Fixed lots of typos
2014-10-30 23:40:05 +01:00
Callback for SSL context logic. See \fICURLOPT_SSL_CTX_FUNCTION(3)\fP
Peter Sylvester's CURLOPT_SSL_CTX_FUNCTION docs I reworded some of the intial paragraphs to avoid 'NOTE2'
2004-01-15 11:38:08 +01:00
.IP CURLOPT_SSL_CTX_DATA
curl_easy_setopt.3: Fixed lots of typos
2014-10-30 23:40:05 +01:00
Data pointer to pass to the SSL context callback. See \fICURLOPT_SSL_CTX_DATA(3)\fP
the new conversion stuff documented (mostly by David McCreedy)
2006-04-19 11:08:15 +02:00
.IP CURLOPT_CONV_TO_NETWORK_FUNCTION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Callback for code base conversion. See \fICURLOPT_CONV_TO_NETWORK_FUNCTION(3)\fP
the new conversion stuff documented (mostly by David McCreedy)
2006-04-19 11:08:15 +02:00
.IP CURLOPT_CONV_FROM_NETWORK_FUNCTION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Callback for code base conversion. See \fICURLOPT_CONV_FROM_NETWORK_FUNCTION(3)\fP
the new conversion stuff documented (mostly by David McCreedy)
2006-04-19 11:08:15 +02:00
.IP CURLOPT_CONV_FROM_UTF8_FUNCTION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Callback for code base conversion. See \fICURLOPT_CONV_FROM_UTF8_FUNCTION(3)\fP
s/RTPFUNCTION/INTERLEAVEFUNCTION/ s/RTPDATA/INTERLEAVEDATA/
2010-01-22 13:17:03 +01:00
.IP CURLOPT_INTERLEAVEFUNCTION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Callback for RTSP interleaved data. See \fICURLOPT_INTERLEAVEFUNCTION(3)\fP
s/RTPFUNCTION/INTERLEAVEFUNCTION/ s/RTPDATA/INTERLEAVEDATA/
2010-01-22 13:17:03 +01:00
.IP CURLOPT_INTERLEAVEDATA
curl_easy_setopt.3: Fixed lots of typos
2014-10-30 23:40:05 +01:00
Data pointer to pass to the RTSP interleave callback. See \fICURLOPT_INTERLEAVEDATA(3)\fP
FTP: WILDCARDMATCH/CHUNKING/FNMATCH added
2010-05-12 15:33:22 +02:00
.IP CURLOPT_CHUNK_BGN_FUNCTION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Callback for wildcard download start of chunk. See \fICURLOPT_CHUNK_BGN_FUNCTION(3)\fP
FTP: WILDCARDMATCH/CHUNKING/FNMATCH added
2010-05-12 15:33:22 +02:00
.IP CURLOPT_CHUNK_END_FUNCTION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Callback for wildcard download end of chunk. See \fICURLOPT_CHUNK_END_FUNCTION(3)\fP
FTP: WILDCARDMATCH/CHUNKING/FNMATCH added
2010-05-12 15:33:22 +02:00
.IP CURLOPT_CHUNK_DATA
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Data pointer to pass to the chunk callbacks. See \fICURLOPT_CHUNK_DATA(3)\fP
FTP: WILDCARDMATCH/CHUNKING/FNMATCH added
2010-05-12 15:33:22 +02:00
.IP CURLOPT_FNMATCH_FUNCTION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Callback for wildcard matching. See \fICURLOPT_FNMATCH_FUNCTION(3)\fP
ftp wildcard: a new option CURLOPT_FNMATCH_DATA
2010-05-16 02:49:08 +02:00
.IP CURLOPT_FNMATCH_DATA
curl_easy_setopt.3: Fixed lots of typos
2014-10-30 23:40:05 +01:00
Data pointer to pass to the wildcard matching callback. See \fICURLOPT_FNMATCH_DATA(3)\fP
Re-ordered all the options to be more logically structured. Hopefully this will make this page more readable and easy to find things in!
2002-09-18 17:26:42 +02:00
.SH ERROR OPTIONS
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_ERRORBUFFER
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Error message buffer. See \fICURLOPT_ERRORBUFFER(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_STDERR
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
stderr replacement stream. See \fICURLOPT_STDERR(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_FAILONERROR
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Fail on HTTP 4xx errors. \fICURLOPT_FAILONERROR(3)\fP
Re-ordered all the options to be more logically structured. Hopefully this will make this page more readable and easy to find things in!
2002-09-18 17:26:42 +02:00
.SH NETWORK OPTIONS
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_URL
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
URL to work on. See \fICURLOPT_URL(3)\fP
- David Kierznowski notified us about a security flaw (http://curl.haxx.se/docs/adv_20090303.html also known as CVE-2009-0037) in which previous libcurl versions (by design) can be tricked to access an arbitrary local/different file instead of a remote one when CURLOPT_FOLLOWLOCATION is enabled. This flaw is now fixed in this release together this the addition of two new setopt options for controlling this new behavior: o CURLOPT_REDIR_PROTOCOLS controls what protocols libcurl is allowed to follow to when CURLOPT_FOLLOWLOCATION is enabled. By default, this option excludes the FILE and SCP protocols and thus you nee to explicitly allow them in your app if you really want that behavior. o CURLOPT_PROTOCOLS controls what protocol(s) libcurl is allowed to fetch using the primary URL option. This is useful if you want to allow a user or other outsiders control what URL to pass to libcurl and yet not allow all protocols libcurl may have been built to support.
2009-03-03 00:05:31 +01:00
.IP CURLOPT_PROTOCOLS
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Allowed protocols. See \fICURLOPT_PROTOCOLS(3)\fP
- David Kierznowski notified us about a security flaw (http://curl.haxx.se/docs/adv_20090303.html also known as CVE-2009-0037) in which previous libcurl versions (by design) can be tricked to access an arbitrary local/different file instead of a remote one when CURLOPT_FOLLOWLOCATION is enabled. This flaw is now fixed in this release together this the addition of two new setopt options for controlling this new behavior: o CURLOPT_REDIR_PROTOCOLS controls what protocols libcurl is allowed to follow to when CURLOPT_FOLLOWLOCATION is enabled. By default, this option excludes the FILE and SCP protocols and thus you nee to explicitly allow them in your app if you really want that behavior. o CURLOPT_PROTOCOLS controls what protocol(s) libcurl is allowed to fetch using the primary URL option. This is useful if you want to allow a user or other outsiders control what URL to pass to libcurl and yet not allow all protocols libcurl may have been built to support.
2009-03-03 00:05:31 +01:00
.IP CURLOPT_REDIR_PROTOCOLS
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Protocols to allow redirects to. See \fICURLOPT_REDIR_PROTOCOLS(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_PROXY
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Proxy to use. See \fICURLOPT_PROXY(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_PROXYPORT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Proxy port to use. See \fICURLOPT_PROXYPORT(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_PROXYTYPE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Proxy type. See \fICURLOPT_PROXYTYPE(3)\fP
- Craig A West brought CURLOPT_NOPROXY and the corresponding --noproxy option. They basically offer the same thing the NO_PROXY environment variable only offered previously: list a set of host names that shall not use the proxy even if one is specified.
2009-01-26 00:26:25 +01:00
.IP CURLOPT_NOPROXY
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Filter out hosts from proxy use. \fICURLOPT_NOPROXY(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_HTTPPROXYTUNNEL
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Tunnel through the HTTP proxy. \fICURLOPT_HTTPPROXYTUNNEL(3)\fP
- Markus Moeller introduced two new options to libcurl: CURLOPT_SOCKS5_GSSAPI_SERVICE and CURLOPT_SOCKS5_GSSAPI_NEC to allow libcurl to do GSS-style authentication with SOCKS5 proxies. The curl tool got the options called --socks5-gssapi-service and --socks5-gssapi-nec to enable these.
2009-01-28 22:33:58 +01:00
.IP CURLOPT_SOCKS5_GSSAPI_SERVICE
curl_easy_setopt.3: Fixed lots of typos
2014-10-30 23:40:05 +01:00
Socks5 GSSAPI service name. \fICURLOPT_SOCKS5_GSSAPI_SERVICE(3)\fP
- Markus Moeller introduced two new options to libcurl: CURLOPT_SOCKS5_GSSAPI_SERVICE and CURLOPT_SOCKS5_GSSAPI_NEC to allow libcurl to do GSS-style authentication with SOCKS5 proxies. The curl tool got the options called --socks5-gssapi-service and --socks5-gssapi-nec to enable these.
2009-01-28 22:33:58 +01:00
.IP CURLOPT_SOCKS5_GSSAPI_NEC
curl_easy_setopt.3: Fixed lots of typos
2014-10-30 23:40:05 +01:00
Socks5 GSSAPI NEC mode. See \fICURLOPT_SOCKS5_GSSAPI_NEC(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_INTERFACE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Bind connection locally to this. See \fICURLOPT_INTERFACE(3)\fP
Added CURLOPT_LOCALPORT and CURLOPT_LOCALPORTRANGE to libcurl. Set with the curl tool with --local-port. Plain and simply set the range of ports to bind the local end of connections to. Implemented on to popular demand. Not extensively tested. Please let me know how it works.
2006-01-30 09:24:07 +01:00
.IP CURLOPT_LOCALPORT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Bind connection locally to this port. See \fICURLOPT_LOCALPORT(3)\fP
Added CURLOPT_LOCALPORT and CURLOPT_LOCALPORTRANGE to libcurl. Set with the curl tool with --local-port. Plain and simply set the range of ports to bind the local end of connections to. Implemented on to popular demand. Not extensively tested. Please let me know how it works.
2006-01-30 09:24:07 +01:00
.IP CURLOPT_LOCALPORTRANGE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Bind connection locally to port range. See \fICURLOPT_LOCALPORTRANGE(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_DNS_CACHE_TIMEOUT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Timeout for DNS cache. See \fICURLOPT_DNS_CACHE_TIMEOUT(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_DNS_USE_GLOBAL_CACHE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
OBSOLETE Enable global DNS cache. See \fICURLOPT_DNS_USE_GLOBAL_CACHE(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_BUFFERSIZE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Ask for smaller buffer size. See \fICURLOPT_BUFFERSIZE(3)\fP
Added a few options that were still not documented. Now I believe all options mentioned in the current curl/curl.h header file (that aren't marked as obsolete) are present.
2004-02-27 10:02:06 +01:00
.IP CURLOPT_PORT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Port number to connect to. See \fICURLOPT_PORT(3)\fP
tcp-nodelay patch by Joe Halpin
2004-03-25 14:37:18 +01:00
.IP CURLOPT_TCP_NODELAY
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Disable the Nagle algorithm. See \fICURLOPT_TCP_NODELAY(3)\fP
- Phil Blundell added the CURLOPT_SCOPE option, as well as adjusted the URL parser to allow numerical IPv6-addresses to be specified with the scope given, as per RFC4007 - with a percent letter that itself needs to be URL escaped. For example, for an address of fe80::1234%1 the HTTP URL is: "http://[fe80::1234%251]/"
2008-07-30 23:55:26 +02:00
.IP CURLOPT_ADDRESS_SCOPE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
IPv6 scope for local addresses. See \fICURLOPT_ADDRESS_SCOPE(3)\fP
add library support for tuning TCP_KEEPALIVE This adds three new options to control the behavior of TCP keepalives: - CURLOPT_TCP_KEEPALIVE: enable/disable probes - CURLOPT_TCP_KEEPIDLE: idle time before sending first probe - CURLOPT_TCP_KEEPINTVL: delay between successive probes While not all operating systems support the TCP_KEEPIDLE and TCP_KEEPINTVL knobs, the library will still allow these options to be set by clients, silently ignoring the values.
2012-01-24 02:28:06 +01:00
.IP CURLOPT_TCP_KEEPALIVE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Enable TCP keep-alive. See \fICURLOPT_TCP_KEEPALIVE(3)\fP
add library support for tuning TCP_KEEPALIVE This adds three new options to control the behavior of TCP keepalives: - CURLOPT_TCP_KEEPALIVE: enable/disable probes - CURLOPT_TCP_KEEPIDLE: idle time before sending first probe - CURLOPT_TCP_KEEPINTVL: delay between successive probes While not all operating systems support the TCP_KEEPIDLE and TCP_KEEPINTVL knobs, the library will still allow these options to be set by clients, silently ignoring the values.
2012-01-24 02:28:06 +01:00
.IP CURLOPT_TCP_KEEPIDLE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Idle time before sending keep-alive. See \fICURLOPT_TCP_KEEPIDLE(3)\fP
add library support for tuning TCP_KEEPALIVE This adds three new options to control the behavior of TCP keepalives: - CURLOPT_TCP_KEEPALIVE: enable/disable probes - CURLOPT_TCP_KEEPIDLE: idle time before sending first probe - CURLOPT_TCP_KEEPINTVL: delay between successive probes While not all operating systems support the TCP_KEEPIDLE and TCP_KEEPINTVL knobs, the library will still allow these options to be set by clients, silently ignoring the values.
2012-01-24 02:28:06 +01:00
.IP CURLOPT_TCP_KEEPINTVL
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Interval between keep-alive probes. See \fICURLOPT_TCP_KEEPINTVL(3)\fP
libcurl: add UNIX domain sockets support The ability to do HTTP requests over a UNIX domain socket has been requested before, in Apr 2008 [0][1] and Sep 2010 [2]. While a discussion happened, no patch seems to get through. I decided to give it a go since I need to test a nginx HTTP server which listens on a UNIX domain socket. One patch [3] seems to make it possible to use the CURLOPT_OPENSOCKETFUNCTION function to gain a UNIX domain socket. Another person wrote a Go program which can do HTTP over a UNIX socket for Docker[4] which uses a special URL scheme (though the name contains cURL, it has no relation to the cURL library). This patch considers support for UNIX domain sockets at the same level as HTTP proxies / IPv6, it acts as an intermediate socket provider and not as a separate protocol. Since this feature affects network operations, a new feature flag was added ("unix-sockets") with a corresponding CURL_VERSION_UNIX_SOCKETS macro. A new CURLOPT_UNIX_SOCKET_PATH option is added and documented. This option enables UNIX domain sockets support for all requests on the handle (replacing IP sockets and skipping proxies). A new configure option (--enable-unix-sockets) and CMake option (ENABLE_UNIX_SOCKETS) can disable this optional feature. Note that I deliberately did not mark this feature as advanced, this is a feature/component that should easily be available. [0]: http://curl.haxx.se/mail/lib-2008-04/0279.html [1]: http://daniel.haxx.se/blog/2008/04/14/http-over-unix-domain-sockets/ [2]: http://sourceforge.net/p/curl/feature-requests/53/ [3]: http://curl.haxx.se/mail/lib-2008-04/0361.html [4]: https://github.com/Soulou/curl-unix-socket Signed-off-by: Peter Wu <peter@lekensteyn.nl>
2014-11-27 23:59:25 +01:00
.IP CURLOPT_UNIX_SOCKET_PATH
Path to a UNIX domain socket. See \fICURLOPT_UNIX_SOCKET_PATH(3)\fP
Daniel Kouril's patch that adds HTTP negotiation support to libcurl was added.
2003-06-10 14:22:19 +02:00
.SH NAMES and PASSWORDS OPTIONS (Authentication)
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_NETRC
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Enable .netrc parsing. See \fICURLOPT_NETRC(3)\fP
Added CURLOPT_NETRC_FILE.
2003-11-11 15:30:43 +01:00
.IP CURLOPT_NETRC_FILE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
\&.netrc file name. See \fICURLOPT_NETRC_FILE(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_USERPWD
curl_easy_setopt.3: Fixed lots of typos
2014-10-30 23:40:05 +01:00
User name and password. See \fICURLOPT_USERPWD(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_PROXYUSERPWD
curl_easy_setopt.3: Fixed lots of typos
2014-10-30 23:40:05 +01:00
Proxy user name and password. See \fICURLOPT_PROXYUSERPWD(3)\fP
- Igor Novoseltsev brought a patch that introduced two new options to curl_easy_setopt: CURLOPT_USERNAME and CURLOPT_PASSWORD that sort of deprecates the good old CURLOPT_USERPWD since they allow applications to set the user name and password independently and perhaps more importantly allow both to contain colon(s) which CURLOPT_USERPWD doesn't fully support.
2008-10-08 12:39:43 +02:00
.IP CURLOPT_USERNAME
curl_easy_setopt.3: Fixed lots of typos
2014-10-30 23:40:05 +01:00
User name. See \fICURLOPT_USERNAME(3)\fP
- Igor Novoseltsev brought a patch that introduced two new options to curl_easy_setopt: CURLOPT_USERNAME and CURLOPT_PASSWORD that sort of deprecates the good old CURLOPT_USERPWD since they allow applications to set the user name and password independently and perhaps more importantly allow both to contain colon(s) which CURLOPT_USERPWD doesn't fully support.
2008-10-08 12:39:43 +02:00
.IP CURLOPT_PASSWORD
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Password. See \fICURLOPT_PASSWORD(3)\fP
login options: remove the ;[options] support from CURLOPT_USERPWD To avoid the regression when users pass in passwords containing semi- colons, we now drop the ability to set the login options with the same options. Support for login options in CURLOPT_USERPWD was added in 7.31.0. Test case 83 was modified to verify that colons and semi-colons can be used as part of the password when using -u (CURLOPT_USERPWD). Bug: http://curl.haxx.se/bug/view.cgi?id=1311 Reported-by: Petr Bahula Assisted-by: Steve Holme Signed-off-by: Daniel Stenberg <daniel@haxx.se>
2013-12-14 22:39:27 +01:00
.IP CURLOPT_LOGIN_OPTIONS
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Login options. See \fICURLOPT_LOGIN_OPTIONS(3)\fP
remove some spurious line-endings
2008-10-17 05:59:02 +02:00
.IP CURLOPT_PROXYUSERNAME
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Proxy user name. See \fICURLOPT_PROXYUSERNAME(3)\fP
remove some spurious line-endings
2008-10-17 05:59:02 +02:00
.IP CURLOPT_PROXYPASSWORD
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Proxy password. See \fICURLOPT_PROXYPASSWORD(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_HTTPAUTH
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
HTTP server authentication methods. See \fICURLOPT_HTTPAUTH(3)\fP
TLS-SRP: new options documented
2011-02-09 23:33:06 +01:00
.IP CURLOPT_TLSAUTH_USERNAME
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
TLS authentication user name. See \fICURLOPT_TLSAUTH_USERNAME(3)\fP
TLS-SRP: new options documented
2011-02-09 23:33:06 +01:00
.IP CURLOPT_TLSAUTH_PASSWORD
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
TLS authentication password. See \fICURLOPT_TLSAUTH_PASSWORD(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_PROXYAUTH
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
HTTP proxy authentication methods. See \fICURLOPT_PROXYAUTH(3)\fP
DOCS: Updated following the addition of CURLOPT_SASL_IR Documented the the option in curl_easy_setopt() and added it to symbols-in-versions.
2013-04-27 18:01:50 +02:00
.IP CURLOPT_SASL_IR
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Enable SASL initial response. See \fICURLOPT_SASL_IR(3)\fP
curl_easy_setopt: Fixed OAuth 2.0 Bearer option name Bug: http://curl.haxx.se/bug/view.cgi?id=1313 Reported-by: Viktor Szakáts
2013-12-19 23:40:56 +01:00
.IP CURLOPT_XOAUTH2_BEARER
curl_easy_setopt.3: Fixed lots of typos
2014-10-30 23:40:05 +01:00
OAuth2 bearer token. See \fICURLOPT_XOAUTH2_BEARER(3)\fP
Re-ordered all the options to be more logically structured. Hopefully this will make this page more readable and easy to find things in!
2002-09-18 17:26:42 +02:00
.SH HTTP OPTIONS
Added a few options that were still not documented. Now I believe all options mentioned in the current curl/curl.h header file (that aren't marked as obsolete) are present.
2004-02-27 10:02:06 +01:00
.IP CURLOPT_AUTOREFERER
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Automatically set Referer: header. See \fICURLOPT_AUTOREFERER(3)\fP
transfer-encoding: document the options The new libcurl and command line options are now described.
2011-04-14 22:59:34 +02:00
.IP CURLOPT_ACCEPT_ENCODING
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Accept-Encoding and automatic decompressing data. See \fICURLOPT_ACCEPT_ENCODING(3)\fP
transfer-encoding: document the options The new libcurl and command line options are now described.
2011-04-14 22:59:34 +02:00
.IP CURLOPT_TRANSFER_ENCODING
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Request Transfer-Encoding. See \fICURLOPT_TRANSFER_ENCODING(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_FOLLOWLOCATION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Follow HTTP redirects. See \fICURLOPT_FOLLOWLOCATION(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_UNRESTRICTED_AUTH
curl_easy_setopt.3: Fixed lots of typos
2014-10-30 23:40:05 +01:00
Do not restrict authentication to original host. \fICURLOPT_UNRESTRICTED_AUTH(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_MAXREDIRS
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Maximum number of redirects to follow. See \fICURLOPT_MAXREDIRS(3)\fP
CURLOPT_POST301 => CURLOPT_POSTREDIR
2008-10-16 23:02:38 +02:00
.IP CURLOPT_POSTREDIR
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
How to act on redirects after POST. See \fICURLOPT_POSTREDIR(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_PUT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Issue a HTTP PUT request. See \fICURLOPT_PUT(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_POST
curl_easy_setopt.3: fixed some typos
2014-06-21 20:43:04 +02:00
Issue a HTTP POST request. See \fICURLOPT_POST(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_POSTFIELDS
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Send a POST with this data. See \fICURLOPT_POSTFIELDS(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_POSTFIELDSIZE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
The POST data is this big. See \fICURLOPT_POSTFIELDSIZE(3)\fP
Added CURLOPT_POSTFIELDSIZE_LARGE to offer a large file version of the CURLOPT_POSTFIELDSIZE option to allow really big HTTP POSTs.
2004-03-12 09:55:47 +01:00
.IP CURLOPT_POSTFIELDSIZE_LARGE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
The POST data is this big. See \fICURLOPT_POSTFIELDSIZE_LARGE(3)\fP
Fix dynamic CURLOPT_POSTFIELDS bug: back to static. CURLOPT_COPYPOSTFIELDS option added for dynamic. Fix some OS400 features.
2007-10-15 20:32:01 +02:00
.IP CURLOPT_COPYPOSTFIELDS
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Send a POST with this data - and copy it. See \fICURLOPT_COPYPOSTFIELDS(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_HTTPPOST
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Multipart formpost HTTP POST. See \fICURLOPT_HTTPPOST(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_REFERER
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Referer: header. See \fICURLOPT_REFERER(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_USERAGENT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
User-Agent: header. See \fICURLOPT_USERAGENT(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_HTTPHEADER
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Custom HTTP headers. See \fICURLOPT_HTTPHEADER(3)\fP
CURLOPT_HEADEROPT: added Modified the logic so that CURLOPT_HEADEROPT now controls if PROXYHEADER is actually used or not.
2014-02-04 23:37:29 +01:00
.IP CURLOPT_HEADEROPT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Control custom headers. See \fICURLOPT_HEADEROPT(3)\fP
CURLOPT_PROXYHEADER: set headers for proxy-only Includes docs and new test cases: 1525, 1526 and 1527 Co-written-by: Vijay Panghal
2014-01-31 08:10:07 +01:00
.IP CURLOPT_PROXYHEADER
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Custom HTTP headers sent to proxy. See \fICURLOPT_PROXYHEADER(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_HTTP200ALIASES
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Alternative versions of 200 OK. See \fICURLOPT_HTTP200ALIASES(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_COOKIE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Cookie(s) to send. See \fICURLOPT_COOKIE(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_COOKIEFILE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
File to read cookies from. See \fICURLOPT_COOKIEFILE(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_COOKIEJAR
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
File to write cookies to. See \fICURLOPT_COOKIEJAR(3)\fP
Added a few options that were still not documented. Now I believe all options mentioned in the current curl/curl.h header file (that aren't marked as obsolete) are present.
2004-02-27 10:02:06 +01:00
.IP CURLOPT_COOKIESESSION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Start a new cookie session. See \fICURLOPT_COOKIESESSION(3)\fP
Peteris Krumins added CURLOPT_COOKIELIST and CURLINFO_COOKIELIST, which is a simple interface to extracting and setting cookies in libcurl's internal "cookie jar". See the new cookie_interface.c example code.
2005-07-28 00:17:14 +02:00
.IP CURLOPT_COOKIELIST
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Add or control cookies. See \fICURLOPT_COOKIELIST(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_HTTPGET
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Do a HTTP GET request. See \fICURLOPT_HTTPGET(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_HTTP_VERSION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
HTTP version to use. \fICURLOPT_HTTP_VERSION(3)\fP
Toby Peterson added CURLOPT_IGNORE_CONTENT_LENGTH to the library, accessible from the command line tool with --ignore-content-length. This will make it easier to download files from Apache 1.x (and similar) servers that are still having problems serving files larger than 2 or 4 GB. When this option is enabled, curl will simply have to wait for the server to close the connection to signal end of transfer. I wrote test case 269 that runs a simple test that this works.
2005-08-24 12:57:28 +02:00
.IP CURLOPT_IGNORE_CONTENT_LENGTH
curl_easy_setopt.3: CURLOPT_POSTFIELDS is the exception ... to the always-copy-char *-argument. And fix some minor mistakes.
2014-06-21 19:46:45 +02:00
Ignore Content-Length. See \fICURLOPT_IGNORE_CONTENT_LENGTH(3)\fP
- Shmulik Regev fixed so that the final CRLF of HTTP response headers are sent to the debug callback. - Shmulik Regev added CURLOPT_HTTP_CONTENT_DECODING and CURLOPT_HTTP_TRANSFER_DECODING that if set to zero will disable libcurl's internal decoding of content or transfer encoded content. This may be preferable in cases where you use libcurl for proxy purposes or similar. The command line tool got a --raw option to disable both at once.
2007-02-12 22:13:47 +01:00
.IP CURLOPT_HTTP_CONTENT_DECODING
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Disable Content decoding. See \fICURLOPT_HTTP_CONTENT_DECODING(3)\fP
- Shmulik Regev fixed so that the final CRLF of HTTP response headers are sent to the debug callback. - Shmulik Regev added CURLOPT_HTTP_CONTENT_DECODING and CURLOPT_HTTP_TRANSFER_DECODING that if set to zero will disable libcurl's internal decoding of content or transfer encoded content. This may be preferable in cases where you use libcurl for proxy purposes or similar. The command line tool got a --raw option to disable both at once.
2007-02-12 22:13:47 +01:00
.IP CURLOPT_HTTP_TRANSFER_DECODING
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Disable Transfer decoding. See \fICURLOPT_HTTP_TRANSFER_DECODING(3)\fP
transfer: make Expect: 100-continue timeout configurable. Replaced the #define CURL_TIMEOUT_EXPECT_100 in transfer.c with the CURLOPT_EXPECT_100_TIMEOUT_MS option to make the timeout configurable.
2014-02-13 10:49:27 +01:00
.IP CURLOPT_EXPECT_100_TIMEOUT_MS
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
100-continue timeout. See \fICURLOPT_EXPECT_100_TIMEOUT_MS(3)\fP
added descriptions for CURLOPT_MAIL_FROM and CURLOPT_MAIL_RCPT
2009-12-31 23:38:10 +01:00
.SH SMTP OPTIONS
.IP CURLOPT_MAIL_FROM
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Address of the sender. See \fICURLOPT_MAIL_FROM(3)\fP
added descriptions for CURLOPT_MAIL_FROM and CURLOPT_MAIL_RCPT
2009-12-31 23:38:10 +01:00
.IP CURLOPT_MAIL_RCPT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Address of the recipients. See \fICURLOPT_MAIL_RCPT(3)\fP
DOCS: Added information for CURLOPT_MAIL_AUTH. Added information relating to the new CURLOPT_MAIL_AUTH parameter and reworked CURLOPT_MAIL_FROM and CURLOPT_MAIL_RCPT to be a clearer. Fixed inconsistencies of "vocalisation of the abbreviation" versus "vocalisation of the first word" for all abbreviations. Corrected a typo in CURLOPT_NOPROXY.
2012-01-07 15:10:40 +01:00
.IP CURLOPT_MAIL_AUTH
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Authentication address. See \fICURLOPT_MAIL_AUTH(3)\fP
- Chad Monroe provided the new CURLOPT_TFTP_BLKSIZE option that allows an app to set desired block size to use for TFTP transfers instead of the default 512 bytes.
2009-01-26 23:43:06 +01:00
.SH TFTP OPTIONS
fixed CURLOPT_TFTP_BLKSIZE typo
2009-11-23 10:31:55 +01:00
.IP CURLOPT_TFTP_BLKSIZE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
TFTP block size. See \fICURLOPT_TFTP_BLKSIZE(3)\fP
Re-ordered all the options to be more logically structured. Hopefully this will make this page more readable and easy to find things in!
2002-09-18 17:26:42 +02:00
.SH FTP OPTIONS
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_FTPPORT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Use active FTP. See \fICURLOPT_FTPPORT(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_QUOTE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Commands to run before transfer. See \fICURLOPT_QUOTE(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_POSTQUOTE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Commands to run after transfer. See \fICURLOPT_POSTQUOTE(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_PREQUOTE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Commands to run just before transfer. See \fICURLOPT_PREQUOTE(3)\fP
Renamed several libcurl error codes and options to make them more general and allow reuse by multiple protocols. Several unused error codes were removed. In all cases, macros were added to preserve source (and binary) compatibility with the old names. These macros are subject to removal at a future date, but probably not before 2009. An application can be tested to see if it is using any obsolete code by compiling it with the CURL_NO_OLDIES macro defined. Documented some newer error codes in libcurl-error(3)
2007-08-30 22:34:57 +02:00
.IP CURLOPT_APPEND
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Append to remote file. See \fICURLOPT_APPEND(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_FTP_USE_EPRT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Use EPTR. See \fICURLOPT_FTP_USE_EPRT(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_FTP_USE_EPSV
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Use EPSV. See \fICURLOPT_FTP_USE_EPSV(3)\fP
- Ingmar Runge enhanced libcurl's FTP engine to support the PRET command. This command is a special "hack" used by the drftpd server, but even though it is a custom extension I've deemed it fine to add to libcurl since this server seems to survive and people keep using it and want libcurl to support it. The new libcurl option is named CURLOPT_FTP_USE_PRET, and it is also usable from the curl tool with --ftp-pret. Using this option on a server that doesn't support this command will make libcurl fail.
2010-01-01 15:44:44 +01:00
.IP CURLOPT_FTP_USE_PRET
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Use PRET. See \fICURLOPT_FTP_USE_PRET(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_FTP_CREATE_MISSING_DIRS
curl_easy_setopt.3: Fixed lots of typos
2014-10-30 23:40:05 +01:00
Create missing directories on the remote server. See \fICURLOPT_FTP_CREATE_MISSING_DIRS(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_FTP_RESPONSE_TIMEOUT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Timeout for FTP responses. See \fICURLOPT_FTP_RESPONSE_TIMEOUT(3)\fP
Dan Nelson added the CURLOPT_FTP_ALTERNATIVE_TO_USER libcurl option and curl tool option named --ftp-alternative-to-user. It provides a mean to send a particular command if the normal USER/PASS approach fails.
2006-07-26 00:45:21 +02:00
.IP CURLOPT_FTP_ALTERNATIVE_TO_USER
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Alternative to USER. See \fICURLOPT_FTP_ALTERNATIVE_TO_USER(3)\fP
Added FTP_SKIP_PASV_IP and --ftp-skip-pasv-ip
2005-09-04 07:16:06 +02:00
.IP CURLOPT_FTP_SKIP_PASV_IP
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Ignore the IP address in the PASV response. See \fICURLOPT_FTP_SKIP_PASV_IP(3)\fP
Added CURLOPT_FTPSSLAUTH
2004-09-16 23:45:16 +02:00
.IP CURLOPT_FTPSSLAUTH
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Control how to do TLS. See \fICURLOPT_FTPSSLAUTH(3)\fP
- Linus Nielsen Feltzing introduced the --ftp-ssl-ccc command line option to curl that uses the new CURLOPT_FTP_SSL_CCC option in libcurl. If enabled, it will make libcurl shutdown SSL/TLS after the authentication is done on a FTP-SSL operation.
2007-01-06 00:11:14 +01:00
.IP CURLOPT_FTP_SSL_CCC
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Back to non-TLS again after authentication. See \fICURLOPT_FTP_SSL_CCC(3)\fP
Ian Ford asked about support for the FTP command ACCT, and I discovered it is present in RFC959... so now (lib)curl supports it as well. --ftp-account and CURLOPT_FTP_ACCOUNT set the account string. (The server may ask for an account string after PASS have been sent away. The client responds with "ACCT [account string]".) Added test case 228 and 229 to verify the functionality. Updated the test FTP server to support ACCT somewhat.
2005-01-25 23:13:12 +01:00
.IP CURLOPT_FTP_ACCOUNT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Send ACCT command. See \fICURLOPT_FTP_ACCOUNT(3)\fP
--ftp-method and CURLOPT_FTP_FILEMETHOD are now documented and usable
2006-03-14 01:05:15 +01:00
.IP CURLOPT_FTP_FILEMETHOD
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Specify how to reach files. See \fICURLOPT_FTP_FILEMETHOD(3)\fP
Chris Conroy brought support for RTSP transfers, and with it comes 8(!) new libcurl options for controlling what to get and how to receive posssibly interleaved RTP data. Initial commit.
2010-01-21 14:58:30 +01:00
.SH RTSP OPTIONS
.IP CURLOPT_RTSP_REQUEST
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
RTSP request. See \fICURLOPT_RTSP_REQUEST(3)\fP
Chris Conroy brought support for RTSP transfers, and with it comes 8(!) new libcurl options for controlling what to get and how to receive posssibly interleaved RTP data. Initial commit.
2010-01-21 14:58:30 +01:00
.IP CURLOPT_RTSP_SESSION_ID
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
RTSP session-id. See \fICURLOPT_RTSP_SESSION_ID(3)\fP
Chris Conroy brought support for RTSP transfers, and with it comes 8(!) new libcurl options for controlling what to get and how to receive posssibly interleaved RTP data. Initial commit.
2010-01-21 14:58:30 +01:00
.IP CURLOPT_RTSP_STREAM_URI
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
RTSP stream URI. See \fICURLOPT_RTSP_STREAM_URI(3)\fP
Chris Conroy brought support for RTSP transfers, and with it comes 8(!) new libcurl options for controlling what to get and how to receive posssibly interleaved RTP data. Initial commit.
2010-01-21 14:58:30 +01:00
.IP CURLOPT_RTSP_TRANSPORT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
RTSP Transport: header. See \fICURLOPT_RTSP_TRANSPORT(3)\fP
Chris Conroy brought support for RTSP transfers, and with it comes 8(!) new libcurl options for controlling what to get and how to receive posssibly interleaved RTP data. Initial commit.
2010-01-21 14:58:30 +01:00
.IP CURLOPT_RTSP_CLIENT_CSEQ
curl_easy_setopt.3: fixed the error code for an unsupported option
2014-06-25 22:30:36 +02:00
Client CSEQ number. See \fICURLOPT_RTSP_CLIENT_CSEQ(3)\fP
Chris Conroy brought support for RTSP transfers, and with it comes 8(!) new libcurl options for controlling what to get and how to receive posssibly interleaved RTP data. Initial commit.
2010-01-21 14:58:30 +01:00
.IP CURLOPT_RTSP_SERVER_CSEQ
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
CSEQ number for RTSP Server->Client request. See \fICURLOPT_RTSP_SERVER_CSEQ(3)\fP
Re-ordered all the options to be more logically structured. Hopefully this will make this page more readable and easy to find things in!
2002-09-18 17:26:42 +02:00
.SH PROTOCOL OPTIONS
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_TRANSFERTEXT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Use text transfer. See \fICURLOPT_TRANSFERTEXT(3)\fP
Michal Marek introduced CURLOPT_PROXY_TRANSFER_MODE which is used to control the appending of the "type=" thing on FTP URLs when they are passed to a HTTP proxy. Some proxies just don't like that appending (which is done unconditionally in 7.17.1), and some proxies treat binary/ascii transfers better with the appending done!
2007-12-03 00:38:23 +01:00
.IP CURLOPT_PROXY_TRANSFER_MODE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Add transfer mode to URL over proxy. See \fICURLOPT_PROXY_TRANSFER_MODE(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_CRLF
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Convert newlines. See \fICURLOPT_CRLF(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_RANGE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Range requests. See \fICURLOPT_RANGE(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_RESUME_FROM
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Resume a transfer. See \fICURLOPT_RESUME_FROM(3)\fP
David J Meyer's large file support.
2004-01-05 23:29:29 +01:00
.IP CURLOPT_RESUME_FROM_LARGE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Resume a transfer. See \fICURLOPT_RESUME_FROM_LARGE(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_CUSTOMREQUEST
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Custom request/method. See \fICURLOPT_CUSTOMREQUEST(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_FILETIME
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Request file modification date and time. See \fICURLOPT_FILETIME(3)\fP
curl_easy_setopt.3: Moved CURLOPT_DIRLISTONLY into PROTOCOL OPTIONS ...as this option affects more that just FTP.
2014-10-30 19:22:25 +01:00
.IP CURLOPT_DIRLISTONLY
List only. See \fICURLOPT_DIRLISTONLY(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_NOBODY
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Do not get the body contents. See \fICURLOPT_NOBODY(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_INFILESIZE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Size of file to send. \fICURLOPT_INFILESIZE(3)\fP
David J Meyer's large file support.
2004-01-05 23:29:29 +01:00
.IP CURLOPT_INFILESIZE_LARGE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Size of file to send. \fICURLOPT_INFILESIZE_LARGE(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_UPLOAD
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Upload data. See \fICURLOPT_UPLOAD(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_MAXFILESIZE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Maximum file size to get. See \fICURLOPT_MAXFILESIZE(3)\fP
David J Meyer's large file support.
2004-01-05 23:29:29 +01:00
.IP CURLOPT_MAXFILESIZE_LARGE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Maximum file size to get. See \fICURLOPT_MAXFILESIZE_LARGE(3)\fP
Dominick Meglio's update
2004-02-09 14:51:52 +01:00
.IP CURLOPT_TIMECONDITION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Make a time conditional request. See \fICURLOPT_TIMECONDITION(3)\fP
Dominick Meglio's update
2004-02-09 14:51:52 +01:00
.IP CURLOPT_TIMEVALUE
curl_easy_setopt.3: fixed some typos
2014-06-21 20:43:04 +02:00
Time value for the time conditional request. See \fICURLOPT_TIMEVALUE(3)\fP
Re-ordered all the options to be more logically structured. Hopefully this will make this page more readable and easy to find things in!
2002-09-18 17:26:42 +02:00
.SH CONNECTION OPTIONS
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_TIMEOUT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Timeout for the entire request. See \fICURLOPT_TIMEOUT(3)\fP
- Michael Wallner provided a patch that adds support for CURLOPT_TIMEOUT_MS and CURLOPT_CONNECTTIMEOUT_MS that, as their names should hint, do the timeouts with millisecond resolution instead. The only restriction to that is the alarm() (sometimes) used to abort name resolves as that uses full seconds. I fixed the FTP response timeout part of the patch. Internally we now count and keep the timeouts in milliseconds but it also means we multiply set timeouts with 1000. The effect of this is that no timeout can be set to more than 2^31 milliseconds (on 32 bit systems), which equals 24.86 days. We probably couldn't before either since the code did *1000 on the timeout values on several places already.
2007-02-05 23:51:32 +01:00
.IP CURLOPT_TIMEOUT_MS
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Millisecond timeout for the entire request. See \fICURLOPT_TIMEOUT_MS(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_LOW_SPEED_LIMIT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Low speed limit to abort transfer. See \fICURLOPT_LOW_SPEED_LIMIT(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_LOW_SPEED_TIME
curl_easy_setopt.3: fixed some typos
2014-06-21 20:43:04 +02:00
Time to be below the speed to trigger low speed abort. See \fICURLOPT_LOW_SPEED_TIME(3)\fP
Peter Silva introduced CURLOPT_MAX_SEND_SPEED_LARGE and CURLOPT_MAX_RECV_SPEED_LARGE that limit tha maximum rate libcurl is allowed to send or receive data. This kind of adds the the command line tool's option --limit-rate to the library. The rate limiting logic in the curl app is now removed and is instead provided by libcurl itself. Transfer rate limiting will now also work for -d and -F, which it didn't before.
2006-06-22 23:36:53 +02:00
.IP CURLOPT_MAX_SEND_SPEED_LARGE
curl_easy_setopt.3: Fixed lots of typos
2014-10-30 23:40:05 +01:00
Cap the upload speed to this. See \fICURLOPT_MAX_SEND_SPEED_LARGE(3)\fP
Peter Silva introduced CURLOPT_MAX_SEND_SPEED_LARGE and CURLOPT_MAX_RECV_SPEED_LARGE that limit tha maximum rate libcurl is allowed to send or receive data. This kind of adds the the command line tool's option --limit-rate to the library. The rate limiting logic in the curl app is now removed and is instead provided by libcurl itself. Transfer rate limiting will now also work for -d and -F, which it didn't before.
2006-06-22 23:36:53 +02:00
.IP CURLOPT_MAX_RECV_SPEED_LARGE
curl_easy_setopt.3: Fixed lots of typos
2014-10-30 23:40:05 +01:00
Cap the download speed to this. See \fICURLOPT_MAX_RECV_SPEED_LARGE(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_MAXCONNECTS
CURLOPT_MAXCONNECTS.3: Reworked the description to be less confusing ...and corrected a related typo in curl_easy_setopt.3.
2014-11-02 11:26:21 +01:00
Maximum number of connections in the connection pool. See \fICURLOPT_MAXCONNECTS(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_FRESH_CONNECT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Use a new connection. \fICURLOPT_FRESH_CONNECT(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_FORBID_REUSE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Prevent subsequent connections from re-using this. See \fICURLOPT_FORBID_REUSE(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_CONNECTTIMEOUT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Timeout for the connection phase. See \fICURLOPT_CONNECTTIMEOUT(3)\fP
- Michael Wallner provided a patch that adds support for CURLOPT_TIMEOUT_MS and CURLOPT_CONNECTTIMEOUT_MS that, as their names should hint, do the timeouts with millisecond resolution instead. The only restriction to that is the alarm() (sometimes) used to abort name resolves as that uses full seconds. I fixed the FTP response timeout part of the patch. Internally we now count and keep the timeouts in milliseconds but it also means we multiply set timeouts with 1000. The effect of this is that no timeout can be set to more than 2^31 milliseconds (on 32 bit systems), which equals 24.86 days. We probably couldn't before either since the code did *1000 on the timeout values on several places already.
2007-02-05 23:51:32 +01:00
.IP CURLOPT_CONNECTTIMEOUT_MS
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Millisecond timeout for the connection phase. See \fICURLOPT_CONNECTTIMEOUT_MS(3)\fP
Andrs Garca added CURLOPT_IPRESOLVE
2003-12-22 11:53:55 +01:00
.IP CURLOPT_IPRESOLVE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
IP version to resolve to. See \fICURLOPT_IPRESOLVE(3)\fP
bad syntax
2006-06-20 09:03:29 +02:00
.IP CURLOPT_CONNECT_ONLY
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Only connect, nothing else. See \fICURLOPT_CONNECT_ONLY(3)\fP
CURLOPT_USE_SSL: move from FTP options to connection options
2010-11-08 09:46:48 +01:00
.IP CURLOPT_USE_SSL
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Use TLS/SSL. See \fICURLOPT_USE_SSL(3)\fP
CURLOPT_RESOLVE: documented
2010-11-08 09:53:35 +01:00
.IP CURLOPT_RESOLVE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Provide fixed/fake name resolves. See \fICURLOPT_RESOLVE(3)\fP
libcurl: New options to bind DNS to local interfaces or IP addresses
2013-09-07 18:45:50 +02:00
.IP CURLOPT_DNS_INTERFACE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Bind name resolves to this interface. See \fICURLOPT_DNS_INTERFACE(3)\fP
libcurl: New options to bind DNS to local interfaces or IP addresses
2013-09-07 18:45:50 +02:00
.IP CURLOPT_DNS_LOCAL_IP4
curl_easy_setopt.3: fixed some typos
2014-06-21 20:43:04 +02:00
Bind name resolves to this IP4 address. See \fICURLOPT_DNS_LOCAL_IP4(3)\fP
libcurl: New options to bind DNS to local interfaces or IP addresses
2013-09-07 18:45:50 +02:00
.IP CURLOPT_DNS_LOCAL_IP6
curl_easy_setopt.3: fixed some typos
2014-06-21 20:43:04 +02:00
Bind name resolves to this IP6 address. See \fICURLOPT_DNS_LOCAL_IP6(3)\fP
CURLOPT_ACCEPTTIMEOUT_MS: spellfix
2012-01-22 00:00:55 +01:00
.IP CURLOPT_ACCEPTTIMEOUT_MS
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Timeout for waiting for the server's connect back to be accepted. See \fICURLOPT_ACCEPTTIMEOUT_MS(3)\fP
Re-ordered all the options to be more logically structured. Hopefully this will make this page more readable and easy to find things in!
2002-09-18 17:26:42 +02:00
.SH SSL and SECURITY OPTIONS
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_SSLCERT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Client cert. See \fICURLOPT_SSLCERT(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_SSLCERTTYPE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Client cert type. See \fICURLOPT_SSLCERTTYPE(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_SSLKEY
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Client key. See \fICURLOPT_SSLKEY(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_SSLKEYTYPE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Client key type. See \fICURLOPT_SSLKEYTYPE(3)\fP
Renamed several libcurl error codes and options to make them more general and allow reuse by multiple protocols. Several unused error codes were removed. In all cases, macros were added to preserve source (and binary) compatibility with the old names. These macros are subject to removal at a future date, but probably not before 2009. An application can be tested to see if it is using any obsolete code by compiling it with the CURL_NO_OLDIES macro defined. Documented some newer error codes in libcurl-error(3)
2007-08-30 22:34:57 +02:00
.IP CURLOPT_KEYPASSWD
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Client key password. See \fICURLOPT_KEYPASSWD(3)\fP
curl_easy_setopt.3: add CURLOPT_SSL_ENABLE_ALPN/NPN
2014-02-11 07:44:27 +01:00
.IP CURLOPT_SSL_ENABLE_ALPN
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Enable use of ALPN. See \fICURLOPT_SSL_ENABLE_ALPN(3)\fP
curl_easy_setopt.3: add CURLOPT_SSL_ENABLE_ALPN/NPN
2014-02-11 07:44:27 +01:00
.IP CURLOPT_SSL_ENABLE_NPN
curl_easy_setopt.3: Fixed lots of typos
2014-10-30 23:40:05 +01:00
Enable use of NPN. See \fICURLOPT_SSL_ENABLE_NPN(3)\fP
Added a few options that were still not documented. Now I believe all options mentioned in the current curl/curl.h header file (that aren't marked as obsolete) are present.
2004-02-27 10:02:06 +01:00
.IP CURLOPT_SSLENGINE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Use identifier with SSL engine. See \fICURLOPT_SSLENGINE(3)\fP
Added a few options that were still not documented. Now I believe all options mentioned in the current curl/curl.h header file (that aren't marked as obsolete) are present.
2004-02-27 10:02:06 +01:00
.IP CURLOPT_SSLENGINE_DEFAULT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Default SSL engine. See \fICURLOPT_SSLENGINE_DEFAULT(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_SSLVERSION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
SSL version to use. See \fICURLOPT_SSLVERSION(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_SSL_VERIFYPEER
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Verify the SSL certificate. See \fICURLOPT_SSL_VERIFYPEER(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_CAINFO
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
CA cert bundle. See \fICURLOPT_CAINFO(3)\fP
- Axel Tillequin and Arnaud Ebalard added support for CURLOPT_ISSUERCERT, for OpenSSL, NSS and GnuTLS-built libcurls.
2008-06-06 22:52:32 +02:00
.IP CURLOPT_ISSUERCERT
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Issuer certificate. See \fICURLOPT_ISSUERCERT(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_CAPATH
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Path to CA cert bundle. See \fICURLOPT_CAPATH(3)\fP
- Axel Tillequin and Arnaud Ebalard added support for CURLOPT_CRLFILE, for OpenSSL, NSS and GnuTLS-built libcurls.
2008-06-06 20:40:21 +02:00
.IP CURLOPT_CRLFILE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Certificate Revocation List. See \fICURLOPT_CRLFILE(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_SSL_VERIFYHOST
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Verify the host name in the SSL certificate. See \fICURLOPT_SSL_VERIFYHOST(3)\fP
curl_easy_setopt.3: clarify VERIFYHOST/PEER Extended the descriptions somewhat and made the options get listed next to each other.
2011-01-19 12:54:17 +01:00
.IP CURLOPT_CERTINFO
curl_easy_setopt.3: fixed some typos
2014-06-21 20:43:04 +02:00
Extract certificate info. See \fICURLOPT_CERTINFO(3)\fP
curl_easy_setopt.3: add CURLOPT_PINNEDPUBLICKEY Reported-by: Christian Hägele Bug: http://curl.haxx.se/mail/lib-2014-11/0078.html
2014-11-06 10:14:33 +01:00
.IP CURLOPT_PINNEDPUBLICKEY
Set pinned SSL public key . See \fICURLOPT_PINNEDPUBLICKEY(3)\fP
curl_easy_setopt.3: clarify VERIFYHOST/PEER Extended the descriptions somewhat and made the options get listed next to each other.
2011-01-19 12:54:17 +01:00
.IP CURLOPT_RANDOM_FILE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Provide source for entropy random data. See \fICURLOPT_RANDOM_FILE(3)\fP
curl_easy_setopt.3: clarify VERIFYHOST/PEER Extended the descriptions somewhat and made the options get listed next to each other.
2011-01-19 12:54:17 +01:00
.IP CURLOPT_EGDSOCKET
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Identify EGD socket for entropy. See \fICURLOPT_EGDSOCKET(3)\fP
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_SSL_CIPHER_LIST
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Ciphers to use. See \fICURLOPT_SSL_CIPHER_LIST(3)\fP
- Fixed my breakage from earlier today so that doing curl_easy_cleanup() on a handle that is part of a multi handle first removes the handle from the stack. - Added CURLOPT_SSL_SESSIONID_CACHE and --no-sessionid to disable SSL session-ID re-use on demand since there obviously are broken servers out there that misbehave with session-IDs used.
2006-09-11 19:18:18 +02:00
.IP CURLOPT_SSL_SESSIONID_CACHE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Disable SSL session-id cache. See \fICURLOPT_SSL_SESSIONID_CACHE(3)\fP
CURLOPT_SSL_OPTIONS: added Allow an appliction to set libcurl specific SSL options. The first and only options supported right now is CURLSSLOPT_ALLOW_BEAST. It will make libcurl to disable any work-arounds the underlying SSL library may have to address a known security flaw in the SSL3 and TLS1.0 protocol versions. This is a reaction to us unconditionally removing that behavior after this security advisory: http://curl.haxx.se/docs/adv_20120124B.html ... it did however cause a lot of programs to fail because of old servers not liking this work-around. Now programs can opt to decrease the security in order to interoperate with old servers better.
2012-02-06 22:12:06 +01:00
.IP CURLOPT_SSL_OPTIONS
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Control SSL behavior. See \fICURLOPT_SSL_OPTIONS(3)\fP
Thomas J. Moore provided a patch that introduces Kerberos5 support in libcurl. This also makes the options change name to --krb (from --krb4) and CURLOPT_KRBLEVEL (from CURLOPT_KRB4LEVEL) but the old names are still
2007-07-02 00:01:18 +02:00
.IP CURLOPT_KRBLEVEL
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Kerberos security level. See \fICURLOPT_KRBLEVEL(3)\fP
Add new CURLOPT_GSSAPI_DELEGATION option. Curl_gss_init_sec_context got new parameter - SessionHandle. Signed-off-by: Adam Tkac <atkac@redhat.com>
2011-07-19 19:10:43 +02:00
.IP CURLOPT_GSSAPI_DELEGATION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Disable GSS-API delegation. See \fICURLOPT_GSSAPI_DELEGATION(3)\fP
mention the new options
2006-11-02 23:10:18 +01:00
.SH SSH OPTIONS
.IP CURLOPT_SSH_AUTH_TYPES
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
SSH authentication types. See \fICURLOPT_SSH_AUTH_TYPES(3)\fP
Based on a patch brought by Johnny Luong, libcurl now offers CURLOPT_SSH_HOST_PUBLIC_KEY_MD5 and the curl tool --hostpubmd5. They both make the SCP or SFTP connection verify the remote host's md5 checksum of the public key before doing a connect, to reduce the risk of a man-in-the-middle attack.
2007-10-03 10:00:42 +02:00
.IP CURLOPT_SSH_HOST_PUBLIC_KEY_MD5
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
MD5 of host's public key. See \fICURLOPT_SSH_HOST_PUBLIC_KEY_MD5(3)\fP
mention the new options
2006-11-02 23:10:18 +01:00
.IP CURLOPT_SSH_PUBLIC_KEYFILE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
File name of public key. See \fICURLOPT_SSH_PUBLIC_KEYFILE(3)\fP
mention the new options
2006-11-02 23:10:18 +01:00
.IP CURLOPT_SSH_PRIVATE_KEYFILE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
File name of private key. See \fICURLOPT_SSH_PRIVATE_KEYFILE(3)\fP
- Added CURLOPT_SSH_KNOWNHOSTS, CURLOPT_SSH_KEYFUNCTION, CURLOPT_SSH_KEYDATA. They introduce known_host support for SSH keys to libcurl. See docs for details.
2009-07-23 00:49:01 +02:00
.IP CURLOPT_SSH_KNOWNHOSTS
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
File name with known hosts. See \fICURLOPT_SSH_KNOWNHOSTS(3)\fP
- Added CURLOPT_SSH_KNOWNHOSTS, CURLOPT_SSH_KEYFUNCTION, CURLOPT_SSH_KEYDATA. They introduce known_host support for SSH keys to libcurl. See docs for details.
2009-07-23 00:49:01 +02:00
.IP CURLOPT_SSH_KEYFUNCTION
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Callback for known hosts handling. See \fICURLOPT_SSH_KEYFUNCTION(3)\fP
- Added CURLOPT_SSH_KNOWNHOSTS, CURLOPT_SSH_KEYFUNCTION, CURLOPT_SSH_KEYDATA. They introduce known_host support for SSH keys to libcurl. See docs for details.
2009-07-23 00:49:01 +02:00
.IP CURLOPT_SSH_KEYDATA
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Custom pointer to pass to ssh key callback. See \fICURLOPT_SSH_KEYDATA(3)\fP
Kjetil Jacobsen's patch that introduces CURLOPT_PRIVATE and CURLINFO_PRIVATE for storage and retrieval of private data in the curl handle.
2002-11-20 20:11:22 +01:00
.SH OTHER OPTIONS
Use .IP instead of .TP and .B for each item.
2003-11-04 13:55:53 +01:00
.IP CURLOPT_PRIVATE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Private pointer to store. See \fICURLOPT_PRIVATE(3)\fP
added CURLOPT_SHARE
2004-02-25 13:20:41 +01:00
.IP CURLOPT_SHARE
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Share object to use. See \fICURLOPT_SHARE(3)\fP
Add two new options for the SFTP/SCP/FILE protocols: CURLOPT_NEW_FILE_PERMS and CURLOPT_NEW_DIRECTORY_PERMS. These control the premissions for files and directories created on the remote server. CURLOPT_NEW_FILE_PERMS defaults to 0644 and CURLOPT_NEW_DIRECTORY_PERMS defaults to 0755
2007-06-27 22:15:48 +02:00
.IP CURLOPT_NEW_FILE_PERMS
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
Mode for creating new remote files. See \fICURLOPT_NEW_FILE_PERMS(3)\fP
Add two new options for the SFTP/SCP/FILE protocols: CURLOPT_NEW_FILE_PERMS and CURLOPT_NEW_DIRECTORY_PERMS. These control the premissions for files and directories created on the remote server. CURLOPT_NEW_FILE_PERMS defaults to 0644 and CURLOPT_NEW_DIRECTORY_PERMS defaults to 0755
2007-06-27 22:15:48 +02:00
.IP CURLOPT_NEW_DIRECTORY_PERMS
curl_easy_setopt.3: Fixed lots of typos
2014-10-30 23:40:05 +01:00
Mode for creating new remote directories. See \fICURLOPT_NEW_DIRECTORY_PERMS(3)\fP
Added a few options that were still not documented. Now I believe all options mentioned in the current curl/curl.h header file (that aren't marked as obsolete) are present.
2004-02-27 10:02:06 +01:00
.SH TELNET OPTIONS
.IP CURLOPT_TELNETOPTIONS
curl_easy_setopt.3: refer to the individual man pages With all the new individual option man pages created, this now refers to each separate one instead of duplicaing the info. Also makes this page easier to overview.
2014-06-21 15:45:50 +02:00
TELNET options. See \fICURLOPT_TELNETOPTIONS(3)\fP
ripped out from ../ and put in its own directory now
2002-03-04 11:09:48 +01:00
.SH RETURN VALUE
curl_easy_setopt.3: fixed the error code for an unsupported option
2014-06-25 22:30:36 +02:00
\fICURLE_OK\fP (zero) means that the option was set properly, non-zero means an
formatting update to produce better links with the new roffit version
2004-02-27 16:34:06 +01:00
error occurred as \fI<curl/curl.h>\fP defines. See the \fIlibcurl-errors(3)\fP
7.9.6-pre5
2002-04-12 13:39:27 +02:00
man page for the full list with descriptions.
CURLE_FAILED_INIT is returend when an unknown option is set
2004-06-03 13:19:35 +02:00
If you try to set an option that libcurl doesn't know about, perhaps because
the library is too old to support it or the option was removed in a recent
curl_easy_setopt.3: fixed the error code for an unsupported option
2014-06-25 22:30:36 +02:00
version, this function will return \fICURLE_UNKNOWN_OPTION\fP. If support for
the option was disabled at compile-time, it will return
\fICURLE_NOT_BUILT_IN\fP.
curl*3: added small examples and some minor edits
2014-11-25 14:25:02 +01:00
.SH EXAMPLE
.nf
CURL *curl = curl_easy_init();
if(curl) {
CURLcode res;
curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
res = curl_easy_perform(curl);
curl_easy_cleanup(curl);
}}
.fi
ripped out from ../ and put in its own directory now
2002-03-04 11:09:48 +01:00
.SH "SEE ALSO"
docs: edited lots of libcurl docs for clarity
2014-10-21 10:26:40 +02:00
.BR curl_easy_init "(3), " curl_easy_cleanup "(3), " curl_easy_reset "(3), "
.BR curl_multi_setopt "(3), "
Reference in New Issue Copy Permalink