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

opts: 11 more man pages

parent efbffa2f

docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3

0 → 100644
+61 −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_ACCEPT_ENCODING 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_ACCEPT_ENCODING \- enables automatic decompression of HTTP downloads

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ACCEPT_ENCODING, char *enc);

.SH DESCRIPTION

Pass a char * argument specifying what encoding you'd like.



Sets the contents of the Accept-Encoding: header sent in a HTTP request, and

enables decoding of a response when a Content-Encoding: header is received.

Three encodings are supported: \fIidentity\fP, which does nothing,

\fIdeflate\fP which requests the server to compress its response using the

zlib algorithm, and \fIgzip\fP which requests the gzip algorithm.



If a zero-length string is set like "", then an Accept-Encoding: header

containing all built-in supported encodings is sent.



You can also opt to just include the Accept-Encoding: heder in your request

with \fICURLOPT_HTTPHEADER(3)\fP but then there will be no automatic

decompressing when receiving data.



This is a request, not an order; the server may or may not do it.  This option

must be set (to any non-NULL value) or else any unsolicited encoding done by

the server is ignored. See the special file lib/README.encoding for further

details.

.SH DEFAULT

NULL

.SH PROTOCOLS

HTTP

.SH EXAMPLE

TODO

.SH AVAILABILITY

This option was called CURLOPT_ENCODING before 7.21.6

.SH RETURN VALUE

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

.SH "SEE ALSO"

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

docs/libcurl/opts/CURLOPT_BUFFERSIZE.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_BUFFERSIZE 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_BUFFERSIZE \- set preferred receive buffer size

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_BUFFERSIZE, long size);

.SH DESCRIPTION

Pass a long specifying your preferred \fIsize\fP (in bytes) for the receive

buffer in libcurl.  The main point of this would be that the write callback

gets called more often and with smaller chunks. This is just treated as a

request, not an order. You cannot be guaranteed to actually get the given

size.



This size is by default set as big as possible (\fICURL_MAX_WRITE_SIZE\fP), so

it only makes sense to use this option if you want it smaller.

.SH DEFAULT

CURL_MAX_WRITE_SIZE

.SH PROTOCOLS

All

.SH EXAMPLE

TODO

.SH AVAILABILITY

Added in 7.10

.SH RETURN VALUE

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

.SH "SEE ALSO"

.BR CURLOPT_MAX_RECV_SPEED "(3), " CURLOPT_WRITEFUNCTION "(3), "

docs/libcurl/opts/CURLOPT_CAPATH.3

0 → 100644
+53 −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_CAPATH 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_CAPATH \- specify directory holding CA certificates

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CAPATH, char *capath);

.SH DESCRIPTION

Pass a char * to a zero terminated string naming a directory holding multiple

CA certificates to verify the peer with. If libcurl is built against OpenSSL,

the certificate directory must be prepared using the openssl c_rehash utility.

This makes sense only when used in combination with the

\fICURLOPT_SSL_VERIFYPEER(3)\fP option.  If \fICURLOPT_SSL_VERIFYPEER(3)\fP is

zero, \fICURLOPT_CAPATH(3)\fP need not even indicate an accessible path.  The

\fICURLOPT_CAPATH(3)\fP function apparently does not work in Windows due to

some limitation in openssl.

.SH DEFAULT

NULL

.SH PROTOCOLS

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

.SH EXAMPLE

TODO

.SH AVAILABILITY

This option is OpenSSL-specific and does nothing if libcurl is built to use

GnuTLS. NSS-powered libcurl provides the option only for backward

compatibility.

.SH RETURN VALUE

Returns CURLE_OK if TLS enabled, and CURLE_UNKNOWN_OPTION if not, or

CURLE_OUT_OF_MEMORY if there was insufficient heap space.

.SH "SEE ALSO"

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

docs/libcurl/opts/CURLOPT_COOKIESESSION.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_COOKIESESSION 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_COOKIESESSION \- start a new cookie session

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIESESSION, long init);

.SH DESCRIPTION

Pass a long set to 1 to mark this as a new cookie "session". It will force

libcurl to ignore all cookies it is about to load that are "session cookies"

from the previous session. By default, libcurl always stores and loads all

cookies, independent if they are session cookies or not. Session cookies are

cookies without expiry date and they are meant to be alive and existing for

this "session" only.



A "session" is usually defined in browser land for as long as you have your

browser up, more or less.

.SH DEFAULT

0

.SH PROTOCOLS

HTTP

.SH EXAMPLE

TODO

.SH AVAILABILITY

Along with HTTP

.SH RETURN VALUE

Returns CURLE_OK

.SH "SEE ALSO"

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

docs/libcurl/opts/CURLOPT_DEBUGDATA.3

0 → 100644
+45 −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_DEBUGDATA 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_DEBUGDATA \- custom pointer for debug callback

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DEBUGDATA, void *pointer);

.SH DESCRIPTION

Pass a \fIpointer\fP to whatever you want passed in to your

\fICURLOPT_DEBUGFUNCTION(3)\fP in the last void * argument. This pointer is

not used by libcurl, it is only passed to the callback.

.SH DEFAULT

NULL

.SH PROTOCOLS

All

.SH EXAMPLE

http://curl.haxx.se/libcurl/c/debug.html

.SH AVAILABILITY

Always

.SH RETURN VALUE

Returns CURLE_OK

.SH "SEE ALSO"

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