share/man/man9/extattr.9

   1 .\"-
   2 .\" Copyright (c) 1999, 2000, 2001, 2003 Robert N. M. Watson
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .Dd December 23, 1999
  27 .Dt EXTATTR 9
  28 .Os
  29 .Sh NAME
  30 .Nm extattr
  31 .Nd virtual file system named extended attributes
  32 .Sh SYNOPSIS
  33 .In sys/param.h
  34 .In sys/vnode.h
  35 .In sys/extattr.h
  36 .Sh DESCRIPTION
  37 Named extended attributes allow additional meta-data to be associated
  38 with vnodes representing files and directories.
  39 The semantics of this additional data is that of a "name=value" pair, where
  40 a name may be defined or undefined, and if defined, associated with zero or
  41 more bytes of arbitrary binary data.
  42 Extended attribute names exist within a set of namespaces; each operation
  43 on an extended attribute is required to provide the namespace to which to
  44 operation refers.
  45 If the same name is present in multiple namespaces, the extended attributes
  46 associated with the names are stored and manipulated independently.
  47 The following two namespaces are defined universally, although individual
  48 file systems may implement additional namespaces, or not implement
  49 these namespaces:
  50 .Dv EXTATTR_NAMESPACE_USER ,
  51 .Dv EXTATTR_NAMESPACE_SYSTEM .
  52 The semantics of these attributes are intended to be as follows: user
  53 attribute data is protected according the normal discretionary
  54 and mandatory protections associated with the data in the file or
  55 directory; system attribute data is protected such that appropriate
  56 privilege is required to directly access or manipulate these attributes.
  57 .Pp
  58 Reads of extended attribute data may return specific contiguous regions of
  59 the meta-data, in the style of
  60 .Xr VOP_READ 9 ,
  61 but writes will replace the entire current "value" associated with
  62 a given name.
  63 As there are a plethora of file systems with differing extended attributes,
  64 availability and functionality of these functions may be limited, and they
  65 should be used with awareness of the underlying semantics of the supporting
  66 file system.
  67 Authorization schemes for extended attribute data may also vary by file
  68 system, as well as maximum attribute size, and whether or not any or
  69 specific new attributes may be defined.
  70 .Pp
  71 Extended attributes are named using a null-terminated character string.
  72 Depending on underlying file system semantics, this name may or may not be
  73 case-sensitive.
  74 Appropriate vnode extended attribute calls are:
  75 .Xr VOP_GETEXTATTR 9 ,
  76 .Xr VOP_LISTEXTATTR 9 ,
  77 and
  78 .Xr VOP_SETEXTATTR 9 .
  79 .Sh SEE ALSO
  80 .Xr VFS 9 ,
  81 .Xr VFS_EXTATTRCTL 9 ,
  82 .Xr VOP_GETEXTATTR 9 ,
  83 .Xr VOP_LISTEXTATTR 9 ,
  84 .Xr VOP_SETEXTATTR 9
  85 .Sh AUTHORS
  86 This manual page was written by
  87 .An Robert Watson .
  88 .Sh BUGS
  89 In addition, the interface does not provide a mechanism to retrieve
  90 the current set of available attributes; it has been suggested that
  91 providing a
  92 .Dv NULL
  93 attribute name should cause a list of defined attributes for the passed file
  94 or directory, but this is not currently implemented.