git.maemo.org Git - uzbl-mobile/blob - docs/INSTALL

   1 Packages
   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 For other distros, see [uzbl.org/wiki/howtos](http://www.uzbl.org/wiki/howtos)
  10
  11 From source
  12 -----------
  13 You can pull the code from git or get a tagged tarball.
  14
  15         $ git clone git://github.com/Dieterbe/uzbl.git
  16         [ $ git checkout origin/experimental ] # optional. see below
  17         $ cd uzbl
  18         $ make
  19         $ sudo make install
  20 If you want to remove uzbl again, you can issue:
  21
  22         $ make uninstall
  23
  24 Tarballs can be pulled from [github.com/Dieterbe/uzbl/downloads](http://github.com/Dieterbe/uzbl/downloads)
  25
  26 Though you can only get tagged versions from the master branch, which may be older then what you'll have through git.
  27
  28 Dependencies
  29 ------------
  30 * git (for downloading)
  31 * pkgconfig (for Make/gcc)
  32 * libwebkit 1.1.4 or higher
  33 * libsoup 2.24 or higher (dep for webkit/gtk+)
  34 * gtk 2.14 or higher
  35
  36 Optional/Recommended
  37 --------------------
  38 The following tools are quite useful, and some of them are used in the
  39 sample scripts:
  40
  41 * dmenu (with vertical patch)
  42 * zenity
  43 * bash
  44 * python (cookies.py)
  45 * perl (formfiller.pl)
  46
  47 File locations
  48 --------------
  49 After installing - using either method - you will find:
  50
  51 * /usr/bin : uzbl [and uzblctrl]
  52 * /usr/share/uzbl/docs/ : documentation files included with uzbl. (readme, checklist, .. )
  53 * /usr/share/uzbl/examples: sample scripts, config files and a sample data (boomarks, .. )
  54
  55 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
  56 $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
  57 the config file with the --config parameter.
  58
  59 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)
  60 is very useful for keeping a clean home directory, so we recommend:
  61
  62 * $XDG\_CONFIG\_HOME/uzbl/config* (~/.config/uzbl/config on most systems): config file
  63 * $XDG\_DATA\_HOME/uzbl (~/.local/share/uzbl on most systems): bookmarks file, history file. and "scripts" directory with scripts
  64
  65 Git Repo's & branches
  66 --------------------
  67 * Main official repo:
  68   http://github.com/Dieterbe/uzbl
  69 - master -> uzbl stable branch
  70 - experimental -> bleeding edge stuff that may break. after QA Dieter merges into his master
  71
  72 * Most contributors & developers also have their clones on github (http://github.com/dusanx, http://github.com/Barrucadu/uzbl, ...).
  73   They may be developing specific features, which get merged into Dieters experimental branch