Add a manual page for extattr_string_to_namespace and
extattr_namespace_to_string. Reviewed by: rwatson
This commit is contained in:
dd
parent
7894e59b7f
commit
4d18dfe3ca
91
lib/libc/posix1e/extattr.3
Normal file
91
lib/libc/posix1e/extattr.3
Normal file
@ -0,0 +1,91 @@
|
||||
.\"
|
||||
.\" Copyright (c) 2001 Dima Dorfman <dd@FreeBSD.org>
|
||||
.\" 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 June 24, 2001
|
||||
.Dt EXTATTR 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm extattr_namespace_to_string ,
|
||||
.Nm extattr_string_to_namespace
|
||||
.Nd convert an extended attribute namespace identifier to a string and
|
||||
vice versa
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/extattr.h>
|
||||
.Fd #include <libutil.h>
|
||||
.Ft int
|
||||
.Fn extattr_namespace_to_string "int attrnamespace" "char **string"
|
||||
.Ft int
|
||||
.Fn extattr_string_to_namespace "const char *string" "int *attrnamespace"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn extattr_namespace_to_string
|
||||
function converts a VFS extended attribute identifier to a human-readable
|
||||
string;
|
||||
the
|
||||
.Fn extattr_string_to_namespace
|
||||
function undoes the aforementioned operation,
|
||||
and converts a human-readable string representing a namespace to a
|
||||
namespace identifier.
|
||||
Although a filesystem may implement arbitrary namespaces,
|
||||
these functions only support the
|
||||
.Dv EXTATTR_NAMESPACE_USER
|
||||
.Pq Dq user
|
||||
and
|
||||
.Dv EXTATTR_NAMESPACE_SYSTEM
|
||||
.Pq Dq system
|
||||
namespaces,
|
||||
which are defined in
|
||||
.Xr extattr 9 .
|
||||
.Pp
|
||||
These functions are meant to be used in error reporting and other
|
||||
interactive tasks.
|
||||
For example,
|
||||
instead of printing the integer identifying an extended attribute in
|
||||
an error message,
|
||||
a program might use
|
||||
.Fn extattr_namespace_to_string
|
||||
to obtain a human-readable representation.
|
||||
Likewise,
|
||||
instead of requiring a user to enter the integer representing a namespace,
|
||||
an interactive program might ask for a name and use
|
||||
.Fn extattr_string_to_namespace
|
||||
to get the desired identifier.
|
||||
.Sh SEE ALSO
|
||||
.Xr extattr_get_file 2 ,
|
||||
.Xr extattr_set_file 2 ,
|
||||
.Xr getextattr 8 ,
|
||||
.Xr setextattr 8 ,
|
||||
.Xr extattr 9
|
||||
.Sh HISTORY
|
||||
Extended attribute support was developed as part of the
|
||||
.Tn TrustedBSD
|
||||
Project, and introduced in
|
||||
.Fx 5.0 .
|
||||
It was developed to support security extensions requiring additional labels
|
||||
to be associated with each file or directory.
|
||||
@ -12,11 +12,14 @@ SRCS= _secure_path.c auth.c extattr.c fparseln.c login.c login_auth.c \
|
||||
trimdomain.c uucplock.c
|
||||
INCS= libutil.h login_cap.h
|
||||
|
||||
MAN+= extattr.3
|
||||
MAN+= login.3 login_auth.3 login_tty.3 logout.3 logwtmp.3 pty.3 \
|
||||
login_cap.3 login_class.3 login_times.3 login_ok.3 \
|
||||
_secure_path.3 uucplock.3 property.3 auth.3 realhostname.3 \
|
||||
realhostname_sa.3 trimdomain.3 fparseln.3
|
||||
MAN+= login.conf.5 auth.conf.5
|
||||
MLINKS+= extattr.3 extattr_namespace_to_string.3 \
|
||||
extattr.3 extattr_string_to_namespace.3
|
||||
MLINKS+= property.3 properties_read.3 property.3 properties_free.3
|
||||
MLINKS+= property.3 property_find.3
|
||||
MLINKS+= auth.3 auth_getval.3
|
||||
|
||||
91
lib/libutil/extattr.3
Normal file
91
lib/libutil/extattr.3
Normal file
@ -0,0 +1,91 @@
|
||||
.\"
|
||||
.\" Copyright (c) 2001 Dima Dorfman <dd@FreeBSD.org>
|
||||
.\" 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 June 24, 2001
|
||||
.Dt EXTATTR 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm extattr_namespace_to_string ,
|
||||
.Nm extattr_string_to_namespace
|
||||
.Nd convert an extended attribute namespace identifier to a string and
|
||||
vice versa
|
||||
.Sh LIBRARY
|
||||
.Lb libutil
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include <sys/extattr.h>
|
||||
.Fd #include <libutil.h>
|
||||
.Ft int
|
||||
.Fn extattr_namespace_to_string "int attrnamespace" "char **string"
|
||||
.Ft int
|
||||
.Fn extattr_string_to_namespace "const char *string" "int *attrnamespace"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn extattr_namespace_to_string
|
||||
function converts a VFS extended attribute identifier to a human-readable
|
||||
string;
|
||||
the
|
||||
.Fn extattr_string_to_namespace
|
||||
function undoes the aforementioned operation,
|
||||
and converts a human-readable string representing a namespace to a
|
||||
namespace identifier.
|
||||
Although a filesystem may implement arbitrary namespaces,
|
||||
these functions only support the
|
||||
.Dv EXTATTR_NAMESPACE_USER
|
||||
.Pq Dq user
|
||||
and
|
||||
.Dv EXTATTR_NAMESPACE_SYSTEM
|
||||
.Pq Dq system
|
||||
namespaces,
|
||||
which are defined in
|
||||
.Xr extattr 9 .
|
||||
.Pp
|
||||
These functions are meant to be used in error reporting and other
|
||||
interactive tasks.
|
||||
For example,
|
||||
instead of printing the integer identifying an extended attribute in
|
||||
an error message,
|
||||
a program might use
|
||||
.Fn extattr_namespace_to_string
|
||||
to obtain a human-readable representation.
|
||||
Likewise,
|
||||
instead of requiring a user to enter the integer representing a namespace,
|
||||
an interactive program might ask for a name and use
|
||||
.Fn extattr_string_to_namespace
|
||||
to get the desired identifier.
|
||||
.Sh SEE ALSO
|
||||
.Xr extattr_get_file 2 ,
|
||||
.Xr extattr_set_file 2 ,
|
||||
.Xr getextattr 8 ,
|
||||
.Xr setextattr 8 ,
|
||||
.Xr extattr 9
|
||||
.Sh HISTORY
|
||||
Extended attribute support was developed as part of the
|
||||
.Tn TrustedBSD
|
||||
Project, and introduced in
|
||||
.Fx 5.0 .
|
||||
It was developed to support security extensions requiring additional labels
|
||||
to be associated with each file or directory.
|
||||
Loading…
x
Reference in New Issue
Block a user