35d9de2486b3b9a57421597d6d909d353de0f73a
[openafs.git] / doc / man-pages / pod1 / fs_listacl.pod
1 =head1 NAME
2
3 fs listacl - Displays ACLs
4
5 =head1 SYNOPSIS
6
7 B<fs listacl> [B<-path> <I<dir/file path>>+] [B<-id>] [B<-if>] [B<-help>]
8
9 B<fs la> [B<-p> <I<dir/file path>>+] [B<-id>] [B<-if>] [B<-h>] 
10
11 B<fs lista> [B<-p> <I<dir/file path>>+] [B<-id>] [B<-if>] [B<-h>] 
12
13 =head1 DESCRIPTION
14
15 The B<fs listacl> command displays the access control list (ACL)
16 associated with each specified file, directory, or symbolic link. The
17 specified element can reside in the DFS filespace if the issuer is using
18 the AFS/DFS Migration Toolkit Protocol Translator to access DFS data (and
19 DFS does implement per-file ACLs). To display the ACL of the current
20 working directory, omit the B<-path> argument.
21
22 To alter an ACL, use the fs setacl command. To copy an ACL from one
23 directory to another, use the B<fs copyacl> command. To remove obsolete
24 entries from an ACL, use the B<fs cleanacl> command.
25
26 =head1 CAUTIONS
27
28 Placing a user or group on the C<Negative rights> section of the ACL does
29 not guarantee denial of permissions, if the C<Normal rights> section
30 grants the permissions to members of the system:anyuser group. In that
31 case, the user needs only to issue the B<unlog> command to obtain the
32 permissions granted to the system:anyuser group.
33
34 =head1 OPTIONS
35
36 =over 4
37
38 =item B<-path> <I<dir/file path>>+
39
40 Names each directory or file for which to display the ACL. For AFS files,
41 the output displays the ACL from the file's parent directory; DFS files do
42 have their own ACL. Incomplete pathnames are interpreted relative to the
43 current working directory, which is also the default value if this
44 argument is omitted.
45
46 =item B<-id>
47
48 Displays the Initial Container ACL of each DFS directory. This argument is
49 supported only on DFS directories accessed via the AFS/DFS Migration
50 Toolkit Protocol Translator.
51
52 =item B<-if>
53
54 Displays the Initial Object ACL of each DFS directory. This argument is
55 supported only on DFS directories accessed via the AFS/DFS Migration
56 Toolkit Protocol Translator.
57
58 =item B<-help>
59
60 Prints the online help for this command. All other valid options are
61 ignored.
62
63 =back
64
65 =head1 OUTPUT
66
67 The first line of the output for each file, directory, or symbolic link
68 reads as follows:
69
70    Access list for <directory> is
71
72 If the issuer used shorthand notation in the pathname, such as the period
73 (C<.>) to represent the current current directory, that notation sometimes
74 appears instead of the full pathname of the directory.
75
76 Next, the C<Normal rights> header precedes a list of users and groups who
77 are granted the indicated permissions, with one pairing of user or group
78 and permissions on each line. If negative permissions have been assigned
79 to any user or group, those entries follow a C<Negative rights>
80 header. The format of negative entries is the same as those on the
81 C<Normal rights> section of the ACL, but the user or group is denied
82 rather than granted the indicated permissions.
83
84 AFS does not implement per-file ACLs, so for a file the command displays
85 the ACL on its directory. The output for a symbolic link displays the ACL
86 that applies to its target file or directory, rather than the ACL on the
87 directory that houses the symbolic link.
88
89 The permissions for AFS enable the possessor to perform the indicated
90 action:
91
92 =over 4
93
94 =item a (administer)
95
96 Change the entries on the ACL.
97
98 =item d (delete)
99
100 Remove files and subdirectories from the directory or move them to other
101 directories.
102
103 =item i (insert)
104
105 Add files or subdirectories to the directory by copying, moving or
106 creating.
107
108 =item k (lock)
109
110 Set read locks or write locks on the files in the directory.
111
112 =item l (lookup)
113
114 List the files and subdirectories in the directory, stat the directory
115 itself, and issue the B<fs listacl> command to examine the directory's
116 ACL.
117
118 =item r (read)
119
120 Read the contents of files in the directory; issue the C<ls -l> command to
121 stat the elements in the directory.
122
123 =item w (write)
124
125 Modify the contents of files in the directory, and issue the UNIX B<chmod>
126 command to change their mode bits
127
128 =item A, B, C, D, E, F, G, H
129
130 Have no default meaning to the AFS server processes, but are made
131 available for applications to use in controlling access to the directory's
132 contents in additional ways. The letters must be uppercase.
133
134 =back
135
136 For DFS files and directories, the permissions are similar, except that
137 the DFS C<x> (execute) permission replaces the AFS C<l> (lookup)
138 permission, DFS C<c> (control) replaces AFS C<a> (administer), and there
139 is no DFS equivalent to the AFS C<k> (lock) permission. The meanings of
140 the various permissions also differ slightly, and DFS does not implement
141 negative permissions. For a complete description of DFS permissions, see
142 the DFS documentation and the I<IBM AFS/DFS Migration Toolkit
143 Administration Guide and Reference>.
144
145 =head1 EXAMPLES
146
147 The following command displays the ACL on the home directory of the user
148 C<pat> (the current working directory), and on its C<private>
149 subdirectory.
150
151    % fs listacl -path . private
152    Access list for . is
153    Normal rights:
154       system:authuser rl
155       pat rlidwka
156       pat:friends rlid
157    Negative rights:
158       smith rlidwka
159    Access list for private is
160    Normal rights:
161       pat rlidwka
162
163 =head1 PRIVILEGE REQUIRED
164
165 If the B<-path> argument names an AFS directory, the issuer must have the
166 C<l> (lookup) permission on its ACL and the ACL for every directory that
167 precedes it in the pathname.
168
169 If the B<-path> argument names an AFS file, the issuer must have the C<l>
170 (lookup) and C<r> (read) permissions on the ACL of the file's directory,
171 and the B<l> permission on the ACL of each directory that precedes it in
172 the pathname.
173
174 If the B<-path> argument names a DFS directory or file, the issuer must
175 have the C<x> (execute) permission on its ACL and on the ACL of each
176 directory that precedes it in the pathname.
177
178 =head1 SEE ALSO
179
180 L<fs_cleanacl(1)>,
181 L<fs_copyacl(1)>,
182 L<fs_setacl(1)>
183
184 I<IBM AFS/DFS Migration Toolkit Administration Guide and Reference>
185
186 =head1 COPYRIGHT
187
188 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
189
190 This documentation is covered by the IBM Public License Version 1.0.  It was
191 converted from HTML to POD by software written by Chas Williams and Russ
192 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.