Package | Role | Debian | Gentoo |
---|---|---|---|
PyYAML | serialized data storage | python-yaml | dev-python/pyyaml |
Sphinx | see Producing this documentation | python-sphinx | dev-python/sphinx |
numpydoc | see Producing this documentation | ||
xsltproc | see Producing this documentation | 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.
[1] | See bugs 490716 and 447959. |
[2] | See Diego Elio Pettenò’s blog entry. |
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. 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 (Producing this documentation). 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.
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-<VERSION>.tar.gz
And install it with::
$ cd be-<VERSION>
$ make install
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.