sample cookie handler and config file
[uzbl-mobile] / INSTALL
1 Arch Linux
2 ----------
3 [Arch Linux](http://www.archlinux.org) is our distro of choice, and the distro we use for testing.
4
5 You can find a [PKGBUILD](http://aur.archlinux.org/packages.php?ID=25972) on the AUR, which installs the latest
6 from the master branch. You can edit the PKGBUILD to change to any other
7 branch you want.
8
9 From source
10 -----------
11         $ git clone git://github.com/Dieterbe/uzbl.git
12         [ $ git checkout master/experimental ] # master == fairly stable.  experimental is more bleeding edge
13         $ cd uzbl
14         $ make
15         $ sudo make install
16
17 Dependencies
18 ------------
19 * git (for downloading)
20 * pkgconfig (for Make/gcc)
21 * libwebkit 1.1.4 or higher
22 * libsoup 2.24 or higher (dep for webkit/gtk+)
23 * gtk 2 something something
24
25 Optional/Recommended
26 --------------------
27 The following tools are quite useful, and some of them are used in the
28 sample scripts:
29
30 * dmenu
31 * zenity
32 * bash 
33
34 File locations
35 --------------
36 After installing - using either method - you will find:
37
38 * /usr/bin : uzbl [and uzblctrl]
39 * /usr/share/uzbl/docs/ : documentation files included with uzbl. (readme, checklist, .. )
40 * /usr/share/uzbl/examples: sample scripts, config files and a sample data (boomarks, .. ) 
41
42 You will probably want to change the scripts to behave more like you want, so copy the scripts to your home dir. If you save your config as
43 $XDG\_CONFIG\_HOME/uzbl/config (this expands to ~/.config/uzbl/config on most systems) it will be recognized automatically. You can also pass the path to
44 the config file with the --config parameter.
45
46 You're free to store your personal stuff where you want, but we think the [XDG basedir spec](http://standards.freedesktop.org/basedir-spec/basedir-spec-0.6.html)
47 is very useful for keeping a clean home directory, so we recommend:
48
49 * $XDG\_CONFIG\_HOME/uzbl/config* (~/.config/uzbl/config on most systems): config file
50 * $XDG\_DATA\_HOME/uzbl (~/.local/share/uzbl on most systems): bookmarks file, history file. and "scripts" directory with scripts