setup project. initial import of uzbl

[uzbl-mobile] / README

diff --git a/README b/README
index 8adcf99..cb7974b 100644 (file)
--- a/README
+++ b/README
@@ -141,6 +141,8 @@ The following commands are recognized:
 * `sync_sh <command>`
    - these are synchronous variants of `spawn` and `sh`, which means uzbl will wait for them to return
    - you should only need to use these manually if you want to use a chain command in a handler that wants output from the command it runs
+* `talk_to_socket <socketfile> <tokens/command>`
+   - lets uzbl talk to a socketfile
 * `exit`
 * `search <string>`
 * `search_reverse <string>`
@@ -158,6 +160,8 @@ The following commands are recognized:
    - use for chaining multiple commands
    - remember to quote the commands; one command must come as one parameter
    - if you use `chain` with a handler script which must return some output (such as a cookie handler -- uzbl will wait for and use its output), use sync_spawn or sync_sh instead of spawn or sh in the command that should give the output
+* `update_gui`
+   - update the contents of the status and title bars
 
 ### VARIABLES AND CONSTANTS
 Uzbl has a lot of internal variables and constants.  You can get the values (using the `print` command, see above), and for variables you can also change the value at
@@ -165,14 +169,12 @@ runtime.  Some of the values can be passed at start up through commandline argum
 Some of them have default values (see config.h)
 Some variables have callback functions which will get called after setting the variable to perform some additional logic (see below)
 
+Besides the builtin variables you can also define your own ones and use them in the exact same way as the buitin ones.
+
 * Variables:
   - uri (callback: load the uri)
   - verbose: affects output on stdout
-  - mode:insert or command mode
   - inject_html
-  - base_url: used when passing html through stdin
-  - html_endmarker: delimiter when passing html through stdin
-  - html_mode_timeout: consider end of html input after x seconds when no endmarker found
   - keycmd: holds the input buffer (callback: update input buffer)
   - status_message (callback: update title)
   - show_status: show statusbar or not
@@ -194,10 +196,10 @@ Some variables have callback functions which will get called after setting the v
   - load_finish_handler
   - load_start_handler
   - load_commit_handler
-  - history_handler
   - download_handler
   - cookie_handler
   - new_window: handler to execute to invoke new uzbl window (TODO better name)
+  - scheme_handler: handler to execute for each URI navigated to - the navigation request will be ignored if handler prints "USED\n"
   - fifo_dir: location to store fifo's
   - socket_dir: location to store sockets
   - http_debug: http debug mode (value 0-3)
@@ -222,6 +224,13 @@ Some variables have callback functions which will get called after setting the v
   - default_encoding: iso-8859-1 by default
   - enforce_96_dpi: 1 by default
   - caret_browsing
+  - default_font_family = sans-serif
+  - monospace_font_family = monospace (example "Aerial Mono" )
+  - cursive_font_family = sans
+  - fantasy_font_family = "Pterra"
+  - serif_font_family = serif (example "DejaVu Serif")
+  - sans_serif_font_family = sans (example "DejaVu Sans")
+
 
 * Constants (not dumpable or writeable):
   - WEBKIT_MAJOR: set at compile time
@@ -344,10 +353,6 @@ Handler scripts that are called by uzbl are passed the following arguments:
 
 The script specific arguments are this:
 
-* history:
-
-    $8 date of visit (Y-m-d H:i:s localtime)
-
 * add bookmark:
 
     none
@@ -355,6 +360,7 @@ The script specific arguments are this:
 * download:
 
     $8 url of item to download
+    $9 url of http proxy (optional)
 
 * cookie handler
 
@@ -364,6 +370,10 @@ The script specific arguments are this:
     $11 request address path
     $12 cookie (only with PUT requests)
 
+* scheme handler:
+
+    $8 URI of the page to be navigated to
+
 
 Custom, userdefined scripts (`spawn foo bar`) get first the arguments as specified in the config and then the above 7 are added at the end.
 
@@ -402,11 +412,12 @@ Copying the Uzbl object and creating public functions should be taken with care
 
 ### COMMAND LINE ARGUMENTS
     uzbl [ uri ]
-    -u, --uri=URI            alternative way to load uri on start. (equivalent to 'set uri = URI')
+    -u, --uri=URI            Uri to load at startup (equivalent to 'uzbl <uri>' or 'set uri = URI' after uzbl has launched)
     -v, --verbose            Whether to print all messages or just errors.
     -n, --name=NAME          Name of the current instance (defaults to Xorg window id)
-    -c, --config=FILE        Config file (or `-` to use stdin)
+    -c, --config=FILE        Path to config file or '-' for stdin
     -s, --socket=SOCKET      Socket ID
+    -g, --geometry=GEOMETRY  Set window geometry (format: WIDTHxHEIGHT+-X+-Y)
     -V, --version            Print the version and exit
     --display=DISPLAY        X display to use
     --help                   Help
@@ -414,6 +425,5 @@ Copying the Uzbl object and creating public functions should be taken with care
 
 
 
-
 ### BUGS
 Please report new issues @ uzbl.org/bugs