README

   1 ### THIS PROJECT IS NOT FOR:
   2 * people want a browser that does everything
   3 * people who want a browser with things like a built-in bookmark manager, address bar, forward/back buttons, ...
   4 * people who expect something that works by default.  You'll need to read configs and write/edit scripts
   5
   6
   7 ### TO NEW PEOPLE:
   8 * please read the documentation in /usr/share/uzbl/docs
   9 * invoke uzbl --help
  10 * to get you started: uzbl --uri 'http://www.archlinux.org' --config /usr/share/uzbl/examples/configs/sampleconfig
  11 * study the sample config, have a look at all the bindings, and note how you can call the scripts to load new url from history and the bookmarks file
  12 * note that there is no url bar. all url editing is supposed to happen _outside_ of uzbl.
  13   For now, you can use the `load_from_*` dmenu based scripts to pick a url or type a new one or write commands into the fifo (see /usr/share/uzbl/docs/CHECKLIST)
  14 * If you have questions, you are likely to find answers in the FAQ or in the other documentation.
  15
  16
  17 ### INTRODUCTION
  18   In my opinion, any program can only be really useful if it complies to the unix philosophy.
  19   Web browsers are frequent violators of this principle:
  20
  21 * They build in way too much things into the browser, dramatically decreasing the options to do things the way you want.
  22 * They store things in way too fancy formats (xml, rdf, sqlite, ... ) which are hard to store under version control, reuse in other scripts, ...
  23
  24 Time to change that!
  25
  26   Here are the general ideas:
  27
  28 * each instance of uzbl renders 1 page (eg it's a small wrapper around webkit), no tabbing, tab previews, or speed dial things.
  29   For "multiple instances management" use your window managers, or scripts.
  30   This way you can get something much more useful than tabbing (see rationale in docs)
  31 * very simple, plaintext , changeable at runtime configuration
  32 * various interfaces for (programmatic) interaction with uzbl (see below)
  33 * customizable keyboard shortcuts in vim or emacs style (whatever user wants)
  34 * "outsource" logic that is not browsing to external scripts under the users control:
  35     - managing bookmarks
  36     - loading a url from bookmarks, history,..  Editing the curent url
  37     - control cookies
  38     - handling of downloads, history logging, etc.
  39     - management of cache.
  40     - password management
  41     - Leverage the power of utilities such as grep, awk, dmenu, zenity, wget, gnupg (password file) etc.
  42 * listen to signals and do useful stuff when triggered.
  43 * no ad blocking built in.
  44   Alternatives:
  45     - privoxy looks cool and perfectly demonstrates the unix philosphy.
  46     - same for http://bfilter.sourceforge.net
  47     - /etc/hosts (not very good cause you need root and it affects the whole system)
  48       uzblctrl would need to support an option to list all images on a page, so you can easily pick the links to ads to add them to your /etc/hosts.
  49 * vimperator/konqueror-like hyperlink following.
  50 * password management. maybe an encrypted store that unlocks with an ssh key?
  51 * no messing in the users $HOME or in /etc: no writing of anything unless the user (or sysadmin) asks for it.
  52   We recommend using XDG basedir spec for separation of config, data and cache. and state should be a subdir in the config dir (not part of the spec yet) too.
  53
  54
  55 ### CONFIGURATION / CONTROL:
  56 The general idea is that uzbl by default is very bare bones.  you can send it commands to update settings and perform actions, through various interfaces. (TODO: some default settings)
  57 For examples, please see the sample config(s).
  58 There are several interfaces to interact with uzbl:
  59
  60 * uzbl --config <filename>: <filename> will be read line by line, and the commands in it will be executed.  useful to configure uzbl at startup.
  61   If you have a file in `$XDG_CONFIG_HOME/uzbl/config` (this expands to ~/.config/uzbl/config on most systems) it will be automatically recognized
  62 * stdin: you can also write commands into stdin
  63 * interactive: you can enter commands (and bind them to shortcuts, even at runtime)
  64   By default, the behaviour is modal (vi style):
  65   command mode: every keystroke is interpreted to run commands
  66   insert mode: keystrokes are not interpreted so you can enter text into html forms
  67   Press ESC/i to toggle command/insert mode
  68   But if you don't like modal interfaces, you can set `always_insert_mode` and configure a modkey to execute the commands. (emacs style).
  69   There is also support for "chained" commands (multiple characters long) (with backspace/esc shortcuts), and keyworded commands.
  70   Also you can have incremental matching on commands or match after pressing return.  (see sampleconfig for more info)
  71   Also, copy paste works when typing commands:
  72   * insert (paste X cliboard)
  73   * shift insert (paste primary selection buffer)
  74 * FIFO & socket file: if enabled by setting their paths through one of the above means, you can have socket and fifo files available which are very useful to programatically control uzbl (from scripts etc).
  75   The advantage of the fifo is you can write plaintxt commands to it, but it's half duplex only (uzbl cannot send a response to you).
  76   The socket is full duplex but you need a socket-compatible wrapper such as netcat to work with it, or uzblctrl of course,
  77   an utitly we include with uzbl made especially for writing commnands to the socket (and at some point, it will be able to tell you the response
  78   too):  `uzblctrl -s <socketfile> -c <command>`
  79
  80 ### COMMAND SYNTAX
  81 TODO
  82
  83 ### VARIABLE REPLACEMENT
  84 Some of the variables are interpreted:
  85
  86 * title bar: variable replacement (long and short version, depending if statusbar is visible or not)
  87 * user agent: variable replacement
  88 * statusbar: variable replacement + pango markup
  89
  90 This means you can customize how these things appear, what's shown in them and for the statusbar you can even play with the layout.
  91 For examples, see the example config.
  92 For a list of possible variables, see uzbl.h
  93 For more info about the markup format see http://library.gnome.org/devel/pango/stable/PangoMarkupFormat.html
  94
  95
  96 ### EXTERNAL SCRIPTS
  97 You can use external scripts with uzbl the following ways:
  98
  99 * let uzbl call them. these scripts are called handlers in the uzbl config. used for handling logging history, handling a new download,..
 100 * call them yourself from inside uzbl.  you can bind keys for this. examples: add new bookmark, load new url,..
 101 * You could also use xbindkeys or your WM config to trigger scripts if uzbl does not have focus
 102
 103 Have a look at the sample configs and scripts!
 104
 105 Handler scripts that are called by uzbl are passed the following arguments:
 106
 107     $1 uzbl-config-file
 108     $2 uzbl-pid
 109     $3 uzbl-x-window-id
 110     $4 uzbl_fifo-filename
 111     $5 uzbl_socket-filename
 112     $6 current page url
 113     $7 current page title
 114     .. [ script specific ] (optional)
 115
 116 The script specific arguments are this:
 117
 118 * history:
 119
 120     $8 date of visit (Y-m-d H:i:s localtime)
 121
 122 * add bookmark:
 123
 124     none
 125
 126 * download:
 127
 128     $8 url of item to download
 129
 130 * cookie handler
 131
 132     $8 GET/PUT
 133     $9 request address host (if current page url is www.foo.com/somepage, this could be something else then foo, eg advertising from another host)
 134     $10 request address path
 135     $11 cookie (only with PUT requests)
 136
 137
 138 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.
 139
 140 ### COMMAND LINE ARGUMENTS
 141
 142     -u, --uri=URI            Uri to load (equivalent to 'set uri = URI')
 143     -v, --verbose            Whether to print all messages or just errors.
 144     -n, --name=NAME          Name of the current instance (defaults to Xorg window id)
 145     -c, --config=FILE        Config file (this is pretty much equivalent to uzbl < FILE )
 146     --display=DISPLAY        X display to use
 147     --help                   Help
 148
 149
 150 ### BUGS
 151 known bugs:
 152
 153 * Segfaults when using zoom commands (happens when max zoom already reached?).
 154
 155 Please report new issues @ uzbl.org/bugs
 156
 157