<commit_before>===================
 Installing LLFUSE
===================

.. highlight:: sh


Dependencies
============

In order to build and run LLFUSE you need the following software:

* Linux, FreeBSD or MacOS X system
* **Linux only**: Kernel 2.6.9 or newer. Starting with kernel
  2.6.26 you will get significantly better write performance, so under
  Linux you should actually use *2.6.26 or newer whenever possible*.
* **Linux only**: Version 2.8.0 or newer of the `FUSE
  <http://fuse.sourceforge.net/>`_ library.
* **FreeBSD only**: The `FUSE4BSD
  <http://www.freshports.org/sysutils/fusefs-kmod/>`_ kernel module.
* **OS-X only**: the `FUSE4X <http://fuse4x.org/>`_ package,
  version 0.9.1 or newer.
* `Python <http://www.python.org/>`_ 2.6 or newer (including Python
  3.x), installed with development headers
* `pkg-config <http://www.freedesktop.org/wiki/Software/pkg-config>`_ (only for building)
* A C compiler (only for building)


Stable releases
===============

LLFUSE can be installed like any other Python extension. Make sure
that you have the Python, FUSE and extended attribute ("xattr")
development headers installed, then download and extract the LLFUSE
tarball and run ::

  sudo python setup.py install

or :: 

  python setup.py install --user

Note that LLFUSE requires at least FUSE 2.8.0 and Python 2.6.

Development Version
===================

If you have checked out the unstable development version from the
Mercurial repository, a bit more effort is required. You need to also
have Cython_ (0.16 or newer) and Sphinx_ (1.1 or newer) installed, and
the necessary commands are::

  python setup.py build_cython
  python setup.py build_ext --inplace
  python setup.py build_sphinx
  python setup.py install
  
  
.. _Cython: http://www.cython.org/
.. _Sphinx: http://sphinx.pocoo.org/
<commit_msg>Improve installation instructions. Fixes issue 20.<commit_after>===================
 Installing LLFUSE
===================

.. highlight:: sh


Dependencies
============

In order to build and run LLFUSE you need the following software:

* Linux, FreeBSD or MacOS X system
* Python_ 2.6 or newer (including Python 3.x), installed with
  development headers
* the `pkg-config`_ tool
* the `attr`_ library
* A C compiler (only for building)

When using Linux, you also need:

* Kernel 2.6.9 or newer. Starting with kernel
  2.6.26 you will get significantly better write performance, so under
  Linux you should actually use *2.6.26 or newer whenever possible*.
* Version 2.8.0 or newer of the FUSE_ library.

In case of FreeBSD, you will need:

* The FUSE4BSD_ kernel module.

For OS-X, you need:

* the FUSE4X_ package, version 0.9.1 or newer.


Stable releases
===============

LLFUSE can be installed like any other Python extension. Make sure
that you have all necessary dependencies installed (when installing
packages from a distribution, make sure to also install the
corresponding *-dev* or *-devel* development packages), then download
and extract the LLFUSE tarball and run ::

  sudo python setup.py install

or :: 

  python setup.py install --user


Development Version
===================

If you have checked out the unstable development version from the
Mercurial repository, a bit more effort is required. You need to also
have Cython_ (0.16 or newer) and Sphinx_ (1.1 or newer) installed, and
the necessary commands are::

  python setup.py build_cython
  python setup.py build_ext --inplace
  python setup.py build_sphinx
  python setup.py install
  
  
.. _Cython: http://www.cython.org/
.. _Sphinx: http://sphinx.pocoo.org/
.. _Python: http://www.python.org/
.. _FUSE: http://fuse.sourceforge.net/
.. _attr: http://savannah.nongnu.org/projects/attr/
.. _`pkg-config`: http://www.freedesktop.org/wiki/Software/pkg-config
.. _FUSE4BSD: http://www.freshports.org/sysutils/fusefs-kmod/
.. _FUSE4X: http://fuse4x.org/

{'fraction_non_alphanumeric': 0.1344364012409514, 'fraction_numerical': 0.016804550155118926, 'mean_word_length': 3.9602564102564104, 'pattern_counts': {'":': 0, '<': 8, '<?xml version=': 0, '>': 8, 'https://': 0, 'lorem ipsum': 0, 'www.': 8, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6462038', 'n_tokens_mistral': 1242, 'n_tokens_neox': 1158, 'n_words': 458}