opts: more 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_CONNECT_ONLY 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_CONNECT_ONLY \- stop when connected to target server

.SH SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONNECT_ONLY, long only);

.SH DESCRIPTION

Pass a long. If the parameter equals 1, it tells the library to perform all

the required proxy authentication and connection setup, but no data transfer,

and then return. This option is implemented for HTTP, SMTP and POP3.

The option can be used to simply test a connection to a server, but is more

useful when used with the \fICURLINFO_LASTSOCKET\fP option to

\fIcurl_easy_getinfo(3)\fP as the library can set up the connection and then

the application can obtain the most recently used socket for special data

transfers.

.SH DEFAULT

0

.SH PROTOCOLS

HTTP, SMTP and POP3

.SH EXAMPLE

TODO

.SH AVAILABILITY

Added in 7.15.2

.SH RETURN VALUE

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

.SH "SEE ALSO"

.BR CURLOPT_VERBOSE "(3), " CURLOPT_HTTPPROXYTUNNEL  "(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_COOKIELIST 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_COOKIELIST \- add to or manipulate cookies held in memory

.SH SYNOPSIS

.nf

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIELIST,

                          char *cookie);

.SH DESCRIPTION

Pass a char * to a \fIcookie\fP string.

Such a cookie can be either a single line in Netscape / Mozilla format or just

regular HTTP-style header (Set-Cookie: ...) format. This will also enable the

cookie engine. This adds that single cookie to the internal cookie store.

Additionally, there are commands available that perform actions if you pass in

these exact strings:

.IP ALL

erases all cookies held in memory

.IP SESS

erases all session cookies held in memory

.IP FLUSH

writes all known cookies to the file specified by \fICURLOPT_COOKIEJAR(3)\fP

.SH DEFAULT

NULL

.SH PROTOCOLS

HTTP

.SH EXAMPLE

TODO

.SH AVAILABILITY

ALL was added in 7.14.1

SESS was added in 7.15.4

FLUSH was added in 7.17.1

.SH RETURN VALUE

Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or

CURLE_OUT_OF_MEMORY if there was insufficient heap space.

.SH "SEE ALSO"

.BR CURLOPT_COOKIEFILE "(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_FTPSSLAUTH 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_FTPSSLAUTH \- set order to attemp TSL vs SSL when using FTP

.SH SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTPSSLAUTH, long order);

.SH DESCRIPTION

Pass a long using one of the values from below, to alter how libcurl issues

\&"AUTH TLS" or "AUTH SSL" when FTP over SSL is activated. This is only

interesting if \fICURLOPT_USE_SSL(3)\fP is also set.

Possible \fIorder\fP values:

.IP CURLFTPAUTH_DEFAULT

Allow libcurl to decide.

.IP CURLFTPAUTH_SSL

Try "AUTH SSL" first, and only if that fails try "AUTH TLS".

.IP CURLFTPAUTH_TLS

Try "AUTH TLS" first, and only if that fails try "AUTH SSL".

.SH DEFAULT

CURLFTPAUTH_DEFAULT

.SH PROTOCOLS

FTP

.SH EXAMPLE

TODO

.SH AVAILABILITY

Added in 7.12.2

.SH RETURN VALUE

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

.SH "SEE ALSO"

.BR CURLOPT_USE_SSL "(3), " CURLOPT_FTP_SSL_CCC "(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_FTP_ACCOUNT 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_FTP_ACCOUNT \- set account info for FTP

.SH SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_ACCOUNT, char *account);

.SH DESCRIPTION

Pass a pointer to a zero terminated string (or NULL to disable). When an FTP

server asks for "account data" after user name and password has been provided,

this data is sent off using the ACCT command.

.SH DEFAULT

NULL

.SH PROTOCOLS

FTP

.SH EXAMPLE

TODO

.SH AVAILABILITY

Added in 7.13.0

.SH RETURN VALUE

Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or

CURLE_OUT_OF_MEMORY if there was insufficient heap space.

.SH "SEE ALSO"

.BR CURLOPT_USERNAME "(3), " CURLOPT_PASSWORD "(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_FTP_CREATE_MISSING_DIRS 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_FTP_CREATE_MISSING_DIRS \- create missing dirs for FTP and SFTP

.SH SYNOPSIS

.nf

#include <curl/curl.h>

typedef enum {

  CURLFTP_CREATE_DIR_NONE,

  CURLFTP_CREATE_DIR,

  CURLFTP_CREATE_DIR_RETRY

} curl_ftpcreatedir;

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_CREATE_MISSING_DIRS,

                          long create);

.SH DESCRIPTION

Pass a long telling libcurl to \fIcreate\fP the dir. If the value is

\fICURLFTP_CREATE_DIR\fP (1), libcurl will attempt to create any remote

directory that it fails to "move" into.

For FTP requests, that means a CWD command fails. CWD being the command that

changes working directory.

For SFTP requests, libcurl will attempt to create the remote directory if it

can't obtain a handle to the target-location. The creation will fail if a file

of the same name as the directory to create already exists or lack of

permissions prevents creation.

Setting \fIcreate\fP to \fICURLFTP_CREATE_DIR_RETRY\fP (2), tells libcurl to

retry the CWD command again if the subsequent MKD command fails. This is

especially useful if you're doing many simultaneous connections against the

same server and they all have this option enabled, as then CWD may first fail

but then another connection does MKD before this connection and thus MKD fails

but trying CWD works!

.SH DEFAULT

CURLFTP_CREATE_DIR_NONE (0)

.SH PROTOCOLS

FTP and SFTP

.SH EXAMPLE

TODO

.SH AVAILABILITY

Added in 7.10.7. SFTP support added in 7.16.3. The retry option was added in

7.19.4.

.SH RETURN VALUE

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

.SH "SEE ALSO"

.BR CURLOPT_FTP_FILEMETHOD "(3), " CURLOPT_FTP_USE_EPSV "(3), "