diff options
author | trasz <trasz@FreeBSD.org> | 2009-05-23 13:51:05 +0000 |
---|---|---|
committer | trasz <trasz@FreeBSD.org> | 2009-05-23 13:51:05 +0000 |
commit | 6cb6efd9fd313f4fc93f865c7abecc287834333a (patch) | |
tree | b99c45a82e7791fd6cdc1fab1bb40884ac4c6a4a /lib/libc | |
parent | 806a0172aa42f0653bc4948ac86d97313ea7e71b (diff) | |
download | FreeBSD-src-6cb6efd9fd313f4fc93f865c7abecc287834333a.zip FreeBSD-src-6cb6efd9fd313f4fc93f865c7abecc287834333a.tar.gz |
Improve API documentation.
Reviewed by: rwatson (earlier version)
Diffstat (limited to 'lib/libc')
-rw-r--r-- | lib/libc/posix1e/acl.3 | 2 | ||||
-rw-r--r-- | lib/libc/posix1e/acl_add_perm.3 | 8 | ||||
-rw-r--r-- | lib/libc/posix1e/acl_get.3 | 9 | ||||
-rw-r--r-- | lib/libc/posix1e/acl_set.3 | 9 | ||||
-rw-r--r-- | lib/libc/posix1e/acl_set_tag_type.3 | 12 |
5 files changed, 39 insertions, 1 deletions
diff --git a/lib/libc/posix1e/acl.3 b/lib/libc/posix1e/acl.3 index 1c824d0..43adcdf 100644 --- a/lib/libc/posix1e/acl.3 +++ b/lib/libc/posix1e/acl.3 @@ -48,7 +48,7 @@ The library calls include routines to allocate, duplicate, retrieve, set, and validate ACLs associated with file objects. As well as the POSIX.1e routines, there are a number of non-portable extensions defined that allow for alternative ACL semantics than the -POSIX.1e semantics, such as AFS, NTFS, Coda, and NWFS semantics. +POSIX.1e semantics, such as NFSv4, AFS, NTFS, Coda, and NWFS semantics. Where routines are non-standard, they are suffixed with _np to indicate that they are not portable. .Pp diff --git a/lib/libc/posix1e/acl_add_perm.3 b/lib/libc/posix1e/acl_add_perm.3 index 6a5893e..dd002d1 100644 --- a/lib/libc/posix1e/acl_add_perm.3 +++ b/lib/libc/posix1e/acl_add_perm.3 @@ -49,6 +49,14 @@ to the permission set .Pp Note: it is not considered an error to attempt to add permissions that already exist in the permission set. +.Pp +For POSIX.1e ACLs, valid values are: +.Pp +.Bl -column -offset 3n "ACL_EXECUTE" +.It ACL_EXECUTE Execute permission +.It ACL_WRITE Write permission +.It ACL_READ Read permission +.El .Sh RETURN VALUES .Rv -std acl_add_perm .Sh ERRORS diff --git a/lib/libc/posix1e/acl_get.3 b/lib/libc/posix1e/acl_get.3 index fa915df..344c595 100644 --- a/lib/libc/posix1e/acl_get.3 +++ b/lib/libc/posix1e/acl_get.3 @@ -91,6 +91,15 @@ with the object referred to by .Va fd . The ACL in the working storage shall not participate in any access control decisions. +.Pp +Valid values for the +.Va type +argument are: +.Pp +.Bl -column -offset 3n "ACL_TYPE_DEFAULT" +.It ACL_TYPE_ACCESS POSIX.1e access ACL +.It ACL_TYPE_DEFAULT POSIX.1e default ACL +.El .Sh IMPLEMENTATION NOTES .Fx Ns 's support for POSIX.1e interfaces and features is still under diff --git a/lib/libc/posix1e/acl_set.3 b/lib/libc/posix1e/acl_set.3 index a2d50b8..e906e79 100644 --- a/lib/libc/posix1e/acl_set.3 +++ b/lib/libc/posix1e/acl_set.3 @@ -75,6 +75,15 @@ The .Fn acl_set_link_np function acts on a symlink rather than its target, if the target of the path is a symlink. +.Pp +Valid values for the +.Va type +argument are: +.Pp +.Bl -column -offset 3n "ACL_TYPE_DEFAULT" +.It ACL_TYPE_ACCESS POSIX.1e access ACL +.It ACL_TYPE_DEFAULT POSIX.1e default ACL +.El .Sh IMPLEMENTATION NOTES .Fx Ns 's support for POSIX.1e interfaces and features is still under diff --git a/lib/libc/posix1e/acl_set_tag_type.3 b/lib/libc/posix1e/acl_set_tag_type.3 index 7cbca81..113aa22 100644 --- a/lib/libc/posix1e/acl_set_tag_type.3 +++ b/lib/libc/posix1e/acl_set_tag_type.3 @@ -46,6 +46,18 @@ is a POSIX.1e call that sets the ACL tag type of ACL entry .Fa entry_d to the value of .Fa tag_type . +.Pp +Valid values are: +.Pp +.Bl -column -offset 3n "ACL_EVERYONE" +.It ACL_USER_OBJ Permissions apply to file owner +.It ACL_USER Permissions apply to additional user specified by qualifier +.It ACL_GROUP_OBJ Permissions apply to file group +.It ACL_GROUP Permissions apply to additional group specified by qualifier +.It ACL_MASK Permissions specify mask +.It ACL_OTHER Permissions apply to "other" +.It ACL_OTHER_OBJ Same as ACL_OTHER +.El .Sh RETURN VALUES .Rv -std acl_set_tag_type .Sh ERRORS |