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