lib/libc/posix1e/acl_clear_perms.3

   1 .\"-
   2 .\" Copyright (c) 2001 Chris D. Faulhaber
   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 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 March 10, 2001
  29 .Dt ACL_CLEAR_PERMS 3
  30 .Os
  31 .Sh NAME
  32 .Nm acl_clear_perms
  33 .Nd clear permissions from a permission set
  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_clear_perms "acl_permset_t permset_d"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn acl_clear_perms
  44 function
  45 is a POSIX.1e call that clears all permissions from permissions set
  46 .Fa permset_d .
  47 .Sh RETURN VALUES
  48 .Rv -std acl_clear_perms
  49 .Sh ERRORS
  50 The
  51 .Fn acl_clear_perms
  52 function fails if:
  53 .Bl -tag -width Er
  54 .It Bq Er EINVAL
  55 Argument
  56 .Fa permset_d
  57 is not a valid descriptor for a permission set.
  58 .El
  59 .Sh SEE ALSO
  60 .Xr acl 3 ,
  61 .Xr acl_add_perm 3 ,
  62 .Xr acl_delete_perm 3 ,
  63 .Xr acl_get_permset 3 ,
  64 .Xr acl_set_permset 3 ,
  65 .Xr posix1e 3
  66 .Sh STANDARDS
  67 POSIX.1e is described in IEEE POSIX.1e draft 17.
  68 .Sh HISTORY
  69 POSIX.1e support was introduced in
  70 .Fx 4.0 .
  71 The
  72 .Fn acl_clear_perms
  73 function was added in
  74 .Fx 5.0 .
  75 .Sh AUTHORS
  76 The
  77 .Fn acl_clear_perms
  78 function was written by
  79 .An Chris D. Faulhaber Aq jedgar@fxp.org .