]> git.k1024.org Git - pyxattr.git/blob - doc/module.rst
Convert the NEWS file to markdown
[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 name space, used by kernel security modules to store
22    (for example) capabilities information.
23
24 .. data:: NS_SYSTEM
25
26    The system name space, used by the kernel to store (for example)
27    ACLs.
28
29 .. data:: NS_TRUSTED
30
31    The trusted name space, visible and accessibly only to trusted
32    processes, used to implement mechanisms in user space.
33
34 .. data:: NS_USER
35
36    The user name space; this is the name space accessible to
37    non-privileged processes.
38
39 Functions
40 ---------
41
42 .. autofunction:: list
43 .. autofunction:: get
44 .. autofunction:: get_all
45 .. autofunction:: set
46 .. autofunction:: remove
47
48
49 Deprecated functions
50 --------------------
51
52 .. autofunction:: getxattr
53 .. autofunction:: setxattr
54 .. autofunction:: listxattr
55 .. autofunction:: removexattr