| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <[email protected]>, et al. |
| 9 |
.\" * |
| 10 |
.\" * This software is licensed as described in the file COPYING, which |
| 11 |
.\" * you should have received as part of this distribution. The terms |
| 12 |
.\" * are also available at https://curl.haxx.se/docs/copyright.html. |
| 13 |
.\" * |
| 14 |
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| 15 |
.\" * copies of the Software, and permit persons to whom the Software is |
| 16 |
.\" * furnished to do so, under the terms of the COPYING file. |
| 17 |
.\" * |
| 18 |
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 19 |
.\" * KIND, either express or implied. |
| 20 |
.\" * |
| 21 |
.\" ************************************************************************** |
| 22 |
.\" |
| 23 |
.TH CURLOPT_COOKIEFILE 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_COOKIEFILE \- file name to read cookies from |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIEFILE, char *filename); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass a pointer to a zero terminated string as parameter. It should point to |
| 32 |
the file name of your file holding cookie data to read. The cookie data can be |
| 33 |
in either the old Netscape / Mozilla cookie data format or just regular HTTP |
| 34 |
headers (Set-Cookie style) dumped to a file. |
| 35 |
|
| 36 |
It also enables the cookie engine, making libcurl parse and send cookies on |
| 37 |
subsequent requests with this handle. |
| 38 |
|
| 39 |
Given an empty or non-existing file or by passing the empty string ("") to |
| 40 |
this option, you can enable the cookie engine without reading any initial |
| 41 |
cookies. If you tell libcurl the file name is "-" (just a single minus sign), |
| 42 |
libcurl will instead read from stdin. |
| 43 |
|
| 44 |
This option only \fBreads\fP cookies. To make libcurl write cookies to file, |
| 45 |
see \fICURLOPT_COOKIEJAR(3)\fP. |
| 46 |
|
| 47 |
Exercise caution if you are using this option and multiple transfers may occur. |
| 48 |
If you use the Set-Cookie format and don't specify a domain then the cookie is |
| 49 |
sent for any domain (even after redirects are followed) and cannot be modified |
| 50 |
by a server-set cookie. If a server sets a cookie of the same name then both |
| 51 |
will be sent on a future transfer to that server, likely not what you intended. |
| 52 |
To address these issues set a domain in Set-Cookie (doing that will include |
| 53 |
sub-domains) or use the Netscape format. |
| 54 |
|
| 55 |
If you use this option multiple times, you just add more files to read. |
| 56 |
Subsequent files will add more cookies. |
| 57 |
|
| 58 |
The application does not have to keep the string around after setting this |
| 59 |
option. |
| 60 |
.SH DEFAULT |
| 61 |
NULL |
| 62 |
.SH PROTOCOLS |
| 63 |
HTTP |
| 64 |
.SH EXAMPLE |
| 65 |
.nf |
| 66 |
CURL *curl = curl_easy_init(); |
| 67 |
if(curl) { |
| 68 |
curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin"); |
| 69 |
|
| 70 |
/* get cookies from an existing file */ |
| 71 |
curl_easy_setopt(curl, CURLOPT_COOKIEFILE, "/tmp/cookies.txt"); |
| 72 |
|
| 73 |
ret = curl_easy_perform(curl); |
| 74 |
|
| 75 |
curl_easy_cleanup(curl); |
| 76 |
} |
| 77 |
.fi |
| 78 |
.SH "Cookie file format" |
| 79 |
The cookie file format and general cookie concepts in curl are described in |
| 80 |
the HTTP-COOKIES.md file, also hosted online here: |
| 81 |
https://curl.haxx.se/docs/http-cookies.html |
| 82 |
.SH AVAILABILITY |
| 83 |
As long as HTTP is supported |
| 84 |
.SH RETURN VALUE |
| 85 |
Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not. |
| 86 |
.SH "SEE ALSO" |
| 87 |
.BR CURLOPT_COOKIE "(3), " CURLOPT_COOKIEJAR "(3), " |