************* Installing BE ************* Dependencies ============ ============== ======================= ============= =========================== Package Role Debian Gentoo ============== ======================= ============= =========================== PyYAML_ serialized data storage python-yaml dev-python/pyyaml Sphinx_ see :doc:`doc` python-sphinx dev-python/sphinx numpydoc_ see :doc:`doc` xsltproc_ see :doc:`doc` xsltproc dev-libs/libxslt ============== ======================= ============= =========================== The XSLT stylesheets reqired to generate the manpage are packaged in ``docbook-xsl-ns`` on Debian [#debian] and ``app-text/docbook-xsl-ns-stylesheets`` on Gentoo [#gentoo]. For futher details on DocBook publishing, see the DocBook wiki pages on tools_ and stylesheets_. .. _PyYAML: http://pyyaml.org/ .. _Sphinx: http://sphinx.pocoo.org/ .. _numpydoc: http://pypi.python.org/pypi/numpydoc .. _xsltproc: http://www.xmlsoft.org/XSLT/ .. [#debian] See bugs `490716 `_ and `447959 `_. .. [#gentoo] See Diego Elio Pettenò's `blog entry `_. .. _tools: http://wiki.docbook.org/topic/DocBookPublishingTools .. _stylesheets: http://wiki.docbook.org/topic/DocBookXslStylesheets Git repository ============== BE is available as a Git repository:: $ git clone git://gitorious.org/be/be.git be See the homepage_ for details. If you do branch the Git repo, you'll need to run:: $ make to build some auto-generated files (e.g. :mod:`libbe._version`), and:: $ make install to install BE. By default BE will install into your home directory, but you can tweak the ``PREFIX`` variable in ``Makefile`` to install to another location. By default, ``make`` builds both a man page for ``be`` and the HTML Sphinx documentation (:doc:`doc`). You can customize the documentation targets by overriding_ the ``DOC`` variable. For example, to disable all documentation during a build/install, run:: $ make DOC= install Note that ``setup.py`` (called during ``make install``) will install the man page (``doc/man/be.1``) if it exists, so:: $ make $ make DOC= install *will* build (first ``make``) install (second ``make``) the man page. .. _homepage: http://bugseverywhere.org/ .. _overriding: http://www.gnu.org/software/make/manual/html_node/Overriding.html#Overriding Release tarballs ================ For those not interested in the cutting edge, or those who don't want to worry about installing Git, we'll post release tarballs somewhere (once we actually make a release). After you've downloaded the release tarball, unpack it with:: $ tar -xzvf be-.tar.gz And install it with::: $ cd be- $ make install Distribution packages ===================== Some distributions (Debian_ , Ubuntu_ , others?) package BE. If you're running one of those distributions, you can install the package with your regular package manager. For Debian, Ubuntu, and related distros, that's:: $ apt-get install bugs-everywhere However, the official packages can lag behind current development. .. _Debian: http://packages.debian.org/sid/bugs-everywhere .. _Ubuntu: http://packages.ubuntu.com/lucid/bugs-everywhere