Merged Barrucadu code (I hope)

[uzbl-mobile] / README

diff --git a/README b/README
index c15cc45..ed8471a 100644 (file)
--- a/README
+++ b/README
@@ -60,17 +60,44 @@ There is code to run a benchmark in the 'extra' dir.  For results & interpretati
 CONTROL:
 - FIFO opened in /tmp/uzbl_pid
 - See config file for commands
-- Press ESC to toggle the command entry.
-- Press enter after typing a command to use it.
+- Press ESC/i to toggle command/insert mode
 
-NOTE:
+NOTES:
 - My c skills are very rusty, it will take me a while to get back up to speed
 - For more thoughts & ideas see http://bbs.archlinux.org/viewtopic.php?id=67463
-- I push the code most times I save any changes, regardless of whether it actually compiles or not. Thus, the code here should be regarded as highly experimental.
+
+REPO's:
+- http://github.com/Dieterbe/uzbl
+  master -> uzbl stable branch
+  experimental -> bleeding edge stuff that may break. after QA codes gets merged into master
+- various contributors also have their clones on github (http://github.com/dusanx, http://github.com/Barrucadu/uzbl, ...).
+  They may be developing specific features, which get merged into Dieters experimental branch
+
+
+EXTERNAL SCRIPTS
+You can use external scripts with uzbl the following ways:
+1) let uzbl call them. these scripts are called handlers in the uzbl config. used for handling logging history, handling a new download,.. 
+2) call them yourself from inside uzbl.  you can bind keys for this. examples: add new bookmark, load new url,..
+3) if you want to call scripts that have no option, you can trigger them with something like xbindkeys. example: ? (we try to keep all possibilities inside option 1/2)
+
+Scripts that are called by uzbl are passed the following arguments:
+$1 uzbl-config-file
+$2 uzbl-pid
+$3 uzbl-x-window-id
+$4 uzbl_fifo-filename
+.. [ script specific ] (optional)
+
+The script specific arguments are this:
+* history:
+  $5 page url
+  $6 page title
+  $7 date of visit (Y-m-d H:i:s localtime)
+* add bookmark:
+  $5 page url
+  $6 page title
+* download:
+  $5 url
 
 KNOWN BUGS
-- Segfault occurs on shutdown, almost definitely FIFO related (I'm not seeing this bug now, but the warning was here when I forked the code and I haven't touched the FIFO bit)
 - Segfaults when using zoom commands (happens when max zoom already reached?).
 - Something in the FIFO code causes CPU usage to jump.
-- Segfaults when loading aliases from config file (currently aliases are defined in the code as a 'work-around').
-- Segfaults when setting the xwin variable
\ No newline at end of file