Merge branch 'experimental' into dev/script-args-in-env

Conflicts:
	src/uzbl-core.c

1 files changed, 41 insertions, 8 deletions

diff --git a/README b/README
index 22c1a99..35492da 100644
--- a/README
+++ b/README
@@ -260,6 +260,11 @@ The following commands are recognized:
   - Read contents of `<file>` and interpret as a set of `uzbl` commands.
 * `show_inspector`
   - Show the WebInspector
+* `add_cookie <domain> <path> <name> <value> <scheme> <expires>`
+  - Adds a new cookie to the cookie jar
+* 'delete_cookie <domain> <path> <name> <value> [<scheme> <expires>]`
+	- Deletes a matching cookie from the cookie jar. scheme and expire time
+	is currently not considered when matching.
 
 ### VARIABLES AND CONSTANTS
 
@@ -305,6 +310,9 @@ file).
   - `data`: The cookie data. Only included for "PUT" requests.
 * `scheme_handler`: handler to execute for each URI navigated to - the
   navigation request will be ignored if handler prints "USED\n"
+* `download_handler`: executed when a download is started. the handler script
+  should print a path that the download should be saved to, or print nothing
+  to cancel the download.
 * `fifo_dir`: location to store FIFOs.
 * `socket_dir`: location to store sockets.
 * `http_debug`: HTTP debug mode (value 0-3).
@@ -494,9 +502,16 @@ access to the following environment variables:
 These variables are also available as positional arguments `$1` through `$7`,
 but this is deprecated and will be removed.
 
-Handler scripts (`cookie_handler`, `scheme_handler` and
+Handler scripts (`download_handler`, `cookie_handler`, `scheme_handler` and
 `authentication_handler`) are called with special arguments:
 
+* download handler
+
+  - `$8 url`: The URL of the item to be downloaded.
+  - `$9 suggested_filename`: A filename suggested by the server or based on the URL.
+  - `$10 content_type`: The mimetype of the file to be downloaded.
+  - `$11 total_size`: The size of the file to be downloaded in bytes. This may be inaccurate.
+
 * cookie handler
 
   - `$8 GET/PUT`: Whether a cookie should be sent to the server (`GET`) or
@@ -622,11 +637,10 @@ The EM allows:
 * Many fine-grained events (`hover_over_link`, `key_press`, `key_release`,..)
 * See example `uzbl-event-manager`.
 
-**Note**: Cookie events are not sent to an event handler but handled internally
-  through the cookie handler because of their synchronous nature. Cookie events
-  are really something completely different from all other events. Maybe someday
-  we'll use HTTP proxies or synchronous events (which also have other nice use
-  cases), but for now we still use the handler code.
+**Note**: Cookie events are sent in addition to (optionally) being handled by 
+  the cookie handler (set by the cookie_handler var). If using a handler it will
+  take precedence before the internal state configured by (add|delete)_cookie
+  commands.
 
 Events have this format:
 
@@ -664,8 +678,13 @@ Events have this format:
 * `EVENT [uzbl_instance_name] TITLE_CHANGED title_name`: When the title of the
   page (and hence maybe, the window title) changed. `title_name` is the new
   title.
-* `EVENT [uzbl_instance_name] DOWNLOAD_REQUEST download_uri`: When content needs
-  to be downloaded, `download_uri` is the URI to get.
+* `EVENT [uzbl_instance_name] DOWNLOAD_STARTED destination_path`: A download
+  has been started, the file will be saved to `destination_path`.
+* `EVENT [uzbl_instance_name] DOWNLOAD_PROGRESS destination_path progress`:
+  While a download is active this event notifies you of the progress.
+  `progress` is a decimal between 0 and 1.
+* `EVENT [uzbl_instance_name] DOWNLOAD_COMPLETE destination_path`: The
+  download being saved to `destination_path` is now complete.
 * `EVENT [uzbl_instance_name] LINK_HOVER uri`: The mouse hovers over the link
   `uri`.
 * `EVENT [uzbl_instance_name] LINK_UNHOVER uri`: The mouse leaves the link
@@ -695,6 +714,11 @@ Events have this format:
   Xembed mode, `plug_id` is the Xembed ID used.
 * `EVENT [uzbl_instance_name] BUILTINS command_list`: Shows a list of all `uzbl`
   commands, whitespace separated, on startup.
+* `EVENT [uzbl_instance_name] ADD_COOKIE domain path name value scheme expire`:
+  When a cookie was added or replaced. scheme is 'http' or 'https', expire will
+  be a unix-timestamp or empty
+* `EVENT [uzbl_instance_name] DELETE_COOKIE domain path name value scheme expire`:
+  When a cookie was deleted. arguments as ADD_COOKIE
 
 Events/requests which the EM and its plugins listens for
 
@@ -769,6 +793,15 @@ Events/requests which the EM and its plugins listens for
     `<index>` is `+`, advance the cursor by one character, and if it is `-`,
     move the cursor back by one character.
 * `START_COMPLETION`: TODO explain completion
+* `BLACKLIST_COOKIE`: add a rule for blacklisting cookies
+  - `request BLACKLIST_COOKIE <component> <regexp>`: Blacklist cookies where
+    `<component>` matches `<regexp>`. `<component>` is one of `domain`,
+    `path`, `name`, `value`, `scheme` or `expires`.
+* `WHITELIST_COOKIE`: add a rule for whitelisting cookies (if any whitelist is
+  set then only cookies that are whitelisted cookies will be used)
+  - `request WHITELIST_COOKIE <component> <regexp>`: Whitelist cookies where
+    `<component>` matches `<regexp>`. `<component>` is one of `domain`,
+    `path`, `name`, `value`, `scheme` or `expires`.
 
 ### COMMAND LINE ARGUMENTS