Commit 290e1bbe authored by Daniel Stenberg's avatar Daniel Stenberg
Browse files

opts: the final bunch of options as man pages 

Now all current options have their own man pages.
parent a6cd174b

docs/libcurl/opts/CURLOPT_ACCEPTTIMEOUT_MS.3

0 → 100644
+44 −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_ACCEPTTIMEOUT_MS 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_ACCEPTTIMEOUT_MS \- timeout waiting for FTP server to connect back

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ACCEPTTIMEOUT_MS, long ms);

.SH DESCRIPTION

Pass a long telling libcurl the maximum number of milliseconds to wait for a

server to connect back to libcurl when an active FTP connection is used.

.SH DEFAULT

If no timeout is set, the internal default of 60000 (one minute) will be used.

.SH PROTOCOLS

FTP

.SH EXAMPLE

TODO

.SH AVAILABILITY

Added in 7.24.0

.SH RETURN VALUE

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

.SH "SEE ALSO"

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

docs/libcurl/opts/CURLOPT_CHUNK_BGN_FUNCTION.3

0 → 100644
+69 −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_CHUNK_BGN_FUNCTION 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_CHUNK_BGN_FUNCTION \- callback before a transfer with FTP wildcardmatch

.SH SYNOPSIS

.nf

#include <curl/curl.h>



long chunk_bgn_callback(const void *transfer_info, void *ptr,

                        int remains);



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_BGN_FUNCTION,

                          chunk_bgn_callback);

.SH DESCRIPTION

Pass a pointer to your callback function, which should match the prototype

shown above.



This callback function gets called by libcurl before a part of the stream is

going to be transferred (if the transfer supports chunks).



The \fItransfer_info\fP pointer will point to a struct curl_fileinfo with

details about the file that is about to get transfered.



This callback makes sense only when using the \fICURLOPT_WILDCARDMATCH(3)\fP

option for now.



The target of transfer_info parameter is a "feature depended" structure. For

the FTP wildcard download, the target is curl_fileinfo structure (see

\fIcurl/curl.h\fP).  The parameter \fIptr\fP is a pointer given by

\fICURLOPT_CHUNK_DATA(3)\fP. The parameter remains contains number of chunks

remaining per the transfer. If the feature is not available, the parameter has

zero value.



Return \fICURL_CHUNK_BGN_FUNC_OK\fP if everything is fine,

\fICURL_CHUNK_BGN_FUNC_SKIP\fP if you want to skip the concrete chunk or

\fICURL_CHUNK_BGN_FUNC_FAIL\fP to tell libcurl to stop if some error occurred.

.SH DEFAULT

NULL

.SH PROTOCOLS

FTP

.SH EXAMPLE

TODO

.SH AVAILABILITY

This was added in 7.21.0

.SH RETURN VALUE

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

.SH "SEE ALSO"

.BR CURLOPT_CHUNK_END_FUNCTION "(3), " CURLOPT_WILDCARDMATCH "(3), "

docs/libcurl/opts/CURLOPT_CHUNK_DATA.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_CHUNK_DATA 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_CHUNK_DATA \- custom pointer to the FTP chunk callbacks

.SH SYNOPSIS

#include <curl/curl.h>



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

.SH DESCRIPTION

Pass a \fIpointer\fP that will be untouched by libcurl and passed as the ptr

argument to the \fICURL_CHUNK_BGN_FUNTION(3)\fP and

\fICURL_CHUNK_END_FUNTION(3)\fP.

.SH DEFAULT

NULL

.SH PROTOCOLS

FTP

.SH EXAMPLE

TODO

.SH AVAILABILITY

Added in 7.21.0

.SH RETURN VALUE

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

.SH "SEE ALSO"

.BR CURLOPT_CHUNK_BGN_FUNCTION "(3), " CURLOPT_WILDCARDMATCH "(3), "

docs/libcurl/opts/CURLOPT_CHUNK_END_FUNCTION.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_CHUNK_END_FUNCTION 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_CHUNK_END_FUNCTION \- callback after a transfer with FTP wildcardmatch

.SH SYNOPSIS

.nf

#include <curl/curl.h>



long chunk_end_callback(void *ptr);



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CHUNK_END_FUNCTION,

                          chunk_end_callback);

.SH DESCRIPTION

Pass a pointer to your callback function, which should match the prototype

shown above.



This function gets called by libcurl as soon as a part of the stream has been

transferred (or skipped).



Return \fICURL_CHUNK_END_FUNC_OK\fP if everything is fine or

\fBCURL_CHUNK_END_FUNC_FAIL\fP to tell the lib to stop if some error occurred.

.SH DEFAULT

NULL

.SH PROTOCOLS

FTP

.SH EXAMPLE

TODO

.SH AVAILABILITY

Added in 7.21.0

.SH RETURN VALUE

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

.SH "SEE ALSO"

.BR CURLOPT_WILDCARDMATCH "(3), " CURLOPT_CHUNK_BGN_FUNCTION "(3), "

docs/libcurl/opts/CURLOPT_DNS_INTERFACE.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_DNS_INTERFACE 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_DNS_INTERFACE \- set interface to speak DNS over

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DNS_INTERFACE, char *ifname);

.SH DESCRIPTION

Pass a char * as parameter. Set the name of the network interface that the DNS

resolver should bind to. This must be an interface name (not an address). Set

this option to NULL to use the default setting (don't bind to a specific

interface).

.SH DEFAULT

NULL

.SH PROTOCOLS

.SH EXAMPLE

TODO

.SH AVAILABILITY

Added in 7.33.0. This option also requires that libcurl was built with a

resolver backend that supports this operation. The c-ares backend is the only

such one.

.SH RETURN VALUE

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

.SH "SEE ALSO"

.BR CURLOPT_DNS_SERVERS "(3), " CURLOPT_DNS_LOCAL_IP4 "(3), "