Man pages for the VFS extended attribute and access control list vnops.

Reviewed by:	eivind

1 files changed, 67 insertions, 0 deletions

diff --git a/share/man/man9/extattr.9 b/share/man/man9/extattr.9
new file mode 100644
index 0000000..9423455
--- /dev/null
+++ b/share/man/man9/extattr.9
@@ -0,0 +1,67 @@
+.\"-
+.\" Copyright (c) 1999 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 EXTATTR 9
+.Sh NAME
+.Nm extattr 
+.Nd virtual file system named extended attributes
+.Sh SYNOPSIS
+.Fd #include <sys/param.h>
+.Fd #include <sys/vnode.h>
+.Fd #include <sys/extattr.h>
+.Sh DESCRIPTION
+Named extended attributes allow additional meta-data to be associated
+with vnodes representing files and directories.  The semantics of this
+additional data is that of a "name=value" pair, where a name may
+be defined or undefined, and if defined, associated with zero or more
+bytes of arbitrary binary data.  Reads of this data may return specific
+contiguous regions of the meta-data, in the style of
+.Xr VOP_READ 9 ,
+but writes will replace the entire current "value" associated with
+a given name.  As there are a plethora of file systems with differing
+extended attributes, availability and functionality of these functions
+may be limited, and they should be used with awareness of the underlying
+semantics of the supporting file system.  Authorization schemes for
+extended attribute data may also vary by file system, as well as
+maximum attribute size, and whether or not any or specific new attributes
+may be defined.
+
+Extended attributes are named using a null-terminated character string.
+Depending on file system semantics, this name may or may not be
+case-sensitive.  Appropriate vnode extended attribute calls are:
+.Xr VOP_GETEXTATTR 9 
+and
+.Xr VOP_SETEXTATTR 9 .
+.Sh SEE ALSO
+.Xr VFS 9 ,
+.Xr VOP_GETEXTATTR 9 ,
+.Xr VOP_SETEXTATTR 9 .
+.Sh AUTHORS
+This man page was written by
+.An Robert Watson .