Welcome to pylibelf's documentation!
====================================

Welcome to pylibelf. Pylibelf is a pythonic wrapper for the libelf [#]_ library, it
allows you to read and write ELF files, and to read ar files. 
It also interprets certain
section types, provides a segment to section mapping, and provides a working
ldd implementation.

Contents
========

.. toctree::
    :maxdepth: 2

    installation
    quickstart 
    modules/index

Download
========
You can download the source here. See the :doc:`installation` notes.

* :download:`pylibelf.tar.gz <pylibelf.tar.gz>`
* :download:`pylibelf-full.tar.gz <pylibelf-full.tar.gz>` (includes docs)

You can also check out the latest version using mercurial::

    hg clone https://bitbucket.org/eggy/pylibelf

Indices and tables
==================

* :ref:`genindex`

References
==========
For an overview of ELF, see the wikipedia [#]_ article. 
It also contains links to the ELF specification.

.. rubric:: References
.. [#] You can download the newest version of ``libelf`` here: 
 http://www.mr511.de/software/. Make sure you have at least version ``0.8.13``.
.. [#] http://cython.org/
.. [#] For a quick overview of the ELF format see 
 http://en.wikipedia.org/wiki/Executable_and_Linkable_Format. It also contains
 links to the various ELF specifications.
