aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/INSTALL
blob: 93e55f7ac8445566d5443ffee092715f7683d11b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
Packages
--------
[Arch Linux](http://www.archlinux.org) is our distro of choice, and the distro we use for testing.

You can find a [PKGBUILD](http://aur.archlinux.org/packages.php?ID=25972) on the AUR, which installs the latest
from the master branch. You can edit the PKGBUILD to change to any other
branch you want.

For other distros, see [uzbl.org/wiki/howtos](http://www.uzbl.org/wiki/howtos)

From source
-----------
You can pull the code from git or get a tagged tarball.

	$ git clone git://github.com/Dieterbe/uzbl.git
	[ $ git checkout origin/experimental ] # optional. see below
	$ cd uzbl
	$ make
	$ sudo make install
If you want to remove uzbl again, you can issue:

	$ make uninstall

Tarballs can be pulled from [github.com/Dieterbe/uzbl/downloads](http://github.com/Dieterbe/uzbl/downloads)

Though you can only get tagged versions from the master branch, which may be older then what you'll have through git.

Dependencies
------------
* git (for downloading)
* pkg-config (for Make/gcc)
* libwebkit 1.1.4 or higher
* libsoup 2.24 or higher (dep for webkit/gtk+)
* gtk 2.14 or higher

Optional/Recommended
--------------------
The following tools are quite useful, and some of them are used in the
sample scripts:

* socat (for socket communication)
* dmenu (with vertical patch)
* zenity
* bash
* python (cookies.py)
* perl (formfiller.pl)

File locations
--------------
After installing - using either method - you will find:

* /usr/bin : uzbl
* /usr/share/uzbl/docs/ : documentation files included with uzbl. (readme, checklist, .. )
* /usr/share/uzbl/examples: sample scripts, config files and a sample data (boomarks, .. )

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
$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
the config file with the --config parameter.

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)
is very useful for keeping a clean home directory, so we recommend:

* $XDG\_CONFIG\_HOME/uzbl/config* (~/.config/uzbl/config on most systems): config file
* $XDG\_DATA\_HOME/uzbl (~/.local/share/uzbl on most systems): bookmarks file, history file. and "scripts" directory with scripts

Git Repo's & branches
--------------------
* Main official repo:
  http://github.com/Dieterbe/uzbl
- master -> uzbl stable branch
- experimental -> bleeding edge stuff that may break. after QA Dieter merges into his master

* Most contributors & developers 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