diff --git a/reference/xattr/constants.xml b/reference/xattr/constants.xml index 6315fe9b1e..8f2b6b37e3 100644 --- a/reference/xattr/constants.xml +++ b/reference/xattr/constants.xml @@ -1,5 +1,5 @@ - +
&reftitle.constants; &extension.constants; @@ -11,7 +11,7 @@ - + Set attribute in root (trusted) namespace. Requires root privileges. @@ -22,7 +22,7 @@ - + Do not follow the symbolic link but operate on symbolic link itself. @@ -33,7 +33,7 @@ - + Function will fail if extended attribute already exists. @@ -44,7 +44,7 @@ - + Function will fail if extended attribute doesn't exist. diff --git a/reference/xattr/functions/xattr-get.xml b/reference/xattr/functions/xattr-get.xml index 839f1d1cbc..fefe145388 100644 --- a/reference/xattr/functions/xattr-get.xml +++ b/reference/xattr/functions/xattr-get.xml @@ -1,57 +1,84 @@ - + - - - xattr_get - - Get an extended attribute - - - - Description - - stringxattr_get - stringpath - stringname - intflags - - - This function gets a value of an extended attribute named name - of a file path. - - - Extended attributes have two different namespaces: user and root namespace. - User namespace is available for all users while root namespace is available - only for user with root privileges. xattr operates on user namespace by default, - but you can change that using flags argument. - - - - Supported xattr flags - - - - XATTR_DONTFOLLOW - Do not follow the symbolic link but operate on symbolic link itself. - - - XATTR_ROOT - Set attribute in root (trusted) namespace. Requires root privileges. - - - -
-
- - Returns string with value or &false; if attribute doesn't exist. - - - <function>xattr_get</function> example - - The following code checks if system administrator has signed the file. - - + + + xattr_get + + Get an extended attribute + + + + &reftitle.description; + + stringxattr_get + stringfilename + stringname + intflags + + + This function gets the value of an extended attribute of a file. + + &xattr.namespace; + + + &reftitle.parameters; + + + + filename + + + The file from which we get the attribute. + + + + + name + + + The name of the attribute. + + + + + flags + + + + Supported xattr flags + + + + XATTR_DONTFOLLOW + Do not follow the symbolic link but operate on symbolic link itself. + + + XATTR_ROOT + Set attribute in root (trusted) namespace. Requires root privileges. + + + +
+
+
+
+
+
+
+ + &reftitle.returnvalues; + + Returns a string containing the value or &false; if the attribute doesn't + exist. + + + + &reftitle.examples; + + + Checks if system administrator has signed the file + ]]> - - - - See also xattr_set, xattr_remove, - xattr_list, xattr_supported. - - -
+
+
+ +
+ + &reftitle.seealso; + + + xattr_list + xattr_set + xattr_remove + + + +
+--> \ No newline at end of file diff --git a/reference/xattr/functions/xattr-list.xml b/reference/xattr/functions/xattr-list.xml index b2d030b6f9..c7e449b777 100644 --- a/reference/xattr/functions/xattr-list.xml +++ b/reference/xattr/functions/xattr-list.xml @@ -1,56 +1,74 @@ - + - - - xattr_list - - Get a list of extended attributes - - - - Description - - arrayxattr_list - stringpath - intflags - - - This functions gets a list of names of extended attributes of a file - path. - - - Extended attributes have two different namespaces: user and root namespace. - User namespace is available for all users while root namespace is available - only for user with root privileges. xattr operates on user namespace by default, - but you can change that using flags argument. - - - - Supported xattr flags - - - - XATTR_DONTFOLLOW - Do not follow the symbolic link but operate on symbolic link itself. - - - XATTR_ROOT - Set attribute in root (trusted) namespace. Requires root privileges. - - - -
-
- - This function returns array with names of extended attributes. - - - <function>xattr_list</function> example - - The following code prints names of all extended attributes of file. - - + + + xattr_list + + Get a list of extended attributes + + + + &reftitle.description; + + arrayxattr_list + stringfilename + intflags + + + This functions gets a list of names of extended attributes of a file. + + &xattr.namespace; + + + &reftitle.parameters; + + + + filename + + + The path of the file. + + + + + flags + + + + Supported xattr flags + + + + XATTR_DONTFOLLOW + Do not follow the symbolic link but operate on symbolic link itself. + + + XATTR_ROOT + Set attribute in root (trusted) namespace. Requires root privileges. + + + +
+
+
+
+
+
+
+ + &reftitle.returnvalues; + + This function returns an array with names of extended attributes. + + + + &reftitle.examples; + + + Prints names of all extended attributes of file + ]]> - - - - See also xattr_get, xattr_set, - xattr_remove, xattr_supported. - - -
+
+
+ +
+ + &reftitle.seealso; + + + xattr_get + + + +
+--> \ No newline at end of file diff --git a/reference/xattr/functions/xattr-remove.xml b/reference/xattr/functions/xattr-remove.xml index 70f17ec7ed..46517c89b1 100644 --- a/reference/xattr/functions/xattr-remove.xml +++ b/reference/xattr/functions/xattr-remove.xml @@ -1,57 +1,83 @@ - + - - - xattr_remove - - Remove an extended attribute - - - - Description - - boolxattr_remove - stringpath - stringname - intflags - - - This function removes an extended attribute named name - of a file path. - - - Extended attributes have two different namespaces: user and root namespace. - User namespace is available for all users while root namespace is available - only for user with root privileges. xattr operates on user namespace by default, - but you can change that using flags argument. - - - - Supported xattr flags - - - - XATTR_DONTFOLLOW - Do not follow the symbolic link but operate on symbolic link itself. - - - XATTR_ROOT - Set attribute in root (trusted) namespace. Requires root privileges. - - - -
-
- - &return.success; - - - <function>xattr_remove</function> example - - The following code removes all extended attributes of file. - - + + + xattr_remove + + Remove an extended attribute + + + + &reftitle.description; + + boolxattr_remove + stringfilename + stringname + intflags + + + This function removes an extended attribute of a file. + + &xattr.namespace; + + + &reftitle.parameters; + + + + filename + + + The file from which we remove the attribute. + + + + + name + + + The name of the attribute to remove. + + + + + flags + + + + Supported xattr flags + + + + XATTR_DONTFOLLOW + Do not follow the symbolic link but operate on symbolic link itself. + + + XATTR_ROOT + Set attribute in root (trusted) namespace. Requires root privileges. + + + +
+
+
+
+
+
+
+ + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.examples; + + + Removes all extended attributes of a file + ]]> - - - - See also xattr_get, xattr_set, - xattr_list, xattr_supported. - - -
+
+
+ +
+ + &reftitle.seealso; + + + xattr_list + xattr_set + xattr_get + + + +
+--> \ No newline at end of file diff --git a/reference/xattr/functions/xattr-set.xml b/reference/xattr/functions/xattr-set.xml index f66be002dc..a721ff109b 100644 --- a/reference/xattr/functions/xattr-set.xml +++ b/reference/xattr/functions/xattr-set.xml @@ -1,69 +1,102 @@ - + - - - xattr_set - - Set an extended attribute - - - - Description - - boolxattr_set - stringpath - stringname - stringvalue - intflags - - - This function sets value of an extended attribute named name - to value of a file path. - Extended attribute will be created if it doesn't exist or replaced - otherwise. You can change this behaviour by using flags - parameter. - - - Extended attributes have two different namespaces: user and root namespace. - User namespace is available for all users while root namespace is available - only for user with root privileges. xattr operates on user namespace by default, - but you can change that using flags argument. - - - - Supported xattr flags - - - - XATTR_CREATE - Function will fail if extended attribute already exists. - - - XATTR_REPLACE - Function will fail if extended attribute doesn't exist. - - - XATTR_DONTFOLLOW - Do not follow the symbolic link but operate on symbolic link itself. - - - XATTR_ROOT - Set attribute in root (trusted) namespace. Requires root privileges. - - - -
-
- - &return.success; - - - <function>xattr_set</function> example - - The following code sets extended attributes on .wav file. - - + + + xattr_set + + Set an extended attribute + + + + &reftitle.description; + + boolxattr_set + stringfilename + stringname + stringvalue + intflags + + + This function sets the value of an extended attribute of a file. + + &xattr.namespace; + + + &reftitle.parameters; + + + + filename + + + The file in which we set the attribute. + + + + + name + + + The name of the exteded attribute. This attribute will be created if + it doesn't exist or replaced otherwise. You can change this behaviour + by using the flags parameter. + + + + + value + + + The value of the attribute. + + + + + flags + + + + Supported xattr flags + + + + XATTR_CREATE + Function will fail if extended attribute already exists. + + + XATTR_REPLACE + Function will fail if extended attribute doesn't exist. + + + XATTR_DONTFOLLOW + Do not follow the symbolic link but operate on symbolic link itself. + + + XATTR_ROOT + Set attribute in root (trusted) namespace. Requires root privileges. + + + +
+
+
+
+
+
+
+ + &reftitle.returnvalues; + + &return.success; + + + + &reftitle.examples; + + + Sets extended attributes on .wav file + ]]> - - - - See also xattr_get, xattr_remove, - xattr_list, xattr_supported. - - -
+
+
+ +
+ + &reftitle.seealso; + + + xattr_get + xattr_remove + + + +
+--> \ No newline at end of file diff --git a/reference/xattr/functions/xattr-supported.xml b/reference/xattr/functions/xattr-supported.xml index 8bb20d1253..cee858e585 100644 --- a/reference/xattr/functions/xattr-supported.xml +++ b/reference/xattr/functions/xattr-supported.xml @@ -1,36 +1,75 @@ - + - - - xattr_supported - - Check if filesystem supports extended attributes - - - - Description - - boolxattr_supported - stringpath - intflags - + + + xattr_supported + + Check if filesystem supports extended attributes + + + + &reftitle.description; + + boolxattr_supported + stringfilename + intflags + + + This functions checks if the filesystem holding the given file supports + extended attributes. Read access to the file is required. + + + + &reftitle.parameters; + + + + filename + + + The path of the tested file. + + + + + flags + + + + Supported xattr flags + + + + XATTR_DONTFOLLOW + Do not follow the symbolic link but operate on symbolic link itself. + + + +
+
+
+
+
+
+
+ + &reftitle.returnvalues; + + This function returns &true; if filesystem supports extended attributes, + &false; if it doesn't and &null; if it can't be determined (for example + wrong path or lack of permissions to file). + + + + &reftitle.examples; + + + <function>xattr_supported</function> example - This functions checks if filesystem holding file path - supports extended attributes. Read access to file path - is required. + The following code checks if we can use extended attributes. - - This function returns &true; if filesystem supports extended attributes, - &false; if it doesn't and &null; if it can't be determined (for example - wrong path or lack of permissions to file). - - - <function>xattr_supported</function> example - - The following code checks if we can use extended attributes. - - + ]]> - - - - See also xattr_get, xattr_set, - xattr_remove, xattr_list. - - -
+ + + +
+ + &reftitle.seealso; + + + xattr_get + xattr_list + + + +
+--> \ No newline at end of file