opts: 29 more options as 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_APPEND 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_APPEND \- enable appending to the remote file

.SH SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_APPEND, long append);

.SH DESCRIPTION

A parameter set to 1 tells the library to append to the remote file instead of

overwrite it. This is only useful when uploading to an FTP site.

.SH DEFAULT

0

.SH PROTOCOLS

FTP

.SH EXAMPLE

TODO

.SH AVAILABILITY

This option was known as CURLOPT_FTPAPPEND up to 7.16.4

.SH RETURN VALUE

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

.SH "SEE ALSO"

.BR CURLOPT_DIRLISTONLY "(3), " CURLOPT_RESUME_FROM "(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_COOKIE 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_COOKIE \- set contents of HTTP Cookie header

.SH SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIE, char *cookie);

.SH DESCRIPTION

Pass a pointer to a zero terminated string as parameter. It will be used to

set a cookie in the HTTP request. The format of the string should be

NAME=CONTENTS, where NAME is the cookie name and CONTENTS is what the cookie

should contain.

If you need to set multiple cookies, set them all using a single option

concatenated like this: "name1=content1; name2=content2;" etc.

This option sets the cookie header explicitly in the outgoing request(s). If

multiple requests are done due to authentication, followed redirections or

similar, they will all get this cookie passed on.

Using this option multiple times will only make the latest string override the

previous ones.

This option will not enable the cookie engine. Use \fICURLOPT_COOKIEFILE(3)\fP

or \fICURLOPT_COOKIEJAR(3)\fP to enable parsing and sending cookies

automatically.

.SH DEFAULT

NULL, no cookies

.SH PROTOCOLS

HTTP

.SH EXAMPLE

TODO

.SH AVAILABILITY

If HTTP is enabled

.SH RETURN VALUE

Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.

.SH "SEE ALSO"

.BR CURLOPT_COOKIEFILE "(3), " CURLOPT_COOKIEJAR "(3), "

.BR CURLOPT_HTTPHEADER "(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_COOKIEFILE 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_COOKIEFILE \- file name to read cookies from

.SH SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIEFILE, char *filename);

.SH DESCRIPTION

Pass a pointer to a zero terminated string as parameter. It should point to

the file name of your file holding cookie data to read. The cookie data can be

in either the old Netscape / Mozilla cookie data format or just regular

HTTP-style headers dumped to a file.

It also enables the cookie engine, making libcurl parse and send cookies on

subsequent requests with this handle.

Given an empty or non-existing file or by passing the empty string ("") to

this option, you can enable the cookie engine without reading any initial

cookies.

This option only \fBreads\fP cookies. To make libcurl write cookies to file,

see \fICURLOPT_COOKIEJAR(3)\fP.

If you use this option multiple times, you just add more files to read.

Subsequent files will add more cookies.

.SH DEFAULT

NULL

.SH PROTOCOLS

HTTP

.SH EXAMPLE

TODO

.SH AVAILABILITY

As long as HTTP is supported

.SH RETURN VALUE

Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.

.SH "SEE ALSO"

.BR CURLOPT_COOKIE "(3), " CURLOPT_COOKIEJAR "(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_CRLF 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_CRLF \- enable/disable CRLF conversion

.SH SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CRLF, long conv);

.SH DESCRIPTION

Pass a long. If the value is set to 1 (one), libcurl converts Unix newlines to

CRLF newlines on transfers. Disable this option again by setting the value to

0 (zero).

This is a legacy option of questionable use.

.SH DEFAULT

0

.SH PROTOCOLS

All

.SH EXAMPLE

TODO

.SH AVAILABILITY

Always

.SH RETURN VALUE

Returns CURLE_OK

.SH "SEE ALSO"

.BR CURLOPT_CONV_FROM_NETWORK_FUNCTION "(3), " CURLOPT_CONV_TO_NETWORK_FUNCTION "(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_CUSTOMREQUEST 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_CUSTOMREQUEST \- custom string for request

.SH SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CUSTOMREQUEST, char *request);

.SH DESCRIPTION

Pass a pointer to a zero terminated string as parameter.

When you change the request method by setting \fBCURLOPT_CUSTOMREQUEST(3)\fP

to something, you don't actually change how libcurl behaves or acts in regards

to the particular request method, it will only change the actual string sent

in the request.

Restore to the internal default by setting this to NULL.

This option can be used to specify the request:

.IP HTTP

Instead of GET or HEAD when performing HTTP based requests. This is

particularly useful, for example, for performing a HTTP DELETE request.

For example:

When you tell libcurl to do a HEAD request, but then specify a GET though a

custom request libcurl will still act as if it sent a HEAD. To switch to a

proper HEAD use \fICURLOPT_NOBODY(3)\fP, to switch to a proper POST use

\fICURLOPT_POST(3)\fP or \fICURLOPT_POSTFIELDS(3)\fP and to switch to a proper

GET use \fICURLOPT_HTTPGET(3)\fP.

Many people have wrongly used this option to replace the entire request with

their own, including multiple headers and POST contents. While that might work

in many cases, it will cause libcurl to send invalid requests and it could

possibly confuse the remote server badly. Use \fICURLOPT_POST(3)\fP and

\fICURLOPT_POSTFIELDS(3)\fP to set POST data. Use \fICURLOPT_HTTPHEADER(3)\fP

to replace or extend the set of headers sent by libcurl. Use

\fICURLOPT_HTTP_VERSION(3)\fP to change HTTP version.

.IP FTP

Instead of LIST and NLST when performing FTP directory listings.

.IP IMAP

Instead of LIST when issuing IMAP based requests.

.IP POP3

Instead of LIST and RETR when issuing POP3 based requests.

For example:

When you tell libcurl to use a custom request it will behave like a LIST or

RETR command was sent where it expects data to be returned by the server. As

such \fICURLOPT_NOBODY(3)\fP should be used when specifying commands such as

DELE and NOOP for example.

.IP SMTP

Instead of a HELP or VRFY when issuing SMTP based requests.

For example:

Normally a multiline response is returned which can be used, in conjuection

with \fICURLOPT_MAIL_RCPT(3)\fP, to specify an EXPN request. If the

\fICURLOPT_NOBODY(3)\fP option is specified then the request can be used to

issue NOOP and RSET commands.

.SH DEFAULT

NULL

.SH PROTOCOLS

HTTP, FTP, IMAP, POP3

.SH EXAMPLE

TODO

.SH AVAILABILITY

IMAP is supported since 7.30.0, POP3 since 7.26.0 and SMTP since 7.34.0.

.SH RETURN VALUE

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

.SH "SEE ALSO"

.BR CURLOPT_HTTPHEADER "(3), " CURLOPT_NOBODY "(3), "