pod-man-pages-20051015
[openafs.git] / doc / man-pages / pod / fs_copyacl.pod
1 =head1 NAME
2
3 fs copyacl - Copies an ACL from one directory to one or more other directories
4
5 =head1 SYNOPSIS
6
7 fs copyacl B<-fromdir> I<source directory (or DFS file)>
8 B<-todir> I<destination directory (or DFS file)> [I<destination directory (or DFS file)> ...]
9 [B<-clear>]  [B<-id>]  [B<-if>]  [B<-help>]
10
11 fs co B<-f> I<source directory (or DFS file)>
12 B<-t> I<destination directory (or DFS file)> [I<destination directory (or DFS file)> ...]
13 [B<-c>]  [B<-id>]  [B<-if>]  [B<-h>]
14
15 =head1 DESCRIPTION
16
17 The C<fs copyacl> command copies the access control list (ACL) from a
18 source directory to each specified destination directory. The source
19 directory's ACL is unchanged, and changes to the destination
20 directory's ACL obey the following rules:
21
22 =over
23
24 =item *
25
26 If an entry on the source ACL does not already exist on the
27 destination ACL, it is added.
28
29 =item *
30
31 If an entry exists on both the source and destination ACLs, the
32 permissions from the source ACL entry replace the current
33 permissions on the destination ACL entry.
34
35 =item *
36
37 If an entry on the destination ACL has no corresponding entry on
38 the source ACL, it is removed if the B<-clear> flag is included and
39 is unchanged otherwise. In other words, if the B<-clear> flag is
40 provided, the source ACL completely replaces the destination ACL.
41
42 =back
43
44 When using this command to copy ACLs between objects in DFS filespace
45 accessed via the AFS/DFS Migration Toolkit Protocol Translator, it is
46 possible to specify files, as well as directories, with the B<-fromdir>
47 and B<-todir> arguments. For more information on copying ACLs between DFS
48 directories and files, refer to the IBM AFS/DFS Migration Toolkit
49 Administration Guide and Reference.
50
51 =head1 OPTIONS
52
53 =over 4
54
55 =item B<-fromdir> I<source directory (or DFS file)>
56
57 Specifies the source directory from which to copy the ACL.
58 (Specifying an AFS file copies its directory's ACL, but
59 specifying a DFS file copies its own ACL). A partial pathname
60 is interpreted relative to the current working directory.
61
62 =item B<-todir> I<destination directory (or DFS file)> [I<destination directory (or DFS file)> ...]
63
64 Specifies each directory for which to alter the ACL to match
65 the source ACL. (Specifying an AFS file halts the command with
66 an error, but specifying a DFS file alters the file's ACL). A
67 partial pathname is interpreted relative to the current working
68 directory.
69
70 Specify the read/write path to each directory (or DFS file), to
71 avoid the failure that results from attempting to change a
72 read-only volume. By convention, the read/write path is
73 indicated by placing a period before the cell name at the
74 pathname's second level (for example, B</afs/.abc.com>). For
75 further discussion of the concept of read/write and read-only
76 paths through the filespace, see the L<fs_mkmount(1)> reference page.
77
78 =item B<-clear>
79
80 Replaces the ACL of each destination directory with the source
81 ACL.
82
83 =item B<-id>
84
85 Modifies the Initial Container ACL of each DFS directory named
86 by the B<-todir> argument, rather than the regular Object ACL.
87 This argument is supported only when both the source and each
88 destination directory reside in DFS and are accessed via the
89 AFS/DFS Migration Toolkit Protocol Translator.
90
91 =item B<-if>
92
93 Modifies the Initial Object ACL of each DFS directory named by
94 the B<-todir> argument, rather than the regular Object ACL. This
95 argument is supported only when both the source and each
96 destination directory reside in DFS and are accessed via the
97 AFS/DFS Migration Toolkit Protocol Translator.
98
99 =item B<-help>
100
101 Prints the online help for this command. All other valid
102 options are ignored.
103
104 =back
105
106 =head1 EXAMPLES
107
108 The following example command copies the current working directory's
109 ACL to its subdirectory called B<reports>. Note that the source
110 directory's ACL is unaffected. Entries on the B<reports> directory's that
111 are not on the source ACL of the current directory remain unaffected
112 as well, because the -clear flag is not used.
113
114     fs listacl . reports
115    Access list for . is
116    Normal rights:
117       pat rlidwka
118       smith rlidwk
119    Access list for reports is
120    Normal rights:
121       pat rl
122       pat:friends rl
123    Negative rights
124       jones rlidwka
125
126
127     fs copyacl -fromdir . -todir reports
128
129
130     fs listacl . reports
131    Access list for . is
132    Normal rights:
133       pat rlidwka
134       smith rlidwk
135    Access list for reports is
136    Normal rights:
137       pat rlidwka
138       pat:friends rl
139       smith rlidwk
140    Negative rights
141       jones rlidwka
142
143 =head1 PRIVILEGE REQUIRED
144
145 To copy an ACL between AFS objects, the issuer must have the B<l>
146 (B<lookup>) permission on the source directory's ACL and the B<a>
147 (B<administer>) permission on each destination directory's ACL. If the
148 B<-fromdir> argument names a file rather than a directory, the issuer
149 must have both the B<l> and B<r> (B<read>) permissions on the ACL of the file's
150 directory.
151
152 To copy an ACL between DFS objects, the issuer must have the B<r>
153 permission on the source directory or file's ACL and the B<c> (B<control>)
154 permission on each destination directory or file's ACL.
155
156 =head1 CAVEATS
157
158 Do not copy ACLs between AFS and DFS files or directories. The ACL
159 formats are incompatible.
160
161 =head1 COPYRIGHT
162
163 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
164
165 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
166 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
167 Stanford Linear Accelerator Center, a department of Stanford University.
168
169 =head1 SEE ALSO
170
171 L<fs_listacl(1)>,
172 L<fs_mkmount(1)>,
173 L<fs_setacl(1)>,
174 IBM AFS/DFS Migration Toolkit Administration Guide and Reference
175
176 =cut