Factor out the common text in vos_addsite, vos_copy, and vos_zap

Factor out some common options out of the man pages.

LICENSE IPL

Change-Id: Ic79e53a2d6464cc62d49987ab58d38c9898f372b
Reviewed-on: http://gerrit.openafs.org/2496
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>

diff --git a/doc/man-pages/pod1/.gitignore b/doc/man-pages/pod1/.gitignore
index b794ac3..1a1d4d6 100644 (file)
--- a/doc/man-pages/pod1/.gitignore
+++ b/doc/man-pages/pod1/.gitignore
@@ -20,3 +20,6 @@
 /pts_setmax.pod
 /pts_sleep.pod
 /pts_source.pod
+/vos_addsite.pod
+/vos_copy.pod
+/vos_zap.pod

diff --git a/doc/man-pages/pod1/fragments/vos-common.pod b/doc/man-pages/pod1/fragments/vos-common.pod
new file mode 100644 (file)
index 0000000..5a05f37
--- /dev/null
+++ b/doc/man-pages/pod1/fragments/vos-common.pod
@@ -0,0 +1,42 @@
+=item B<-cell> <I<cell name>>
+
+Names the cell in which to run the command. Do not combine this argument
+with the B<-localauth> flag. For more details, see L<vos(1)>.
+
+=item B<-noauth>
+
+Assigns the unprivileged identity C<anonymous> to the issuer. Do not
+combine this flag with the B<-localauth> flag. For more details, see
+L<vos(1)>.
+
+=item B<-localauth>
+
+Constructs a server ticket using a key from the local
+F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
+to the Volume Server and Volume Location Server during mutual
+authentication. Do not combine this flag with the B<-cell> argument or
+B<-noauth> flag. For more details, see L<vos(1)>.
+
+=item B<-verbose>
+
+Produces on the standard output stream a detailed trace of the command's
+execution. If this argument is omitted, only warnings and error messages
+appear.
+
+=item B<-encrypt>
+
+Encrypts the command so that the operation's results are not transmitted
+across the network in clear text. This option is available in OpenAFS
+versions 1.4.11 or later and 1.5.60 or later.
+
+=item B<-noresolve>
+
+Shows all servers as IP addresses instead of the DNS name. This is very
+useful when the server address is registered as 127.0.0.1 or when dealing
+with multi-homed servers. This option is available in OpenAFS
+versions 1.4.8 or later and 1.5.35 or later.
+
+=item B<-help>
+
+Prints the online help for this command. All other valid options are
+ignored.

diff --git a/doc/man-pages/pod1/vos_addsite.pod b/doc/man-pages/pod1/vos_addsite.pod.in
similarity index 77%
rename from doc/man-pages/pod1/vos_addsite.pod
rename to doc/man-pages/pod1/vos_addsite.pod.in
index 5bc3973..c9645e9 100644 (file)
--- a/doc/man-pages/pod1/vos_addsite.pod
+++ b/doc/man-pages/pod1/vos_addsite.pod.in
@@ -100,47 +100,7 @@ flag at the new site. This option is available in OpenAFS clients 1.4.7 or
 later and 1.5.31 or later. This option can be used with OpenAFS server
 versions later than 1.4.1 or 1.5.0.
 
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. Do not combine this argument
-with the B<-localauth> flag. For more details, see L<vos(1)>.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity anonymous to the issuer. Do not combine
-this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
-to the Volume Server and Volume Location Server during mutual
-authentication. Do not combine this flag with the B<-cell> argument or
-B<-noauth> flag. For more details, see L<vos(1)>.
-
-=item B<-verbose>
-
-Produces on the standard output stream a detailed trace of the command's
-execution. If this argument is omitted, only warnings and error messages
-appear.
-
-=item B<-encrypt>
-
-Encrypts the command so that the operation's results are not transmitted
-across the network in clear text. This option is available in OpenAFS
-versions 1.4.11 or later and 1.5.60 or later.
-
-=item B<-noresolve>
-
-Shows all servers as IP addresses instead of the DNS name. This is very
-useful when the server address is registered as 127.0.0.1 or when dealing
-with multi-homed servers. This option is available in OpenAFS
-versions 1.4.8 or later and 1.5.35 or later.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/vos-common.pod
 
 =back
 

diff --git a/doc/man-pages/pod1/vos_copy.pod b/doc/man-pages/pod1/vos_copy.pod.in
similarity index 83%
rename from doc/man-pages/pod1/vos_copy.pod
rename to doc/man-pages/pod1/vos_copy.pod.in
index b0c3bd9..50cc0a0 100644 (file)
--- a/doc/man-pages/pod1/vos_copy.pod
+++ b/doc/man-pages/pod1/vos_copy.pod.in
@@ -91,37 +91,7 @@ Copies the live volume without cloning.  This is normally not necessary and
 causes the volume to be kept locked for longer than the normal copy
 mechanism.
 
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it to
-the Volume Server and Volume Location Server during mutual
-authentication. Do not combine this flag with the B<-cell> argument or
-B<-noauth> flag. For more details, see L<vos(1)>.
-
-=item B<-verbose>
-
-Produces on the standard output stream a detailed trace of the command's
-execution. If this argument is omitted, only warnings and error messages
-appear.
-
-=item B<-encrypt>
-
-Encrypts the command so that the operation's results are not transmitted
-across the network in clear text. This option is available in OpenAFS
-versions 1.4.11 or later and 1.5.60 or later.
-
-=item B<-noresolve>
-
-Shows all servers as IP addresses instead of the DNS name. This is very
-useful when the server address is registered as 127.0.0.1 or when dealing
-with multi-homed servers. This option is available in OpenAFS
-versions 1.4.8 or later and 1.5.35 or later.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/vos-common.pod
 
 =back
 

diff --git a/doc/man-pages/pod1/vos_zap.pod b/doc/man-pages/pod1/vos_zap.pod.in
similarity index 77%
rename from doc/man-pages/pod1/vos_zap.pod
rename to doc/man-pages/pod1/vos_zap.pod.in
index ae31fef..b3f3517 100644 (file)
--- a/doc/man-pages/pod1/vos_zap.pod
+++ b/doc/man-pages/pod1/vos_zap.pod.in
@@ -104,48 +104,7 @@ Removes the backup version of the read/write volume specified by the
 B<-id> argument. Do not use this flag if the B<-id> argument identifies a
 read-only or backup volume.
 
-=item B<-cell> <I<cell name>>
-
-Names the cell in which to run the command. Do not combine this argument
-with the B<-localauth> flag. For more details, see L<vos(1)>.
-
-=item B<-noauth>
-
-Assigns the unprivileged identity C<anonymous> to the issuer. Do not
-combine this flag with the B<-localauth> flag. For more details, see
-L<vos(1)>.
-
-=item B<-localauth>
-
-Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
-to the Volume Server and Volume Location Server during mutual
-authentication. Do not combine this flag with the B<-cell> argument or
-B<-noauth> flag. For more details, see L<vos(1)>.
-
-=item B<-verbose>
-
-Produces on the standard output stream a detailed trace of the command's
-execution. If this argument is omitted, only warnings and error messages
-appear.
-
-=item B<-encrypt>
-
-Encrypts the command so that the operation's results are not transmitted
-across the network in clear text. This option is available in OpenAFS
-versions 1.4.11 or later and 1.5.60 or later.
-
-=item B<-noresolve>
-
-Shows all servers as IP addresses instead of the DNS name. This is very
-useful when the server address is registered as 127.0.0.1 or when dealing
-with multi-homed servers. This option is available in OpenAFS
-versions 1.4.8 or later and 1.5.35 or later.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/vos-common.pod
 
 =back