manpages-fs-chown-chgrp-20090701
[openafs.git] / doc / man-pages / pod1 / fs_chgrp.pod
1 =head1 NAME
2
3 fs_chgrp - Changes the group for an object stored within AFS [Windows only]
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fs chown> S<<< B<-group> <I<user/group>> >>> S<<< B<-path> <I<dir/file path>>+ >>> 
11     [B<-literal>][B<-help>]
12
13 =for html
14 </div>
15
16 =head1 DESCRIPTION
17
18 The B<fs chgrp> command assigns the specified B<group> to each object 
19 specified with the B<-path>.
20
21 If the B<-literal> argument is specified, the targets of symlinks and mountpoints 
22 are not resolved.  This permits the group of the symlink or 
23 mountpoint to be assigned.
24
25 The B<group> can be specified by name or by number.  If specified by 
26 name, the name will be resolved to the numeric value by querying the
27 protection server in the cell for each specified B<-path> object.
28
29 To display the current group, use the B<fs examine> command.
30
31 =head1 CAUTIONS
32
33 Explicit or implicit administrator access rights are required to be able to 
34 change the group of an object stored in AFS.
35
36 This command is available in versions of OpenAFS for Windows 1.5.61 and higher.
37
38 =head1 OPTIONS
39
40 =over 4
41
42 =item B<-group> <I<user/group>>
43
44 A valid name or number of a user or group identifier in the Protection Service
45 database.  
46
47 =item B<-path> <I<dir/file path>>+
48
49 Names each AFS directory or file, on which the group will be set.
50 Partial pathnames are interpreted relative to the current working
51 directory.
52
53 Specify the read/write path to each directory to avoid the
54 failure that results from attempting to change a read-only volume. By
55 convention, the read/write path is indicated by placing a period before
56 the cell name at the pathname's second level (for example,
57 F</afs/.abc.com>). For further discussion of the concept of read/write and
58 read-only paths through the filespace, see the B<fs mkmount> reference
59 page.
60
61 =item B<-literal>
62
63 When specified, the targets of symlinks and mountpoints are not resolved.  
64 This permits the ownership of the symlink or mountpoint to be assigned.
65
66 =item B<-help>
67
68 Prints the online help for this command. All other valid options are
69 ignored.
70
71 =back
72
73 =head1 PRIVILEGE REQUIRED
74
75 The issuer must have the C<a> (administer) permission on the directory's
76 ACL, a member of the system:administrators group, be the UID owner of the 
77 object, or, as a special case, must be the UID owner of the top-level directory 
78 of the volume containing the object.
79
80 =head1 SEE ALSO
81
82 L<fs_examine(1)>,
83 L<fs_chown(1)>
84
85 =head1 COPYRIGHT
86
87 This document was written by Jeffrey Altman and is released under the BSD license.