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
|
Installation
============
There are several options for installing drgn.
Dependencies
------------
drgn depends on:
- `Python <https://www.python.org/>`_ 3.6 or newer
- `elfutils <https://sourceware.org/elfutils/>`_ 0.165 or newer
It optionally depends on:
- `libkdumpfile <https://github.com/ptesarik/libkdumpfile>`_ for `makedumpfile
<https://github.com/makedumpfile/makedumpfile>`_ compressed kernel core dump
format support
- `liblzma <https://tukaani.org/xz/>`_ for `MiniDebuginfo
<https://sourceware.org/gdb/current/onlinedocs/gdb.html/MiniDebugInfo.html>`_
support
The build requires:
- `GCC <https://gcc.gnu.org/>`_
- `GNU Make <https://www.gnu.org/software/make/>`_
- `pkgconf <http://pkgconf.org/>`_
- `setuptools <https://pypi.org/project/setuptools/>`_
Running tests requires:
- `check <https://libcheck.github.io/check/>`_ 0.10.0 or newer
Building from the Git repository (rather than a release tarball) additionally
requires:
- `autoconf <https://www.gnu.org/software/autoconf/>`_
- `automake <https://www.gnu.org/software/automake/>`_
- `libtool <https://www.gnu.org/software/libtool/>`_
.. include:: ../README.rst
:start-after: start-installation
:end-before: end-installation
.. highlight:: console
Virtual Environment
^^^^^^^^^^^^^^^^^^^
The above options all install drgn globally. You can also install drgn in a
`virtual environment <https://docs.python.org/3/library/venv.html>`_, either
with pip::
$ python3 -m venv drgnenv
$ source drgnenv/bin/activate
(drgnenv) $ pip3 install drgn
(drgnenv) $ drgn --help
Or from source::
$ python3 -m venv drgnenv
$ source drgnenv/bin/activate
(drgnenv) $ python3 setup.py install
(drgnenv) $ drgn --help
Running Locally
---------------
If you build drgn from source, you can also run it without installing it::
$ python3 setup.py build_ext -i
$ python3 -m drgn --help
|