doc: Make all vos pages =include common options
authorAndrew Deason <adeason@sinenomine.net>
Sun, 30 Jun 2013 02:06:51 +0000 (21:06 -0500)
committerDerrick Brashear <shadow@your-file-system.com>
Mon, 4 Nov 2013 17:32:57 +0000 (09:32 -0800)
Many manpages for "vos" subcommands were not using the "common" vos
fragments, and instead were just repeating the information directly in
their manpage. Make them all use the "common" vos fragment to avoid
duplication.

Change-Id: I62d84a1164b4ba46082e33a6d27fd24e3722014c
Reviewed-on: http://gerrit.openafs.org/10398
Reviewed-by: Derrick Brashear <shadow@your-file-system.com>
Tested-by: BuildBot <buildbot@rampaginggeek.com>

39 files changed:
doc/man-pages/pod1/.gitignore
doc/man-pages/pod1/vos_backupsys.pod.in [moved from doc/man-pages/pod1/vos_backupsys.pod with 88% similarity]
doc/man-pages/pod1/vos_changeaddr.pod.in [moved from doc/man-pages/pod1/vos_changeaddr.pod with 74% similarity]
doc/man-pages/pod1/vos_changeloc.pod.in [moved from doc/man-pages/pod1/vos_changeloc.pod with 73% similarity]
doc/man-pages/pod1/vos_clone.pod.in
doc/man-pages/pod1/vos_convertROtoRW.pod [deleted file]
doc/man-pages/pod1/vos_convertROtoRW.pod.in [new file with mode: 0644]
doc/man-pages/pod1/vos_create.pod.in
doc/man-pages/pod1/vos_delentry.pod.in [moved from doc/man-pages/pod1/vos_delentry.pod with 80% similarity]
doc/man-pages/pod1/vos_endtrans.pod.in [moved from doc/man-pages/pod1/vos_endtrans.pod with 74% similarity]
doc/man-pages/pod1/vos_examine.pod.in
doc/man-pages/pod1/vos_listaddrs.pod.in [moved from doc/man-pages/pod1/vos_listaddrs.pod with 70% similarity]
doc/man-pages/pod1/vos_listpart.pod [deleted file]
doc/man-pages/pod1/vos_listpart.pod.in [new file with mode: 0644]
doc/man-pages/pod1/vos_listvldb.pod.in [moved from doc/man-pages/pod1/vos_listvldb.pod with 85% similarity]
doc/man-pages/pod1/vos_listvol.pod.in [moved from doc/man-pages/pod1/vos_listvol.pod with 88% similarity]
doc/man-pages/pod1/vos_lock.pod [deleted file]
doc/man-pages/pod1/vos_lock.pod.in [new file with mode: 0644]
doc/man-pages/pod1/vos_move.pod.in
doc/man-pages/pod1/vos_offline.pod.in [moved from doc/man-pages/pod1/vos_offline.pod with 73% similarity]
doc/man-pages/pod1/vos_online.pod [deleted file]
doc/man-pages/pod1/vos_online.pod.in [new file with mode: 0644]
doc/man-pages/pod1/vos_partinfo.pod.in
doc/man-pages/pod1/vos_release.pod.in [moved from doc/man-pages/pod1/vos_release.pod with 82% similarity]
doc/man-pages/pod1/vos_remove.pod.in [moved from doc/man-pages/pod1/vos_remove.pod with 80% similarity]
doc/man-pages/pod1/vos_remsite.pod.in [moved from doc/man-pages/pod1/vos_remsite.pod with 70% similarity]
doc/man-pages/pod1/vos_rename.pod [deleted file]
doc/man-pages/pod1/vos_rename.pod.in [new file with mode: 0644]
doc/man-pages/pod1/vos_restore.pod.in [moved from doc/man-pages/pod1/vos_restore.pod with 85% similarity]
doc/man-pages/pod1/vos_setaddrs.pod.in [moved from doc/man-pages/pod1/vos_setaddrs.pod with 70% similarity]
doc/man-pages/pod1/vos_setfields.pod.in [moved from doc/man-pages/pod1/vos_setfields.pod with 69% similarity]
doc/man-pages/pod1/vos_shadow.pod.in
doc/man-pages/pod1/vos_size.pod.in [moved from doc/man-pages/pod1/vos_size.pod with 74% similarity]
doc/man-pages/pod1/vos_status.pod.in [moved from doc/man-pages/pod1/vos_status.pod with 75% similarity]
doc/man-pages/pod1/vos_syncserv.pod.in [moved from doc/man-pages/pod1/vos_syncserv.pod with 69% similarity]
doc/man-pages/pod1/vos_syncvldb.pod.in [moved from doc/man-pages/pod1/vos_syncvldb.pod with 76% similarity]
doc/man-pages/pod1/vos_unlock.pod [deleted file]
doc/man-pages/pod1/vos_unlock.pod.in [new file with mode: 0644]
doc/man-pages/pod1/vos_unlockvldb.pod.in [moved from doc/man-pages/pod1/vos_unlockvldb.pod with 71% similarity]

index fc1716f..c41eb7c 100644 (file)
 /vos.pod
 /vos_addsite.pod
 /vos_backup.pod
+/vos_backupsys.pod
+/vos_changeaddr.pod
+/vos_changeloc.pod
+/vos_convertROtoRW.pod
 /vos_copy.pod
 /vos_clone.pod
 /vos_create.pod
+/vos_delentry.pod
 /vos_dump.pod
+/vos_endtrans.pod
 /vos_examine.pod
+/vos_listaddrs.pod
+/vos_listpart.pod
+/vos_listvldb.pod
+/vos_listvol.pod
+/vos_lock.pod
 /vos_move.pod
+/vos_offline.pod
+/vos_online.pod
 /vos_partinfo.pod
+/vos_release.pod
+/vos_remove.pod
+/vos_remsite.pod
+/vos_rename.pod
+/vos_restore.pod
+/vos_setaddrs.pod
+/vos_setfields.pod
 /vos_shadow.pod
+/vos_size.pod
+/vos_status.pod
+/vos_syncserv.pod
+/vos_syncvldb.pod
+/vos_unlock.pod
+/vos_unlockvldb.pod
 /vos_zap.pod
similarity index 88%
rename from doc/man-pages/pod1/vos_backupsys.pod
rename to doc/man-pages/pod1/vos_backupsys.pod.in
index e02488f..910076c 100644 (file)
@@ -178,48 +178,7 @@ B<-prefix>, B<-server>, B<-partition>, and B<-exclude> options.
 Displays on the standard output stream a list of the volumes to be cloned,
 without actually cloning them.
 
-=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
 
similarity index 74%
rename from doc/man-pages/pod1/vos_changeaddr.pod
rename to doc/man-pages/pod1/vos_changeaddr.pod.in
index 74d438c..8945919 100644 (file)
@@ -83,48 +83,7 @@ addresses.
 Removes from the VLDB the server entry that includes the address specified
 by the B<-oldaddr> argument.
 
-=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
 
similarity index 73%
rename from doc/man-pages/pod1/vos_changeloc.pod
rename to doc/man-pages/pod1/vos_changeloc.pod.in
index 8a6b3b3..92cb79c 100644 (file)
@@ -76,48 +76,7 @@ L<vos(1)>.
 
 Specifies the name or volume ID number on which to operate.
 
-=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
 
index 3e6d90f..f60caaa 100644 (file)
@@ -106,48 +106,7 @@ Flags the new volume as read-only in the volume database.
 
 Flags the new volume as read-write in the volume database.
 
-=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
 
diff --git a/doc/man-pages/pod1/vos_convertROtoRW.pod b/doc/man-pages/pod1/vos_convertROtoRW.pod
deleted file mode 100644 (file)
index 4e7d61c..0000000
+++ /dev/null
@@ -1,138 +0,0 @@
-=head1 NAME
-
-vos_convertROtoRW - Converts a Read-Only volume into a Read/Write volume
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos convertROtoRW> S<<< [B<-server>] <I<machine name>> >>>
-   S<<< [B<-partition>] <I<partition name>> >>>
-   S<<< [B<-id>] <I<volume name or ID>> >>> [B<-force>]
-   S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
-   [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
-   S<<< [B<-config> <I<config directory>>] >>>
-   [B<-help>]
-
-B<vos con> S<<< [B<-s>] <I<machine name>> >>>
-   S<<< [B<-p>] <I<partition name>> >>>
-   S<<< [B<-i>] <I<volume name or ID>> >>> [B<-f>]
-   S<<< [B<-c> <I<cell name>>] >>> [B<-noa>] [B<-l>]
-   [B<-v>] [B<-e>] [B<-nor>]
-   S<<< [B<-co> <I<config directory>>] >>>
-   [B<-h>]
-
-=for html
-</div>
-
-=head1 DESCRIPTION
-
-B<vos convertROtoRW> converts a Read-Only volume into a Read/Write volume
-when the original Read/Write volume is no longer available.  It's normal use
-is to recover the Read/Write volume from a replica after a failed disk,
-failed server, or accidental deletion.
-
-=head1 CAUTIONS
-
-The command name is case-sensitive.  It must be issued with the capital "RO"
-and "RW".
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-server> <I<server name>>
-
-Identifies the file server machine that houses the Read-Only volume which
-will be converted.  Provide the machine's IP address or its host name
-(either fully qualified or using an unambiguous abbreviation).  For details,
-see L<vos(1)>.
-
-=item B<-partition> <I<partition name>>
-
-Identifies the partition on the file server machine that houses the
-Read-Only volume which will be converted.  Provide the full partition name
-(for, example, B</vicepa>) or one of the abbreviated forms described in
-L<vos(1)>.
-
-=item B<-id> <I<volume ID>>
-
-Specifies either the complete name or volume ID number of a Read/Write
-volume.
-
-=item B<-force>
-
-Don't ask for confirmation.
-
-=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.
-
-=back
-
-=head1 EXAMPLES
-
-The following example converts the read-only volume test3.readonly in
-partition vicepb on server1 to a read-write volume:
-
-   % vos convertROtoRW server1 b test3.readonly
-
-=head1 PRIVILEGE REQUIRED
-
-The issuer must be listed in the F</usr/afs/etc/UserList> file on the
-machine specified with the B<-server> argument and
-on each database server machine.  If the B<-localauth> flag is included,
-the issuer must instead be logged on to a server machine as the local
-superuser C<root>.
-
-=head1 SEE ALSO
-
-L<vos(1)>
-
-=head1 COPYRIGHT
-
-Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
-
-This documentation is covered by the BSD License as written in the
-doc/LICENSE file. This man page was written by Jason Edgecombe for
-OpenAFS.
diff --git a/doc/man-pages/pod1/vos_convertROtoRW.pod.in b/doc/man-pages/pod1/vos_convertROtoRW.pod.in
new file mode 100644 (file)
index 0000000..c19e7b4
--- /dev/null
@@ -0,0 +1,97 @@
+=head1 NAME
+
+vos_convertROtoRW - Converts a Read-Only volume into a Read/Write volume
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos convertROtoRW> S<<< [B<-server>] <I<machine name>> >>>
+   S<<< [B<-partition>] <I<partition name>> >>>
+   S<<< [B<-id>] <I<volume name or ID>> >>> [B<-force>]
+   S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
+   [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
+   S<<< [B<-config> <I<config directory>>] >>>
+   [B<-help>]
+
+B<vos con> S<<< [B<-s>] <I<machine name>> >>>
+   S<<< [B<-p>] <I<partition name>> >>>
+   S<<< [B<-i>] <I<volume name or ID>> >>> [B<-f>]
+   S<<< [B<-c> <I<cell name>>] >>> [B<-noa>] [B<-l>]
+   [B<-v>] [B<-e>] [B<-nor>]
+   S<<< [B<-co> <I<config directory>>] >>>
+   [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+B<vos convertROtoRW> converts a Read-Only volume into a Read/Write volume
+when the original Read/Write volume is no longer available.  It's normal use
+is to recover the Read/Write volume from a replica after a failed disk,
+failed server, or accidental deletion.
+
+=head1 CAUTIONS
+
+The command name is case-sensitive.  It must be issued with the capital "RO"
+and "RW".
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-server> <I<server name>>
+
+Identifies the file server machine that houses the Read-Only volume which
+will be converted.  Provide the machine's IP address or its host name
+(either fully qualified or using an unambiguous abbreviation).  For details,
+see L<vos(1)>.
+
+=item B<-partition> <I<partition name>>
+
+Identifies the partition on the file server machine that houses the
+Read-Only volume which will be converted.  Provide the full partition name
+(for, example, B</vicepa>) or one of the abbreviated forms described in
+L<vos(1)>.
+
+=item B<-id> <I<volume ID>>
+
+Specifies either the complete name or volume ID number of a Read/Write
+volume.
+
+=item B<-force>
+
+Don't ask for confirmation.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 EXAMPLES
+
+The following example converts the read-only volume test3.readonly in
+partition vicepb on server1 to a read-write volume:
+
+   % vos convertROtoRW server1 b test3.readonly
+
+=head1 PRIVILEGE REQUIRED
+
+The issuer must be listed in the F</usr/afs/etc/UserList> file on the
+machine specified with the B<-server> argument and
+on each database server machine.  If the B<-localauth> flag is included,
+the issuer must instead be logged on to a server machine as the local
+superuser C<root>.
+
+=head1 SEE ALSO
+
+L<vos(1)>
+
+=head1 COPYRIGHT
+
+Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
+
+This documentation is covered by the BSD License as written in the
+doc/LICENSE file. This man page was written by Jason Edgecombe for
+OpenAFS.
index 436cfbb..52bb01b 100644 (file)
@@ -141,48 +141,7 @@ sufficient for almost all cases, so you should almost never need to
 specify them explicitly. This option is available in OpenAFS
 versions 1.5.61 or later.
 
-=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
 
similarity index 80%
rename from doc/man-pages/pod1/vos_delentry.pod
rename to doc/man-pages/pod1/vos_delentry.pod.in
index 0a2a673..991e910 100644 (file)
@@ -126,52 +126,11 @@ acceptable abbreviated forms. For details, see L<vos(1)>.
 Combine this argument with the B<-prefix> argument, the B<-server>
 argument, or both.
 
-=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<-dryrun>
 
 Show the actions which would be taken, but do not make changes.
 
-=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
 
similarity index 74%
rename from doc/man-pages/pod1/vos_endtrans.pod
rename to doc/man-pages/pod1/vos_endtrans.pod.in
index f57367a..2846354 100644 (file)
@@ -71,46 +71,7 @@ Identifies which transaction to end on the Volume Server. You can get a
 listing of active transactions and their IDs from the output of
 L<B<vos status>|vos_status(1)>.
 
-=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.
-
-=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.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/vos-common.pod
 
 =back
 
index c727b73..c42f625 100644 (file)
@@ -67,48 +67,7 @@ directories in the volume.
 
 Shows information in a format suitable for machine parsing.
 
-=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
 
similarity index 70%
rename from doc/man-pages/pod1/vos_listaddrs.pod
rename to doc/man-pages/pod1/vos_listaddrs.pod.in
index f78317c..d4f0dee 100644 (file)
@@ -54,47 +54,7 @@ Prints the UUID of server entries in addition to the registered
 addresses. The B<-printuuid> option is available in OpenAFS versions 1.4.5
 or later and 1.5.8 or later.
 
-=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_listpart.pod b/doc/man-pages/pod1/vos_listpart.pod
deleted file mode 100644 (file)
index 3a242fc..0000000
+++ /dev/null
@@ -1,119 +0,0 @@
-=head1 NAME
-
-vos_listpart - Displays all AFS partitions on a file server machine
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos listpart> S<<< B<-server> <I<machine name>> >>>
-    S<<< [B<-cell> <I<cell name>>] >>>
-    [B<-noauth>] [B<-localauth>]
-    [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
-    S<<< [B<-config> <I<config directory>>] >>>
-    [B<-help>]
-
-B<vos listp> S<<< B<-s> <I<machine name>> >>> S<<< [B<-c> <I<cell name>>] >>>
-    [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
-    S<<< [B<-co> <I<config directory>>] >>>
-    [B<-h>]
-
-=for html
-</div>
-
-=head1 DESCRIPTION
-
-The B<vos listpart> command displays all of the valid AFS partitions on
-the indicated file server machine, without consulting the Volume Location
-Database (VLDB). The B<vos partinfo> command reports the size of a
-partition and the available space on that partition.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-server> <I<server name>>
-
-Identifies the file server machine for which to list the partitions.
-Provide the machine's IP address or its host name (either fully qualified
-or using an unambiguous abbreviation). For details, see L<vos(1)>.
-
-=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
-B</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.
-
-=back
-
-=head1 OUTPUT
-
-The output consists of a list of partition names of the form
-F</vicepI<xx>>, following the header:
-
-   The partitions on the server are:
-
-The last line of the output reports the total number of partitions.
-
-=head1 EXAMPLES
-
-The following command displays the partitions on C<fs1.example.com>:
-
-   % vos listpart fs1.example.com
-   The partitions on the server are:
-       /vicepa     /vicepb     /vicepc     /vicepd
-   Total:  4
-
-=head1 PRIVILEGE REQUIRED
-
-None
-
-=head1 SEE ALSO
-
-L<vos(1)>,
-L<vos_partinfo(1)>
-
-=head1 COPYRIGHT
-
-IBM Corporation 2000. <http://www.ibm.com/> 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/vos_listpart.pod.in b/doc/man-pages/pod1/vos_listpart.pod.in
new file mode 100644 (file)
index 0000000..bf4e13c
--- /dev/null
@@ -0,0 +1,79 @@
+=head1 NAME
+
+vos_listpart - Displays all AFS partitions on a file server machine
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos listpart> S<<< B<-server> <I<machine name>> >>>
+    S<<< [B<-cell> <I<cell name>>] >>>
+    [B<-noauth>] [B<-localauth>]
+    [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
+    S<<< [B<-config> <I<config directory>>] >>>
+    [B<-help>]
+
+B<vos listp> S<<< B<-s> <I<machine name>> >>> S<<< [B<-c> <I<cell name>>] >>>
+    [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
+    S<<< [B<-co> <I<config directory>>] >>>
+    [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<vos listpart> command displays all of the valid AFS partitions on
+the indicated file server machine, without consulting the Volume Location
+Database (VLDB). The B<vos partinfo> command reports the size of a
+partition and the available space on that partition.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-server> <I<server name>>
+
+Identifies the file server machine for which to list the partitions.
+Provide the machine's IP address or its host name (either fully qualified
+or using an unambiguous abbreviation). For details, see L<vos(1)>.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 OUTPUT
+
+The output consists of a list of partition names of the form
+F</vicepI<xx>>, following the header:
+
+   The partitions on the server are:
+
+The last line of the output reports the total number of partitions.
+
+=head1 EXAMPLES
+
+The following command displays the partitions on C<fs1.example.com>:
+
+   % vos listpart fs1.example.com
+   The partitions on the server are:
+       /vicepa     /vicepb     /vicepc     /vicepd
+   Total:  4
+
+=head1 PRIVILEGE REQUIRED
+
+None
+
+=head1 SEE ALSO
+
+L<vos(1)>,
+L<vos_partinfo(1)>
+
+=head1 COPYRIGHT
+
+IBM Corporation 2000. <http://www.ibm.com/> 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.
similarity index 85%
rename from doc/man-pages/pod1/vos_listvldb.pod
rename to doc/man-pages/pod1/vos_listvldb.pod.in
index 30e1dd5..7f6798c 100644 (file)
@@ -117,48 +117,7 @@ the output includes more than one volume.
 Suppresses the default sorting of volume entries alphabetically by volume
 name.
 
-=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
 
similarity index 88%
rename from doc/man-pages/pod1/vos_listvol.pod
rename to doc/man-pages/pod1/vos_listvol.pod.in
index 1445a24..4dae63f 100644 (file)
@@ -109,48 +109,7 @@ flag.
 
 Show information in a format suitable for machine parsing.
 
-=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
 
diff --git a/doc/man-pages/pod1/vos_lock.pod b/doc/man-pages/pod1/vos_lock.pod
deleted file mode 100644 (file)
index 2957f68..0000000
+++ /dev/null
@@ -1,123 +0,0 @@
-=head1 NAME
-
-vos_lock - Locks a VLDB volume entry
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos lock> S<<< B<-id> <I<volume name or ID>> >>>
-    S<<< [B<-cell> <I<cell name>>] >>>
-    [B<-noauth>] [B<-localauth>]
-    [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
-    S<<< [B<-config> <I<config directory>>] >>>
-    [B<-help>]
-
-B<vos lo> S<<< B<-i> <I<volume name or ID>> >>>
-    S<<< [B<-c> <I<cell name>>] >>>
-    [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
-    S<<< [B<-co> <I<config directory>>] >>>
-    [B<-h>]
-
-=for html
-</div>
-
-=head1 DESCRIPTION
-
-The B<vos lock> command locks the Volume Location Database (VLDB) entry
-for the indicated volume, blocking any operation that requires a write to
-that entry. The lock applies to all of the volume versions associated with
-the entry, not just the one specified with the B<-id> argument.
-
-To unlock a single VLDB entry, use the B<vos unlock> command. To unlock
-several entries, or all locked entries in the VLDB, use the B<vos
-unlockvldb> command.
-
-=head1 CAUTIONS
-
-Do not use this command in normal circumstances. It is useful for
-guaranteeing that the volume stays unchanged when there is reason to
-believe that volume operations cannot properly lock VLDB volume entries as
-they normally do to synchronize with one another.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-id> <I<volume name or ID>>
-
-Specifies either the complete name or volume ID number of a volume of the
-any of the three types.
-
-=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.
-
-=back
-
-=head1 EXAMPLES
-
-The following command locks the VLDB entry for C<user.terry>.
-
-   % vos lock user.terry
-
-=head1 PRIVILEGE REQUIRED
-
-The issuer must be listed in the F</usr/afs/etc/UserList> file on the
-machine specified with the B<-server> argument and on each database server
-machine. If the B<-localauth> flag is included, the issuer must instead be
-logged on to a server machine as the local superuser C<root>.
-
-=head1 SEE ALSO
-
-L<vos(1)>,
-L<vos_unlock(1)>,
-L<vos_unlockvldb(1)>
-
-=head1 COPYRIGHT
-
-IBM Corporation 2000. <http://www.ibm.com/> 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/vos_lock.pod.in b/doc/man-pages/pod1/vos_lock.pod.in
new file mode 100644 (file)
index 0000000..cacd41d
--- /dev/null
@@ -0,0 +1,82 @@
+=head1 NAME
+
+vos_lock - Locks a VLDB volume entry
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos lock> S<<< B<-id> <I<volume name or ID>> >>>
+    S<<< [B<-cell> <I<cell name>>] >>>
+    [B<-noauth>] [B<-localauth>]
+    [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
+    S<<< [B<-config> <I<config directory>>] >>>
+    [B<-help>]
+
+B<vos lo> S<<< B<-i> <I<volume name or ID>> >>>
+    S<<< [B<-c> <I<cell name>>] >>>
+    [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
+    S<<< [B<-co> <I<config directory>>] >>>
+    [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<vos lock> command locks the Volume Location Database (VLDB) entry
+for the indicated volume, blocking any operation that requires a write to
+that entry. The lock applies to all of the volume versions associated with
+the entry, not just the one specified with the B<-id> argument.
+
+To unlock a single VLDB entry, use the B<vos unlock> command. To unlock
+several entries, or all locked entries in the VLDB, use the B<vos
+unlockvldb> command.
+
+=head1 CAUTIONS
+
+Do not use this command in normal circumstances. It is useful for
+guaranteeing that the volume stays unchanged when there is reason to
+believe that volume operations cannot properly lock VLDB volume entries as
+they normally do to synchronize with one another.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-id> <I<volume name or ID>>
+
+Specifies either the complete name or volume ID number of a volume of the
+any of the three types.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 EXAMPLES
+
+The following command locks the VLDB entry for C<user.terry>.
+
+   % vos lock user.terry
+
+=head1 PRIVILEGE REQUIRED
+
+The issuer must be listed in the F</usr/afs/etc/UserList> file on the
+machine specified with the B<-server> argument and on each database server
+machine. If the B<-localauth> flag is included, the issuer must instead be
+logged on to a server machine as the local superuser C<root>.
+
+=head1 SEE ALSO
+
+L<vos(1)>,
+L<vos_unlock(1)>,
+L<vos_unlockvldb(1)>
+
+=head1 COPYRIGHT
+
+IBM Corporation 2000. <http://www.ibm.com/> 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.
index cffb583..5e2f996 100644 (file)
@@ -135,48 +135,7 @@ volumes to a another partition or server to free up disk space. The
 caveat is that the volume is locked during the entire operation
 instead of the short time that is needed to make the temporary clone.
 
-=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
 
similarity index 73%
rename from doc/man-pages/pod1/vos_offline.pod
rename to doc/man-pages/pod1/vos_offline.pod.in
index ea12f40..875e4e4 100644 (file)
@@ -95,47 +95,7 @@ it becomes available again.
 If B<-busy> is specified, the B<-sleep> option must also be specified, to
 indicate for how long to keep the volume busy.
 
-=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_online.pod b/doc/man-pages/pod1/vos_online.pod
deleted file mode 100644 (file)
index be243c4..0000000
+++ /dev/null
@@ -1,129 +0,0 @@
-=head1 NAME
-
-vos_online - Brings a volume online
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos online> S<<< B<-server> <I<machine name>> >>>
-    S<<< B<-partition> <I<partition name>> >>> 
-    S<<< B<-id> <I<volume name or ID>> >>>
-    S<<< [B<-cell> <I<cell name>>] >>>
-    [B<-noauth>] B<-localauth>]
-    [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
-    S<<< [B<-config> <I<config directory>>] >>>
-    [B<-help>]
-
-B<vos on> S<<< B<-s> <I<machine name>> >>>
-    S<<< B<-p> <I<partition name>> >>> 
-    S<<< B<-i> <I<volume name or ID>> >>>
-    S<<< [B<-c> <I<cell name>>] >>>
-    [B<-noa>] B<-l>] [B<-v>] [B<-e>] [B<-nor>]
-    S<<< [B<-co> <I<config directory>>] >>>
-    [B<-h>]
-
-=for html
-</div>
-
-=head1 DESCRIPTION
-
-The B<vos online> command brings an offline volume on line with the 
-B<fileserver>.
-
-=head1 CAUTIONS
-
-None.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-server> <I<machine name>>
-
-Identifies the file server machine where the volume resides. 
-Provide the machine's IP address or its host name (either fully
-qualified or using an unambiguous abbreviation). For details, see
-L<vos(1)>.
-
-=item B<-partition> <I<partition name>>
-
-Identifies the partition where the volume resides, on the
-file server machine named by the B<-server> argument. Provide the
-partition's complete name with preceding slash (for example, C</vicepa>)
-or use one of the three acceptable abbreviated forms. For details, see
-L<vos(1)>.
-
-=item B<-id> <I<volume name or ID>>
-
-Specifies either the complete name or volume ID number of the 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 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.
-
-=back
-
-=head1 EXAMPLES
-
-The following example brings an offline volume online:
-
-   % vos online -server sv7.example.org -partition /vicepb -id root.afs
-
-=head1 PRIVILEGE REQUIRED
-
-The issuer must be listed in the F</usr/afs/etc/UserList> file on the
-machine specified with the B<-server> argument and on each database server
-machine. If the B<-localauth> flag is included, the issuer must instead be
-logged on to a server machine as the local superuser C<root>.
-
-=head1 SEE ALSO
-
-L<vos(1)>,
-L<vos_offline(1)>,
-L<bos_salvage(8)>,
-
-=head1 COPYRIGHT
-
-IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
-
-This man page was created by Steven Jenkins.
diff --git a/doc/man-pages/pod1/vos_online.pod.in b/doc/man-pages/pod1/vos_online.pod.in
new file mode 100644 (file)
index 0000000..94bcd94
--- /dev/null
@@ -0,0 +1,89 @@
+=head1 NAME
+
+vos_online - Brings a volume online
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos online> S<<< B<-server> <I<machine name>> >>>
+    S<<< B<-partition> <I<partition name>> >>> 
+    S<<< B<-id> <I<volume name or ID>> >>>
+    S<<< [B<-cell> <I<cell name>>] >>>
+    [B<-noauth>] B<-localauth>]
+    [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
+    S<<< [B<-config> <I<config directory>>] >>>
+    [B<-help>]
+
+B<vos on> S<<< B<-s> <I<machine name>> >>>
+    S<<< B<-p> <I<partition name>> >>> 
+    S<<< B<-i> <I<volume name or ID>> >>>
+    S<<< [B<-c> <I<cell name>>] >>>
+    [B<-noa>] B<-l>] [B<-v>] [B<-e>] [B<-nor>]
+    S<<< [B<-co> <I<config directory>>] >>>
+    [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<vos online> command brings an offline volume on line with the 
+B<fileserver>.
+
+=head1 CAUTIONS
+
+None.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-server> <I<machine name>>
+
+Identifies the file server machine where the volume resides. 
+Provide the machine's IP address or its host name (either fully
+qualified or using an unambiguous abbreviation). For details, see
+L<vos(1)>.
+
+=item B<-partition> <I<partition name>>
+
+Identifies the partition where the volume resides, on the
+file server machine named by the B<-server> argument. Provide the
+partition's complete name with preceding slash (for example, C</vicepa>)
+or use one of the three acceptable abbreviated forms. For details, see
+L<vos(1)>.
+
+=item B<-id> <I<volume name or ID>>
+
+Specifies either the complete name or volume ID number of the volume.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 EXAMPLES
+
+The following example brings an offline volume online:
+
+   % vos online -server sv7.example.org -partition /vicepb -id root.afs
+
+=head1 PRIVILEGE REQUIRED
+
+The issuer must be listed in the F</usr/afs/etc/UserList> file on the
+machine specified with the B<-server> argument and on each database server
+machine. If the B<-localauth> flag is included, the issuer must instead be
+logged on to a server machine as the local superuser C<root>.
+
+=head1 SEE ALSO
+
+L<vos(1)>,
+L<vos_offline(1)>,
+L<bos_salvage(8)>,
+
+=head1 COPYRIGHT
+
+IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
+
+This man page was created by Steven Jenkins.
index 77c69da..f6743ae 100644 (file)
@@ -60,48 +60,7 @@ L<vos(1)>.
 
 Prints storage summary.
 
-=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
 
similarity index 82%
rename from doc/man-pages/pod1/vos_release.pod
rename to doc/man-pages/pod1/vos_release.pod.in
index f4367fa..9aff1b8 100644 (file)
@@ -144,54 +144,13 @@ Creates a new ReleaseClone and distributes it all read-only sites
 regardless of whether or not any site definitions in the VLDB entry are
 marked with a flag.
 
-=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<-stayonline>
 
 Avoids taking replica sites offline by cloning both the source
 and destinations to temporary clones, applying updates, and then
 bringing all clones online as updated readonly volumes.
 
-=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
 
similarity index 80%
rename from doc/man-pages/pod1/vos_remove.pod
rename to doc/man-pages/pod1/vos_remove.pod.in
index 481438e..1ac8640 100644 (file)
@@ -117,48 +117,7 @@ Identifies the volume to remove, either by its complete name or volume ID
 number. If identifying a read-only or backup volume by name, include the
 appropriate extension (C<.readonly> or C<.backup>).
 
-=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
 
similarity index 70%
rename from doc/man-pages/pod1/vos_remsite.pod
rename to doc/man-pages/pod1/vos_remsite.pod.in
index ac19108..bd20adc 100644 (file)
@@ -72,48 +72,7 @@ forms. For details, see L<vos(1)>.
 Specifies either the complete name or volume ID number of the read/write
 volume to remove.
 
-=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
 
diff --git a/doc/man-pages/pod1/vos_rename.pod b/doc/man-pages/pod1/vos_rename.pod
deleted file mode 100644 (file)
index bd10f08..0000000
+++ /dev/null
@@ -1,129 +0,0 @@
-=head1 NAME
-
-vos_rename - Renames a volume
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos rename> S<<< B<-oldname> <I<old volume name>> >>>
-    S<<< B<-newname> <I<new volume name>> >>>
-    S<<< [B<-cell> <I<cell name>>] >>>
-    [B<-noauth>] [B<-localauth>]
-    [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
-    S<<< [B<-config> <I<config directory>>] >>>
-    [B<-help>]
-
-B<vos ren> S<<< B<-o> <I<old volume name>> >>>
-    S<<< B<-ne> <I<new volume name>> >>>
-    [-c <I<cell name>>] [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
-    S<<< [B<-co> <I<config directory>>] >>>
-    [B<-h>]
-
-=for html
-</div>
-
-=head1 DESCRIPTION
-
-The B<vos rename> command changes the name of the read/write volume
-specified with the B<-oldname> argument to the name specified with the
-B<-newname> argument. The names of the read/write's read-only copies and
-backup copy, if any, change automatically to match.
-
-After issuing this command, remember to correct any mount points that
-refer to the old volume name, by removing the old mount point with the
-B<fs rmmount> command and creating a new one with the B<fs mkmount>
-command.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-oldname> <I<old volume name>>
-
-Is the current name of the read/write volume.
-
-=item B<-newname> <I<new volume name>>
-
-Is the desired new name for the 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.
-
-=back
-
-=head1 OUTPUT
-
-The B<vos rename> command produces no output if the command succeeds.
-
-If the volume named by the B<-oldname> argument does not exist, the
-following message appears:
-
-   vos: Could not find entry for volume <old volume name>.
-
-=head1 EXAMPLES
-
-The following example changes the mistaken volume name C<sun4x_56.afsws>
-to the correct alternative C<sun4x_56.usr.afsws>.
-
-   % vos rename -oldname sun4x_56.afsws -newname sun4x_56.usr.afsws
-
-=head1 PRIVILEGE REQUIRED
-
-The issuer must be listed in the F</usr/afs/etc/UserList> file on the
-machine specified with the B<-server> argument and on each database server
-machine. If the B<-localauth> flag is included, the issuer must instead be
-logged on to a server machine as the local superuser C<root>.
-
-=head1 SEE ALSO
-
-L<vos(1)>
-
-=head1 COPYRIGHT
-
-IBM Corporation 2000. <http://www.ibm.com/> 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/vos_rename.pod.in b/doc/man-pages/pod1/vos_rename.pod.in
new file mode 100644 (file)
index 0000000..f2b05fd
--- /dev/null
@@ -0,0 +1,88 @@
+=head1 NAME
+
+vos_rename - Renames a volume
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos rename> S<<< B<-oldname> <I<old volume name>> >>>
+    S<<< B<-newname> <I<new volume name>> >>>
+    S<<< [B<-cell> <I<cell name>>] >>>
+    [B<-noauth>] [B<-localauth>]
+    [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
+    S<<< [B<-config> <I<config directory>>] >>>
+    [B<-help>]
+
+B<vos ren> S<<< B<-o> <I<old volume name>> >>>
+    S<<< B<-ne> <I<new volume name>> >>>
+    [-c <I<cell name>>] [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
+    S<<< [B<-co> <I<config directory>>] >>>
+    [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<vos rename> command changes the name of the read/write volume
+specified with the B<-oldname> argument to the name specified with the
+B<-newname> argument. The names of the read/write's read-only copies and
+backup copy, if any, change automatically to match.
+
+After issuing this command, remember to correct any mount points that
+refer to the old volume name, by removing the old mount point with the
+B<fs rmmount> command and creating a new one with the B<fs mkmount>
+command.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-oldname> <I<old volume name>>
+
+Is the current name of the read/write volume.
+
+=item B<-newname> <I<new volume name>>
+
+Is the desired new name for the volume.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 OUTPUT
+
+The B<vos rename> command produces no output if the command succeeds.
+
+If the volume named by the B<-oldname> argument does not exist, the
+following message appears:
+
+   vos: Could not find entry for volume <old volume name>.
+
+=head1 EXAMPLES
+
+The following example changes the mistaken volume name C<sun4x_56.afsws>
+to the correct alternative C<sun4x_56.usr.afsws>.
+
+   % vos rename -oldname sun4x_56.afsws -newname sun4x_56.usr.afsws
+
+=head1 PRIVILEGE REQUIRED
+
+The issuer must be listed in the F</usr/afs/etc/UserList> file on the
+machine specified with the B<-server> argument and on each database server
+machine. If the B<-localauth> flag is included, the issuer must instead be
+logged on to a server machine as the local superuser C<root>.
+
+=head1 SEE ALSO
+
+L<vos(1)>
+
+=head1 COPYRIGHT
+
+IBM Corporation 2000. <http://www.ibm.com/> 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.
similarity index 85%
rename from doc/man-pages/pod1/vos_restore.pod
rename to doc/man-pages/pod1/vos_restore.pod.in
index 99fbe89..6c5dd70 100644 (file)
@@ -213,48 +213,7 @@ 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 1.4.1 or later and 1.5.0 or later.
 
-=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
 
similarity index 70%
rename from doc/man-pages/pod1/vos_setaddrs.pod
rename to doc/man-pages/pod1/vos_setaddrs.pod.in
index a6239ff..63792c1 100644 (file)
@@ -66,46 +66,7 @@ The unique ID as provided by the C<vos listaddrs -printuuid> command.
 
 The new list of IP addresses for the File Server.
 
-=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.
-
-=item B<-noresolve>
-
-Shows all servers as IP addresses instead of the DNS name. Lets you
-work with IP addresses for input, without the DNS translation between
-the input and the registration of the IP address in the VLDB.
-
-=item B<-help>
-
-Prints the online help for this command. All other valid options are
-ignored.
+=include fragments/vos-common.pod
 
 =back
 
similarity index 69%
rename from doc/man-pages/pod1/vos_setfields.pod
rename to doc/man-pages/pod1/vos_setfields.pod.in
index b8f74e5..5a35230 100644 (file)
@@ -71,48 +71,7 @@ will increment with time and stop updating when it reaches the maximum
 value. This option will reset it to 0. This option is available in OpenAFS
 version 1.5.0 or later.
 
-=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
 
index 28420fc..9c9301c 100644 (file)
@@ -124,48 +124,7 @@ mechanism.
 Copy the changes from the source volume to a previously created shadow
 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
 
similarity index 74%
rename from doc/man-pages/pod1/vos_size.pod
rename to doc/man-pages/pod1/vos_size.pod.in
index a3970ef..ad1c88c 100644 (file)
@@ -72,44 +72,7 @@ Specifies whether the dump is full or incremental. Omit this argument to
 size a full dump. See L<vos_dump(1)> for the valid values for this
 option.
 
-=item B<-cell> <I<cell name>>
-
-The cell in which the volume resides, if it's not in the current cell.
-
-=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>
-
-Show more output about what's going on.
-
-=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
 
similarity index 75%
rename from doc/man-pages/pod1/vos_status.pod
rename to doc/man-pages/pod1/vos_status.pod.in
index 401d6a3..8dd7631 100644 (file)
@@ -45,48 +45,7 @@ display status information. Provide the machine's IP address or its host
 name (either fully qualified or using an unambiguous abbreviation). For
 details, see L<vos(1)>.
 
-=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
 
similarity index 69%
rename from doc/man-pages/pod1/vos_syncserv.pod
rename to doc/man-pages/pod1/vos_syncserv.pod.in
index 6bf1ae7..e9d0983 100644 (file)
@@ -64,52 +64,11 @@ the partition's complete name with preceding slash (for example,
 C</vicepa>) or use one of the three acceptable abbreviated forms. For
 details, see L<vos(1)>.
 
-=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<-dryrun>
 
 Show the actions which would be taken, but do not make changes.
 
-=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
 
similarity index 76%
rename from doc/man-pages/pod1/vos_syncvldb.pod
rename to doc/man-pages/pod1/vos_syncvldb.pod.in
index 5f02163..30b0e18 100644 (file)
@@ -87,52 +87,11 @@ Specifies the name or volume ID number of a single volume for which to
 verify the VLDB entry. This argument can be combined with the B<-server>
 (and optionally, the B<-partition>) argument.
 
-=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<-dryrun>
 
 Show the actions which would be taken, but do not make changes.
 
-=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
 
diff --git a/doc/man-pages/pod1/vos_unlock.pod b/doc/man-pages/pod1/vos_unlock.pod
deleted file mode 100644 (file)
index 408f05e..0000000
+++ /dev/null
@@ -1,123 +0,0 @@
-=head1 NAME
-
-vos_unlock - Unlocks a single VLDB entry
-
-=head1 SYNOPSIS
-
-=for html
-<div class="synopsis">
-
-B<vos unlock> S<<< B<-id> <I<volume name or ID>> >>>
-    S<<< [B<-cell> <I<cell name>>] >>>
-    [B<-noauth>] [B<-localauth>]
-    [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
-    S<<< [B<-config> <I<config directory>>] >>>
-    [B<-help>]
-
-B<vos unlock> S<<< B<-i> <I<volume name or ID>> >>>
-    S<<< [B<-c> <I<cell name>>] >>>
-    [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
-    S<<< [B<-co> <I<config directory>>] >>>
-    [B<-h>]
-
-=for html
-</div>
-
-=head1 DESCRIPTION
-
-The B<vos unlock> command releases the lock on the Volume Location
-Database (VLDB) entry for the indicated volume.
-
-=head1 CAUTIONS
-
-Do not user this command under normal circumstances.
-
-It is useful if the VLDB entry is locked but there is no reason to suspect
-inconsistency within the volume or between it and the VLDB. Note that it
-is possible to list information from locked VLDB entries, even though they
-cannot be manipulated in other ways.
-
-The B<vos unlockvldb> command unlocks several VLDB entries at once, or
-even the entire VLDB. The B<vos lock> command locks a VLDB entry so that
-no one else can perform an action that requires writing the VLDB.
-
-=head1 OPTIONS
-
-=over 4
-
-=item B<-id> <I<volume name or ID>>
-
-Specifies either the complete name or volume ID number of a volume of any
-of the three types.
-
-=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.
-
-=back
-
-=head1 EXAMPLES
-
-The following example unlocks the VLDB entry for the volume C<user.terry>.
-
-   % vos unlock user.terry
-
-=head1 PRIVILEGE REQUIRED
-
-The issuer must be listed in the F</usr/afs/etc/UserList> file on the
-machine specified with the B<-server> argument and on each database server
-machine. If the B<-localauth> flag is included, the issuer must instead be
-logged on to a server machine as the local superuser C<root>.
-
-=head1 SEE ALSO
-
-L<vos(1)>,
-L<vos_lock(1)>,
-L<vos_unlockvldb(1)>
-
-=head1 COPYRIGHT
-
-IBM Corporation 2000. <http://www.ibm.com/> 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/vos_unlock.pod.in b/doc/man-pages/pod1/vos_unlock.pod.in
new file mode 100644 (file)
index 0000000..4b9fbf5
--- /dev/null
@@ -0,0 +1,82 @@
+=head1 NAME
+
+vos_unlock - Unlocks a single VLDB entry
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<vos unlock> S<<< B<-id> <I<volume name or ID>> >>>
+    S<<< [B<-cell> <I<cell name>>] >>>
+    [B<-noauth>] [B<-localauth>]
+    [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
+    S<<< [B<-config> <I<config directory>>] >>>
+    [B<-help>]
+
+B<vos unlock> S<<< B<-i> <I<volume name or ID>> >>>
+    S<<< [B<-c> <I<cell name>>] >>>
+    [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
+    S<<< [B<-co> <I<config directory>>] >>>
+    [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<vos unlock> command releases the lock on the Volume Location
+Database (VLDB) entry for the indicated volume.
+
+=head1 CAUTIONS
+
+Do not user this command under normal circumstances.
+
+It is useful if the VLDB entry is locked but there is no reason to suspect
+inconsistency within the volume or between it and the VLDB. Note that it
+is possible to list information from locked VLDB entries, even though they
+cannot be manipulated in other ways.
+
+The B<vos unlockvldb> command unlocks several VLDB entries at once, or
+even the entire VLDB. The B<vos lock> command locks a VLDB entry so that
+no one else can perform an action that requires writing the VLDB.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-id> <I<volume name or ID>>
+
+Specifies either the complete name or volume ID number of a volume of any
+of the three types.
+
+=include fragments/vos-common.pod
+
+=back
+
+=head1 EXAMPLES
+
+The following example unlocks the VLDB entry for the volume C<user.terry>.
+
+   % vos unlock user.terry
+
+=head1 PRIVILEGE REQUIRED
+
+The issuer must be listed in the F</usr/afs/etc/UserList> file on the
+machine specified with the B<-server> argument and on each database server
+machine. If the B<-localauth> flag is included, the issuer must instead be
+logged on to a server machine as the local superuser C<root>.
+
+=head1 SEE ALSO
+
+L<vos(1)>,
+L<vos_lock(1)>,
+L<vos_unlockvldb(1)>
+
+=head1 COPYRIGHT
+
+IBM Corporation 2000. <http://www.ibm.com/> 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.
similarity index 71%
rename from doc/man-pages/pod1/vos_unlockvldb.pod
rename to doc/man-pages/pod1/vos_unlockvldb.pod.in
index 02abdd0..8c81c7f 100644 (file)
@@ -88,48 +88,7 @@ partition's complete name with preceding slash (for example, C</vicepa>)
 or use one of the three acceptable abbreviated forms. For details, see
 L<vos(1)>.
 
-=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