Makefile improvements
[pyxattr.git] / doc / module.rst
1 Interface to extended filesystem attributes
2 ===========================================
3
4 .. automodule:: xattr
5
6 Constants
7 ---------
8
9 .. data:: XATTR_CREATE
10
11    Used as flags value, the target attribute
12    will be created, giving an error if it already exists.
13
14 .. data:: XATTR_REPLACE
15
16    Used as flags value, the target attribute
17    will be replaced, giving an error if it doesn't exist.
18
19 .. data:: NS_SECURITY
20
21    The security namespace, used by kernel security modules.
22
23 .. data:: NS_SYSTEM
24
25    The system namespace, used by the kernel to store things such as
26    ACLs and capabilities.
27
28 .. data:: NS_TRUSTED
29
30    The trusted namespace, visible and accessibly only to trusted
31    processes, used to implement mechanisms in user space.
32
33 .. data:: NS_USER
34
35    The user namespace; this is the namespace accessible to
36    non-privileged processes.
37
38 Functions
39 ---------
40
41 .. autofunction:: list
42 .. autofunction:: get
43 .. autofunction:: get_all
44 .. autofunction:: set
45 .. autofunction:: remove
46
47
48 Deprecated functions
49 --------------------
50
51 .. autofunction:: getxattr
52 .. autofunction:: setxattr
53 .. autofunction:: listxattr
54 .. autofunction:: removexattr