support for some default settings so that uzbl is more uzbl by default (without confi...
[uzbl-mobile] / docs / 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 ] # optional. see below
13         $ cd uzbl
14         $ make
15         $ sudo make install
16 If you want to remove uzbl again, you can issue:
17
18         $ make uninstall
19
20 Dependencies
21 ------------
22 * git (for downloading)
23 * pkgconfig (for Make/gcc)
24 * libwebkit 1.1.4 or higher
25 * libsoup 2.24 or higher (dep for webkit/gtk+)
26 * gtk 2 something something
27
28 Optional/Recommended
29 --------------------
30 The following tools are quite useful, and some of them are used in the
31 sample scripts:
32
33 * dmenu (with vertical patch
34 * zenity
35 * bash 
36
37 File locations
38 --------------
39 After installing - using either method - you will find:
40
41 * /usr/bin : uzbl [and uzblctrl]
42 * /usr/share/uzbl/docs/ : documentation files included with uzbl. (readme, checklist, .. )
43 * /usr/share/uzbl/examples: sample scripts, config files and a sample data (boomarks, .. ) 
44
45 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
46 $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
47 the config file with the --config parameter.
48
49 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)
50 is very useful for keeping a clean home directory, so we recommend:
51
52 * $XDG\_CONFIG\_HOME/uzbl/config* (~/.config/uzbl/config on most systems): config file
53 * $XDG\_DATA\_HOME/uzbl (~/.local/share/uzbl on most systems): bookmarks file, history file. and "scripts" directory with scripts
54
55 Git Repo's & branches
56 --------------------
57 * Main official repo:
58   http://github.com/Dieterbe/uzbl
59 - master -> uzbl stable branch
60 - experimental -> bleeding edge stuff that may break. after QA Dieter merges into his master
61
62 * Most contributors & developers also have their clones on github (http://github.com/dusanx, http://github.com/Barrucadu/uzbl, ...).
63   They may be developing specific features, which get merged into Dieters experimental branch