share/man/man9/VOP_SETEXTATTR.9

   1 .\"-
   2 .\" Copyright (c) 1999 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 .\" $FreeBSD: src/share/man/man9/VOP_SETEXTATTR.9,v 1.1.2.3 2001/12/17 11:30:18 ru Exp $
  27 .\" $DragonFly: src/share/man/man9/VOP_SETEXTATTR.9,v 1.3 2008/04/15 22:05:38 swildner Exp $
  28 .\"
  29 .Dd December 23, 1999
  30 .Os
  31 .Dt VOP_SETEXTATTR 9
  32 .Sh NAME
  33 .Nm VOP_SETEXTATTR
  34 .Nd set named extended attribute for a vnode
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/vnode.h
  38 .In sys/extattr.h
  39 .Ft int
  40 .Fn VOP_SETEXTATTR "struct vnode *vp" "char *name" "struct uio *uio" "struct ucred *cred" "struct proc *p"
  41 .Sh DESCRIPTION
  42 This vnode call may be used to set specific named extended attribute for a
  43 file or directory.
  44 .Pp
  45 Its arguments are:
  46 .Bl -tag -width type
  47 .It Fa vp
  48 the vnode of the file or directory
  49 .It Fa name
  50 pointer to a null-terminated character string containing the attribute name
  51 .It Fa uio
  52 the location of the data to be read or written
  53 .It Fa cred
  54 the user credentials to use in authorizing the request
  55 .It Fa p
  56 the process setting the extended attribute
  57 .El
  58 .Pp
  59 The uio structure is used in a manner similar to the argument of the same
  60 name in
  61 .Xr VOP_WRITE 9 .
  62 However, as extended attributes provide a strict "name=value" semantic,
  63 non-zero offsets will be rejected.
  64 .Pp
  65 The
  66 .Fa uio
  67 pointer may be
  68 .Dv NULL
  69 to indicate that the specified extended attribute should be deleted.
  70 .Pp
  71 The
  72 .Fa cred
  73 pointer may be
  74 .Dv NULL
  75 to indicate that access control checks are not to be performed, if possible.
  76 This
  77 .Fa cred
  78 setting might be used to allow the kernel to authorize extended attribute
  79 changes that the active process might not be permitted to make.
  80 .Pp
  81 Extended attribute semantics may vary by file system implementing the call.
  82 More information on extended attributes may be found in
  83 .Xr extattr 9 .
  84 .Sh LOCKS
  85 The vnode will be locked on entry and should remain locked on return.
  86 .Sh RETURN VALUES
  87 If the extended attribute is successfully set, then zero is returned.
  88 Otherwise, an appropriate error code is returned.
  89 .Sh ERRORS
  90 .Bl -tag -width Er
  91 .It Bq Er EACCES
  92 Permission denied
  93 .It Bq Er ENXIO
  94 The request was not valid in this file system for the specified vnode and
  95 attribute name.
  96 .It Bq Er ENOMEM
  97 Insufficient memory available to fulfill request
  98 .It Bq Er EFAULT
  99 The uio structure refers to an invalid userspace address
 100 .It Bq Er EINVAL
 101 The name or uio argument is invalid
 102 .It Bq Er EOPNOTSUPP
 103 The file system does not support
 104 .Fn VOP_SETEXTATTR
 105 .It Bq Er ENOSPC
 106 The file system is out of space
 107 .It Bq Er EROFS
 108 The file system is read-only
 109 .El
 110 .Sh SEE ALSO
 111 .Xr extattr 9 ,
 112 .Xr vnode 9 ,
 113 .Xr VOP_GETEXTATTR 9
 114 .Sh AUTHORS
 115 This man page was written by
 116 .An Robert Watson .