lib/libc/posix1e/acl_get_brand_np.3

   1 .\"-
   2 .\" Copyright (c) 2008, 2009 Edward Tomasz Napierala
   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$
  27 .\"
  28 .Dd June 25, 2009
  29 .Dt ACL_GET_BRAND_NP 3
  30 .Os
  31 .Sh NAME
  32 .Nm acl_get_brand_np
  33 .Nd retrieve the ACL brand from an ACL entry
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In sys/types.h
  38 .In sys/acl.h
  39 .Ft int
  40 .Fn acl_get_brand_np "acl_t acl" "int *brand_p"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn acl_get_brand_np
  44 function
  45 is a non-portable call that returns the ACL brand for the ACL
  46 .Fa acl .
  47 Upon successful completion, the location referred to by the argument
  48 .Fa brand_p
  49 will be set to the ACL brand of the ACL
  50 .Fa acl .
  51 .Pp
  52 Branding is an internal mechanism intended to prevent mixing POSIX.1e
  53 and NFSv4 entries by mistake.
  54 It's also used by the libc to determine how to print out the ACL.
  55 The first call to function that is specific for one particular brand - POSIX.1e
  56 or NFSv4 - "brands" the ACL.
  57 After that, calling function specific to another brand will result in error.
  58 .Sh RETURN VALUES
  59 .Rv -std acl_get_brand_np
  60 .Sh ERRORS
  61 The
  62 .Fn acl_get_brand_np
  63 function fails if:
  64 .Bl -tag -width Er
  65 .It Bq Er EINVAL
  66 Argument
  67 .Fa acl
  68 does not point to a valid ACL.
  69 .El
  70 .Sh SEE ALSO
  71 .Xr acl 3 ,
  72 .Xr posix1e 3
  73 .Sh STANDARDS
  74 POSIX.1e is described in IEEE POSIX.1e draft 17.
  75 .Sh HISTORY
  76 POSIX.1e support was introduced in
  77 .Fx 4.0 .
  78 The
  79 .Fn acl_get_brand_np
  80 function was added in
  81 .Fx 8.0 .
  82 .Sh AUTHORS
  83 The
  84 .Fn acl_get_brand_np
  85 function was written by
  86 .An Edward Tomasz Napierala Aq trasz@FreeBSD.org .