aboutsummaryrefslogtreecommitdiffhomepage
path: root/README
diff options
context:
space:
mode:
authorGravatar keis <keijser@gmail.com>2011-01-17 20:50:20 +0100
committerGravatar keis <keijser@gmail.com>2011-01-17 21:08:06 +0100
commite8814adcd1835d6faa0ad166ba1bf2aaf64bb5e0 (patch)
tree1d491e1b7ea11738dc757eaff751abbbe9312a1b /README
parent15c83d8a85a150f46e80f7fc97041f10a43a96df (diff)
parent835f5d8d09b429a4776192dbe00be5ae20704b16 (diff)
Merge branch 'experimental' of git://github.com/Dieterbe/uzbl into intcookies
Conflicts: Makefile
Diffstat (limited to 'README')
-rw-r--r--README75
1 files changed, 28 insertions, 47 deletions
diff --git a/README b/README
index 2c87290..a8c500c 100644
--- a/README
+++ b/README
@@ -286,8 +286,10 @@ file).
* `keycmd`: Holds the input buffer (callback: update input buffer).
* `show_status`: Show statusbar or not.
* `status_top`: statusbar on top?
-* `status_format`: Marked up, to be expanded string for statusbar (callback:
- update statusbar).
+* `status_format`: Marked up, to be expanded string for statusbar's left side
+ (callback: update statusbar).
+* `status_format_right`: Marked up, to be expanded string for statusbar's right side
+ (callback: update statusbar).
* `status_background`: color which can be used to override Gtk theme.
* `title_format_long`: titlebar string when no statusbar shown (will be
expanded).
@@ -324,6 +326,7 @@ file).
rendered content.
* `useragent`: The User-Agent to send to the browser, expands variables in its
definition.
+* `accept_languages`: The Accept-Language header to send with HTTP requests.
* `zoom_level`: The factor by which elements in the page are scaled with respect
to their original size. Setting this will resize the currently displayed page.
* `zoom_type`: Whether to use "full-content" zoom (defaults to true). With
@@ -464,10 +467,10 @@ that should be evaluated on every update need to be escaped:
set title_format_short = \\\@(date)\\\@
# the title will stay constant as a literal "@(date)@"
-The `status_format` variable can contain
+The `status_format` and `status_format_right` variables can contain
[Pango](http://library.gnome.org/devel/pango/stable/PangoMarkupFormat.html)
-markup . In the `status_format`, variables that might contain characters like
-`<`, `&` and `>`, should be wrapped in a `@[ ]@` substitution so that they don't
+markup . In these variables, expansions that might produce the characters `<`,
+`&` or `>` should be wrapped in `@[ ]@` substitutions so that they don't
interfere with the status bar's markup; see the sample config for examples.
### EXTERNAL SCRIPTS
@@ -494,39 +497,36 @@ access to the following environment variables:
* `$UZBL_URI`: The URI of the current page.
* `$UZBL_TITLE`: The current page title.
-These variables are also available as positional arguments `$1` through `$7`,
-but this is deprecated and will be removed.
-
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.
+ - `$1 url`: The URL of the item to be downloaded.
+ - `$2 suggested_filename`: A filename suggested by the server or based on the URL.
+ - `$3 content_type`: The mimetype of the file to be downloaded.
+ - `$4 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
+ - `$1 GET/PUT`: Whether a cookie should be sent to the server (`GET`) or
stored by the browser (`PUT`).
- - `$9 scheme`: Either `http` or `https`.
- - `$10 host`: If current page URL is `www.example.com/somepage`, this could be
+ - `$2 scheme`: Either `http` or `https`.
+ - `$3 host`: If current page URL is `www.example.com/somepage`, this could be
something else than `example.com`, eg advertising from another host.
- - `$11 path`: The request address path.
- - `$12 data`: The cookie data. Only included for `PUT` requests.
+ - `$4 path`: The request address path.
+ - `$5 data`: The cookie data. Only included for `PUT` requests.
* scheme handler
- - `$8 URI` of the page to be navigated to
+ - `$1 URI` of the page to be navigated to
* authentication handler:
- - `$8`: authentication zone unique identifier
- - `$9`: domain part of URL that requests authentication
- - `$10`: authentication realm
- - `$11`: FALSE if this is the first attempt to authenticate, TRUE otherwise
+ - `$1`: authentication zone unique identifier
+ - `$2`: domain part of URL that requests authentication
+ - `$3`: authentication realm
+ - `$4`: FALSE if this is the first attempt to authenticate, TRUE otherwise
### Formfiller.sh
@@ -572,15 +572,15 @@ Example:
Script will be executed on each authentication request.
It will receive four auth-related parameters:
- $8 authentication zone unique identifier (may be used as 'key')
- $9 domain part of URL that requests authentication
- $10 authentication realm
- $11 FALSE if this is the first attempt to authenticate, TRUE otherwise
+ $1 authentication zone unique identifier (may be used as 'key')
+ $2 domain part of URL that requests authentication
+ $3 authentication realm
+ $4 FALSE if this is the first attempt to authenticate, TRUE otherwise
Script is expected to print exactly two lines of text on stdout (that means
its output must contain exactly two '\n' bytes).
The first line contains username, the second one - password.
-If authentication fails, script will be executed again (with $11 = TRUE).
+If authentication fails, script will be executed again (with $4 = TRUE).
Non-interactive scripts should handle this case and do not try to
authenticate again to avoid loops. If number of '\n' characters in scripts
output does not equal 2, authentication will fail.
@@ -589,7 +589,7 @@ That means 401 error will be displayed and uzbl won't try to authenticate anymor
The simplest example of authentication handler script is:
#!/bin/sh
-[ "$11" == "TRUE ] && exit
+[ "$4" == "TRUE ] && exit
echo alice
echo wonderland
@@ -597,25 +597,6 @@ This script tries to authenticate as user alice with password wonderland once
and never retries authentication.
See examples for more sofisticated, interactive authentication handler.
-### JAVASCRIPT HELPER OBJECT DISABLED BECAUSE OF SECURITY LEAK
-
-JavaScript code run from `uzbl` is given a special object in the global
-namespace which gives special privileges to these scripts. This object is called
-`Uzbl`, and it is added and removed before and after the script execution so
-that it is hidden to web JavaScript code (there is no race condition, since all
-the JavaScript code runs in a single thread).
-
-Currently, the `Uzbl` object provides only one function:
-
-* `Uzbl.run( <command> )`
- - Command is any `uzbl` command as defined above.
- - Return value: a string, either empty or containing the output of the
- command. Very few commands return their output currently, including `js`,
- `script`, and `print`.
- - Examples:
- * `Uzbl.run("spawn insert_bookmark.sh")`
- * `uri = Uzbl.run("print @uri")` (see variable expansion below)
-
### EVENTS
Unlike commands, events are not handled in `uzbl` itself, but are propagated