aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2020-01-10 22:53:05 +0100
committerDaniel Stenberg <daniel@haxx.se>2020-01-13 23:18:32 +0100
commit9d1a0922b7b1eadd0f36167641f78d24a819b62d (patch)
tree14785bb6ecdbea3f4b2ddb9433fc25786ca953bd /docs
parent4ccf7622db04af58442c460b8091b952585de5c7 (diff)
HTTP-COOKIES.md: describe the cookie file format
... and refer to that file from from CURLOPT_COOKIEFILE.3 and CURLOPT_COOKIELIST.3 Assisted-by: Jay Satiro Reported-by: bsammon on github Fixes #4805 Closes #4806
Diffstat (limited to 'docs')
-rw-r--r--docs/HTTP-COOKIES.md18
-rw-r--r--docs/libcurl/opts/CURLOPT_COOKIEFILE.36
-rw-r--r--docs/libcurl/opts/CURLOPT_COOKIELIST.36
3 files changed, 28 insertions, 2 deletions
diff --git a/docs/HTTP-COOKIES.md b/docs/HTTP-COOKIES.md
index 06790f8a7..62367c2a9 100644
--- a/docs/HTTP-COOKIES.md
+++ b/docs/HTTP-COOKIES.md
@@ -43,6 +43,24 @@
When libcurl saves a cookiejar, it creates a file header of its own in which
there is a URL mention that will link to the web version of this document.
+## Cookie file format
+
+ The cookie file format is text based and stores one cookie per line. Lines
+ that start with `#` are treated as comments.
+
+ Each line that each specifies a single cookie consists of seven text fields
+ separated with TAB characters.
+
+ |Field| Type | Example | Meaning |
+ |---|---------|-------------|-----------------------------------------------|
+ | 0 | string | example.com | Domain name |
+ | 1 | boolean | FALSE | Include subdomains |
+ | 2 | string | /foobar/ | Path |
+ | 3 | boolean | TRUE | Send/receive over HTTPS only |
+ | 4 | number | 1462299217 | Expires at – seconds since Jan 1st 1970, or 0 |
+ | 5 | string | person | Name of the cookie |
+ | 6 | string | daniel | Value of the cookie |
+
## Cookies with curl the command line tool
curl has a full cookie "engine" built in. If you just activate it, you can
diff --git a/docs/libcurl/opts/CURLOPT_COOKIEFILE.3 b/docs/libcurl/opts/CURLOPT_COOKIEFILE.3
index fb33e41f0..f327ec148 100644
--- a/docs/libcurl/opts/CURLOPT_COOKIEFILE.3
+++ b/docs/libcurl/opts/CURLOPT_COOKIEFILE.3
@@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2020, 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
@@ -75,6 +75,10 @@ if(curl) {
curl_easy_cleanup(curl);
}
.fi
+.SH "Cookie file format"
+The cookie file format and general cookie concepts in curl are described in
+the HTTP-COOKIES.md file, also hosted online here:
+https://curl.haxx.se/docs/http-cookies.html
.SH AVAILABILITY
As long as HTTP is supported
.SH RETURN VALUE
diff --git a/docs/libcurl/opts/CURLOPT_COOKIELIST.3 b/docs/libcurl/opts/CURLOPT_COOKIELIST.3
index 7de4da882..f46d12eb9 100644
--- a/docs/libcurl/opts/CURLOPT_COOKIELIST.3
+++ b/docs/libcurl/opts/CURLOPT_COOKIELIST.3
@@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2020, 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
@@ -104,6 +104,10 @@ curl_easy_perform(curl); /* cookies imported from cookies.txt */
curl_easy_cleanup(curl); /* cookies exported to cookies.txt */
.fi
+.SH "Cookie file format"
+The cookie file format and general cookie concepts in curl are described in
+the HTTP-COOKIES.md file, also hosted online here:
+https://curl.haxx.se/docs/http-cookies.html
.SH AVAILABILITY
ALL was added in 7.14.1