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