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

opts: 4 more man pages

parent 1a876a37

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

.SH NAME

CURLOPT_AUTOREFERER \- automatically update the referer header

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_AUTOREFERER, long autorefer);

.SH DESCRIPTION

Pass a parameter set to 1 to enable this. When enabled, libcurl will

automatically set the Referer: header field in HTTP requests where it follows

a Location: redirect.

.SH DEFAULT

0, disabled

.SH PROTOCOLS

HTTP

.SH EXAMPLE

TODO

.SH AVAILABILITY

Along with HTTP

.SH RETURN VALUE

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

.SH "SEE ALSO"

.BR CURLOPT_REFERER "(3), " CURLOPT_FOLLOWLOCATION "(3), "

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

.SH NAME

CURLOPT_FOLLOWLOCATION \- follow HTTP 3xx redirects

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FOLLOWLOCATION, [argument]);

.SH DESCRIPTION

A parameter set to 1 tells the library to follow any Location: header that the

server sends as part of a HTTP header in a 3xx response.



This means that libcurl will re-send the same request on the new location and

follow new Location: headers all the way until no more such headers are

returned. \fICURLOPT_MAXREDIRS(3)\fP can be used to limit the number of

redirects libcurl will follow.



libcurl can limit to what protocols it will automatically follow. The accepted

protocols are set with \fICURLOPT_REDIR_PROTOCOLS(3)\fP and it excludes the

FILE protocol by default.

.SH DEFAULT

0, disabled

.SH PROTOCOLS

HTTP

.SH EXAMPLE

TODO

.SH AVAILABILITY

Along with HTTP

.SH RETURN VALUE

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

.SH "SEE ALSO"

.BR CURLOPT_REDIR_PROTOCOLS "(3), " CURLOPT_PROTOCOLS "(3), "

docs/libcurl/opts/CURLOPT_PUT.3

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

.SH NAME

CURLOPT_PUT \- make a HTTP PUT request

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PUT, long put);

.SH DESCRIPTION

A parameter set to 1 tells the library to use HTTP PUT to transfer data. The

data should be set with \fICURLOPT_READDATA(3)\fP and

\fICURLOPT_INFILESIZE(3)\fP.



This option is \dBdeprecated\fP since version 7.12.1. Use

\fICURLOPT_UPLOAD(3)\fP!

.SH DEFAULT

0, disabled

.SH PROTOCOLS

HTTP

.SH EXAMPLE

TODO

.SH AVAILABILITY

Deprecated since 7.12.1. Do not use.

.SH RETURN VALUE

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

.SH "SEE ALSO"

.BR CURLOPT_UPLOAD "(3), " CURLOPT_HTTPGET "(3), "

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

.SH NAME

CURLOPT_TRANSFERTEXT \- request a text based transfer for FTP

.SH SYNOPSIS

#include <curl/curl.h>



CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TRANSFERTEXT, long text);

.SH DESCRIPTION

A parameter set to 1 tells the library to use ASCII mode for FTP transfers,

instead of the default binary transfer. For win32 systems it does not set the

stdout to binary mode. This option can be usable when transferring text data

between systems with different views on certain characters, such as newlines

or similar.



libcurl does not do a complete ASCII conversion when doing ASCII transfers

over FTP. This is a known limitation/flaw that nobody has rectified. libcurl

simply sets the mode to ASCII and performs a standard transfer.

.SH DEFAULT

0, disabled

.SH PROTOCOLS

FTP

.SH EXAMPLE

TODO

.SH AVAILABILITY

Along with FTP

.SH RETURN VALUE

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

.SH "SEE ALSO"

.BR CURLOPT_CRLF "(3), "