.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Linux::ACL 3pm"
.TH Linux::ACL 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Linux::ACL \- Perl extension for reading and setting Access Control Lists for files by libacl linux library.
.SH VERSION
.IX Header "VERSION"
Version 0.05
.SH SYNOPSIS
.IX Header "SYNOPSIS"
Quick summary of what the module does.
.PP
Perhaps a little code snippet.
.PP
.Vb 3
\&  use Linux::ACL;
\&  ($acl, $default_acl) = getfacl("path/to/file");
\&  setfacl("path/to/file", $acl [, $default_acl]);
.Ve
.SH EXPORT
.IX Header "EXPORT"
.IP setfacl($$;$) 4
.IX Item "setfacl($$;$)"
Set the ACL of the file or directory named by \f(CW$path\fR to that
specified by \f(CW$acl\fR.  If \f(CW$path\fR names a directory, then the optional
\&\f(CW$default_acl\fR argument can also be passed to specify the default ACL
for the directory.  See "ACL structure" for information on how the
\&\f(CW$acl\fR and \f(CW$default_acl\fR hashes should be constructed.
.IP getfacl($) 4
.IX Item "getfacl($)"
Return a reference to a hash containing information about the file's
ACL.  If the file is a directory with a default ACL, then a list is
returned, with the first entry being a hash reference to the ACL, and
the second being a hash reference to the default ACL.  See "Accessing
ACL structures" for information on how to access these hashes, and
"ACL structure" for information on how these hashes are internally
constructed.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
.IP setfacl 4
.IX Item "setfacl"
returns TRUE if successful and FALSE if unsuccessful.
.IP getfacl 4
.IX Item "getfacl"
if successful, returns a list containing a reference to
the hash describing an acl, and, if there is a default acl, a
reference to the hash describing the default acl.  If unsuccessful,
\&\f(CW\*(C`getfacl\*(C'\fR returns a null list.
.SH Examples
.IX Header "Examples"
getfacl example
.PP
.Vb 4
\&  use Linux::ACL;
\&  use Data::Dumper;
\&  my @a = getfacl("/tmp");
\&  print Dumper \e@a;
.Ve
.PP
prints:
.PP
.Vb 10
\&  $VAR1 = [
\&          {
\&            \*(Aquperm\*(Aq => {
\&                         \*(Aqw\*(Aq => 1,
\&                         \*(Aqr\*(Aq => 1,
\&                         \*(Aqx\*(Aq => 1
\&                       },
\&            \*(Aqgperm\*(Aq => {
\&                         \*(Aqw\*(Aq => 1,
\&                         \*(Aqr\*(Aq => 1,
\&                         \*(Aqx\*(Aq => 1
\&                       },
\&            \*(Aqother\*(Aq => {
\&                         \*(Aqw\*(Aq => 1,
\&                         \*(Aqr\*(Aq => 1,
\&                         \*(Aqx\*(Aq => 1
\&                       }
\&          }
\&        ];
.Ve
.PP
setfacl example
.PP
.Vb 10
\&  use Linux::ACL;
\&  setfacl("/mnt/testacl/d", {
\&        uperm=>{r=>1,w=>1,x=>1},
\&        gperm=>{r=>1,w=>1,x=>1},
\&        other=>{r=>1,w=>0,x=>1},
\&        mask=>{r=>1,w=>1,x=>1},
\&        group=>{
\&                123456=>{r=>1,w=>1,x=>1}
\&        }
\&  }, {
\&        uperm=>{r=>1,w=>1,x=>1},
\&        gperm=>{r=>1,w=>1,x=>1},
\&        other=>{r=>1,w=>1,x=>1},
\&        mask=>{r=>1,w=>1,x=>1}
\&  });
\&  system("getfacl /mnt/testacl/d");
.Ve
.PP
prints:
.PP
.Vb 10
\&  $ getfacl d
\&  # file: d
\&  # owner: user
\&  # group: user
\&  user::rwx
\&  group::rwx
\&  group:123456:rwx
\&  mask::rwx
\&  other::r\-x
\&  default:user::rwx
\&  default:group::rwx
\&  default:mask::rwx
\&  default:other::rwx
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
Yuriy Nazarov, \f(CW\*(C`<nazarov at cpan.org>\*(C'\fR
.SH BUGS
.IX Header "BUGS"
Please report any bugs or feature requests to \f(CW\*(C`bug\-linux\-acl at rt.cpan.org\*(C'\fR, or through
the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Linux\-ACL>.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
.SH SUPPORT
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\&    perldoc Linux::ACL
.Ve
.PP
You can also look for information at:
.IP \(bu 4
RT: CPAN's request tracker
.Sp
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Linux\-ACL>
.IP \(bu 4
AnnoCPAN: Annotated CPAN documentation
.Sp
<http://annocpan.org/dist/Linux\-ACL>
.IP \(bu 4
CPAN Ratings
.Sp
<http://cpanratings.perl.org/d/Linux\-ACL>
.IP \(bu 4
Search CPAN
.Sp
<http://search.cpan.org/dist/Linux\-ACL/>
.SH ACKNOWLEDGEMENTS
.IX Header "ACKNOWLEDGEMENTS"
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2013 Yuriy Nazarov.
.PP
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
.PP
See http://dev.perl.org/licenses/ for more information.