opts: 9 more options as separate man pages

.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  Project                     ___| | | |  _ \| |

.\" *                             / __| | | | |_) | |

.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * 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.

.\" *

.\" **************************************************************************

.\"

.TH CURLOPT_ERRORBUFFER 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_ERRORBUFFER \- set error buffer for error messages

.SH SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ERRORBUFFER, [argument]);

.SH DESCRIPTION

Pass a char * to a buffer that the libcurl may store human readable error

messages in on failures or problems. This may be more helpful than just the

return code from \fIcurl_easy_perform(3)\fP and related functions. The buffer

\fBmust be at least CURL_ERROR_SIZE bytes big\fP.

You must keep the associated buffer available until libcurl no longer needs

it. Failing to do so will cause very odd behavior or even crashes. libcurl

will need it until you call \fIcurl_easy_cleanup(3)\fP or you set the same

option again to use a different pointer.

Consider \fICURLOPT_VERBOSE(3)\fP and \fICURLOPT_DEBUGFUNCTION(3)\fP to better

debug and trace why errors happen.

If the library does not return an error, the buffer may not have been

touched. Do not rely on the contents in those cases.

.SH DEFAULT

NULL

.SH PROTOCOLS

All

.SH EXAMPLE

TODO

.SH AVAILABILITY

Always

.SH RETURN VALUE

Returns CURLE_OK

.SH "SEE ALSO"

.BR CURLOPT_DEBUGFUNCTION "(3), " CURLOPT_VERBOSE "(3), "

.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  Project                     ___| | | |  _ \| |

.\" *                             / __| | | | |_) | |

.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * 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.

.\" *

.\" **************************************************************************

.\"

.TH CURLOPT_INFILESIZE 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_INFILESIZE \- set size of the input file to send off

.SH SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INFILESIZE, long filesize);

.SH DESCRIPTION

When uploading a file to a remote site, \fIfilesize\fP should be used to tell

libcurl what the expected size of the input file is. This value must be passed

as a long. See also \fICURLOPT_INFILESIZE_LARGE(3)\fP for sending files larger

than 2GB.

For uploading using SCP, this option or \fICURLOPT_INFILESIZE_LARGE(3)\fP is

mandatory.

To unset this value again, set it to -1.

When sending emails using SMTP, this command can be used to specify the

optional SIZE parameter for the MAIL FROM command.

This option does not limit how much data libcurl will actually send, as that

is controlled entirely by what the read callback returns, but telling one

value and sending a different amount may lead to errors.

.SH DEFAULT

Unset

.SH PROTOCOLS

Many

.SH EXAMPLE

TODO

.SH AVAILABILITY

SMTP support added in 7.23.0

.SH RETURN VALUE

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.

.SH "SEE ALSO"

.BR CURLOPT_INFILESIZE_LARGE "(3), " CURLOPT_UPLOAD "(3), "

.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  Project                     ___| | | |  _ \| |

.\" *                             / __| | | | |_) | |

.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * 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.

.\" *

.\" **************************************************************************

.\"

.TH CURLOPT_PORT 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_PORT \- set remote port number to work with

.SH SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PORT, long number);

.SH DESCRIPTION

This option sets \fInumber\fP to be the remote port number to connect to,

instead of the one specified in the URL or the default port for the used

protocol.

Usually, you just let the URL decide which port to use but this allows the

application to override that.

While this option accepts a 'long', a port number is usually a 16 bit number

and therefore using a port number over 65535 will cause a run-time error.

.SH DEFAULT

By default this is 0 which makes it not used.

.SH PROTOCOLS

Used for all protocols that speak to a port number.

.SH EXAMPLE

TODO

.SH AVAILABILITY

Always

.SH RETURN VALUE

Returns CURLE_OK

.SH "SEE ALSO"

.BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "

.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  Project                     ___| | | |  _ \| |

.\" *                             / __| | | | |_) | |

.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * 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.

.\" *

.\" **************************************************************************

.\"

.TH CURLOPT_PROXY 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_PROXY \- set proxy to use

.SH SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY, char *proxy);

.SH DESCRIPTION

Set the \fIproxy\fP to use for the upcoming request. The parameter should be a

char * to a zero terminated string holding the host name or dotted IP

address.

To specify port number in this string, append :[port] to the end of the host

name. The proxy's port number may optionally be specified with the separate

option \fICURLOPT_PROXYPORT(3)\fP. If not specified, libcurl will default to

using port 1080 for proxies.

The proxy string may be prefixed with [scheme]:// to specify which kind of

proxy is used. Use socks4://, socks4a://, socks5:// or socks5h:// (the last

one to enable socks5 and asking the proxy to do the resolving, also known as

\fICURLPROXY_SOCKS5_HOSTNAME\fP type) to request the specific SOCKS version to

be used. No protocol specified, http:// and all others will be treated as HTTP

proxies.

Without a scheme prefix, \fICURLOPT_PROXYTYPE(3)\fP can be used to specify

which kind of proxy the string identifies.

When you tell the library to use a HTTP proxy, libcurl will transparently

convert operations to HTTP even if you specify an FTP URL etc. This may have

an impact on what other features of the library you can use, such as

\fICURLOPT_QUOTE(3)\fP and similar FTP specifics that don't work unless you

tunnel through the HTTP proxy. Such tunneling is activated with

\fICURLOPT_HTTPPROXYTUNNEL(3)\fP.

libcurl respects the environment variables \fBhttp_proxy\fP, \fBftp_proxy\fP,

\fBall_proxy\fP etc, if any of those are set. The \fICURLOPT_PROXY(3)\fP

option does however override any possibly set environment variables.

Setting the proxy string to "" (an empty string) will explicitly disable the

use of a proxy, even if there is an environment variable set for it.

A proxy host string given in an environment variable can also include protocol

scheme (http://) and embedded user + password.

.SH DEFAULT

Default is NULL, meaning no proxy is used.

When you set a host name to use, do not assume that there's any particular

single port number used widely for proxies. Specify it!

.SH PROTOCOLS

All except file://. Note that some protocols don't do very well over proxy.

.SH EXAMPLE

TODO

.SH AVAILABILITY

Since 7.14.1 the proxy environment variable names can include the protocol

scheme.

Since 7.21.7 the proxy string supports the socks protocols as "schemes".

.SH RETURN VALUE

Returns CURLE_OK.

.SH "SEE ALSO"

.BR CURLOPT_PROXYPORT "(3), " CURLOPT_HTTPPROXYTUNNEL "(3), "

.BR CURLOPT_PROXYTYPE "(3)"

.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  Project                     ___| | | |  _ \| |

.\" *                             / __| | | | |_) | |

.\" *                            | (__| |_| |  _ <| |___

.\" *                             \___|\___/|_| \_\_____|

.\" *

.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.

.\" *

.\" * 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.

.\" *

.\" **************************************************************************

.\"

.TH CURLOPT_PROXYUSERPWD 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_PROXYUSERPWD \- set user and password to use for the proxy

.SH SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYUSERPWD, char *userpwd);

.SH DESCRIPTION

Pass a char * as parameter, which should be [user name]:[password] to use for

the connection to the HTTP proxy. Both the name and the password will be URL

decoded before use, so to include for example a colon in the user name you

should encode it as %3A. (This is different to how \fICURLOPT_USERPWD(3)\fP is

used - beware.)

Use \fICURLOPT_PROXYAUTH(3)\fP to specify the authentication method.

.SH DEFAULT

This is NULL by default.

.SH PROTOCOLS

Used with all protocols that can use a proxy

.SH EXAMPLE

TODO

.SH AVAILABILITY

Always

.SH RETURN VALUE

Returns CURLE_OK

.SH "SEE ALSO"

.BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "