From 35d46ce87930bee64d8515244c6ad01abc33099d Mon Sep 17 00:00:00 2001 From: Jeffrey Altman Date: Wed, 1 Jul 2009 22:13:29 +0000 Subject: [PATCH] DEVEL15-manpages-fs-chown-chgrp-20090701 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. (cherry picked from commit 4db337f87c0170380037593d1c998fb1b9819aa3) --- doc/man-pages/NTMakefile | 2 + doc/man-pages/pod1/fs_chgrp.pod | 87 ++++++++++++++++++++++++++ doc/man-pages/pod1/fs_chown.pod | 88 +++++++++++++++++++++++++++ doc/man-pages/pod1/fs_cscpolicy.pod | 2 +- doc/man-pages/pod1/fs_memdump.pod | 2 +- doc/man-pages/pod1/symlink.pod | 2 +- doc/man-pages/pod1/symlink_list.pod | 2 +- doc/man-pages/pod1/symlink_make.pod | 2 +- doc/man-pages/pod1/symlink_remove.pod | 2 +- 9 files changed, 183 insertions(+), 6 deletions(-) create mode 100644 doc/man-pages/pod1/fs_chgrp.pod create mode 100644 doc/man-pages/pod1/fs_chown.pod diff --git a/doc/man-pages/NTMakefile b/doc/man-pages/NTMakefile index 8d82ae3067..6b3823159b 100644 --- a/doc/man-pages/NTMakefile +++ b/doc/man-pages/NTMakefile @@ -40,6 +40,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 index 0000000000..63137c204c --- /dev/null +++ b/doc/man-pages/pod1/fs_chgrp.pod @@ -0,0 +1,87 @@ +=head1 NAME + +fs_chgrp - Changes the group for an object stored within AFS [Windows only] + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-group> > >>> S<<< B<-path> >+ >>> + [B<-literal>][B<-help>] + +=for html +
+ +=head1 DESCRIPTION + +The B command assigns the specified B 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 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 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> > + +A valid name or number of a user or group identifier in the Protection Service +database. + +=item B<-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). For further discussion of the concept of read/write and +read-only paths through the filespace, see the B 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 (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, +L + +=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 index 0000000000..420803f504 --- /dev/null +++ b/doc/man-pages/pod1/fs_chown.pod @@ -0,0 +1,88 @@ +=head1 NAME + +fs_chown - Changes the owner for an object stored within AFS [Windows only] + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-owner> > >>> S<<< B<-path> >+ >>> + [B<-literal>][B<-help>] + +=for html +
+ +=head1 DESCRIPTION + +The B command assigns the specified B 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 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 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> > + +A valid name or number of a user identifier in the Protection Service +database. + +=item B<-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). For further discussion of the concept of read/write and +read-only paths through the filespace, see the B 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 (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, +L + +=head1 COPYRIGHT + +This document was written by Jeffrey Altman and is released under the BSD license. diff --git a/doc/man-pages/pod1/fs_cscpolicy.pod b/doc/man-pages/pod1/fs_cscpolicy.pod index d52c2f82ce..c43944d275 100644 --- a/doc/man-pages/pod1/fs_cscpolicy.pod +++ b/doc/man-pages/pod1/fs_cscpolicy.pod @@ -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 diff --git a/doc/man-pages/pod1/fs_memdump.pod b/doc/man-pages/pod1/fs_memdump.pod index 2a308dbcfe..025202ca42 100644 --- a/doc/man-pages/pod1/fs_memdump.pod +++ b/doc/man-pages/pod1/fs_memdump.pod @@ -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 diff --git a/doc/man-pages/pod1/symlink.pod b/doc/man-pages/pod1/symlink.pod index a024edb338..97f1562d2b 100644 --- a/doc/man-pages/pod1/symlink.pod +++ b/doc/man-pages/pod1/symlink.pod @@ -1,6 +1,6 @@ =head1 NAME -symlink - Introduction to the symlink command suite +symlink - Introduction to the symlink command suite [Windows only] =head1 DESCRIPTION diff --git a/doc/man-pages/pod1/symlink_list.pod b/doc/man-pages/pod1/symlink_list.pod index 8b21fc86fb..7cc64f51a1 100644 --- a/doc/man-pages/pod1/symlink_list.pod +++ b/doc/man-pages/pod1/symlink_list.pod @@ -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 diff --git a/doc/man-pages/pod1/symlink_make.pod b/doc/man-pages/pod1/symlink_make.pod index f04a7086e8..cf258dfefd 100644 --- a/doc/man-pages/pod1/symlink_make.pod +++ b/doc/man-pages/pod1/symlink_make.pod @@ -1,6 +1,6 @@ =head1 NAME -symlink_make - Create a symbolic link +symlink_make - Create a symbolic link [Windows only] =head1 SYNOPSIS diff --git a/doc/man-pages/pod1/symlink_remove.pod b/doc/man-pages/pod1/symlink_remove.pod index bec9a92ec6..0fa4e4431e 100644 --- a/doc/man-pages/pod1/symlink_remove.pod +++ b/doc/man-pages/pod1/symlink_remove.pod @@ -1,6 +1,6 @@ =head1 NAME -symlink_remove - Remove a symbolic link. +symlink_remove - Remove a symbolic link [Windows only] =head1 SYNOPSIS