Import Upstream version 1.8.5

[hcoop/debian/openafs.git] / doc / man-pages / pod1 / fs_listacl.pod

=head1 NAME

fs_listacl - Displays ACLs

=head1 SYNOPSIS

=for html
<div class="synopsis">

B<fs listacl> S<<< [B<-path> <I<dir/file path>>+] >>> [B<-id>] [B<-if>] [B<-cmd>] [B<-help>]

B<fs la> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-id>] [B<-if>] [B<-cmd>] [B<-h>]

B<fs lista> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-id>] [B<-if>] [B<-cmd>] [B<-h>]

=for html
</div>

=head1 DESCRIPTION

The B<fs listacl> command displays the access control list (ACL)
associated with each specified file, directory, or symbolic link. The
specified element can reside in the DFS filespace if the issuer is using
the AFS/DFS Migration Toolkit Protocol Translator to access DFS data (and
DFS does implement per-file ACLs). To display the ACL of the current
working directory, omit the B<-path> argument.

To alter an ACL, use the B<fs setacl> command. To copy an ACL from one
directory to another, use the B<fs copyacl> command. To remove obsolete
entries from an ACL, use the B<fs cleanacl> command.

=head1 CAUTIONS

Placing a user or group on the C<Negative rights> section of the ACL does
not guarantee denial of permissions, if the C<Normal rights> section
grants the permissions to members of the system:anyuser group. In that
case, the user needs only to issue the B<unlog> command to obtain the
permissions granted to the system:anyuser group.

=head1 OPTIONS

=over 4

=item B<-path> <I<dir/file path>>+

Names each directory or file for which to display the ACL. For AFS files,
the output displays the ACL from the file's parent directory; DFS files do
have their own ACL. Incomplete pathnames are interpreted relative to the
current working directory, which is also the default value if this
argument is omitted.

=item B<-id>

Displays the Initial Container ACL of each DFS directory. This argument is
supported only on DFS directories accessed via the AFS/DFS Migration
Toolkit Protocol Translator.

=item B<-if>

Displays the Initial Object ACL of each DFS directory. This argument is
supported only on DFS directories accessed via the AFS/DFS Migration
Toolkit Protocol Translator.

=item B<-cmd>

Outputs an B<fs setacl> command string that can be used to recreate
the ACL applied to the specified file, directory or symbolic link. 

=item B<-help>

Prints the online help for this command. All other valid options are
ignored.

=back

=head1 OUTPUT

The first line of the output for each file, directory, or symbolic link
reads as follows:

   Access list for <directory> is

If the issuer used shorthand notation in the pathname, such as the period
(C<.>) to represent the current current directory, that notation sometimes
appears instead of the full pathname of the directory.

Next, the C<Normal rights> header precedes a list of users and groups who
are granted the indicated permissions, with one pairing of user or group
and permissions on each line. If negative permissions have been assigned
to any user or group, those entries follow a C<Negative rights>
header. The format of negative entries is the same as those on the
C<Normal rights> section of the ACL, but the user or group is denied
rather than granted the indicated permissions.

AFS does not implement per-file ACLs, so for a file the command displays
the ACL on its directory. The output for a symbolic link displays the ACL
that applies to its target file or directory, rather than the ACL on the
directory that houses the symbolic link.

The permissions for AFS enable the possessor to perform the indicated
action:

=over 4

=item a (administer)

Change the entries on the ACL.

=item d (delete)

Remove files and subdirectories from the directory or move them to other
directories.

=item i (insert)

Add files or subdirectories to the directory by copying, moving or
creating.

=item k (lock)

Set read locks or write locks on the files in the directory.

=item l (lookup)

List the files and subdirectories in the directory, stat the directory
itself, and issue the B<fs listacl> command to examine the directory's
ACL.

=item r (read)

Read the contents of files in the directory; issue the C<ls -l> command to
stat the elements in the directory.

=item w (write)

Modify the contents of files in the directory, and issue the UNIX B<chmod>
command to change their mode bits

=item A, B, C, D, E, F, G, H

Have no default meaning to the AFS server processes, but are made
available for applications to use in controlling access to the directory's
contents in additional ways. The letters must be uppercase.

=back

For DFS files and directories, the permissions are similar, except that
the DFS C<x> (execute) permission replaces the AFS C<l> (lookup)
permission, DFS C<c> (control) replaces AFS C<a> (administer), and there
is no DFS equivalent to the AFS C<k> (lock) permission. The meanings of
the various permissions also differ slightly, and DFS does not implement
negative permissions. For a complete description of DFS permissions, see
the DFS documentation.

=head1 EXAMPLES

The following command displays the ACL on the home directory of the user
C<pat> (the current working directory), and on its C<private>
subdirectory.

   % fs listacl -path . private
   Access list for . is
   Normal rights:
      system:authuser rl
      pat rlidwka
      pat:friends rlid
   Negative rights:
      smith rlidwka
   Access list for private is
   Normal rights:
      pat rlidwka

The following command generates the B<fs setacl> command required to
recreate the ACL on the home directory of the user
C<pat> (the current working directory), and on its C<private>
subdirectory.

   % fs listacl -path . private -cmd
   fs setacl -dir . -acl system:authuser rl  pat rlidwka   pat:friends rlid
   fs setacl -dir . -acl smith rlidwka -negative
   fs setacl -dir private -acl pat rlidwka

=head1 PRIVILEGE REQUIRED

If the B<-path> argument names an AFS directory, the issuer must have the
C<l> (lookup) permission on its ACL and the ACL for every directory that
precedes it in the pathname.

If the B<-path> argument names an AFS file, the issuer must have the C<l>
(lookup) and C<r> (read) permissions on the ACL of the file's directory,
and the B<l> permission on the ACL of each directory that precedes it in
the pathname.

If the B<-path> argument names a DFS directory or file, the issuer must
have the C<x> (execute) permission on its ACL and on the ACL of each
directory that precedes it in the pathname.

=head1 SEE ALSO

L<fs_cleanacl(1)>,
L<fs_copyacl(1)>,
L<fs_setacl(1)>

=head1 COPYRIGHT

IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.

This documentation is covered by the IBM Public License Version 1.0.  It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.