docs/libcurl/opts/CURLOPT_COOKIEFILE.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 http://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
  34 HTTP-style headers 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.
  42
  43 This option only \fBreads\fP cookies. To make libcurl write cookies to file,
  44 see \fICURLOPT_COOKIEJAR(3)\fP.
  45
  46 If you use this option multiple times, you just add more files to read.
  47 Subsequent files will add more cookies.
  48 .SH DEFAULT
  49 NULL
  50 .SH PROTOCOLS
  51 HTTP
  52 .SH EXAMPLE
  53 TODO
  54 .SH AVAILABILITY
  55 As long as HTTP is supported
  56 .SH RETURN VALUE
  57 Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
  58 .SH "SEE ALSO"
  59 .BR CURLOPT_COOKIE "(3), " CURLOPT_COOKIEJAR "(3), "