manpages-fs-chown-chgrp-20090701
authorJeffrey Altman <jaltman@secure-endpoints.com>
Wed, 1 Jul 2009 22:12:10 +0000 (22:12 +0000)
committerJeffrey Altman <jaltman@secure-endpoints.com>
Wed, 1 Jul 2009 22:12:10 +0000 (22:12 +0000)
LICENSE BSD

Add new man pages for fs chown and chgrp on Windows.

Update titles for Windows only commands to indicate they are Windows only.

doc/man-pages/NTMakefile
doc/man-pages/pod1/fs_chgrp.pod [new file with mode: 0644]
doc/man-pages/pod1/fs_chown.pod [new file with mode: 0644]
doc/man-pages/pod1/fs_cscpolicy.pod
doc/man-pages/pod1/fs_memdump.pod
doc/man-pages/pod1/symlink.pod
doc/man-pages/pod1/symlink_list.pod
doc/man-pages/pod1/symlink_make.pod
doc/man-pages/pod1/symlink_remove.pod

index 2d412fb..ccf8407 100644 (file)
@@ -39,6 +39,8 @@ PODS = \
         pod1\fs_apropos.pod            \
         pod1\fs_checkservers.pod       \
         pod1\fs_checkvolumes.pod       \
+        pod1\fs_chgrp.pod              \
+        pod1\fs_chown.pod              \
         pod1\fs_cleanacl.pod           \
         pod1\fs_copyacl.pod            \
         pod1\fs_cscpolicy.pod          \
diff --git a/doc/man-pages/pod1/fs_chgrp.pod b/doc/man-pages/pod1/fs_chgrp.pod
new file mode 100644 (file)
index 0000000..63137c2
--- /dev/null
@@ -0,0 +1,87 @@
+=head1 NAME
+
+fs_chgrp - Changes the group for an object stored within AFS [Windows only]
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<fs chown> S<<< B<-group> <I<user/group>> >>> S<<< B<-path> <I<dir/file path>>+ >>> 
+    [B<-literal>][B<-help>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<fs chgrp> command assigns the specified B<group> to each object 
+specified with the B<-path>.
+
+If the B<-literal> argument is specified, the targets of symlinks and mountpoints 
+are not resolved.  This permits the group of the symlink or 
+mountpoint to be assigned.
+
+The B<group> can be specified by name or by number.  If specified by 
+name, the name will be resolved to the numeric value by querying the
+protection server in the cell for each specified B<-path> object.
+
+To display the current group, use the B<fs examine> command.
+
+=head1 CAUTIONS
+
+Explicit or implicit administrator access rights are required to be able to 
+change the group of an object stored in AFS.
+
+This command is available in versions of OpenAFS for Windows 1.5.61 and higher.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-group> <I<user/group>>
+
+A valid name or number of a user or group identifier in the Protection Service
+database.  
+
+=item B<-path> <I<dir/file path>>+
+
+Names each AFS directory or file, on which the group will be set.
+Partial pathnames are interpreted relative to the current working
+directory.
+
+Specify the read/write path to each directory to avoid the
+failure that results from attempting to change a read-only volume. By
+convention, the read/write path is indicated by placing a period before
+the cell name at the pathname's second level (for example,
+F</afs/.abc.com>). For further discussion of the concept of read/write and
+read-only paths through the filespace, see the B<fs mkmount> reference
+page.
+
+=item B<-literal>
+
+When specified, the targets of symlinks and mountpoints are not resolved.  
+This permits the ownership of the symlink or mountpoint to be assigned.
+
+=item B<-help>
+
+Prints the online help for this command. All other valid options are
+ignored.
+
+=back
+
+=head1 PRIVILEGE REQUIRED
+
+The issuer must have the C<a> (administer) permission on the directory's
+ACL, a member of the system:administrators group, be the UID owner of the 
+object, or, as a special case, must be the UID owner of the top-level directory 
+of the volume containing the object.
+
+=head1 SEE ALSO
+
+L<fs_examine(1)>,
+L<fs_chown(1)>
+
+=head1 COPYRIGHT
+
+This document was written by Jeffrey Altman and is released under the BSD license.
diff --git a/doc/man-pages/pod1/fs_chown.pod b/doc/man-pages/pod1/fs_chown.pod
new file mode 100644 (file)
index 0000000..420803f
--- /dev/null
@@ -0,0 +1,88 @@
+=head1 NAME
+
+fs_chown - Changes the owner for an object stored within AFS [Windows only]
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<fs chown> S<<< B<-owner> <I<owner>> >>> S<<< B<-path> <I<dir/file path>>+ >>> 
+    [B<-literal>][B<-help>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<fs chown> command assigns the specified B<owner> to each object 
+specified with the B<-path>.
+
+If the B<-literal> argument is specified, the targets of symlinks and mountpoints 
+are not resolved.  This permits the ownership of the symlink or 
+mountpoint to be assigned.
+
+The B<owner> can be specified by name or by number.  If specified by 
+name, the name will be resolved to the numeric value by querying the
+protection server in the cell for each specified B<-path> object.
+
+To display the current owner, use the B<fs examine> command.
+
+=head1 CAUTIONS
+
+Explicit or implicit administrator access rights are required to be able to 
+change the owner of an object stored in AFS.  Changing ownership can alter
+the current user's implicit rights.
+
+This command is available in versions of OpenAFS for Windows 1.5.61 and higher.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-owner> <I<owner>>
+
+A valid name or number of a user identifier in the Protection Service
+database.  
+
+=item B<-path> <I<dir/file path>>+
+
+Names each AFS directory or file, on which the owner will be set.
+Partial pathnames are interpreted relative to the current working
+directory.
+
+Specify the read/write path to each directory to avoid the
+failure that results from attempting to change a read-only volume. By
+convention, the read/write path is indicated by placing a period before
+the cell name at the pathname's second level (for example,
+F</afs/.abc.com>). For further discussion of the concept of read/write and
+read-only paths through the filespace, see the B<fs mkmount> reference
+page.
+
+=item B<-literal>
+
+When specified, the targets of symlinks and mountpoints are not resolved.  
+This permits the ownership of the symlink or mountpoint to be assigned.
+
+=item B<-help>
+
+Prints the online help for this command. All other valid options are
+ignored.
+
+=back
+
+=head1 PRIVILEGE REQUIRED
+
+The issuer must have the C<a> (administer) permission on the directory's
+ACL, a member of the system:administrators group, or, as a special case,
+must be the UID owner of the top-level directory of the volume containing
+the object.
+
+=head1 SEE ALSO
+
+L<fs_examine(1)>,
+L<fs_chgrp(1)>
+
+=head1 COPYRIGHT
+
+This document was written by Jeffrey Altman and is released under the BSD license.
index d52c2f8..c43944d 100644 (file)
@@ -1,6 +1,6 @@
 =head1 NAME
 
-fs_cscpolicy - Change client side caching policy for AFS shares
+fs_cscpolicy - Change client side caching policy for AFS shares [Windows only]
 
 =head1 SYNOPSIS
 
index 2a308db..025202c 100644 (file)
@@ -1,6 +1,6 @@
 =head1 NAME
 
-fs_memdump - Dump AFS cache state and memory allocations
+fs_memdump - Dump AFS cache state and memory allocations [Windows only]
 
 =head1 SYNOPSIS
 
index a024edb..97f1562 100644 (file)
@@ -1,6 +1,6 @@
 =head1 NAME
 
-symlink - Introduction to the symlink command suite
+symlink - Introduction to the symlink command suite [Windows only]
 
 =head1 DESCRIPTION
 
index 8b21fc8..7cc64f5 100644 (file)
@@ -1,6 +1,6 @@
 =head1 NAME
 
-symlink_list - Show the file to which a symlink points
+symlink_list - Show the file to which a symlink points [Windows only]
 
 =head1 SYNOPSIS
 
index f04a708..cf258df 100644 (file)
@@ -1,6 +1,6 @@
 =head1 NAME
 
-symlink_make - Create a symbolic link
+symlink_make - Create a symbolic link [Windows only]
 
 =head1 SYNOPSIS
 
index bec9a92..0fa4e44 100644 (file)
@@ -1,6 +1,6 @@
 =head1 NAME
 
-symlink_remove - Remove a symbolic link.
+symlink_remove - Remove a symbolic link [Windows only]
 
 =head1 SYNOPSIS