docs/libcurl/opts/CURLOPT_COOKIELIST.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_COOKIELIST 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_COOKIELIST \- add to or manipulate cookies held in memory
  26 .SH SYNOPSIS
  27 .nf
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIELIST,
  31                           char *cookie);
  32 .SH DESCRIPTION
  33 Pass a char * to a \fIcookie\fP string.
  34
  35 Such a cookie can be either a single line in Netscape / Mozilla format or just
  36 regular HTTP-style header (Set-Cookie: ...) format. This will also enable the
  37 cookie engine. This adds that single cookie to the internal cookie store.
  38
  39 Additionally, there are commands available that perform actions if you pass in
  40 these exact strings:
  41 .IP ALL
  42 erases all cookies held in memory
  43
  44 .IP SESS
  45 erases all session cookies held in memory
  46
  47 .IP FLUSH
  48 writes all known cookies to the file specified by \fICURLOPT_COOKIEJAR(3)\fP
  49
  50 .IP RELOAD
  51 loads all cookies from the files specified by \fICURLOPT_COOKIEFILE(3)\fP
  52
  53 .SH DEFAULT
  54 NULL
  55 .SH PROTOCOLS
  56 HTTP
  57 .SH EXAMPLE
  58 TODO
  59 .SH AVAILABILITY
  60 ALL was added in 7.14.1
  61
  62 SESS was added in 7.15.4
  63
  64 FLUSH was added in 7.17.1
  65
  66 RELOAD was added in 7.39.0
  67 .SH RETURN VALUE
  68 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  69 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  70 .SH "SEE ALSO"
  71 .BR CURLOPT_COOKIEFILE "(3), " CURLOPT_COOKIEJAR "(3), "  CURLOPT_COOKIE "(3), "