Commit c3954ffb authored by Daniel Stenberg's avatar Daniel Stenberg
Browse files

opts: more man pages

parent 38bf85fd

docs/libcurl/opts/CURLOPT_CAINFO.3

0 → 100644
+54 −0
Original line number Diff line number Diff line 
.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  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_CAINFO 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_CAINFO \- path to Certificate Authority (CA) bundle

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CAINFO, char *path);

.SH DESCRIPTION

Pass a char * to a zero terminated string naming a file holding one or more

certificates to verify the peer with.



If \fICURLOPT_SSL_VERIFYPEER(3)\fP is zero and you avoid verifying the

server's certificate, \fICURLOPT_CAINFO(3)\fP need not even indicate an

accessible file.



This option is by default set to the system path where libcurl's cacert bundle

is assumed to be stored, as established at build time.



If curl is built against the NSS SSL library, the NSS PEM PKCS#11 module

(libnsspem.so) needs to be available for this option to work properly.

.SH DEFAULT

Built-in system specific

.SH PROTOCOLS

All TLS based protocols: HTTPS, FTPS, IMAPS, POP3, SMTPS etc.

.SH EXAMPLE

TODO

.SH AVAILABILITY

If built TLS enabled

.SH RETURN VALUE

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

.SH "SEE ALSO"

.BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "

docs/libcurl/opts/CURLOPT_FILETIME.3

0 → 100644
+47 −0
Original line number Diff line number Diff line 
.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  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_FILETIME 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_FILETIME \- get the modification time of the remote resource

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FILETIME, long gettime);

.SH DESCRIPTION

Pass a long. If it is 1, libcurl will attempt to get the modification time of

the remote document in this operation. This requires that the remote server

sends the time or replies to a time querying command. The

\fIcurl_easy_getinfo(3)\fP function with the \fICURLINFO_FILETIME\fP argument

can be used after a transfer to extract the received time (if any).

.SH DEFAULT

0

.SH PROTOCOLS

HTTP, FTP, SFTP, FILE

.SH EXAMPLE

TODO

.SH AVAILABILITY

Always

.SH RETURN VALUE

Returns CURLE_OK

.SH "SEE ALSO"

.BR curl_easy_getinfo "(3), "

docs/libcurl/opts/CURLOPT_FORBID_REUSE.3

0 → 100644
+50 −0
Original line number Diff line number Diff line 
.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  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_FORBID_REUSE 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_FORBID_REUSE \- make connection get closed at once after use

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FORBID_REUSE, long close);

.SH DESCRIPTION

Pass a long. Set \fIclose\fP to 1 to make libcurl explicitly close the

connection when done with the transfer. Normally, libcurl keeps all

connections alive when done with one transfer in case a succeeding one follows

that can re-use them.  This option should be used with caution and only if you

understand what it does as it can seriously impact performance.



Set to 0 to have libcurl keep the connection open for possible later re-use

(default behavior).

.SH DEFAULT

0

.SH PROTOCOLS

Most

.SH EXAMPLE

TODO

.SH AVAILABILITY

Always

.SH RETURN VALUE

Returns CURLE_OK

.SH "SEE ALSO"

.BR CURLOPT_FRESH_CONNECT "(3), " CURLOPT_MAXCONNECTS "(3), "

docs/libcurl/opts/CURLOPT_FRESH_CONNECT.3

0 → 100644
+52 −0
Original line number Diff line number Diff line 
.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  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_FRESH_CONNECT 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_FRESH_CONNECT \- force a new connection to be used

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FRESH_CONNECT, long fresh);

.SH DESCRIPTION

Pass a long. Set to 1 to make the next transfer use a new (fresh) connection

by force instead of trying to re-use an existing one.  This option should be

used with caution and only if you understand what it does as it may seriously

impact performance.



Related functionality is \fICURLOPT_FORBID_REUSE(3)\fP which makes sure the

connection is closed after use so that it won't be re-used.



Set \fIfresh\fP to 0 to have libcurl attempt re-using an existing connection

(default behavior).

.SH DEFAULT

0

.SH PROTOCOLS

Most

.SH EXAMPLE

TODO

.SH AVAILABILITY

Always

.SH RETURN VALUE

Returns CURLE_OK

.SH "SEE ALSO"

.BR CURLOPT_FORBID_REUSE "(3), "

docs/libcurl/opts/CURLOPT_HTTPPROXYTUNNEL.3

0 → 100644
+51 −0
Original line number Diff line number Diff line 
.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  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_HTTPPROXYTUNNEL 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_HTTPPROXYTUNNEL \- tunnel through HTTP proxy

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPPROXYTUNNEL, long tunnel);

.SH DESCRIPTION

Set the parameter to 1 to make libcurl tunnel all operations through the HTTP

proxy. There is a big difference between using a proxy and to tunnel through

it. If you don't know what this means, you probably don't want this tunneling

option.



Tunneling essentially means that a CONNECT is sent to the proxy, asking it to

connect to a remote host on a specific port number and then the traffic is

just passed through the proxy. Proxies tend to whitelist specific port numbers

it allows CONNECT requests to and often only port 80 and 443 are allowed.

.SH DEFAULT

0

.SH PROTOCOLS

All network protocols

.SH EXAMPLE

TODO

.SH AVAILABILITY

Always

.SH RETURN VALUE

Returns CURLE_OK

.SH "SEE ALSO"

.BR CURLOPT_PROXY "(3), "