aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorGravatar Brendan Taylor <whateley@gmail.com>2011-02-14 21:54:00 -0700
committerGravatar Brendan Taylor <whateley@gmail.com>2011-02-14 21:54:00 -0700
commit940591850179640811bac6cf206fabae61964f55 (patch)
tree23325ce4f6899ef0dc35edc5747c5f2dd76495b6 /docs
parent7e5a921c93a580725b64fee3bdbf0af406d369a3 (diff)
parent6a737a7137c8cfbbe21bb5f0c0182ca2255a5b4c (diff)
Merge commit '6a737a7137' (keis/intcookies) into experimental
Conflicts: docs/README.uzbl-event-manager
Diffstat (limited to 'docs')
-rw-r--r--docs/README.cookies63
-rw-r--r--docs/README.uzbl-event-manager20
2 files changed, 10 insertions, 73 deletions
diff --git a/docs/README.cookies b/docs/README.cookies
deleted file mode 100644
index 148603f..0000000
--- a/docs/README.cookies
+++ /dev/null
@@ -1,63 +0,0 @@
-# Cookies and Uzbl #
-
-The speed of cookie lookups is important, since a single page load can involve
-dozens of HTTP requests, each of which needs a separate cookie lookup (since
-another instance of uzbl may have obtained new cookies for a site).
-
-It is possible handle cookie lookup (and storage) using a `spawn_async` cookie
-handler, but spawning new processes is inherently slow so a `talk_to_socket`
-cookie daemon (like the default uzbl-cookie-manager) is recommended.
-
-## uzbl-cookie-manager ##
-
-uzbl-cookie-manager is a cookie daemon based on libsoup's SoupCookieJar. Cookies
-are stored in a file in the Mozilla cookies.txt format (default location
-$XDG_DATA_HOME/.local/share/cookies.txt).
-
-### uzbl-cookie-manager Whitelist ###
-
-If a whitelist file is present (default location
-$XDG_CONFIG_HOME/uzbl/cookie_whitelist), then website attempts to set cookies
-will be ignored unless the site's domain is present in the whitelist.
-
-The whitelist can contain comment lines beginning with `#`, and domain lines. A
-domain line beginning with . will whitelist the given domain name and any
-subdomain of it. Otherwise only exact matches of the domain are whitelisted.
-
-For instance, given this whitelist file:
-
- example.com
- .uzbl.org
-
-uzbl-cookie-manager would accept cookies for example.com, uzbl.org and
-www.uzbl.org, but ignore cookies set for www.example.com (and any other
-domain that is not a subdomain of uzbl.org).
-
-## uzbl-cookie-daemon ##
-
-uzbl-cookie-daemon is a Python cookie daemon based on Python's cookielib.
-Cookielib's lookup algorithm isn't very efficient for our needs, so
-uzbl-cookie-daemon is noticeably slow.
-
-## Cookie Daemon Protocol ##
-
-When uzbl's `cookie_handler` variable is set to `talk_to_socket path`, uzbl
-connects to the Unix domain socket located at `path`. uzbl will send a cookie
-lookup request on this socket every time it makes an HTTP request. The format of
-this lookup request is:
-
- GET\0scheme\0host\0path\0
-
-where `\0` is the null character, `scheme` is the URL scheme (http or https),
-`host` is the hostname from the URL and `path` is the requested path. The cookie
-daemon should respond with the names and values of cookies that match the
-request, in the format used by the `Cookie` header, terminated with a `\0`.
-
-When a website adds, deletes or changes a cookie, uzbl notifies the cookie
-daemon with a request in the format:
-
- PUT\0scheme\0host\0path\0name=value\0
-
-where `scheme`, `host` and `path` are (approximately) as above, and `name=value`
-is the cookie name-value pair to store. The cookie daemon should respond by
-writing `\0` to the socket.
diff --git a/docs/README.uzbl-event-manager b/docs/README.uzbl-event-manager
index 92f0228..23e185c 100644
--- a/docs/README.uzbl-event-manager
+++ b/docs/README.uzbl-event-manager
@@ -83,20 +83,20 @@ events. If any whitelist is set, then any cookie that is not whitelisted will
be rejected. Otherwise, only cookies that have been blacklisted will be
rejected.
-BLACKLIST_COOKIE <part> <re>
- Adds a new blacklist filter. cookies where the component specified by
- `part` matches the regular expression `re` will be filtered. part can be
- either 0-5 or any of the symbolic names domain, path, name, value, scheme,
- expires
+BLACKLIST_COOKIE [<component> <re>]*
+ Adds a new blacklist filter. cookies where the components specified by
+ `component` matches the regular expression `re` will be filtered. component
+ may be either 0-5 or any of the symbolic names domain, path, name, value,
+ scheme, expires
- for example to block all cookies which name is "__utm" followed by a single
+ for example to block all cookies which name is "__utm" followed by a single
character (google analytics cookies) do.
request BLACKLIST_COOKIE name '^__utm.$'
-WHITELIST_COOKIE <part> <re>
- Adds a new whitelist filter. cookies where the component specified by
- `part` matches the regular expression `re` will be allowed. part can be any
- of the parts allowed for the BLACKLIST_COOKIE event
+WHITELIST_COOKIE [<component> <re>]*
+ Adds a new whitelist filter. cookies where the components specified by
+ `component` matches the regular expression `re` will be allowed. component
+ may be any of the components allowed for the BLACKLIST_COOKIE event
### history.py ###
- Status bar command history