From: Russ Allbery Date: Sat, 28 Jun 2008 04:21:30 +0000 (-0700) Subject: Rename the up man page to afs-up, matching our renaming X-Git-Tag: debian/1.4.7.dfsg1-3~30 X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=37b7d8c5bbabbffc03a5fc638e09cbbf02671df1;p=packages%2Fo%2Fopenafs.git Rename the up man page to afs-up, matching our renaming Apply quilt patch afs-up-rename: Update the up man page to say afs-up instead, matching our renaming of the command, and rename it in the source tree so that the generated man page will have the correct name. Closes: #459635 --- diff --git a/debian/patches/afs-up-rename b/debian/patches/afs-up-rename deleted file mode 100644 index 8da84b5a9..000000000 --- a/debian/patches/afs-up-rename +++ /dev/null @@ -1,62 +0,0 @@ -Update the up man page to say afs-up instead, matching our renaming of -the command. We also have to copy up.pod to afs-up.pod to get the right -man page headers, but quilt can't do that easily, so we do that in -debian/rules. - -Not suitable upstream unless they rename the up command as well. - -Debian Bug#459635 - ---- openafs.orig/doc/man-pages/pod1/up.pod -+++ openafs/doc/man-pages/pod1/up.pod -@@ -1,13 +1,13 @@ - =head1 NAME - --up - Recursively copy directories, preserving AFS metadata -+afs-up - Recursively copy directories, preserving AFS metadata - - =head1 SYNOPSIS - - =for html -
- --B [B<-v>] [B<-1>] [B<-f>] [B<-r>] [B<-x>] [B<-m>] -+B [B<-v>] [B<-1>] [B<-f>] [B<-r>] [B<-x>] [B<-m>] - > > - - =for html -@@ -15,7 +15,7 @@ - - =head1 DESCRIPTION - --The B command recursively copies the files and subdirectories in a -+The B command recursively copies the files and subdirectories in a - specified source directory to a specified destination directory. The - command interpreter changes the destination directory and the files and - subdirectories in it in the following ways: -@@ -56,14 +56,14 @@ - - =back - --The up command is idempotent, meaning that if its execution is interrupted -+The B command is idempotent, meaning that if its execution is interrupted - by a network, server machine, or process outage, then a subsequent reissue - of the same command continues from the interruption point, rather than - starting over at the beginning. This saves time and reduces network - traffic in comparison to the UNIX commands that provide similar - functionality. - --The B command returns a status code of C<0> (zero) only if it -+The B command returns a status code of C<0> (zero) only if it - succeeds. Otherwise, it returns a status code of C<1> (one). - - This command does not use the syntax conventions of the AFS command -@@ -124,7 +124,7 @@ - The following command copies the contents of the directory F to - directory F: - -- % up dir1 dir2 -+ % afs-up dir1 dir2 - - =head1 PRIVILEGE REQUIRED - diff --git a/debian/rules b/debian/rules index e79fd5655..8ff0a4a76 100755 --- a/debian/rules +++ b/debian/rules @@ -49,7 +49,7 @@ DOC_PACKAGES = libpam-openafs-kaserver openafs-dbserver openafs-fileserver \ IGNORE = -XAuthLog -Xcompile_et -Xcopyauth -Xdlog -Xdpass -Xfms.log \ -Xkadb_check -Xkaserver -Xkdb -Xkdump -Xklog.krb -Xkpwvalid \ -Xlibafssetpag.so -Xlibafsrpc.so -Xlibafsauthent.so -Xpackage \ - -Xpagsh.krb -Xrestorevol -Xsymlink -Xtokens.krb -Xman1/up.1 -Xuss \ + -Xpagsh.krb -Xrestorevol -Xsymlink -Xtokens.krb -Xuss \ -Xvldb_convert -Xvsys -Xxfs_size_check # Installed via other means since we have to rename them. @@ -88,7 +88,6 @@ configure: configure-stamp configure-stamp: $(QUILT_STAMPFN) @if test x"$(SYS_NAME)" = x"UNKNOWN" ; then exit 1 ; fi dh_testdir - cp doc/man-pages/pod1/up.pod doc/man-pages/pod1/afs-up.pod sh regen.sh afslogsdir=/var/log/openafs afslocaldir=/var/lib/openafs/local \ sh configure \ diff --git a/doc/man-pages/pod1/afs-up.pod b/doc/man-pages/pod1/afs-up.pod new file mode 100644 index 000000000..ebcee4100 --- /dev/null +++ b/doc/man-pages/pod1/afs-up.pod @@ -0,0 +1,140 @@ +=head1 NAME + +afs-up - Recursively copy directories, preserving AFS metadata + +=head1 SYNOPSIS + +=for html +
+ +B [B<-v>] [B<-1>] [B<-f>] [B<-r>] [B<-x>] [B<-m>] + > > + +=for html +
+ +=head1 DESCRIPTION + +The B command recursively copies the files and subdirectories in a +specified source directory to a specified destination directory. The +command interpreter changes the destination directory and the files and +subdirectories in it in the following ways: + +=over 4 + +=item * + +It copies the source directory's access control list (ACL) to the +destination directory and its subdirectories, overwriting any existing +ACLs. + +=item * + +If the issuer is logged on as the local superuser root and has AFS tokens +as a member of the group system:administrators, then the source +directory's owner (as reported by the C command) becomes the owner +of the destination directory and all files and subdirectories in +it. Otherwise, the issuer's user name is recorded as the owner. + +=item * + +If a file or directory exists in both the source and destination +directories, the source version overwrites the destination version. The +overwrite operation fails if the first (user) C (write) mode bit is +turned off on the version in the destination directory, unless the B<-f> +flag is provided. + +=item * + +The modification timestamp on a file (as displayed by the C +command) in the source directory overwrites the timestamp on a file of the +same name in the destination directory, but the timestamp on an existing +subdirectory in the destination directory remains unchanged. If the +command creates a new subdirectory in the destination directory, the new +subdirectory's timestamp is set to the time of the copy operation, rather +than to the timestamp that the subdirectory has in the source directory. + +=back + +The B command is idempotent, meaning that if its execution is interrupted +by a network, server machine, or process outage, then a subsequent reissue +of the same command continues from the interruption point, rather than +starting over at the beginning. This saves time and reduces network +traffic in comparison to the UNIX commands that provide similar +functionality. + +The B command returns a status code of C<0> (zero) only if it +succeeds. Otherwise, it returns a status code of C<1> (one). + +This command does not use the syntax conventions of the AFS command +suites. Provide the command name and all option names in full. + +=head1 OPTIONS + +=over 4 + +=item B<-v> + +Prints a detailed trace to the standard output stream as the command runs. + +=item B<-1> + +Copies only the files in the top level source directory to the destination +directory, rather than copying recursively through subdirectories. The +source directory's ACL still overwrites the destination directory's. (This +is the number one, not the letter C.) + +=item B<-f> + +Overwrites existing directories, subdirectories, and files even if the +first (user) C (write) mode bit is turned off on the version in the +destination directory. + +=item B<-m> + +Recognize and copy mount points rather than traversing the volumes they +reference during the recursive copy operation. Without B<-m>, B's +default behavior is to copy the contents of all volumes and subvolumes +mounted under the source directory into the volume containing the +destination directory. + +=item B<-r> + +Creates a backup copy of all files overwritten in the destination +directory and its subdirectories, by adding a C<.old> extension to each +filename. + +=item B<-x> + +Sets the modification timestamp on each file to the time of the copying +operation. + +=item I + +Names the directory to copy recursively. + +=item I + +Names the directory to which to copy. It does not have to exist already. + +=back + +=head1 EXAMPLES + +The following command copies the contents of the directory F to +directory F: + + % afs-up dir1 dir2 + +=head1 PRIVILEGE REQUIRED + +The issuer must have the C (administer) permission on the ACL of both +the source and destination directories. + +=head1 COPYRIGHT + +IBM Corporation 2000. All Rights Reserved. + +This documentation is covered by the IBM Public License Version 1.0. It was +converted from HTML to POD by software written by Chas Williams and Russ +Allbery, based on work by Alf Wachsmann and Elizabeth Cassell. diff --git a/doc/man-pages/pod1/up.pod b/doc/man-pages/pod1/up.pod deleted file mode 100644 index adb09670c..000000000 --- a/doc/man-pages/pod1/up.pod +++ /dev/null @@ -1,140 +0,0 @@ -=head1 NAME - -up - Recursively copy directories, preserving AFS metadata - -=head1 SYNOPSIS - -=for html -
- -B [B<-v>] [B<-1>] [B<-f>] [B<-r>] [B<-x>] [B<-m>] - > > - -=for html -
- -=head1 DESCRIPTION - -The B command recursively copies the files and subdirectories in a -specified source directory to a specified destination directory. The -command interpreter changes the destination directory and the files and -subdirectories in it in the following ways: - -=over 4 - -=item * - -It copies the source directory's access control list (ACL) to the -destination directory and its subdirectories, overwriting any existing -ACLs. - -=item * - -If the issuer is logged on as the local superuser root and has AFS tokens -as a member of the group system:administrators, then the source -directory's owner (as reported by the C command) becomes the owner -of the destination directory and all files and subdirectories in -it. Otherwise, the issuer's user name is recorded as the owner. - -=item * - -If a file or directory exists in both the source and destination -directories, the source version overwrites the destination version. The -overwrite operation fails if the first (user) C (write) mode bit is -turned off on the version in the destination directory, unless the B<-f> -flag is provided. - -=item * - -The modification timestamp on a file (as displayed by the C -command) in the source directory overwrites the timestamp on a file of the -same name in the destination directory, but the timestamp on an existing -subdirectory in the destination directory remains unchanged. If the -command creates a new subdirectory in the destination directory, the new -subdirectory's timestamp is set to the time of the copy operation, rather -than to the timestamp that the subdirectory has in the source directory. - -=back - -The up command is idempotent, meaning that if its execution is interrupted -by a network, server machine, or process outage, then a subsequent reissue -of the same command continues from the interruption point, rather than -starting over at the beginning. This saves time and reduces network -traffic in comparison to the UNIX commands that provide similar -functionality. - -The B command returns a status code of C<0> (zero) only if it -succeeds. Otherwise, it returns a status code of C<1> (one). - -This command does not use the syntax conventions of the AFS command -suites. Provide the command name and all option names in full. - -=head1 OPTIONS - -=over 4 - -=item B<-v> - -Prints a detailed trace to the standard output stream as the command runs. - -=item B<-1> - -Copies only the files in the top level source directory to the destination -directory, rather than copying recursively through subdirectories. The -source directory's ACL still overwrites the destination directory's. (This -is the number one, not the letter C.) - -=item B<-f> - -Overwrites existing directories, subdirectories, and files even if the -first (user) C (write) mode bit is turned off on the version in the -destination directory. - -=item B<-m> - -Recognize and copy mount points rather than traversing the volumes they -reference during the recursive copy operation. Without B<-m>, B's -default behavior is to copy the contents of all volumes and subvolumes -mounted under the source directory into the volume containing the -destination directory. - -=item B<-r> - -Creates a backup copy of all files overwritten in the destination -directory and its subdirectories, by adding a C<.old> extension to each -filename. - -=item B<-x> - -Sets the modification timestamp on each file to the time of the copying -operation. - -=item I - -Names the directory to copy recursively. - -=item I - -Names the directory to which to copy. It does not have to exist already. - -=back - -=head1 EXAMPLES - -The following command copies the contents of the directory F to -directory F: - - % up dir1 dir2 - -=head1 PRIVILEGE REQUIRED - -The issuer must have the C (administer) permission on the ACL of both -the source and destination directories. - -=head1 COPYRIGHT - -IBM Corporation 2000. All Rights Reserved. - -This documentation is covered by the IBM Public License Version 1.0. It was -converted from HTML to POD by software written by Chas Williams and Russ -Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.