README.rst

   1 pylibacl
   2 ========
   3
   4 This is a Python 2.7+ extension module allows you to manipulate the
   5 POSIX.1e Access Control Lists present in some OS/file-systems
   6 combinations.
   7
   8 Downloads: go to http://pylibacl.k1024.org/downloads. Latest
   9 version is 0.5.3. The source repository is either
  10 at `<git://git.k1024.org/pylibacl.git>`_ or
  11 at https://github.com/iustin/pylibacl.
  12
  13 For any issues, please file bugs at
  14 https://github.com/iustin/pylibacl/issues.
  15
  16 Requirements
  17 ------------
  18
  19 pylibacl has been written and tested on Linux, kernel v2.4 or newer,
  20 with XFS filesystems; ext2/ext3 should also work. Since release 0.4.0,
  21 FreeBSD 7 also has quite good support. If any other platform
  22 implements the POSIX.1e draft, pylibacl can be used. I heard that
  23 Solaris does, but I can't test it.
  24
  25 - Python 2.7 or newer.
  26 - Operating system:
  27     - Linux, kernel v2.4 or newer, and the libacl library and
  28       development packages (all modern distributions should have this,
  29       under various names); also the file-systems you use must have
  30       ACLs turned on, either as a compile or mount option.
  31     - FreeBSD 7.0 or newer.
  32 - The sphinx python module, for your python version, if building the
  33   documentation.
  34
  35 Note: to build from source, by default, Python 3 is needed. It can
  36 still be built with Python 2, by calling `make PYTHON=python2`.
  37
  38 FreeBSD
  39 +++++++
  40
  41 Note that on FreeBSD, ACLs are not enabled by default (at least on UFS
  42 file systems). To enable them, run `tunefs -a enabled` on the file
  43 system in question (after mounting it read-only). Then install:
  44
  45 - pkg install py36-setuptools py36-sphinx
  46
  47 or:
  48
  49 - pkg install py37-setuptools
  50
  51
  52 License
  53 -------
  54
  55 pylibacl is Copyright (C) 2002-2009, 2012, 2014, 2015 Iustin Pop.
  56
  57 pylibacl is free software; you can redistribute it and/or modify it under the
  58 terms of the GNU Lesser General Public License as published by the Free
  59 Software Foundation; either version 2.1 of the License, or (at your option) any
  60 later version. See the COPYING file for the full license terms.