freebsd-dev/share/man/man9/VOP_SETEXTATTR.9

.\"-
.\" Copyright (c) 1999, 2000, 2001 Robert N. M. Watson
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd December 23, 1999
.Os
.Dt VOP_SETEXTATTR 9
.Sh NAME
.Nm VOP_SETEXTATTR
.Nd set named extended attribute for a vnode
.Sh SYNOPSIS
.In sys/param.h
.In sys/vnode.h
.In sys/extattr.h
.Ft int
.Fn VOP_SETEXTATTR "struct vnode *vp" "int attrnamespace" "const char *name" "struct uio *uio" "struct ucred *cred" "struct thread *td"
.Sh DESCRIPTION
This vnode call may be used to set specific named extended attribute for a
file or directory.
.Pp
Its arguments are:
.Bl -tag -width type
.It Fa vp
The vnode of the file or directory.
.It Fa attrnamespace
Integer constant indicating which extended attribute namespace the attribute
name is present in.
.It Fa name
Pointer to a null-terminated character string containing the attribute name.
.It Fa uio
The location of the data to be read or written.
.It Fa cred
The user credentials to use in authorizing the request.
.It Fa td
The thread setting the extended attribute.
.El
.Pp
The uio structure is used in a manner similar to the argument of the same
name in
.Xr VOP_WRITE 9 .
However, as extended attributes provide a strict "name=value" semantic,
non-zero offsets will be rejected.
.Pp
The
.Fa uio
pointer may be
.Dv NULL
to indicate that the specified extended attribute should be deleted.
.Pp
The
.Fa cred
pointer may be
.Dv NULL
to indicate that access control checks are not to be performed, if possible.
This
.Fa cred
setting might be used to allow the kernel to authorize extended attribute
changes that the active process might not be permitted to make.
.Pp
Extended attribute semantics may vary by file system implementing the call.
More information on extended attributes may be found in
.Xr extattr 9 .
.Sh LOCKS
The vnode will be locked on entry and should remain locked on return.
.Sh RETURN VALUES
If the extended attribute is successfully set, then zero is returned.
Otherwise, an appropriate error code is returned.
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er EACCES
The the caller does not have the appropriate privilege.
.It Bq Er ENXIO
The request was not valid in this file system for the specified vnode and
attribute name.
.It Bq Er ENOMEM
Insufficient memory available to fulfill request
.It Bq Er EFAULT
The uio structure refers to an invalid userspace address.
.It Bq Er EINVAL
The name, namespace, or uio argument is invalid.
.It Bq Er EOPNOTSUPP
The file system does not support
.Fn VOP_SETEXTATTR .
.It Bq Er ENOSPC
The file system is out of space.
.It Bq Er EROFS
The file system is read-only.
.El
.Sh SEE ALSO
.Xr extattr 9 ,
.Xr vnode 9 ,
.Xr VOP_GETEXTATTR 9 ,
.Xr VOP_LISTEXTATTR 9
.Sh AUTHORS
This manual page was written by
.An Robert Watson .
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.\"-`
o Update some of the kernel man pages associated with extended attributes to reflect EA API change to explicit namespacing. Obtained from: TrustedBSD Project 2001-03-15 03:13:58 +00:00			`.\" Copyright (c) 1999, 2000, 2001 Robert N. M. Watson`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.\" All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
o Update some of the kernel man pages associated with extended attributes to reflect EA API change to explicit namespacing. Obtained from: TrustedBSD Project 2001-03-15 03:13:58 +00:00			`.\" $FreeBSD$`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.\"`
			`.Dd December 23, 1999`
			`.Os`
			`.Dt VOP_SETEXTATTR 9`
			`.Sh NAME`
			`.Nm VOP_SETEXTATTR`
mdoc(7) police: normalize .Nd. 2001-04-18 15:54:10 +00:00			`.Nd set named extended attribute for a vnode`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In sys/param.h`
			`.In sys/vnode.h`
			`.In sys/extattr.h`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.Ft int`
- Fix a number of man pages broken by the KSE merger. 2001-11-20 18:19:19 +00:00			`.Fn VOP_SETEXTATTR "struct vnode vp" "int attrnamespace" "const char name" "struct uio uio" "struct ucred cred" "struct thread *td"`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.Sh DESCRIPTION`
			`This vnode call may be used to set specific named extended attribute for a`
			`file or directory.`
			`.Pp`
			`Its arguments are:`
			`.Bl -tag -width type`
o The mdoc(7) police strike with avengance: - These pages abused Ar macro (they should have used Fa). - NULL constant should be marked with Dv. - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked with Fn. Submitted by: ru 2001-03-16 15:02:30 +00:00			`.It Fa vp`
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly) 2005-01-28 10:43:05 +00:00			`The vnode of the file or directory.`
o Rename "namespace" argument to "attrnamespace" as namespace is a C++ reserved word Submitted by: jkh Obtained from: TrustedBSD Project 2001-03-19 05:53:39 +00:00			`.It Fa attrnamespace`
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly) 2005-01-28 10:43:05 +00:00			`Integer constant indicating which extended attribute namespace the attribute`
			`name is present in.`
o The mdoc(7) police strike with avengance: - These pages abused Ar macro (they should have used Fa). - NULL constant should be marked with Dv. - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked with Fn. Submitted by: ru 2001-03-16 15:02:30 +00:00			`.It Fa name`
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly) 2005-01-28 10:43:05 +00:00			`Pointer to a null-terminated character string containing the attribute name.`
o The mdoc(7) police strike with avengance: - These pages abused Ar macro (they should have used Fa). - NULL constant should be marked with Dv. - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked with Fn. Submitted by: ru 2001-03-16 15:02:30 +00:00			`.It Fa uio`
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly) 2005-01-28 10:43:05 +00:00			`The location of the data to be read or written.`
o The mdoc(7) police strike with avengance: - These pages abused Ar macro (they should have used Fa). - NULL constant should be marked with Dv. - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked with Fn. Submitted by: ru 2001-03-16 15:02:30 +00:00			`.It Fa cred`
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly) 2005-01-28 10:43:05 +00:00			`The user credentials to use in authorizing the request.`
- Fix a number of man pages broken by the KSE merger. 2001-11-20 18:19:19 +00:00			`.It Fa td`
Mark lists as in the rest of section 9 manpages. Submitted by: Joel Dahl (mostly) 2005-01-28 10:43:05 +00:00			`The thread setting the extended attribute.`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.El`
			`.Pp`
			`The uio structure is used in a manner similar to the argument of the same`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`name in`
Add or correct section number in .Xr 2003-06-08 13:27:57 +00:00			`.Xr VOP_WRITE 9 .`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`However, as extended attributes provide a strict "name=value" semantic,`
			`non-zero offsets will be rejected.`
			`.Pp`
			`The`
			`.Fa uio`
o The mdoc(7) police strike with avengance: - These pages abused Ar macro (they should have used Fa). - NULL constant should be marked with Dv. - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked with Fn. Submitted by: ru 2001-03-16 15:02:30 +00:00			`pointer may be`
			`.Dv NULL`
			`to indicate that the specified extended attribute should be deleted.`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.Pp`
			`The`
			`.Fa cred`
o The mdoc(7) police strike with avengance: - These pages abused Ar macro (they should have used Fa). - NULL constant should be marked with Dv. - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked with Fn. Submitted by: ru 2001-03-16 15:02:30 +00:00			`pointer may be`
			`.Dv NULL`
Fix typos. o replace `of possible' with `if possible' o VOP_SETACL(9) is modified to say about `ACL' instead of `extended attributed' o EOPNOTSUPP of VOP_SETEXTATTR(9) is modified to say about VOP_SETEXTATTR(9) instead of VOP_GETEXTATTR(9) Reviewed by: Robert Watson <rwatson@FreeBSD.org>, Chris Costello <chris@calldei.com> 2001-05-07 22:15:18 +00:00			`to indicate that access control checks are not to be performed, if possible.`
o The mdoc(7) police strike with avengance: - These pages abused Ar macro (they should have used Fa). - NULL constant should be marked with Dv. - VOP_* in the ERRORS section for the EOPNOTSUPP entry should be marked with Fn. Submitted by: ru 2001-03-16 15:02:30 +00:00			`This`
o Update some of the kernel man pages associated with extended attributes to reflect EA API change to explicit namespacing. Obtained from: TrustedBSD Project 2001-03-15 03:13:58 +00:00			`.Fa cred`
			`setting might be used to allow the kernel to authorize extended attribute`
			`changes that the active process might not be permitted to make.`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.Pp`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`Extended attribute semantics may vary by file system implementing the call.`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`More information on extended attributes may be found in`
			`.Xr extattr 9 .`
			`.Sh LOCKS`
			`The vnode will be locked on entry and should remain locked on return.`
			`.Sh RETURN VALUES`
			`If the extended attribute is successfully set, then zero is returned.`
			`Otherwise, an appropriate error code is returned.`
			`.Sh ERRORS`
			`.Bl -tag -width Er`
			`.It Bq Er EACCES`
Convert descriptions in the ERRORS section to full sentences if they were not full sentences, elaborating as necessary. 2002-09-18 22:12:43 +00:00			`The the caller does not have the appropriate privilege.`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.It Bq Er ENXIO`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`The request was not valid in this file system for the specified vnode and`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`attribute name.`
			`.It Bq Er ENOMEM`
			`Insufficient memory available to fulfill request`
			`.It Bq Er EFAULT`
Style and markup changes only. Capitalize the first letter of the descriptions for the entries in the ERRORS section if they are complete sentences and end the sentences with periods. 2002-09-18 09:34:01 +00:00			`The uio structure refers to an invalid userspace address.`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.It Bq Er EINVAL`
ENOATTR is now used for error returns indicating an undefined extended attribute. EINVAL can also reflect an invalid namespace for either a get or set operation on EAs. Obtained from: TrustedBSD Project Sponsored by: DARPA, Network Associates Laboratories 2003-06-05 13:42:37 +00:00			`The name, namespace, or uio argument is invalid.`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.It Bq Er EOPNOTSUPP`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`The file system does not support`
Style and markup changes only. Capitalize the first letter of the descriptions for the entries in the ERRORS section if they are complete sentences and end the sentences with periods. 2002-09-18 09:34:01 +00:00			`.Fn VOP_SETEXTATTR .`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.It Bq Er ENOSPC`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`The file system is out of space.`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.It Bq Er EROFS`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`The file system is read-only.`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.El`
			`.Sh SEE ALSO`
			`.Xr extattr 9 ,`
			`.Xr vnode 9 ,`
mdoc(7): Fix common mistakes made in the SEE ALSO section. 2003-09-12 21:54:11 +00:00			`.Xr VOP_GETEXTATTR 9 ,`
Document VOP_LISTEXTATTR(9). Obtained from: TrustedBSD Project Sponsored by: DARPA, Network Associates Laboratories 2003-06-05 14:20:48 +00:00			`.Xr VOP_LISTEXTATTR 9`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.Sh AUTHORS`
Use 'manual page' instead of 'man page' for consistency. Approved by: re (hrs) 2005-06-28 20:15:19 +00:00			`This manual page was written by`
Man pages for the VFS extended attribute and access control list vnops. Reviewed by: eivind 2000-01-05 04:59:02 +00:00			`.An Robert Watson .`