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