[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnurl] 29/282: HTTP-COOKIES.md: describe the cookie file format
From: |
gnunet |
Subject: |
[gnurl] 29/282: HTTP-COOKIES.md: describe the cookie file format |
Date: |
Wed, 01 Apr 2020 14:28:14 +0200 |
This is an automated email from the git hooks/post-receive script.
ng0 pushed a commit to branch master
in repository gnurl.
commit 9d1a0922b7b1eadd0f36167641f78d24a819b62d
Author: Daniel Stenberg <address@hidden>
AuthorDate: Fri Jan 10 22:53:05 2020 +0100
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
---
docs/HTTP-COOKIES.md | 18 ++++++++++++++++++
docs/libcurl/opts/CURLOPT_COOKIEFILE.3 | 6 +++++-
docs/libcurl/opts/CURLOPT_COOKIELIST.3 | 6 +++++-
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, <address@hidden>, et al.
+.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <address@hidden>, 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, <address@hidden>, et al.
+.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <address@hidden>, 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
--
To stop receiving notification emails like this one, please contact
address@hidden.
- [gnurl] 27/282: RELEASE-NOTES: synced, (continued)
- [gnurl] 27/282: RELEASE-NOTES: synced, gnunet, 2020/04/01
- [gnurl] 33/282: wolfssh: set the password correctly for PASSWORD auth, gnunet, 2020/04/01
- [gnurl] 42/282: CMake: support specifying the target Windows version, gnunet, 2020/04/01
- [gnurl] 35/282: libssh2: fix variable type, gnunet, 2020/04/01
- [gnurl] 24/282: wolfSSH: new SSH backend, gnunet, 2020/04/01
- [gnurl] 45/282: http: move "oauth_bearer" from connectdata to Curl_easy, gnunet, 2020/04/01
- [gnurl] 40/282: HTTP: increase EXPECT_100_THRESHOLD to 1Mb, gnunet, 2020/04/01
- [gnurl] 32/282: wolfssh: remove fprintf() calls (and uses of __func__), gnunet, 2020/04/01
- [gnurl] 46/282: copyright: fix year ranges, gnunet, 2020/04/01
- [gnurl] 34/282: curl:progressbarinit: ignore column width from terminals < 20, gnunet, 2020/04/01
- [gnurl] 29/282: HTTP-COOKIES.md: describe the cookie file format,
gnunet <=
- [gnurl] 51/282: openssl: make CURLINFO_CERTINFO not truncate x509v3 fields, gnunet, 2020/04/01
- [gnurl] 60/282: curl: make the -# spaceship bar not wrap the line, gnunet, 2020/04/01
- [gnurl] 50/282: CURLOPT_PROXY_SSL_OPTIONS.3: Sync with CURLOPT_SSL_OPTIONS.3, gnunet, 2020/04/01
- [gnurl] 61/282: urldata: do string enums without #ifdefs for build scripts, gnunet, 2020/04/01
- [gnurl] 47/282: smtp: Allow RCPT TO command to fail for some recipients, gnunet, 2020/04/01
- [gnurl] 62/282: RELEASE-NOTES: synced, gnunet, 2020/04/01
- [gnurl] 48/282: RELEASE-NOTES: synced, gnunet, 2020/04/01
- [gnurl] 58/282: conn: do not reuse connection if SOCKS proxy credentials differ, gnunet, 2020/04/01
- [gnurl] 37/282: wolfssl: use the wc-prefixed symbol alternatives, gnunet, 2020/04/01
- [gnurl] 28/282: CMake: Add support for CMAKE_LTO option., gnunet, 2020/04/01