Return to CURLOPT_COOKIEFILE.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_COOKIEFILE.3, revision 1.1.1.1

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